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

ListComponents

Returns the list of components that you have access to. By default, the response doesn't include components in the DEPRECATED state. To list deprecated components, use the status filter with the value DEPRECATED.

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: You can 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.

Request Syntax


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

{
   "byName": boolean,
   "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.

byName

Specifies whether to return one entry per component name, with all versions of each component aggregated. Defaults to false, which returns one entry per component version. You can't combine this option with the version filter.

Type: Boolean

Required: No

filters

Use the following filters to streamline results:

description
name
platform
productCodes
status
supportedOsVersion
type
version

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

Filters results based on the type of owner for the component. By default, this request returns a list of components that your account owns. To see results for other types of owners, you can specify components that Amazon manages, components from the AWS Marketplace, third party components, or components that other accounts have shared with you.

Type: String

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

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "componentVersionList": [ 
      { 
         "arn": "string",
         "dateCreated": "string",
         "description": "string",
         "name": "string",
         "owner": "string",
         "platform": "string",
         "productCodes": [ 
            { 
               "productCodeId": "string",
               "productCodeType": "string"
            }
         ],
         "status": "string",
         "supportedOsVersions": [ "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.

componentVersionList

The list of component 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.

Type: Array of ComponentVersion 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 components that you own

The following example lists the component versions that your account owns, filtered to components for the Linux platform.

Sample Request


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

{
    "owner": "Self",
    "filters": [
        {
            "name": "platform",
            "values": [
                "Linux"
            ]
        }
    ]
}

Sample Response


HTTP/1.1 200
Content-type: application/json

{
    "componentVersionList": [
        {
            "arn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.0",
            "name": "my-example-component",
            "version": "1.0.0",
            "description": "Installs my example application",
            "platform": "Linux",
            "supportedOsVersions": [
                "Amazon Linux 2023"
            ],
            "type": "BUILD",
            "owner": "111122223333",
            "dateCreated": "2026-09-09T18:31:49.661Z",
            "status": "ACTIVE"
        },
        {
            "arn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-imported-component/1.0.0",
            "name": "my-example-imported-component",
            "version": "1.0.0",
            "description": "Installs my application from an imported shell script",
            "platform": "Linux",
            "type": "BUILD",
            "owner": "111122223333",
            "dateCreated": "2026-09-09T18:31:21.941Z",
            "status": "ACTIVE"
        },
        {
            "arn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-test-component/1.0.0",
            "name": "my-example-test-component",
            "version": "1.0.0",
            "description": "Verifies that my example application is installed",
            "platform": "Linux",
            "type": "TEST",
            "owner": "111122223333",
            "dateCreated": "2026-09-09T18:31:52.888Z",
            "status": "ACTIVE"
        }
    ],
    "requestId": "fc51d989-ca0a-4ac7-9ca6-fb7786e70955"
}