Skip to content

update_capacity_provider

Operation

update_capacity_provider

update_capacity_provider(request: UpdateCapacityProviderInput | UpdateCapacityProviderInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateCapacityProviderInputDict]) -> UpdateCapacityProviderOutput

Updates the configuration of an existing capacity provider.

Parameters:

Name Type Description Default
request UpdateCapacityProviderInput | UpdateCapacityProviderInputDict | 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[UpdateCapacityProviderInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateCapacityProviderOutput

An instance of UpdateCapacityProviderOutput.

update_capacity_provider async

update_capacity_provider(request: UpdateCapacityProviderInput | UpdateCapacityProviderInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateCapacityProviderInputDict]) -> UpdateCapacityProviderOutput

Updates the configuration of an existing capacity provider.

Parameters:

Name Type Description Default
request UpdateCapacityProviderInput | UpdateCapacityProviderInputDict | 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[UpdateCapacityProviderInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateCapacityProviderOutput

An instance of UpdateCapacityProviderOutput.

Input

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

UpdateCapacityProviderInputDict

Bases: TypedDict

Dictionary form of UpdateCapacityProviderInput.

Attributes

capacity_provider_name instance-attribute
capacity_provider_name: Required[str]

The name of the capacity provider to update.

capacity_provider_scaling_config instance-attribute
capacity_provider_scaling_config: CapacityProviderScalingConfig | CapacityProviderScalingConfigDict | None

The updated scaling configuration for the capacity provider.

propagate_tags instance-attribute
propagate_tags: PropagateTags | PropagateTagsDict | None

Configuration for tag propagation to managed resources launched by the capacity provider.

telemetry_config instance-attribute

The updated telemetry configuration for the capacity provider.

UpdateCapacityProviderInput dataclass

Bases: _SerdeShape

Dataclass for UpdateCapacityProviderInput structure.

Attributes

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

The name of the capacity provider to update.

capacity_provider_scaling_config class-attribute instance-attribute
capacity_provider_scaling_config: CapacityProviderScalingConfig | None = ...

The updated scaling configuration for the capacity provider.

propagate_tags class-attribute instance-attribute
propagate_tags: PropagateTags | None = ...

Configuration for tag propagation to managed resources launched by the capacity provider.

telemetry_config class-attribute instance-attribute
telemetry_config: CapacityProviderTelemetryConfig | None = ...

The updated telemetry configuration for the capacity provider.

Output

UpdateCapacityProviderOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateCapacityProviderOutput structure.

Attributes

capacity_provider instance-attribute
capacity_provider: CapacityProvider

Information about the updated capacity provider.

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.