Skip to content

Bedrock AgentCore Control  >  Operations  >  get_capacity_provider

get_capacity_provider

Operation

get_capacity_provider async 

get_capacity_provider(input: GetCapacityProviderInput, plugins: list[Plugin] | None = None) -> GetCapacityProviderOutput

Retrieves information about a capacity provider, including its status, permissions configuration, and compute configuration.

Parameters:

Name Type Description Default
input GetCapacityProviderInput

An instance of GetCapacityProviderInput.

 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
GetCapacityProviderOutput

An instance of GetCapacityProviderOutput.

Input

GetCapacityProviderInput dataclass

Dataclass for GetCapacityProviderInput structure.

Attributes

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

The unique identifier of the capacity provider.

Output

GetCapacityProviderOutput dataclass

Dataclass for GetCapacityProviderOutput 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.

compute_configuration instance-attribute 
compute_configuration: ComputeConfiguration

The compute configuration for the capacity provider.

created_at instance-attribute 
created_at: datetime

The timestamp when the capacity provider was created.

description class-attribute instance-attribute 
description: str | None = field(repr=False, default=None)

The description of the capacity provider, if one was provided.

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.

permissions_configuration instance-attribute 
permissions_configuration: PermissionsConfiguration

The permissions configuration for the capacity provider.

status instance-attribute 
status: CapacityProviderStatus

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

status_code class-attribute instance-attribute 
status_code: CapacityProviderStatusCode | None = None

A reason code for a capacity provider that is not in the READY state. Use this code for programmatic error handling.

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

A human-readable message that describes why the capacity provider is not in the READY state. Because these messages can change, use statusCode for programmatic error handling.