ListImages
Lists the images in your account and their properties. The list can be filtered by creation time or modified time, and whether the image name contains a specified string.
Request Syntax
{
"MaxResults": number,
"NameContains": "string",
"NextToken": "string",
"SortBy": "string",
"SortOrder": "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.
- MaxResults
-
The maximum number of images to return in the response. The default value is 10.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NameContains
-
A filter that returns only images whose name contains the specified string.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 63.
Pattern:
[a-zA-Z0-9\-.]+Required: No
- NextToken
-
If the previous call to
ListImagesdidn't return the full set of images, the call returns a token for getting the next set of images.Type: String
Length Constraints: Minimum length of 0. Maximum length of 8192.
Pattern:
.*Required: No
- SortBy
-
The property used to sort results. The default value is
CREATION_TIME.Type: String
Valid Values:
CREATION_TIME | LAST_MODIFIED_TIME | IMAGE_NAMERequired: No
- SortOrder
-
The sort order. The default value is
DESCENDING.Type: String
Valid Values:
ASCENDING | DESCENDINGRequired: No
Response Syntax
{
"Images": [
{
"Description": "string",
"DisplayName": "string",
"FailureReason": "string",
"ImageArn": "string",
"ImageName": "string",
"ImageStatus": "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.
Errors
For information about the errors that are common to all actions, see Common Error Types.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
