:doc:`BedrockAgentCoreControl <../../bedrock-agentcore-control>` / Paginator / ListAgentRuntimeEndpoints

*************************
ListAgentRuntimeEndpoints
*************************



.. py:class:: BedrockAgentCoreControl.Paginator.ListAgentRuntimeEndpoints

  ::

    
    paginator = client.get_paginator('list_agent_runtime_endpoints')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`BedrockAgentCoreControl.Client.list_agent_runtime_endpoints`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          agentRuntimeId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type agentRuntimeId: string
    :param agentRuntimeId: **[REQUIRED]** 

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

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :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 resume pagination.

          
    