Skip to content

describe_capacity_providers

Operation

describe_capacity_providers

describe_capacity_providers(request: DescribeCapacityProvidersInput | DescribeCapacityProvidersInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeCapacityProvidersInputDict]) -> DescribeCapacityProvidersOutput

Describes one or more of your capacity providers.

Parameters:

Name Type Description Default
request DescribeCapacityProvidersInput | DescribeCapacityProvidersInputDict | 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[DescribeCapacityProvidersInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeCapacityProvidersOutput

An instance of DescribeCapacityProvidersOutput.

describe_capacity_providers async

describe_capacity_providers(request: DescribeCapacityProvidersInput | DescribeCapacityProvidersInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeCapacityProvidersInputDict]) -> DescribeCapacityProvidersOutput

Describes one or more of your capacity providers.

Parameters:

Name Type Description Default
request DescribeCapacityProvidersInput | DescribeCapacityProvidersInputDict | 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[DescribeCapacityProvidersInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeCapacityProvidersOutput

An instance of DescribeCapacityProvidersOutput.

Input

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

DescribeCapacityProvidersInputDict

Bases: TypedDict

Dictionary form of DescribeCapacityProvidersInput.

Attributes

capacity_providers instance-attribute
capacity_providers: Sequence[str] | None

The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to 100 capacity providers can be described in an action.

cluster instance-attribute
cluster: str | None

The name of the cluster to describe capacity providers for. When specified, only capacity providers associated with this cluster are returned, including Amazon ECS Managed Instances capacity providers.

include instance-attribute
include: Sequence[str] | None

Specifies whether or not you want to see the resource tags for the capacity provider. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.

max_results instance-attribute
max_results: int | None

The maximum number of account setting results returned by DescribeCapacityProviders in paginated output. When this parameter is used, DescribeCapacityProviders only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeCapacityProviders request with the returned nextToken value. This value can be between 1 and 10. If this parameter is not used, then DescribeCapacityProviders returns up to 10 results and a nextToken value if applicable.

next_token instance-attribute
next_token: str | None

The nextToken value returned from a previous paginated DescribeCapacityProviders request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

Note

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

DescribeCapacityProvidersInput dataclass

Bases: _SerdeShape

Dataclass for DescribeCapacityProvidersInput structure.

Attributes

capacity_providers class-attribute instance-attribute
capacity_providers: list[str] | None = ...

The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to 100 capacity providers can be described in an action.

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

The name of the cluster to describe capacity providers for. When specified, only capacity providers associated with this cluster are returned, including Amazon ECS Managed Instances capacity providers.

include class-attribute instance-attribute
include: list[str] | None = ...

Specifies whether or not you want to see the resource tags for the capacity provider. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.

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

The maximum number of account setting results returned by DescribeCapacityProviders in paginated output. When this parameter is used, DescribeCapacityProviders only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeCapacityProviders request with the returned nextToken value. This value can be between 1 and 10. If this parameter is not used, then DescribeCapacityProviders returns up to 10 results and a nextToken value if applicable.

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

The nextToken value returned from a previous paginated DescribeCapacityProviders request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

Note

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Output

DescribeCapacityProvidersOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeCapacityProvidersOutput structure.

Attributes

capacity_providers class-attribute instance-attribute
capacity_providers: list[CapacityProvider] | None = ...

The list of capacity providers.

failures class-attribute instance-attribute
failures: list[Failure] | None = ...

Any failures associated with the call.

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

The nextToken value to include in a future DescribeCapacityProviders request. When the results of a DescribeCapacityProviders request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

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.