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

DescribeImages

Describes the specified images or all images in the account.

Request Syntax

{
   "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

The names of the images to describe.

Type: Array of strings

Length Constraints: Minimum length of 1.

Required: No

Response Syntax

{
   "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",
         "PublicBaseImageReleasedDate": number,
         "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

Information about the 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: