Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . appstream ]

describe-images

Description

Retrieves a list that describes one or more specified images, if the image names are provided. Otherwise, all images in the account are described.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-images
[--names <value>]
[--arns <value>]
[--type <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--names (list)

The names of the images to describe.

Syntax:

"string" "string" ...

--arns (list)

The ARNs of the public, private, and shared images to describe.

Syntax:

"string" "string" ...

--type (string)

The type of image (public, private, or shared) to describe.

Possible values:

  • PUBLIC
  • PRIVATE
  • SHARED

--next-token (string)

The pagination token to use to retrieve the next page of results. If this value is empty, only the first page is retrieved.

--max-results (integer)

The maximum size of each page of results.

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

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

See 'aws help' for descriptions of global parameters.

Output

Images -> (list)

Information about the images.

(structure)

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

Additional attributes that describe the application.

key -> (string)

value -> (string)

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.

NextToken -> (string)

The pagination token to use to retrieve the next page of results. If there are no more pages, this value is null.