update_capacity_provider¶
Operation¶
update_capacity_provider
async
¶
update_capacity_provider(request: UpdateCapacityProviderInput | UpdateCapacityProviderInputDict, /, *, plugins: list[Plugin] | None = None) -> UpdateCapacityProviderOutput
update_capacity_provider(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateCapacityProviderInputDict]) -> UpdateCapacityProviderOutput
Modifies the parameters for a capacity provider.
These changes only apply to new Amazon ECS Managed Instances, or EC2 instances, not existing ones.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
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 |
|---|---|
UpdateCapacityProviderOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
UpdateCapacityProviderInput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateCapacityProviderInput structure.
Attributes¶
auto_scaling_group_provider
class-attribute
instance-attribute
¶
auto_scaling_group_provider: AutoScalingGroupProviderUpdate | None = ...
An object that represent the parameters to update for the Auto Scaling group capacity provider.
cluster
class-attribute
instance-attribute
¶
cluster: str | None = ...
The name of the cluster that contains the capacity provider to update. Managed instances capacity providers are cluster-scoped and can only be updated within their associated cluster.
managed_instances_provider
class-attribute
instance-attribute
¶
managed_instances_provider: UpdateManagedInstancesProviderConfiguration | None = ...
The updated configuration for the Amazon ECS Managed Instances provider. You can modify the infrastructure role, instance launch template, and tag propagation settings. Changes take effect for new instances launched after the update.
Dictionaries¶
UpdateCapacityProviderInputDict
¶
Bases: TypedDict
Dictionary form of UpdateCapacityProviderInput.
Attributes¶
auto_scaling_group_provider
instance-attribute
¶
auto_scaling_group_provider: AutoScalingGroupProviderUpdate | AutoScalingGroupProviderUpdateDict | None
An object that represent the parameters to update for the Auto Scaling group capacity provider.
cluster
instance-attribute
¶
cluster: str | None
The name of the cluster that contains the capacity provider to update. Managed instances capacity providers are cluster-scoped and can only be updated within their associated cluster.
managed_instances_provider
instance-attribute
¶
managed_instances_provider: UpdateManagedInstancesProviderConfiguration | UpdateManagedInstancesProviderConfigurationDict | None
The updated configuration for the Amazon ECS Managed Instances provider. You can modify the infrastructure role, instance launch template, and tag propagation settings. Changes take effect for new instances launched after the update.
Output¶
UpdateCapacityProviderOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateCapacityProviderOutput structure.
Attributes¶
capacity_provider
class-attribute
instance-attribute
¶
capacity_provider: CapacityProvider | None = ...
Details about the capacity provider.
response_metadata
class-attribute
instance-attribute
¶
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.