AppStream / Client / delete_image



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

See also: AWS API Documentation

Request Syntax

response = client.delete_image(

Name (string) –


The name of the image.

Return type:



Response Syntax

    'Image': {
        'Name': 'string',
        'Arn': 'string',
        'BaseImageArn': 'string',
        'DisplayName': 'string',
        'Visibility': 'PUBLIC'|'PRIVATE'|'SHARED',
        'ImageBuilderSupported': True|False,
        'ImageBuilderName': 'string',
        'Description': 'string',
        'StateChangeReason': {
            'Message': 'string'
        'Applications': [
                'Name': 'string',
                'DisplayName': 'string',
                'IconURL': 'string',
                'LaunchPath': 'string',
                'LaunchParameters': 'string',
                'Enabled': True|False,
                'Metadata': {
                    'string': 'string'
                'WorkingDirectory': 'string',
                'Description': 'string',
                'Arn': 'string',
                'AppBlockArn': 'string',
                'IconS3Location': {
                    'S3Bucket': 'string',
                    'S3Key': 'string'
                'Platforms': [
                'InstanceFamilies': [
                'CreatedTime': datetime(2015, 1, 1)
        'CreatedTime': datetime(2015, 1, 1),
        'PublicBaseImageReleasedDate': datetime(2015, 1, 1),
        'AppstreamAgentVersion': 'string',
        'ImagePermissions': {
            'allowFleet': True|False,
            'allowImageBuilder': True|False
        'ImageErrors': [
                'ErrorMessage': 'string',
                'ErrorTimestamp': datetime(2015, 1, 1)

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

      • ImageBuilderName (string) –

        The name of the image builder that was used to create the private image. If the image is shared, this value is null.

      • Platform (string) –

        The operating system platform of the image.

      • Description (string) –

        The description to 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 to 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) –

          • WorkingDirectory (string) –

            The working directory for the application.

          • Description (string) –

            The description of the application.

          • Arn (string) –

            The ARN of the application.

          • AppBlockArn (string) –

            The app block ARN of the application.

          • IconS3Location (dict) –

            The S3 location of the application icon.

            • S3Bucket (string) –

              The S3 bucket of the S3 object.

            • S3Key (string) –

              The S3 key of the S3 object.

              This is required when used for the following:

              • IconS3Location (Actions: CreateApplication and UpdateApplication)

              • SessionScriptS3Location (Actions: CreateFleet and UpdateFleet)

              • ScriptDetails (Actions: CreateAppBlock)

              • SourceS3Location when creating an app block with CUSTOM PackagingType (Actions: CreateAppBlock)

              • SourceS3Location when creating an app block with APPSTREAM2 PackagingType, and using an existing application package (VHD file). In this case, S3Key refers to the VHD file. If a new application package is required, then S3Key is not required. (Actions: CreateAppBlock)

          • Platforms (list) –

            The platforms on which the application can run.

            • (string) –

          • InstanceFamilies (list) –

            The instance families for the application.

            • (string) –

          • CreatedTime (datetime) –

            The time at which the application was created within the app block.

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

      • ImagePermissions (dict) –

        The permissions to provide to the destination AWS account for the specified image.

        • allowFleet (boolean) –

          Indicates whether the image can be used for a fleet.

        • allowImageBuilder (boolean) –

          Indicates whether the image can be used for an image builder.

      • ImageErrors (list) –

        Describes the errors that are returned when a new image can’t be created.

        • (dict) –

          Describes a resource error.

          • ErrorCode (string) –

            The error code.

          • ErrorMessage (string) –

            The error message.

          • ErrorTimestamp (datetime) –

            The time the error occurred.


  • AppStream.Client.exceptions.ResourceInUseException

  • AppStream.Client.exceptions.ResourceNotFoundException

  • AppStream.Client.exceptions.OperationNotPermittedException

  • AppStream.Client.exceptions.ConcurrentModificationException