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

Returns a list of capacity providers in your account.

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

Returns a list of capacity providers in your account.

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

marker instance-attribute
marker: str | None

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

max_items instance-attribute
max_items: int | None

The maximum number of capacity providers to return.

state instance-attribute
state: str | None

Filter capacity providers by their current state.

ListCapacityProvidersInput dataclass

Bases: _SerdeShape

Dataclass for ListCapacityProvidersInput structure.

Attributes

marker class-attribute instance-attribute
marker: str | 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 = ...

The maximum number of capacity providers to return.

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

Filter capacity providers by their current state.

Output

ListCapacityProvidersOutput dataclass

Bases: _SerdeShape

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 = ...

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

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.