WorkMail / Paginator / ListUsers


class WorkMail.Paginator.ListUsers#
paginator = client.get_paginator('list_users')

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'UsernamePrefix': 'string',
        'DisplayNamePrefix': 'string',
        'PrimaryEmailPrefix': 'string',
        'State': 'ENABLED'|'DISABLED'|'DELETED'
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • OrganizationId (string) –


    The identifier for the organization under which the users exist.

  • Filters (dict) –

    Limit the user search results based on the filter criteria. You can only use one filter per request.

    • UsernamePrefix (string) –

      Filters only users with the provided username prefix.

    • DisplayNamePrefix (string) –

      Filters only users with the provided display name prefix.

    • PrimaryEmailPrefix (string) –

      Filters only users with the provided email prefix.

    • State (string) –

      Filters only users 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:



Response Syntax

    'Users': [
            'Id': 'string',
            'Email': 'string',
            'Name': 'string',
            'DisplayName': 'string',
            'State': 'ENABLED'|'DISABLED'|'DELETED',
            'UserRole': 'USER'|'RESOURCE'|'SYSTEM_USER'|'REMOTE_USER',
            'EnabledDate': datetime(2015, 1, 1),
            'DisabledDate': datetime(2015, 1, 1)


Response Structure

  • (dict) –

    • Users (list) –

      The overview of users for an organization.

      • (dict) –

        The representation of an WorkMail user.

        • Id (string) –

          The identifier of the user.

        • Email (string) –

          The email of the user.

        • Name (string) –

          The name of the user.

        • DisplayName (string) –

          The display name of the user.

        • State (string) –

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

        • UserRole (string) –

          The role of the user.

        • EnabledDate (datetime) –

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

        • DisabledDate (datetime) –

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