AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . appstream ]

delete-image

Description

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

Synopsis

  delete-image
--name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--name (string)

The name of the image.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

Image -> (structure)

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 -> (structure)

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.

(structure)

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 -> (map)

Additional attributes that describe the application.

key -> (string)

value -> (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 -> (structure)

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 -> (timestamp)

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

CreatedTime -> (timestamp)

The time the image was created.

PublicBaseImageReleasedDate -> (timestamp)

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 -> (structure)

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.

(structure)

Describes a resource error.

ErrorCode -> (string)

The error code.

ErrorMessage -> (string)

The error message.

ErrorTimestamp -> (timestamp)

The time the error occurred.

LatestAppstreamAgentVersion -> (string)

Indicates whether the image is using the latest AppStream 2.0 agent version or not.

SupportedInstanceFamilies -> (list)

The supported instances families that determine which image a customer can use when the customer launches a fleet or image builder. The following instances families are supported:

  • General Purpose
  • Compute Optimized
  • Memory Optimized
  • Graphics
  • Graphics Design
  • Graphics Pro
  • Graphics G4
  • Graphics G5

(string)

DynamicAppProvidersEnabled -> (string)

Indicates whether dynamic app providers are enabled within an AppStream 2.0 image or not.

ImageSharedWithOthers -> (string)

Indicates whether the image is shared with another account ID.