BedrockAgentCoreControlPlaneFrontingLayer / Client / list_agent_runtime_endpoints

list_agent_runtime_endpoints¶

BedrockAgentCoreControlPlaneFrontingLayer.Client.list_agent_runtime_endpoints(**kwargs)¶

Lists all endpoints for a specific Amazon Secure Agent.

Request Syntax

response = client.list_agent_runtime_endpoints(
    agentRuntimeId='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

agentRuntimeId (string) –
[REQUIRED]

The unique identifier of the agent runtime to list endpoints for.
maxResults (integer) – The maximum number of results to return in the response.
nextToken (string) – A token to retrieve the next page of results.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- runtimeEndpoints (list) –
  
  The list of agent runtime endpoints.
  - (dict) –
    
    Contains information about an agent runtime endpoint. An endpoint provides a way to connect to and interact with an agent runtime.
    - name (string) –
      
      The name of the agent runtime endpoint.
    - liveVersion (string) –
      
      The live version of the agent runtime endpoint. This is the version that is currently serving requests.
    - targetVersion (string) –
      
      The target version of the agent runtime endpoint. This is the version that the endpoint is being updated to.
    - agentRuntimeEndpointArn (string) –
      
      The Amazon Resource Name (ARN) of the agent runtime endpoint.
    - agentRuntimeArn (string) –
      
      The Amazon Resource Name (ARN) of the agent runtime associated with the endpoint.
    - status (string) –
      
      The current status of the agent runtime endpoint.
    - id (string) –
      
      The unique identifier of the agent runtime endpoint.
    - description (string) –
      
      The description of the agent runtime endpoint.
    - createdAt (datetime) –
      
      The timestamp when the agent runtime endpoint was created.
    - lastUpdatedAt (datetime) –
      
      The timestamp when the agent runtime endpoint was last updated.
- nextToken (string) –
  
  A token to retrieve the next page of results.

Exceptions

BedrockAgentCoreControlPlaneFrontingLayer.Client.exceptions.AccessDeniedException
BedrockAgentCoreControlPlaneFrontingLayer.Client.exceptions.ValidationException
BedrockAgentCoreControlPlaneFrontingLayer.Client.exceptions.ThrottlingException
BedrockAgentCoreControlPlaneFrontingLayer.Client.exceptions.InternalServerException