Skip to content

get_capacity_provider

Operation

get_capacity_provider

get_capacity_provider(request: GetCapacityProviderInput | GetCapacityProviderInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetCapacityProviderInputDict]) -> GetCapacityProviderOutput

Retrieves information about a specific capacity provider, including its configuration, state, and associated resources.

Parameters:

Name Type Description Default
request GetCapacityProviderInput | GetCapacityProviderInputDict | 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[GetCapacityProviderInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetCapacityProviderOutput

An instance of GetCapacityProviderOutput.

get_capacity_provider async

get_capacity_provider(request: GetCapacityProviderInput | GetCapacityProviderInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetCapacityProviderInputDict]) -> GetCapacityProviderOutput

Retrieves information about a specific capacity provider, including its configuration, state, and associated resources.

Parameters:

Name Type Description Default
request GetCapacityProviderInput | GetCapacityProviderInputDict | 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[GetCapacityProviderInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetCapacityProviderOutput

An instance of GetCapacityProviderOutput.

Input

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

GetCapacityProviderInputDict

Bases: TypedDict

Dictionary form of GetCapacityProviderInput.

Attributes

capacity_provider_name instance-attribute
capacity_provider_name: Required[str]

The name of the capacity provider to retrieve.

GetCapacityProviderInput dataclass

Bases: _SerdeShape

Dataclass for GetCapacityProviderInput structure.

Attributes

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

The name of the capacity provider to retrieve.

Output

GetCapacityProviderOutput dataclass

Bases: _SerdeShape

Dataclass for GetCapacityProviderOutput structure.

Attributes

capacity_provider instance-attribute
capacity_provider: CapacityProvider

Information about the capacity provider, including its configuration and current state.

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.