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

ListContainerRecipes

Returns a list of container recipes.

Request Syntax


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

{
   "filters": [ 
      { 
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "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.

filters

Use the following filters to streamline results:

containerType
name
parentImage
platform

Type: Array of Filter objects

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

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

owner

Returns container recipes belonging to the specified owner, that have been shared with you. You can omit this field to return container recipes belonging to your account. For container recipes, the valid owner values are Self, Shared, and Amazon.

Type: String

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

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "containerRecipeSummaryList": [ 
      { 
         "arn": "string",
         "containerType": "string",
         "dateCreated": "string",
         "instanceImage": "string",
         "name": "string",
         "owner": "string",
         "parentImage": "string",
         "platform": "string",
         "tags": { 
            "string" : "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.

containerRecipeSummaryList

The list of container recipes returned for the request.

Type: Array of ContainerRecipeSummary 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 1024.

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 container recipes you own

The following example lists the container recipes that you own.

Sample Request


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

{
    "owner": "Self"
}

Sample Response


HTTP/1.1 200
Content-type: application/json

{
    "requestId": "883e6f0e-8883-4c1a-9710-791afb74be0d",
    "containerRecipeSummaryList": [
        {
            "arn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/1.0.0",
            "containerType": "DOCKER",
            "name": "my-example-container-recipe",
            "platform": "Linux",
            "owner": "111122223333",
            "parentImage": "amazonlinux:latest",
            "dateCreated": "2026-09-09T19:31:26.363Z",
            "tags": {}
        }
    ]
}