AgentsforBedrock / Client / associate_agent_collaborator

associate_agent_collaborator#

AgentsforBedrock.Client.associate_agent_collaborator(**kwargs)#

Makes an agent a collaborator for another agent.

See also: AWS API Documentation

Request Syntax

response = client.associate_agent_collaborator(
    agentDescriptor={
        'aliasArn': 'string'
    },
    agentId='string',
    agentVersion='string',
    clientToken='string',
    collaborationInstruction='string',
    collaboratorName='string',
    relayConversationHistory='TO_COLLABORATOR'|'DISABLED'
)
Parameters:

  • agentDescriptor (dict) –

    [REQUIRED]

    The alias of the collaborator agent.

    • aliasArn (string) –

      The agent’s alias ARN.

  • agentId (string) –

    [REQUIRED]

    The agent’s ID.

  • agentVersion (string) –

    [REQUIRED]

    An agent version.

  • clientToken (string) –

    A client token.

    This field is autopopulated if not provided.

  • collaborationInstruction (string) –

    [REQUIRED]

    Instruction for the collaborator.

  • collaboratorName (string) –

    [REQUIRED]

    A name for the collaborator.

  • relayConversationHistory (string) – A relay conversation history for the collaborator.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • agentCollaborator (dict) –

      Details about the collaborator.

      • agentDescriptor (dict) –

        The collaborator’s agent descriptor.

        • aliasArn (string) –

          The agent’s alias ARN.

      • agentId (string) –

        The collaborator’s agent ID.

      • agentVersion (string) –

        The collaborator’s agent version.

      • clientToken (string) –

        The collaborator’s client token.

      • collaborationInstruction (string) –

        The collaborator’s instructions.

      • collaboratorId (string) –

        The collaborator’s collaborator ID.

      • 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.

Exceptions