DescribeWorkspaceImages
Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.
Request Syntax
{
"ImageIds": [ "string" ],
"ImageType": "string",
"MaxResults": number,
"NextToken": "string"
}Request Parameters
The request accepts the following data in JSON format.
- ImageIds
-
The identifier of the image.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 25 items.
Pattern:
wsi-[0-9a-z]{9,63}$Required: No
- ImageType
-
The type (owned or shared) of the image.
Type: String
Valid Values:
OWNED | SHAREDRequired: No
- MaxResults
-
The maximum number of items to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 25.
Required: No
- NextToken
-
If you received a
NextTokenfrom a previous call that was paginated, provide this token to receive the next set of results.Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
Response Syntax
{
"Images": [
{
"Created": number,
"Description": "string",
"ErrorCode": "string",
"ErrorDetails": [
{
"ErrorCode": "string",
"ErrorMessage": "string"
}
],
"ErrorMessage": "string",
"ImageId": "string",
"Name": "string",
"OperatingSystem": {
"Type": "string"
},
"OwnerAccountId": "string",
"RequiredTenancy": "string",
"State": "string",
"Updates": {
"Description": "string",
"UpdateAvailable": boolean
}
}
],
"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 WorkspaceImage objects
- NextToken
-
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The user is not authorized to access a resource.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
