AgentsforBedrock / Paginator / ListAgentCollaborators

ListAgentCollaborators

class AgentsforBedrock.Paginator.ListAgentCollaborators

paginator = client.get_paginator('list_agent_collaborators')

paginate(**kwargs)

Creates an iterator that will paginate through responses from AgentsforBedrock.Client.list_agent_collaborators().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    agentId='string',
    agentVersion='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• agentId (string) –

  [REQUIRED]

  The agent’s ID.

• agentVersion (string) –

  [REQUIRED]

  The agent’s version.

• PaginationConfig (dict) –

  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.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • agentCollaboratorSummaries (list) –

    A list of collaborator summaries.

    • (dict) –

      An agent collaborator summary.

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

      • collaborationInstruction (string) –

        The collaborator’s collaboration instruction.

      • collaboratorId (string) –

        The collaborator’s ID.

      • collaboratorName (string) –

        The collaborator’s name.

      • createdAt (datetime) –

        When the collaborator was created.

      • lastUpdatedAt (datetime) –

        When the collaborator was last updated.

      • relayConversationHistory (string) –

        The collaborator’s relay conversation history.

  • NextToken (string) –

    A token to resume pagination.