ListUserHierarchyGroups

class Connect.Paginator.ListUserHierarchyGroups

paginator = client.get_paginator('list_user_hierarchy_groups')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Connect.Client.list_user_hierarchy_groups().

See also: AWS API Documentation

Request Syntax

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

Parameters

• InstanceId (string) --

  [REQUIRED]

  The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

• 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

{
    'UserHierarchyGroupSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string'
        },
    ],

}

Response Structure

• (dict) --

  • UserHierarchyGroupSummaryList (list) --

    Information about the hierarchy groups.

    • (dict) --

      Contains summary information about a hierarchy group.

      • Id (string) --

        The identifier of the hierarchy group.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the hierarchy group.

      • Name (string) --

        The name of the hierarchy group.