Skip to content

get_agent_runtime

Operation

get_agent_runtime

get_agent_runtime(request: GetAgentRuntimeInput | GetAgentRuntimeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetAgentRuntimeInputDict]) -> GetAgentRuntimeOutput

Gets an Amazon Bedrock AgentCore Runtime.

Parameters:

Name Type Description Default
request GetAgentRuntimeInput | GetAgentRuntimeInputDict | 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[GetAgentRuntimeInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetAgentRuntimeOutput

An instance of GetAgentRuntimeOutput.

get_agent_runtime async

get_agent_runtime(request: GetAgentRuntimeInput | GetAgentRuntimeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetAgentRuntimeInputDict]) -> GetAgentRuntimeOutput

Gets an Amazon Bedrock AgentCore Runtime.

Parameters:

Name Type Description Default
request GetAgentRuntimeInput | GetAgentRuntimeInputDict | 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[GetAgentRuntimeInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetAgentRuntimeOutput

An instance of GetAgentRuntimeOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetAgentRuntimeInputDict

Bases: TypedDict

Dictionary form of GetAgentRuntimeInput.

Attributes

agent_runtime_id instance-attribute
agent_runtime_id: Required[str]

The unique identifier of the AgentCore Runtime to retrieve.

agent_runtime_version instance-attribute
agent_runtime_version: str | None

The version of the AgentCore Runtime to retrieve.

GetAgentRuntimeInput dataclass

Bases: _SerdeShape

Dataclass for GetAgentRuntimeInput structure.

Attributes

agent_runtime_id class-attribute instance-attribute
agent_runtime_id: str | None = ...

The unique identifier of the AgentCore Runtime to retrieve.

agent_runtime_version class-attribute instance-attribute
agent_runtime_version: str | None = ...

The version of the AgentCore Runtime to retrieve.

Output

GetAgentRuntimeOutput dataclass

Bases: _SerdeShape

Dataclass for GetAgentRuntimeOutput structure.

Attributes

agent_runtime_arn instance-attribute
agent_runtime_arn: str

The Amazon Resource Name (ARN) of the AgentCore Runtime.

agent_runtime_artifact class-attribute instance-attribute
agent_runtime_artifact: AgentRuntimeArtifact | None = ...

The artifact of the AgentCore Runtime.

agent_runtime_id instance-attribute
agent_runtime_id: str

The unique identifier of the AgentCore Runtime.

agent_runtime_name instance-attribute
agent_runtime_name: str

The name of the AgentCore Runtime.

agent_runtime_version instance-attribute
agent_runtime_version: str

The version of the AgentCore Runtime.

allowed_ports class-attribute instance-attribute
allowed_ports: list[AllowedPort] | None = ...

The additional ports on the AgentCore Runtime that are reachable through the runtime's session URL.

authorizer_configuration class-attribute instance-attribute
authorizer_configuration: AuthorizerConfiguration | None = ...

The authorizer configuration for the AgentCore Runtime.

capacity_provider_configuration class-attribute instance-attribute
capacity_provider_configuration: CapacityProviderConfiguration | None = ...

The capacity provider configuration for the AgentCore Runtime.

created_at instance-attribute
created_at: datetime

The timestamp when the AgentCore Runtime was created.

description class-attribute instance-attribute
description: str | None = ...

The description of the AgentCore Runtime.

environment_variables class-attribute instance-attribute
environment_variables: dict[str, str] | None = ...

Environment variables set in the AgentCore Runtime environment.

failure_reason class-attribute instance-attribute
failure_reason: str | None = ...

The reason for failure if the AgentCore Runtime is in a failed state.

filesystem_configurations class-attribute instance-attribute
filesystem_configurations: list[FilesystemConfiguration] | None = ...

The filesystem configurations mounted into the AgentCore Runtime.

hooks_configuration class-attribute instance-attribute
hooks_configuration: RuntimeHooksConfiguration | None = ...

The lifecycle hooks configuration for the AgentCore Runtime.

last_updated_at instance-attribute
last_updated_at: datetime

The timestamp when the AgentCore Runtime was last updated.

lifecycle_configuration instance-attribute
lifecycle_configuration: LifecycleConfiguration

The life cycle configuration for the AgentCore Runtime.

metadata_configuration class-attribute instance-attribute
metadata_configuration: RuntimeMetadataConfiguration | None = ...

Configuration for microVM Metadata Service (MMDS) settings for the AgentCore Runtime.

network_configuration class-attribute instance-attribute
network_configuration: NetworkConfiguration | None = ...

The network configuration for the AgentCore Runtime.

platform_version class-attribute instance-attribute
platform_version: str | None = ...

The version of the runtime platform used by the AgentCore Runtime.

protocol_configuration class-attribute instance-attribute
protocol_configuration: ProtocolConfiguration | None = ...

The protocol configuration for the AgentCore Runtime, including the protocol, port, and path on which the agent server is available.

request_header_configuration class-attribute instance-attribute
request_header_configuration: RequestHeaderConfiguration | None = ...

Configuration for HTTP request headers that will be passed through to the runtime.

resource_configurations class-attribute instance-attribute
resource_configurations: list[ResourceConfiguration] | None = ...

The resource configurations for the AgentCore Runtime.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.

role_arn instance-attribute
role_arn: str

The IAM role ARN that provides permissions for the AgentCore Runtime.

status instance-attribute
status: str

The current status of the AgentCore Runtime.

workload_identity_details class-attribute instance-attribute
workload_identity_details: WorkloadIdentityDetails | None = ...

The workload identity details for the AgentCore Runtime.