Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListImages

Returns the list of images that you have access to. Newly created images can take up to two minutes to appear in the ListImages API Results.

Request Syntax


POST /ListImages HTTP/1.1
Content-type: application/json

{
   "byName": boolean,
   "filters": [ 
      { 
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "includeDeprecated": boolean,
   "maxResults": number,
   "nextToken": "string",
   "owner": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

byName

Requests a list of images with a specific recipe name.

Type: Boolean

Required: No

filters

Use the following filters to streamline results:

name
osVersion
platform
type
version

Type: Array of Filter objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: No

includeDeprecated

Includes deprecated images in the response list.

Type: Boolean

Required: No

maxResults

The maximum items to return in a request.

Type: Integer

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

Required: No

nextToken

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 65535.

Required: No

owner

The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers.

Type: String

Valid Values: Self | Shared | Amazon | ThirdParty | AWSMarketplace

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "imageVersionList": [ 
      { 
         "arn": "string",
         "buildType": "string",
         "dateCreated": "string",
         "imageSource": "string",
         "name": "string",
         "osVersion": "string",
         "owner": "string",
         "platform": "string",
         "type": "string",
         "version": "string"
      }
   ],
   "nextToken": "string",
   "requestId": "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.

imageVersionList

The list of image semantic versions.

Note

The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

Type: Array of ImageVersion objects

nextToken

The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 65535.

requestId

The request ID that uniquely identifies this request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Errors

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

CallRateLimitExceededException

You have exceeded the permitted request rate for the specific operation.

HTTP Status Code: 429

ClientException

These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.

HTTP Status Code: 400

ForbiddenException

You are not authorized to perform the requested operation.

HTTP Status Code: 403

InvalidPaginationTokenException

You have provided an invalid pagination token in your request.

HTTP Status Code: 400

InvalidRequestException

You have requested an action that that the service doesn't support.

HTTP Status Code: 400

ServiceException

This exception is thrown when the service encounters an unrecoverable exception.

HTTP Status Code: 500

ServiceUnavailableException

The service is unable to process your request at this time.

HTTP Status Code: 503