Amazon AppStream

2017/09/29 - Amazon AppStream - 7 new api methods

Changes  Update appstream client to latest version

StopImageBuilder (new) Link ¶

See also: AWS API Documentation

Request Syntax

client.stop_image_builder(
    Name='string'
)
type Name:

string

param Name:

[REQUIRED]

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'|'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)
            },
        ]
    }
}

Response Structure

  • (dict) --

    • ImageBuilder (dict) --

      • Name (string) --

      • Arn (string) --

      • ImageArn (string) --

      • Description (string) --

      • DisplayName (string) --

      • VpcConfig (dict) --

        Describes VPC configuration information.

        • 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) --

      • Platform (string) --

      • State (string) --

      • StateChangeReason (dict) --

        • Code (string) --

        • Message (string) --

      • CreatedTime (datetime) --

      • EnableDefaultInternetAccess (boolean) --

      • DomainJoinInfo (dict) --

        Contains the information needed for streaming instances to join a 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) --

        • (dict) --

          • ErrorCode (string) --

          • ErrorMessage (string) --

          • ErrorTimestamp (datetime) --

StartImageBuilder (new) Link ¶

See also: AWS API Documentation

Request Syntax

client.start_image_builder(
    Name='string'
)
type Name:

string

param Name:

[REQUIRED]

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'|'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)
            },
        ]
    }
}

Response Structure

  • (dict) --

    • ImageBuilder (dict) --

      • Name (string) --

      • Arn (string) --

      • ImageArn (string) --

      • Description (string) --

      • DisplayName (string) --

      • VpcConfig (dict) --

        Describes VPC configuration information.

        • 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) --

      • Platform (string) --

      • State (string) --

      • StateChangeReason (dict) --

        • Code (string) --

        • Message (string) --

      • CreatedTime (datetime) --

      • EnableDefaultInternetAccess (boolean) --

      • DomainJoinInfo (dict) --

        Contains the information needed for streaming instances to join a 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) --

        • (dict) --

          • ErrorCode (string) --

          • ErrorMessage (string) --

          • ErrorTimestamp (datetime) --

DescribeImageBuilders (new) Link ¶

See also: AWS API Documentation

Request Syntax

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

list

param Names:

  • (string) --

type MaxResults:

integer

param MaxResults:

type NextToken:

string

param NextToken:

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'|'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)
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • ImageBuilders (list) --

      • (dict) --

        • Name (string) --

        • Arn (string) --

        • ImageArn (string) --

        • Description (string) --

        • DisplayName (string) --

        • VpcConfig (dict) --

          Describes VPC configuration information.

          • 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) --

        • Platform (string) --

        • State (string) --

        • StateChangeReason (dict) --

          • Code (string) --

          • Message (string) --

        • CreatedTime (datetime) --

        • EnableDefaultInternetAccess (boolean) --

        • DomainJoinInfo (dict) --

          Contains the information needed for streaming instances to join a 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) --

          • (dict) --

            • ErrorCode (string) --

            • ErrorMessage (string) --

            • ErrorTimestamp (datetime) --

    • NextToken (string) --

CreateImageBuilderStreamingURL (new) Link ¶

See also: AWS API Documentation

Request Syntax

client.create_image_builder_streaming_url(
    Name='string',
    Validity=123
)
type Name:

string

param Name:

[REQUIRED]

type Validity:

integer

param Validity:

rtype:

dict

returns:

Response Syntax

{
    'StreamingURL': 'string',
    'Expires': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • StreamingURL (string) --

    • Expires (datetime) --

CreateImageBuilder (new) Link ¶

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'
    }
)
type Name:

string

param Name:

[REQUIRED]

type ImageName:

string

param ImageName:

[REQUIRED]

type InstanceType:

string

param InstanceType:

[REQUIRED]

type Description:

string

param Description:

type DisplayName:

string

param DisplayName:

type VpcConfig:

dict

param VpcConfig:

Describes VPC configuration information.

  • 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:

type DomainJoinInfo:

dict

param DomainJoinInfo:

Contains the information needed for streaming instances to join a 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.

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'|'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)
            },
        ]
    }
}

Response Structure

  • (dict) --

    • ImageBuilder (dict) --

      • Name (string) --

      • Arn (string) --

      • ImageArn (string) --

      • Description (string) --

      • DisplayName (string) --

      • VpcConfig (dict) --

        Describes VPC configuration information.

        • 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) --

      • Platform (string) --

      • State (string) --

      • StateChangeReason (dict) --

        • Code (string) --

        • Message (string) --

      • CreatedTime (datetime) --

      • EnableDefaultInternetAccess (boolean) --

      • DomainJoinInfo (dict) --

        Contains the information needed for streaming instances to join a 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) --

        • (dict) --

          • ErrorCode (string) --

          • ErrorMessage (string) --

          • ErrorTimestamp (datetime) --

DeleteImageBuilder (new) Link ¶

See also: AWS API Documentation

Request Syntax

client.delete_image_builder(
    Name='string'
)
type Name:

string

param Name:

[REQUIRED]

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'|'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)
            },
        ]
    }
}

Response Structure

  • (dict) --

    • ImageBuilder (dict) --

      • Name (string) --

      • Arn (string) --

      • ImageArn (string) --

      • Description (string) --

      • DisplayName (string) --

      • VpcConfig (dict) --

        Describes VPC configuration information.

        • 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) --

      • Platform (string) --

      • State (string) --

      • StateChangeReason (dict) --

        • Code (string) --

        • Message (string) --

      • CreatedTime (datetime) --

      • EnableDefaultInternetAccess (boolean) --

      • DomainJoinInfo (dict) --

        Contains the information needed for streaming instances to join a 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) --

        • (dict) --

          • ErrorCode (string) --

          • ErrorMessage (string) --

          • ErrorTimestamp (datetime) --

DeleteImage (new) Link ¶

See also: AWS API Documentation

Request Syntax

client.delete_image(
    Name='string'
)
type Name:

string

param Name:

[REQUIRED]

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)
    }
}

Response Structure

  • (dict) --

    • Image (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 displayed to end users.

      • 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 displayed to end users.

      • 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 displayed to end users.

          • 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.