Skip to content

Lambda  >  Operations  >  list_capacity_providers

list_capacity_providers

Operation

list_capacity_providers async 

list_capacity_providers(input: ListCapacityProvidersInput, plugins: list[Plugin] | None = None) -> ListCapacityProvidersOutput

Returns a list of capacity providers in your account.

Parameters:

Name Type Description Default
input ListCapacityProvidersInput

An instance of ListCapacityProvidersInput.

 required
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

Returns:

Type Description
ListCapacityProvidersOutput

An instance of ListCapacityProvidersOutput.

Input

ListCapacityProvidersInput dataclass

Dataclass for ListCapacityProvidersInput structure.

Attributes

marker class-attribute instance-attribute 
marker: str | None = None

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

max_items class-attribute instance-attribute 
max_items: int | None = None

The maximum number of capacity providers to return.

state class-attribute instance-attribute 
state: str | None = None

Filter capacity providers by their current state.

Output

ListCapacityProvidersOutput dataclass

Dataclass for ListCapacityProvidersOutput structure.

Attributes

capacity_providers instance-attribute 
capacity_providers: list[CapacityProvider]

A list of capacity providers in your account.

next_marker class-attribute instance-attribute 
next_marker: str | None = None

The pagination token that's included if more results are available.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

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.