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

DescribeImages

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

Request Syntax

{ "Arns": [ "string" ], "MaxResults": number, "Names": [ "string" ], "NextToken": "string", "Type": "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.

Arns

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

Type: Array of strings

Pattern: ^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$

Required: No

MaxResults

The maximum size of each page of results.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 25.

Required: No

Names

The names of the public or private images to describe.

Type: Array of strings

Length Constraints: Minimum length of 1.

Required: No

NextToken

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Type: String

Length Constraints: Minimum length of 1.

Required: No

Type

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

Type: String

Valid Values: PUBLIC | PRIVATE | SHARED

Required: No

Response Syntax

{ "Images": [ { "Applications": [ { "DisplayName": "string", "Enabled": boolean, "IconURL": "string", "LaunchParameters": "string", "LaunchPath": "string", "Metadata": { "string" : "string" }, "Name": "string" } ], "AppstreamAgentVersion": "string", "Arn": "string", "BaseImageArn": "string", "CreatedTime": number, "Description": "string", "DisplayName": "string", "ImageBuilderSupported": boolean, "ImagePermissions": { "allowFleet": boolean, "allowImageBuilder": boolean }, "Name": "string", "Platform": "string", "PublicBaseImageReleasedDate": number, "State": "string", "StateChangeReason": { "Code": "string", "Message": "string" }, "Visibility": "string" } ], "NextToken": "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

Information about the images.

Type: Array of Image objects

NextToken

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

Type: String

Length Constraints: Minimum length of 1.

Errors

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

InvalidParameterCombinationException

Indicates an incorrect combination of parameters, or a missing parameter.

HTTP Status Code: 400

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: