AWS API Changes

2017/12/08 - Amazon AppStream - 7 updated api methods

Changes This API update is to support the feature that allows customers to automatically consume the latest Amazon AppStream 2.0 agent as and when published by AWS.

CreateImageBuilder (updated)

Link ¶
Changes (request, response)
Request

{'AppstreamAgentVersion': 'string'}

Response

{'ImageBuilder': {'AppstreamAgentVersion': 'string',
                  'State': {'UPDATING_AGENT'}}}

Creates an image builder.

The initial state of the builder is PENDING . When it is ready, the state is RUNNING .

See also: AWS API Documentation

Request Syntax

client.create_image_builder(
    Name='string',
    ImageName='string',
    InstanceType='string',
    Description='string',
    DisplayName='string',
    VpcConfig={
        'SubnetIds': [
            'string',
        ],
        'SecurityGroupIds': [
            'string',
        ]
    },
    EnableDefaultInternetAccess=True|False,
    DomainJoinInfo={
        'DirectoryName': 'string',
        'OrganizationalUnitDistinguishedName': 'string'
    },
    AppstreamAgentVersion='string'
)

type Name

string

param Name

[REQUIRED]

A unique name for the image builder.

type ImageName

string

param ImageName

[REQUIRED]

The name of the image used to create the builder.

type InstanceType

string

param InstanceType

[REQUIRED]

The instance type to use when launching the image builder.

type Description

string

param Description

The description for display.

type DisplayName

string

param DisplayName

The image builder name for display.

type VpcConfig

dict

param VpcConfig

The VPC configuration for the image builder. You can specify only one subnet.

SubnetIds (list) --

The subnets to which a network interface is established from the fleet instance.
- (string) --
SecurityGroupIds (list) --

The security groups for the fleet.
- (string) --

type EnableDefaultInternetAccess

boolean

param EnableDefaultInternetAccess

Enables or disables default internet access for the image builder.

type DomainJoinInfo

dict

param DomainJoinInfo

The information needed to join a Microsoft Active Directory domain.

DirectoryName (string) --

The fully qualified name of the directory (for example, corp.example.com).
OrganizationalUnitDistinguishedName (string) --

The distinguished name of the organizational unit for computer accounts.

type AppstreamAgentVersion

string

param AppstreamAgentVersion

The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].

rtype

dict

returns

Response Syntax

{
    'ImageBuilder': {
        'Name': 'string',
        'Arn': 'string',
        'ImageArn': 'string',
        'Description': 'string',
        'DisplayName': 'string',
        'VpcConfig': {
            'SubnetIds': [
                'string',
            ],
            'SecurityGroupIds': [
                'string',
            ]
        },
        'InstanceType': 'string',
        'Platform': 'WINDOWS',
        'State': 'PENDING'|'UPDATING_AGENT'|'RUNNING'|'STOPPING'|'STOPPED'|'REBOOTING'|'SNAPSHOTTING'|'DELETING'|'FAILED',
        'StateChangeReason': {
            'Code': 'INTERNAL_ERROR'|'IMAGE_UNAVAILABLE',
            'Message': 'string'
        },
        'CreatedTime': datetime(2015, 1, 1),
        'EnableDefaultInternetAccess': True|False,
        'DomainJoinInfo': {
            'DirectoryName': 'string',
            'OrganizationalUnitDistinguishedName': 'string'
        },
        'ImageBuilderErrors': [
            {
                'ErrorCode': 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'IAM_SERVICE_ROLE_IS_MISSING'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
                'ErrorMessage': 'string',
                'ErrorTimestamp': datetime(2015, 1, 1)
            },
        ],
        'AppstreamAgentVersion': 'string'
    }
}

Response Structure

(dict) --
- ImageBuilder (dict) --
  
  Information about the image builder.
  - Name (string) --
    
    The name of the image builder.
  - Arn (string) --
    
    The ARN for the image builder.
  - ImageArn (string) --
    
    The ARN of the image from which this builder was created.
  - Description (string) --
    
    The description for display.
  - DisplayName (string) --
    
    The image builder name for display.
  - VpcConfig (dict) --
    
    The VPC configuration of the image builder.
    - SubnetIds (list) --
      
      The subnets to which a network interface is established from the fleet instance.
      - (string) --
    - SecurityGroupIds (list) --
      
      The security groups for the fleet.
      - (string) --
  - InstanceType (string) --
    
    The instance type for the image builder.
  - Platform (string) --
    
    The operating system platform of the image builder.
  - State (string) --
    
    The state of the image builder.
  - StateChangeReason (dict) --
    
    The reason why the last state change occurred.
    - Code (string) --
      
      The state change reason code.
    - Message (string) --
      
      The state change reason message.
  - CreatedTime (datetime) --
    
    The time stamp when the image builder was created.
  - EnableDefaultInternetAccess (boolean) --
    
    Enables or disables default internet access for the image builder.
  - DomainJoinInfo (dict) --
    
    The information needed to join a Microsoft Active Directory domain.
    - DirectoryName (string) --
      
      The fully qualified name of the directory (for example, corp.example.com).
    - OrganizationalUnitDistinguishedName (string) --
      
      The distinguished name of the organizational unit for computer accounts.
  - ImageBuilderErrors (list) --
    
    The image builder errors.
    - (dict) --
      
      Describes a resource error.
      - ErrorCode (string) --
        
        The error code.
      - ErrorMessage (string) --
        
        The error message.
      - ErrorTimestamp (datetime) --
        
        The time the error occurred.
  - AppstreamAgentVersion (string) --
    
    The version of the AppStream 2.0 agent that is currently being used by this image builder.

DeleteImage (updated)

Link ¶
Changes (response)

{'Image': {'AppstreamAgentVersion': 'string'}}

Deletes the specified image. You cannot delete an image that is currently in use. After you delete an image, you cannot provision new capacity using the image.

See also: AWS API Documentation

Request Syntax

client.delete_image(
    Name='string'
)

type Name

string

param Name

[REQUIRED]

The name of the image.

rtype

dict

returns

Response Syntax

{
    'Image': {
        'Name': 'string',
        'Arn': 'string',
        'BaseImageArn': 'string',
        'DisplayName': 'string',
        'State': 'PENDING'|'AVAILABLE'|'FAILED'|'DELETING',
        'Visibility': 'PUBLIC'|'PRIVATE',
        'ImageBuilderSupported': True|False,
        'Platform': 'WINDOWS',
        'Description': 'string',
        'StateChangeReason': {
            'Code': 'INTERNAL_ERROR'|'IMAGE_BUILDER_NOT_AVAILABLE',
            'Message': 'string'
        },
        'Applications': [
            {
                'Name': 'string',
                'DisplayName': 'string',
                'IconURL': 'string',
                'LaunchPath': 'string',
                'LaunchParameters': 'string',
                'Enabled': True|False,
                'Metadata': {
                    'string': 'string'
                }
            },
        ],
        'CreatedTime': datetime(2015, 1, 1),
        'PublicBaseImageReleasedDate': datetime(2015, 1, 1),
        'AppstreamAgentVersion': 'string'
    }
}

Response Structure

