WorkMail / Client / list_group_members

list_group_members#

WorkMail.Client.list_group_members(**kwargs)#

Returns an overview of the members of a group. Users and groups can be members of a group.

See also: AWS API Documentation

Request Syntax

response = client.list_group_members(
    OrganizationId='string',
    GroupId='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • OrganizationId (string) –

    [REQUIRED]

    The identifier for the organization under which the group exists.

  • GroupId (string) –

    [REQUIRED]

    The identifier for the group to which the members (users or groups) are associated.

    The identifier can accept GroupId, Groupname, or email. The following identity formats are available:

    • Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: group@domain.tld

    • Group name: group

  • NextToken (string) – The token to use to retrieve the next page of results. The first call does not contain any tokens.

  • MaxResults (integer) – The maximum number of results to return in a single call.

Return type:

dict

Returns:

Response Syntax

{
    'Members': [
        {
            'Id': 'string',
            'Name': 'string',
            'Type': 'GROUP'|'USER',
            'State': 'ENABLED'|'DISABLED'|'DELETED',
            'EnabledDate': datetime(2015, 1, 1),
            'DisabledDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Members (list) –

      The members associated to the group.

      • (dict) –

        The representation of a user or group.

        • Id (string) –

          The identifier of the member.

        • Name (string) –

          The name of the member.

        • Type (string) –

          A member can be a user or group.

        • State (string) –

          The state of the member, which can be ENABLED, DISABLED, or DELETED.

        • EnabledDate (datetime) –

          The date indicating when the member was enabled for WorkMail use.

        • DisabledDate (datetime) –

          The date indicating when the member was disabled from WorkMail use.

    • NextToken (string) –

      The token to use to retrieve the next page of results. The first call does not contain any tokens.

Exceptions