Skip to content

Bedrock AgentCore Control  >  Operations  >  update_capacity_provider

update_capacity_provider

Operation

update_capacity_provider async

update_capacity_provider(input: UpdateCapacityProviderInput, plugins: list[Plugin] | None = None) -> 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
input UpdateCapacityProviderInput

An instance of UpdateCapacityProviderInput.

required
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 UpdateCapacityProviderOutput.

Input

UpdateCapacityProviderInput dataclass

Dataclass for UpdateCapacityProviderInput structure.

Attributes

capacity_provider_id class-attribute instance-attribute
capacity_provider_id: str | None = None

The unique identifier of the capacity provider to update.

client_token class-attribute instance-attribute
client_token: str | None = 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.

description class-attribute instance-attribute
description: UpdatedDescription | None = None

The updated description of the capacity provider.

Output

UpdateCapacityProviderOutput dataclass

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.

name instance-attribute
name: str

The name of the capacity provider.

status instance-attribute

The current status of the capacity provider. For possible values, see CapacityProviderStatus.