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

*************************
update_agent_collaborator
*************************



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

  

  Updates an agent's collaborator.

  

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


  **Request Syntax**
  ::

    response = client.update_agent_collaborator(
        agentId='string',
        agentVersion='string',
        collaboratorId='string',
        agentDescriptor={
            'aliasArn': 'string'
        },
        collaboratorName='string',
        collaborationInstruction='string',
        relayConversationHistory='TO_COLLABORATOR'|'DISABLED'
    )
    
  :type agentId: string
  :param agentId: **[REQUIRED]** 

    The agent's ID.

    

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

    The agent's version.

    

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

    The collaborator's ID.

    

  
  :type agentDescriptor: dict
  :param agentDescriptor: **[REQUIRED]** 

    An agent descriptor for the agent collaborator.

    

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

      The agent's alias ARN.

      

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

    The collaborator's name.

    

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

    Instruction for the collaborator.

    

  
  :type relayConversationHistory: string
  :param relayConversationHistory: 

    A relay conversation history for the collaborator.

    

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

    
    ::

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

    

    - *(dict) --* 
      

      - **agentCollaborator** *(dict) --* 

        Details about the collaborator.

        
        

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

          The collaborator's agent ID.

          
        

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

          The collaborator's agent version.

          
        

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

          The collaborator's agent descriptor.

          
          

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

            The agent's alias ARN.

            
      
        

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

          The collaborator's collaborator ID.

          
        

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

          The collaborator's instructions.

          
        

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

          The collaborator's collaborator name.

          
        

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

          When the collaborator was created.

          
        

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

          When the collaborator was updated.

          
        

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

          The collaborator's relay conversation history.

          
        

        - **clientToken** *(string) --* 

          The collaborator's client token.

          
    
  
  **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`

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

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

  