Skip to content

list_capacity_providers

Operation

list_capacity_providers

list_capacity_providers(request: ListCapacityProvidersInput | ListCapacityProvidersInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListCapacityProvidersInputDict]) -> ListCapacityProvidersOutput

Lists the capacity providers in your account and returns summary information for each one. To retrieve the full configuration for a specific capacity provider, use GetCapacityProvider. Results are paginated; use the nextToken parameter to retrieve additional results.

Parameters:

Name Type Description Default
request ListCapacityProvidersInput | ListCapacityProvidersInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[ListCapacityProvidersInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListCapacityProvidersOutput

An instance of ListCapacityProvidersOutput.

list_capacity_providers async

list_capacity_providers(request: ListCapacityProvidersInput | ListCapacityProvidersInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListCapacityProvidersInputDict]) -> ListCapacityProvidersOutput

Lists the capacity providers in your account and returns summary information for each one. To retrieve the full configuration for a specific capacity provider, use GetCapacityProvider. Results are paginated; use the nextToken parameter to retrieve additional results.

Parameters:

Name Type Description Default
request ListCapacityProvidersInput | ListCapacityProvidersInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[ListCapacityProvidersInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListCapacityProvidersOutput

An instance of ListCapacityProvidersOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ListCapacityProvidersInputDict

Bases: TypedDict

Dictionary form of ListCapacityProvidersInput.

Attributes

max_results instance-attribute
max_results: int | None

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

next_token instance-attribute
next_token: str | None

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

ListCapacityProvidersInput dataclass

Bases: _SerdeShape

Dataclass for ListCapacityProvidersInput structure.

Attributes

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

next_token class-attribute instance-attribute
next_token: str | None = ...

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Output

ListCapacityProvidersOutput dataclass

Bases: _SerdeShape

Dataclass for ListCapacityProvidersOutput structure.

Attributes

capacity_providers instance-attribute
capacity_providers: list[CapacityProviderSummary]

The list of capacity provider summaries.

next_token class-attribute instance-attribute
next_token: str | None = ...

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.