Menu
Amazon AppStream 2.0
API Reference (API Version 2016-12-01)

DescribeImages

Describes the images. If a list of names is not provided, all images in your account are returned. This operation does not return a paginated result.

Request Syntax

Copy
{ "Names": [ "string" ] }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Names

A specific list of images to describe.

Type: array of Strings

Length Constraints: Minimum length of 1.

Required: No

Response Syntax

Copy
{ "Images": [ { "Applications": [ { "DisplayName": "string", "Enabled": boolean, "IconURL": "string", "LaunchParameters": "string", "LaunchPath": "string", "Metadata": { "string" : "string" }, "Name": "string" } ], "Arn": "string", "BaseImageArn": "string", "CreatedTime": number, "Description": "string", "DisplayName": "string", "ImageBuilderSupported": boolean, "Name": "string", "Platform": "string", "State": "string", "StateChangeReason": { "Code": "string", "Message": "string" }, "Visibility": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Images

The list of images.

Type: array of Image objects

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: