:doc:`AgentsforBedrock <../../bedrock-agent>` / Client / list_agent_collaborators

************************
list_agent_collaborators
************************



.. py:method:: AgentsforBedrock.Client.list_agent_collaborators(**kwargs)

  

  Retrieve a list of an agent's collaborators.

  

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


  **Request Syntax**
  ::

    response = client.list_agent_collaborators(
        agentId='string',
        agentVersion='string',
        maxResults=123,
        nextToken='string'
    )
    
  :type agentId: string
  :param agentId: **[REQUIRED]** 

    The agent's ID.

    

  
  :type agentVersion: string
  :param agentVersion: **[REQUIRED]** 

    The agent's version.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of agent collaborators to return in one page of results.

    

  
  :type nextToken: string
  :param nextToken: 

    Specify the pagination token from a previous request to retrieve the next page of results.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'agentCollaboratorSummaries': [
              {
                  'agentId': 'string',
                  'agentVersion': 'string',
                  'collaboratorId': 'string',
                  'agentDescriptor': {
                      'aliasArn': 'string'
                  },
                  'collaborationInstruction': 'string',
                  'relayConversationHistory': 'TO_COLLABORATOR'|'DISABLED',
                  'collaboratorName': 'string',
                  'createdAt': datetime(2015, 1, 1),
                  'lastUpdatedAt': datetime(2015, 1, 1)
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **agentCollaboratorSummaries** *(list) --* 

        A list of collaborator summaries.

        
        

        - *(dict) --* 

          An agent collaborator summary.

          
          

          - **agentId** *(string) --* 

            The collaborator's agent ID.

            
          

          - **agentVersion** *(string) --* 

            The collaborator's agent version.

            
          

          - **collaboratorId** *(string) --* 

            The collaborator's ID.

            
          

          - **agentDescriptor** *(dict) --* 

            The collaborator's agent descriptor.

            
            

            - **aliasArn** *(string) --* 

              The agent's alias ARN.

              
        
          

          - **collaborationInstruction** *(string) --* 

            The collaborator's collaboration instruction.

            
          

          - **relayConversationHistory** *(string) --* 

            The collaborator's relay conversation history.

            
          

          - **collaboratorName** *(string) --* 

            The collaborator's name.

            
          

          - **createdAt** *(datetime) --* 

            When the collaborator was created.

            
          

          - **lastUpdatedAt** *(datetime) --* 

            When the collaborator was last updated.

            
      
    
      

      - **nextToken** *(string) --* 

        Specify the pagination token from a previous request to retrieve the next page of results.

        
  
  **Exceptions**
  
  *   :py:class:`AgentsforBedrock.Client.exceptions.ThrottlingException`

  
  *   :py:class:`AgentsforBedrock.Client.exceptions.AccessDeniedException`

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

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

  
  *   :py:class:`AgentsforBedrock.Client.exceptions.ResourceNotFoundException`

  