ListGroupMemberships

class IdentityStore.Paginator.ListGroupMemberships

paginator = client.get_paginator('list_group_memberships')

paginate(**kwargs)

Creates an iterator that will paginate through responses from IdentityStore.Client.list_group_memberships().

See also: AWS API Documentation

Request Syntax

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

Parameters

• IdentityStoreId (string) --

  [REQUIRED]

  The globally unique identifier for the identity store.

• GroupId (string) --

  [REQUIRED]

  The identifier for a group in the identity store.

• 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

{
    'GroupMemberships': [
        {
            'IdentityStoreId': 'string',
            'MembershipId': 'string',
            'GroupId': 'string',
            'MemberId': {
                'UserId': 'string'
            }
        },
    ],

}

Response Structure

• (dict) --

  • GroupMemberships (list) --

    A list of GroupMembership objects in the group.

    • (dict) --

      Contains the identifiers for a group, a group member, and a GroupMembership object in the identity store.

      • IdentityStoreId (string) --

        The globally unique identifier for the identity store.

      • MembershipId (string) --

        The identifier for a GroupMembership object in an identity store.

      • GroupId (string) --

        The identifier for a group in the identity store.

      • MemberId (dict) --

        An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: UserId. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        

        • UserId (string) --

          An object containing the identifiers of resources that can be members.