WorkMail / Paginator / ListGroups

ListGroups

class WorkMail.Paginator.ListGroups

paginator = client.get_paginator('list_groups')

paginate(**kwargs)

Creates an iterator that will paginate through responses from WorkMail.Client.list_groups().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    OrganizationId='string',
    Filters={
        'NamePrefix': 'string',
        'PrimaryEmailPrefix': 'string',
        'State': 'ENABLED'|'DISABLED'|'DELETED'
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• OrganizationId (string) –

  [REQUIRED]

  The identifier for the organization under which the groups exist.

• Filters (dict) –

  Limit the search results based on the filter criteria. Only one filter per request is supported.

  • NamePrefix (string) –

    Filters only groups with the provided name prefix.

  • PrimaryEmailPrefix (string) –

    Filters only groups with the provided primary email prefix.

  • State (string) –

    Filters only groups with the provided state.

• 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',
            'Email': 'string',
            'Name': 'string',
            'State': 'ENABLED'|'DISABLED'|'DELETED',
            'EnabledDate': datetime(2015, 1, 1),
            'DisabledDate': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • Groups (list) –

    The overview of groups for an organization.

    • (dict) –

      The representation of an WorkMail group.

      • Id (string) –

        The identifier of the group.

      • Email (string) –

        The email of the group.

      • Name (string) –

        The name of the group.

      • State (string) –

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

      • EnabledDate (datetime) –

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

      • DisabledDate (datetime) –

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