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 a capacity provider. Only the description can be changed. To change other configuration, such as instance types, networking, or storage, create a new 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 |
update_capacity_provider
async
¶
update_capacity_provider(request: UpdateCapacityProviderInput | UpdateCapacityProviderInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateCapacityProviderInputDict]) -> UpdateCapacityProviderOutput
Updates a capacity provider. Only the description can be changed. To change other configuration, such as instance types, networking, or storage, create a new 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 |
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_id
instance-attribute
¶
The unique identifier of the capacity provider to update.
client_token
instance-attribute
¶
client_token: str | None
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
description
instance-attribute
¶
description: UpdatedDescription | UpdatedDescriptionDict | None
The updated description of the capacity provider.
UpdateCapacityProviderInput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateCapacityProviderInput structure.
Attributes¶
capacity_provider_id
class-attribute
instance-attribute
¶
capacity_provider_id: str | None = ...
The unique identifier of the capacity provider to update.
client_token
class-attribute
instance-attribute
¶
client_token: str | None = ...
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
description
class-attribute
instance-attribute
¶
description: UpdatedDescription | None = ...
The updated description of the capacity provider.
Output¶
UpdateCapacityProviderOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateCapacityProviderOutput structure.
Attributes¶
capacity_provider_arn
instance-attribute
¶
capacity_provider_arn: str
The Amazon Resource Name (ARN) of the capacity provider.
capacity_provider_id
instance-attribute
¶
capacity_provider_id: str
The unique identifier of the capacity provider.
created_at
instance-attribute
¶
created_at: datetime
The timestamp when the capacity provider was created.
last_updated_at
instance-attribute
¶
last_updated_at: datetime
The timestamp when the capacity provider was last updated.
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.