Skip to content

get_agent_runtime_endpoint

Operation

get_agent_runtime_endpoint

get_agent_runtime_endpoint(request: GetAgentRuntimeEndpointInput | GetAgentRuntimeEndpointInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetAgentRuntimeEndpointInputDict]) -> GetAgentRuntimeEndpointOutput

Gets information about an Amazon Secure AgentEndpoint.

Parameters:

Name Type Description Default
request GetAgentRuntimeEndpointInput | GetAgentRuntimeEndpointInputDict | 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[GetAgentRuntimeEndpointInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetAgentRuntimeEndpointOutput

An instance of GetAgentRuntimeEndpointOutput.

get_agent_runtime_endpoint async

get_agent_runtime_endpoint(request: GetAgentRuntimeEndpointInput | GetAgentRuntimeEndpointInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetAgentRuntimeEndpointInputDict]) -> GetAgentRuntimeEndpointOutput

Gets information about an Amazon Secure AgentEndpoint.

Parameters:

Name Type Description Default
request GetAgentRuntimeEndpointInput | GetAgentRuntimeEndpointInputDict | 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[GetAgentRuntimeEndpointInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetAgentRuntimeEndpointOutput

An instance of GetAgentRuntimeEndpointOutput.

Input

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

GetAgentRuntimeEndpointInputDict

Bases: TypedDict

Dictionary form of GetAgentRuntimeEndpointInput.

Attributes

agent_runtime_id instance-attribute
agent_runtime_id: Required[str]

The unique identifier of the AgentCore Runtime associated with the endpoint.

endpoint_name instance-attribute
endpoint_name: Required[str]

The name of the AgentCore Runtime endpoint to retrieve.

GetAgentRuntimeEndpointInput dataclass

Bases: _SerdeShape

Dataclass for GetAgentRuntimeEndpointInput structure.

Attributes

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

The unique identifier of the AgentCore Runtime associated with the endpoint.

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

The name of the AgentCore Runtime endpoint to retrieve.

Output

GetAgentRuntimeEndpointOutput dataclass

Bases: _SerdeShape

Dataclass for GetAgentRuntimeEndpointOutput structure.

Attributes

agent_runtime_arn instance-attribute
agent_runtime_arn: str

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

agent_runtime_endpoint_arn instance-attribute
agent_runtime_endpoint_arn: str

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

created_at instance-attribute
created_at: datetime

The timestamp when the AgentCore Runtime endpoint was created.

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

The description of the AgentCore Runtime endpoint.

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

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

id instance-attribute
id: str

The unique identifier of the AgentCore Runtime endpoint.

last_updated_at instance-attribute
last_updated_at: datetime

The timestamp when the AgentCore Runtime endpoint was last updated.

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

The currently deployed version of the AgentCore Runtime on the endpoint.

name instance-attribute
name: str

The name of the AgentCore Runtime endpoint.

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.

status instance-attribute
status: str

The current status of the AgentCore Runtime endpoint.

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

The target version of the AgentCore Runtime for the endpoint.