(dict) --
- Image (dict) --
  
  Information about the image.
  - Name (string) --
    
    The name of the image.
  - Arn (string) --
    
    The ARN of the image.
  - BaseImageArn (string) --
    
    The ARN of the image from which this image was created.
  - DisplayName (string) --
    
    The image name for display.
  - State (string) --
    
    The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE . If image creation fails, the state is FAILED .
  - Visibility (string) --
    
    Indicates whether the image is public or private.
  - ImageBuilderSupported (boolean) --
    
    Indicates whether an image builder can be launched from this image.
  - Platform (string) --
    
    The operating system platform of the image.
  - Description (string) --
    
    The description for display.
  - StateChangeReason (dict) --
    
    The reason why the last state change occurred.
    - Code (string) --
      
      The state change reason code.
    - Message (string) --
      
      The state change reason message.
  - Applications (list) --
    
    The applications associated with the image.
    - (dict) --
      
      Describes an application in the application catalog.
      - Name (string) --
        
        The name of the application.
      - DisplayName (string) --
        
        The application name for display.
      - IconURL (string) --
        
        The URL for the application icon. This URL might be time-limited.
      - LaunchPath (string) --
        
        The path to the application executable in the instance.
      - LaunchParameters (string) --
        
        The arguments that are passed to the application at launch.
      - Enabled (boolean) --
        
        If there is a problem, the application can be disabled after image creation.
      - Metadata (dict) --
        
        Additional attributes that describe the application.
        
        (string) --
        
        (string) --
  - CreatedTime (datetime) --
    
    The time the image was created.
  - PublicBaseImageReleasedDate (datetime) --
    
    The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.
  - AppstreamAgentVersion (string) --
    
    The version of the AppStream 2.0 agent to use for instances that are launched from this image.

DeleteImageBuilder (updated)

Link ¶
Changes (response)

{'ImageBuilder': {'AppstreamAgentVersion': 'string',
                  'State': {'UPDATING_AGENT'}}}

Deletes the specified image builder and releases the capacity.

See also: AWS API Documentation

Request Syntax

client.delete_image_builder(
    Name='string'
)

type Name

string

param Name

[REQUIRED]

The name of the image builder.

rtype

dict

returns

Response Syntax

{
    'ImageBuilder': {
        'Name': 'string',
        'Arn': 'string',
        'ImageArn': 'string',
        'Description': 'string',
        'DisplayName': 'string',
        'VpcConfig': {
            'SubnetIds': [
                'string',
            ],
            'SecurityGroupIds': [
                'string',
            ]
        },
        'InstanceType': 'string',
        'Platform': 'WINDOWS',
        'State': 'PENDING'|'UPDATING_AGENT'|'RUNNING'|'STOPPING'|'STOPPED'|'REBOOTING'|'SNAPSHOTTING'|'DELETING'|'FAILED',
        'StateChangeReason': {
            'Code': 'INTERNAL_ERROR'|'IMAGE_UNAVAILABLE',
            'Message': 'string'
        },
        'CreatedTime': datetime(2015, 1, 1),
        'EnableDefaultInternetAccess': True|False,
        'DomainJoinInfo': {
            'DirectoryName': 'string',
            'OrganizationalUnitDistinguishedName': 'string'
        },
        'ImageBuilderErrors': [
            {
                'ErrorCode': 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'IAM_SERVICE_ROLE_IS_MISSING'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
                'ErrorMessage': 'string',
                'ErrorTimestamp': datetime(2015, 1, 1)
            },
        ],
        'AppstreamAgentVersion': 'string'
    }
}

Response Structure

(dict) --
- ImageBuilder (dict) --
  
  Information about the image builder.
  - Name (string) --
    
    The name of the image builder.
  - Arn (string) --
    
    The ARN for the image builder.
  - ImageArn (string) --
    
    The ARN of the image from which this builder was created.
  - Description (string) --
    
    The description for display.
  - DisplayName (string) --
    
    The image builder name for display.
  - VpcConfig (dict) --
    
    The VPC configuration of the image builder.
    - SubnetIds (list) --
      
      The subnets to which a network interface is established from the fleet instance.
      - (string) --
    - SecurityGroupIds (list) --
      
      The security groups for the fleet.
      - (string) --
  - InstanceType (string) --
    
    The instance type for the image builder.
  - Platform (string) --
    
    The operating system platform of the image builder.
  - State (string) --
    
    The state of the image builder.
  - StateChangeReason (dict) --
    
    The reason why the last state change occurred.
    - Code (string) --
      
      The state change reason code.
    - Message (string) --
      
      The state change reason message.
  - CreatedTime (datetime) --
    
    The time stamp when the image builder was created.
  - EnableDefaultInternetAccess (boolean) --
    
    Enables or disables default internet access for the image builder.
  - DomainJoinInfo (dict) --
    
    The information needed to join a Microsoft Active Directory domain.
    - DirectoryName (string) --
      
      The fully qualified name of the directory (for example, corp.example.com).
    - OrganizationalUnitDistinguishedName (string) --
      
      The distinguished name of the organizational unit for computer accounts.
  - ImageBuilderErrors (list) --
    
    The image builder errors.
    - (dict) --
      
      Describes a resource error.
      - ErrorCode (string) --
        
        The error code.
      - ErrorMessage (string) --
        
        The error message.
      - ErrorTimestamp (datetime) --
        
        The time the error occurred.
  - AppstreamAgentVersion (string) --
    
    The version of the AppStream 2.0 agent that is currently being used by this image builder.

