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

ListImageBuildVersions

Returns a list of image build versions.

Request Syntax


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

{
   "filters": [ 
      { 
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "imageVersionArn": "string",
   "maxResults": number,
   "nextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

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

imageVersionArn

The Amazon Resource Name (ARN) of the image version whose build versions you want to retrieve. The ARN must specify an exact version (<major>.<minor>.<patch>) - wildcards aren't allowed. This parameter is optional. If you don't specify it, Image Builder returns build versions for all of the images in your account.

Type: String

Pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):image/[a-z0-9-_]+/[0-9]+\.[0-9]+\.[0-9]+$

Required: No

maxResults

The maximum number of items to return in a single request.

Type: Integer

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

Required: No

nextToken

A token to specify where to start paginating. Use the nextToken value from a previously truncated response.

Type: String

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

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "imageSummaryList": [ 
      { 
         "arn": "string",
         "buildType": "string",
         "dateCreated": "string",
         "deprecationTime": number,
         "imageSource": "string",
         "lifecycleExecutionId": "string",
         "loggingConfiguration": { 
            "logGroupName": "string"
         },
         "name": "string",
         "osVersion": "string",
         "outputResources": { 
            "amis": [ 
               { 
                  "accountId": "string",
                  "description": "string",
                  "image": "string",
                  "name": "string",
                  "region": "string",
                  "state": { 
                     "failureContext": { 
                        "componentFailure": { 
                           "action": "string",
                           "componentArn": "string",
                           "errorMessage": "string",
                           "phaseName": "string",
                           "stepName": "string"
                        },
                        "distributionFailure": { 
                           "errorMessage": "string",
                           "regionFailures": [ 
                              { 
                                 "errorMessage": "string",
                                 "imageConfigurationStep": "string",
                                 "region": "string",
                                 "status": "string",
                                 "targetAccountId": "string"
                              }
                           ]
                        },
                        "failedStep": "string",
                        "imageStatus": "string",
                        "stepExecutionId": "string",
                        "workflowArn": "string",
                        "workflowExecutionId": "string"
                     },
                     "reason": "string",
                     "status": "string"
                  }
               }
            ],
            "containers": [ 
               { 
                  "imageUris": [ "string" ],
                  "region": "string"
               }
            ]
         },
         "owner": "string",
         "platform": "string",
         "state": { 
            "failureContext": { 
               "componentFailure": { 
                  "action": "string",
                  "componentArn": "string",
                  "errorMessage": "string",
                  "phaseName": "string",
                  "stepName": "string"
               },
               "distributionFailure": { 
                  "errorMessage": "string",
                  "regionFailures": [ 
                     { 
                        "errorMessage": "string",
                        "imageConfigurationStep": "string",
                        "region": "string",
                        "status": "string",
                        "targetAccountId": "string"
                     }
                  ]
               },
               "failedStep": "string",
               "imageStatus": "string",
               "stepExecutionId": "string",
               "workflowArn": "string",
               "workflowExecutionId": "string"
            },
            "reason": "string",
            "status": "string"
         },
         "tags": { 
            "string" : "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.

imageSummaryList

The list of image build versions.

Type: Array of ImageSummary 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 Error Types.

CallRateLimitExceededException

You have exceeded the permitted request rate for the Amazon EC2 APIs that Image Builder calls on your behalf. Retry with an increasing or variable delay between requests.

HTTP Status Code: 429

ClientException

A generic client error. This error usually indicates that the request failed a validation check, such as when a downstream service rejects a configured value.

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

The request is malformed or otherwise invalid. Verify the request and try again.

HTTP Status Code: 400

ServiceException

An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.

HTTP Status Code: 500

ServiceUnavailableException

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

HTTP Status Code: 503

Examples

List the build versions of an image

The following example lists the build versions that exist for version 1.0.0 of the specified image, with the output AMI that each build produced.

Sample Request


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

{
    "imageVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0"
}

Sample Response


HTTP/1.1 200
Content-type: application/json

{
    "requestId": "b4808907-dcad-4951-ada5-dd151e93135a",
    "imageSummaryList": [
        {
            "arn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1",
            "name": "my-example-recipe",
            "type": "AMI",
            "version": "1.0.0/1",
            "platform": "Linux",
            "osVersion": "Amazon Linux 2023",
            "state": {
                "status": "AVAILABLE"
            },
            "owner": "111122223333",
            "dateCreated": "2026-09-09T19:12:18.677Z",
            "outputResources": {
                "amis": [
                    {
                        "region": "us-west-2",
                        "image": "ami-1234567890abcdef0",
                        "name": "my-example-recipe 2026-09-09T19-19-08.103311Z",
                        "accountId": "111122223333"
                    }
                ]
            },
            "tags": {},
            "buildType": "USER_INITIATED"
        }
    ]
}