IdentityStore / Client / list_group_memberships

list_group_memberships

IdentityStore.Client.list_group_memberships(**kwargs)

For the specified group in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.

Note

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

See also: AWS API Documentation

Request Syntax

response = client.list_group_memberships(
    IdentityStoreId='string',
    GroupId='string',
    MaxResults=123,
    NextToken='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.

• MaxResults (integer) – The maximum number of results to be returned per request. This parameter is used in all List requests to specify how many results to return in one page.

• NextToken (string) – The pagination token used for the ListUsers, ListGroups and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

Return type:

dict

Returns:

Response Syntax

{
    'GroupMemberships': [
        {
            'IdentityStoreId': 'string',
            'MembershipId': 'string',
            'GroupId': 'string',
            'MemberId': {
                'UserId': 'string'
            }
        },
    ],
    'NextToken': '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.

  • NextToken (string) –

    The pagination token used for the ListUsers, ListGroups, and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

Exceptions

• IdentityStore.Client.exceptions.ResourceNotFoundException

• IdentityStore.Client.exceptions.ThrottlingException

• IdentityStore.Client.exceptions.AccessDeniedException

• IdentityStore.Client.exceptions.InternalServerException

• IdentityStore.Client.exceptions.ValidationException