WorkDocs / Paginator / DescribeGroups

DescribeGroups#

class WorkDocs.Paginator.DescribeGroups#
paginator = client.get_paginator('describe_groups')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from WorkDocs.Client.describe_groups().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AuthenticationToken='string',
    SearchQuery='string',
    OrganizationId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • AuthenticationToken (string) – Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • SearchQuery (string) –

    [REQUIRED]

    A query to describe groups by group name.

  • OrganizationId (string) – The ID of the organization.

  • 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

{
    'Groups': [
        {
            'Id': 'string',
            'Name': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Groups (list) –

      The list of groups.

      • (dict) –

        Describes the metadata of a user group.

        • Id (string) –

          The ID of the user group.

        • Name (string) –

          The name of the group.

    • NextToken (string) –

      A token to resume pagination.