AgentsforBedrock / Paginator / ListAgentActionGroups

ListAgentActionGroups#

class AgentsforBedrock.Paginator.ListAgentActionGroups#
paginator = client.get_paginator('list_agent_action_groups')
paginate(**kwargs)#

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

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 unique identifier of the agent.

  • agentVersion (string) –

    [REQUIRED]

    The version of the agent.

  • 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

{
    'actionGroupSummaries': [
        {
            'actionGroupId': 'string',
            'actionGroupName': 'string',
            'actionGroupState': 'ENABLED'|'DISABLED',
            'description': 'string',
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • actionGroupSummaries (list) –

      A list of objects, each of which contains information about an action group.

      • (dict) –

        Contains details about an action group.

        • actionGroupId (string) –

          The unique identifier of the action group.

        • actionGroupName (string) –

          The name of the action group.

        • actionGroupState (string) –

          Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.

        • description (string) –

          The description of the action group.

        • updatedAt (datetime) –

          The time at which the action group was last updated.

    • NextToken (string) –

      A token to resume pagination.