:doc:`BedrockAgentCoreControl <../../bedrock-agentcore-control>` / Client / list_agent_runtime_endpoints

****************************
list_agent_runtime_endpoints
****************************



.. py:method:: BedrockAgentCoreControl.Client.list_agent_runtime_endpoints(**kwargs)

  

  Lists all endpoints for a specific Amazon Secure Agent.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-control-2023-06-05/ListAgentRuntimeEndpoints>`_  


  **Request Syntax**
  ::

    response = client.list_agent_runtime_endpoints(
        agentRuntimeId='string',
        maxResults=123,
        nextToken='string'
    )
    
  :type agentRuntimeId: string
  :param agentRuntimeId: **[REQUIRED]** 

    The unique identifier of the AgentCore Runtime to list endpoints for.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return in the response.

    

  
  :type nextToken: string
  :param nextToken: 

    A token to retrieve the next page of results.

    

  
  
  :rtype: 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 AgentCore 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**
  
  *   :py:class:`BedrockAgentCoreControl.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`BedrockAgentCoreControl.Client.exceptions.ValidationException`

  
  *   :py:class:`BedrockAgentCoreControl.Client.exceptions.ThrottlingException`

  
  *   :py:class:`BedrockAgentCoreControl.Client.exceptions.InternalServerException`

  