DescribeImageBuilders (updated)

Link ¶
Changes (response)

{'ImageBuilders': {'AppstreamAgentVersion': 'string',
                   'State': {'UPDATING_AGENT'}}}

Describes the specified image builders or all image builders in the account.

See also: AWS API Documentation

Request Syntax

client.describe_image_builders(
    Names=[
        'string',
    ],
    MaxResults=123,
    NextToken='string'
)

type Names

list

param Names

The names of the image builders to describe.

(string) --

type MaxResults

integer

param MaxResults

The maximum size of each page of results.

type NextToken

string

param NextToken

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

rtype

dict

returns

Response Syntax

{
    'ImageBuilders': [
        {
            'Name': 'string',
            'Arn': 'string',
            'ImageArn': 'string',
            'Description': 'string',
            'DisplayName': 'string',
            'VpcConfig': {
                'SubnetIds': [
                    'string',
                ],
                'SecurityGroupIds': [
                    'string',
                ]
            },
            'InstanceType': 'string',
            'Platform': 'WINDOWS',
            'State': 'PENDING'|'UPDATING_AGENT'|'RUNNING'|'STOPPING'|'STOPPED'|'REBOOTING'|'SNAPSHOTTING'|'DELETING'|'FAILED',
            'StateChangeReason': {
                'Code': 'INTERNAL_ERROR'|'IMAGE_UNAVAILABLE',
                'Message': 'string'
            },
            'CreatedTime': datetime(2015, 1, 1),
            'EnableDefaultInternetAccess': True|False,
            'DomainJoinInfo': {
                'DirectoryName': 'string',
                'OrganizationalUnitDistinguishedName': 'string'
            },
            'ImageBuilderErrors': [
                {
                    'ErrorCode': 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'IAM_SERVICE_ROLE_IS_MISSING'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
                    'ErrorMessage': 'string',
                    'ErrorTimestamp': datetime(2015, 1, 1)
                },
            ],
            'AppstreamAgentVersion': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- ImageBuilders (list) --
  
  Information about the image builders.
  - (dict) --
    
    Describes a streaming instance used for editing an image. New images are created from a snapshot through an image builder.
    - Name (string) --
      
      The name of the image builder.
    - Arn (string) --
      
      The ARN for the image builder.
    - ImageArn (string) --
      
      The ARN of the image from which this builder was created.
    - Description (string) --
      
      The description for display.
    - DisplayName (string) --
      
      The image builder name for display.
    - VpcConfig (dict) --
      
      The VPC configuration of the image builder.
      - SubnetIds (list) --
        
        The subnets to which a network interface is established from the fleet instance.
        
        (string) --
      - SecurityGroupIds (list) --
        
        The security groups for the fleet.
        
        (string) --
    - InstanceType (string) --
      
      The instance type for the image builder.
    - Platform (string) --
      
      The operating system platform of the image builder.
    - State (string) --
      
      The state of the image builder.
    - StateChangeReason (dict) --
      
      The reason why the last state change occurred.
      - Code (string) --
        
        The state change reason code.
      - Message (string) --
        
        The state change reason message.
    - CreatedTime (datetime) --
      
      The time stamp when the image builder was created.
    - EnableDefaultInternetAccess (boolean) --
      
      Enables or disables default internet access for the image builder.
    - DomainJoinInfo (dict) --
      
      The information needed to join a Microsoft Active Directory domain.
      - DirectoryName (string) --
        
        The fully qualified name of the directory (for example, corp.example.com).
      - OrganizationalUnitDistinguishedName (string) --
        
        The distinguished name of the organizational unit for computer accounts.
    - ImageBuilderErrors (list) --
      
      The image builder errors.
      - (dict) --
        
        Describes a resource error.
        
        ErrorCode (string) --
        
        The error code.
        
        ErrorMessage (string) --
        
        The error message.
        
        ErrorTimestamp (datetime) --
        
        The time the error occurred.
    - AppstreamAgentVersion (string) --
      
      The version of the AppStream 2.0 agent that is currently being used by this image builder.
- NextToken (string) --
  
  The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

DescribeImages (updated)

Link ¶
Changes (response)

{'Images': {'AppstreamAgentVersion': 'string'}}

Describes the specified images or all images in the account.

See also: AWS API Documentation

Request Syntax

client.describe_images(
    Names=[
        'string',
    ]
)

type Names

list

param Names

The names of the images to describe.

(string) --

rtype

dict

returns

Response Syntax

{
    'Images': [
        {
            'Name': 'string',
            'Arn': 'string',
            'BaseImageArn': 'string',
            'DisplayName': 'string',
            'State': 'PENDING'|'AVAILABLE'|'FAILED'|'DELETING',
            'Visibility': 'PUBLIC'|'PRIVATE',
            'ImageBuilderSupported': True|False,
            'Platform': 'WINDOWS',
            'Description': 'string',
            'StateChangeReason': {
                'Code': 'INTERNAL_ERROR'|'IMAGE_BUILDER_NOT_AVAILABLE',
                'Message': 'string'
            },
            'Applications': [
                {
                    'Name': 'string',
                    'DisplayName': 'string',
                    'IconURL': 'string',
                    'LaunchPath': 'string',
                    'LaunchParameters': 'string',
                    'Enabled': True|False,
                    'Metadata': {
                        'string': 'string'
                    }
                },
            ],
            'CreatedTime': datetime(2015, 1, 1),
            'PublicBaseImageReleasedDate': datetime(2015, 1, 1),
            'AppstreamAgentVersion': 'string'
        },
    ]
}

Response Structure

(dict) --
- Images (list) --
  
  Information about the images.
  - (dict) --
    
    Describes an image.
    - Name (string) --
      
      The name of the image.
    - Arn (string) --
      
      The ARN of the image.
    - BaseImageArn (string) --
      
      The ARN of the image from which this image was created.
    - DisplayName (string) --
      
      The image name for display.
    - State (string) --
      
      The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE . If image creation fails, the state is FAILED .
    - Visibility (string) --
      
      Indicates whether the image is public or private.
    - ImageBuilderSupported (boolean) --
      
      Indicates whether an image builder can be launched from this image.
    - Platform (string) --
      
      The operating system platform of the image.
    - Description (string) --
      
      The description for display.
    - StateChangeReason (dict) --
      
      The reason why the last state change occurred.
      - Code (string) --
        
        The state change reason code.
      - Message (string) --
        
        The state change reason message.
    - Applications (list) --
      
      The applications associated with the image.
      - (dict) --
        
        Describes an application in the application catalog.
        
        Name (string) --
        
        The name of the application.
        
        DisplayName (string) --
        
        The application name for display.
        
        IconURL (string) --
        
        The URL for the application icon. This URL might be time-limited.
        
        LaunchPath (string) --
        
        The path to the application executable in the instance.
        
        LaunchParameters (string) --
        
        The arguments that are passed to the application at launch.
        
        Enabled (boolean) --
        
        If there is a problem, the application can be disabled after image creation.
        
        Metadata (dict) --
        
        Additional attributes that describe the application.
        
        (string) --
        
        (string) --
    - CreatedTime (datetime) --
      
      The time the image was created.
    - PublicBaseImageReleasedDate (datetime) --
      
      The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.
    - AppstreamAgentVersion (string) --
      
      The version of the AppStream 2.0 agent to use for instances that are launched from this image.

StartImageBuilder (updated)

Link ¶
Changes (request, response)
Request

{'AppstreamAgentVersion': 'string'}

Response

{'ImageBuilder': {'AppstreamAgentVersion': 'string',
                  'State': {'UPDATING_AGENT'}}}

Starts the specified image builder.

See also: AWS API Documentation

Request Syntax

client.start_image_builder(
    Name='string',
    AppstreamAgentVersion='string'
)

type Name

string

param Name

[REQUIRED]

The name of the image builder.

type AppstreamAgentVersion

string

param AppstreamAgentVersion

The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].

rtype

dict

returns

Response Syntax

{
    'ImageBuilder': {
        'Name': 'string',
        'Arn': 'string',
        'ImageArn': 'string',
        'Description': 'string',
        'DisplayName': 'string',
        'VpcConfig': {
            'SubnetIds': [
                'string',
            ],
            'SecurityGroupIds': [
                'string',
            ]
        },
        'InstanceType': 'string',
        'Platform': 'WINDOWS',
        'State': 'PENDING'|'UPDATING_AGENT'|'RUNNING'|'STOPPING'|'STOPPED'|'REBOOTING'|'SNAPSHOTTING'|'DELETING'|'FAILED',
        'StateChangeReason': {
            'Code': 'INTERNAL_ERROR'|'IMAGE_UNAVAILABLE',
            'Message': 'string'
        },
        'CreatedTime': datetime(2015, 1, 1),
        'EnableDefaultInternetAccess': True|False,
        'DomainJoinInfo': {
            'DirectoryName': 'string',
            'OrganizationalUnitDistinguishedName': 'string'
        },
        'ImageBuilderErrors': [
            {
                'ErrorCode': 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'IAM_SERVICE_ROLE_IS_MISSING'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
                'ErrorMessage': 'string',
                'ErrorTimestamp': datetime(2015, 1, 1)
            },
        ],
        'AppstreamAgentVersion': 'string'
    }
}

Response Structure

(dict) --
- ImageBuilder (dict) --
  
  Information about the image builder.
  - Name (string) --
    
    The name of the image builder.
  - Arn (string) --
    
    The ARN for the image builder.
  - ImageArn (string) --
    
    The ARN of the image from which this builder was created.
  - Description (string) --
    
    The description for display.
  - DisplayName (string) --
    
    The image builder name for display.
  - VpcConfig (dict) --
    
    The VPC configuration of the image builder.
    - SubnetIds (list) --
      
      The subnets to which a network interface is established from the fleet instance.
      - (string) --
    - SecurityGroupIds (list) --
      
      The security groups for the fleet.
      - (string) --
  - InstanceType (string) --
    
    The instance type for the image builder.
  - Platform (string) --
    
    The operating system platform of the image builder.
  - State (string) --
    
    The state of the image builder.
  - StateChangeReason (dict) --
    
    The reason why the last state change occurred.
    - Code (string) --
      
      The state change reason code.
    - Message (string) --
      
      The state change reason message.
  - CreatedTime (datetime) --
    
    The time stamp when the image builder was created.
  - EnableDefaultInternetAccess (boolean) --
    
    Enables or disables default internet access for the image builder.
  - DomainJoinInfo (dict) --
    
    The information needed to join a Microsoft Active Directory domain.
    - DirectoryName (string) --
      
      The fully qualified name of the directory (for example, corp.example.com).
    - OrganizationalUnitDistinguishedName (string) --
      
      The distinguished name of the organizational unit for computer accounts.
  - ImageBuilderErrors (list) --
    
    The image builder errors.
    - (dict) --
      
      Describes a resource error.
      - ErrorCode (string) --
        
        The error code.
      - ErrorMessage (string) --
        
        The error message.
      - ErrorTimestamp (datetime) --
        
        The time the error occurred.
  - AppstreamAgentVersion (string) --
    
    The version of the AppStream 2.0 agent that is currently being used by this image builder.

StopImageBuilder (updated)

Link ¶
Changes (response)

{'ImageBuilder': {'AppstreamAgentVersion': 'string',
                  'State': {'UPDATING_AGENT'}}}

Stops the specified image builder.

See also: AWS API Documentation

Request Syntax

client.stop_image_builder(
    Name='string'
)

type Name

string

param Name

[REQUIRED]

The name of the image builder.

rtype

dict

returns

Response Syntax

{
    'ImageBuilder': {
        'Name': 'string',
        'Arn': 'string',
        'ImageArn': 'string',
        'Description': 'string',
        'DisplayName': 'string',
        'VpcConfig': {
            'SubnetIds': [
                'string',
            ],
            'SecurityGroupIds': [
                'string',
            ]
        },
        'InstanceType': 'string',
        'Platform': 'WINDOWS',
        'State': 'PENDING'|'UPDATING_AGENT'|'RUNNING'|'STOPPING'|'STOPPED'|'REBOOTING'|'SNAPSHOTTING'|'DELETING'|'FAILED',
        'StateChangeReason': {
            'Code': 'INTERNAL_ERROR'|'IMAGE_UNAVAILABLE',
            'Message': 'string'
        },
        'CreatedTime': datetime(2015, 1, 1),
        'EnableDefaultInternetAccess': True|False,
        'DomainJoinInfo': {
            'DirectoryName': 'string',
            'OrganizationalUnitDistinguishedName': 'string'
        },
        'ImageBuilderErrors': [
            {
                'ErrorCode': 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'IAM_SERVICE_ROLE_IS_MISSING'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
                'ErrorMessage': 'string',
                'ErrorTimestamp': datetime(2015, 1, 1)
            },
        ],
        'AppstreamAgentVersion': 'string'
    }
}

Response Structure

(dict) --
- ImageBuilder (dict) --
  
  Information about the image builder.
  - Name (string) --
    
    The name of the image builder.
  - Arn (string) --
    
    The ARN for the image builder.
  - ImageArn (string) --
    
    The ARN of the image from which this builder was created.
  - Description (string) --
    
    The description for display.
  - DisplayName (string) --
    
    The image builder name for display.
  - VpcConfig (dict) --
    
    The VPC configuration of the image builder.
    - SubnetIds (list) --
      
      The subnets to which a network interface is established from the fleet instance.
      - (string) --
    - SecurityGroupIds (list) --
      
      The security groups for the fleet.
      - (string) --
  - InstanceType (string) --
    
    The instance type for the image builder.
  - Platform (string) --
    
    The operating system platform of the image builder.
  - State (string) --
    
    The state of the image builder.
  - StateChangeReason (dict) --
    
    The reason why the last state change occurred.
    - Code (string) --
      
      The state change reason code.
    - Message (string) --
      
      The state change reason message.
  - CreatedTime (datetime) --
    
    The time stamp when the image builder was created.
  - EnableDefaultInternetAccess (boolean) --
    
    Enables or disables default internet access for the image builder.
  - DomainJoinInfo (dict) --
    
    The information needed to join a Microsoft Active Directory domain.
    - DirectoryName (string) --
      
      The fully qualified name of the directory (for example, corp.example.com).
    - OrganizationalUnitDistinguishedName (string) --
      
      The distinguished name of the organizational unit for computer accounts.
  - ImageBuilderErrors (list) --
    
    The image builder errors.
    - (dict) --
      
      Describes a resource error.
      - ErrorCode (string) --
        
        The error code.
      - ErrorMessage (string) --
        
        The error message.
      - ErrorTimestamp (datetime) --
        
        The time the error occurred.
  - AppstreamAgentVersion (string) --
    
    The version of the AppStream 2.0 agent that is currently being used by this image builder.