BedrockAgentCoreControl / Client / get_agent_runtime_endpoint

get_agent_runtime_endpoint¶

BedrockAgentCoreControl.Client.get_agent_runtime_endpoint(**kwargs)¶

Gets information about an Amazon Secure AgentEndpoint.

Request Syntax

response = client.get_agent_runtime_endpoint(
    agentRuntimeId='string',
    endpointName='string'
)

Parameters:

agentRuntimeId (string) –
[REQUIRED]

The unique identifier of the AgentCore Runtime associated with the endpoint.
endpointName (string) –
[REQUIRED]

The name of the AgentCore Runtime endpoint to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'liveVersion': 'string',
    'targetVersion': 'string',
    'agentRuntimeEndpointArn': 'string',
    'agentRuntimeArn': 'string',
    'description': 'string',
    'status': 'CREATING'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'READY'|'DELETING',
    'createdAt': datetime(2015, 1, 1),
    'lastUpdatedAt': datetime(2015, 1, 1),
    'failureReason': 'string',
    'name': 'string',
    'id': 'string'
}

Response Structure

(dict) –
- liveVersion (string) –
  
  The currently deployed version of the AgentCore Runtime on the endpoint.
- targetVersion (string) –
  
  The target version of the AgentCore Runtime for the endpoint.
- agentRuntimeEndpointArn (string) –
  
  The Amazon Resource Name (ARN) of the AgentCore Runtime endpoint.
- agentRuntimeArn (string) –
  
  The Amazon Resource Name (ARN) of the AgentCore Runtime.
- description (string) –
  
  The description of the AgentCore Runtime endpoint.
- status (string) –
  
  The current status of the AgentCore Runtime endpoint.
- createdAt (datetime) –
  
  The timestamp when the AgentCore Runtime endpoint was created.
- lastUpdatedAt (datetime) –
  
  The timestamp when the AgentCore Runtime endpoint was last updated.
- failureReason (string) –
  
  The reason for failure if the AgentCore Runtime endpoint is in a failed state.
- name (string) –
  
  The name of the AgentCore Runtime endpoint.
- id (string) –
  
  The unique identifier of the AgentCore Runtime endpoint.

Exceptions

BedrockAgentCoreControl.Client.exceptions.AccessDeniedException
BedrockAgentCoreControl.Client.exceptions.ValidationException
BedrockAgentCoreControl.Client.exceptions.ResourceNotFoundException
BedrockAgentCoreControl.Client.exceptions.ThrottlingException
BedrockAgentCoreControl.Client.exceptions.InternalServerException