get_agent_runtime¶
Operation¶
async
¶
get_agent_runtime(input: GetAgentRuntimeInput, plugins: list[Plugin] | None = None) -> GetAgentRuntimeOutput
Gets an Amazon Bedrock AgentCore Runtime.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetAgentRuntimeInput
|
An instance of |
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 |
|---|---|
GetAgentRuntimeOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for GetAgentRuntimeInput structure.
Attributes¶
class-attribute
instance-attribute
¶
agent_runtime_id: str | None = None
The unique identifier of the AgentCore Runtime to retrieve.
class-attribute
instance-attribute
¶
agent_runtime_version: str | None = None
The version of the AgentCore Runtime to retrieve.
Output¶
dataclass
¶
Dataclass for GetAgentRuntimeOutput structure.
Attributes¶
instance-attribute
¶
agent_runtime_arn: str
The Amazon Resource Name (ARN) of the AgentCore Runtime.
class-attribute
instance-attribute
¶
agent_runtime_artifact: AgentRuntimeArtifact | None = None
The artifact of the AgentCore Runtime.
instance-attribute
¶
agent_runtime_id: str
The unique identifier of the AgentCore Runtime.
instance-attribute
¶
agent_runtime_version: str
The version of the AgentCore Runtime.
class-attribute
instance-attribute
¶
authorizer_configuration: AuthorizerConfiguration | None = None
The authorizer configuration for the AgentCore Runtime.
instance-attribute
¶
created_at: datetime
The timestamp when the AgentCore Runtime was created.
class-attribute
instance-attribute
¶
description: str | None = field(repr=False, default=None)
The description of the AgentCore Runtime.
class-attribute
instance-attribute
¶
environment_variables: dict[str, str] | None = field(repr=False, default=None)
Environment variables set in the AgentCore Runtime environment.
class-attribute
instance-attribute
¶
failure_reason: str | None = None
The reason for failure if the AgentCore Runtime is in a failed state.
class-attribute
instance-attribute
¶
filesystem_configurations: list[FilesystemConfiguration] | None = None
The filesystem configurations mounted into the AgentCore Runtime.
instance-attribute
¶
last_updated_at: datetime
The timestamp when the AgentCore Runtime was last updated.
instance-attribute
¶
lifecycle_configuration: LifecycleConfiguration
The life cycle configuration for the AgentCore Runtime.
class-attribute
instance-attribute
¶
metadata_configuration: RuntimeMetadataConfiguration | None = None
Configuration for microVM Metadata Service (MMDS) settings for the AgentCore Runtime.
instance-attribute
¶
network_configuration: NetworkConfiguration
The network configuration for the AgentCore Runtime.
class-attribute
instance-attribute
¶
protocol_configuration: ProtocolConfiguration | None = None
The protocol configuration for an agent runtime. This structure defines how the agent runtime communicates with clients.
class-attribute
instance-attribute
¶
request_header_configuration: RequestHeaderConfiguration | None = None
Configuration for HTTP request headers that will be passed through to the runtime.
instance-attribute
¶
role_arn: str
The IAM role ARN that provides permissions for the AgentCore Runtime.
class-attribute
instance-attribute
¶
workload_identity_details: WorkloadIdentityDetails | None = None
The workload identity details for the AgentCore Runtime.