Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1484319348.7 KB

List components with summary data. You can filter the result list by environment, service, or a single service instance.

For more information about components, see Proton components in the Proton User Guide.

post/#X-Amz-Target=AwsProton20200720.ListComponents

Query parameters

maxResultsstring

Pagination limit

nextTokenstring

Pagination token

Headers

X-Amz-Target'AwsProton20200720.ListComponents' required

Request body

environmentNamestring

The name of an environment for result list filtering. Proton returns components associated with the environment or attached to service instances running in it.

maxResultsinteger

The maximum number of components to list.

nextTokenstring

A token that indicates the location of the next component in the array of components, after the list of components that was previously requested.

serviceInstanceNamestring

The name of a service instance for result list filtering. Proton returns the component attached to the service instance, if any.

serviceNamestring

The name of a service for result list filtering. Proton returns components attached to service instances of the service.

Response

Success

nextTokenstring

A token that indicates the location of the next component in the array of components, after the current requested list of components.