AlexaForBusiness / Paginator / SearchUsers

SearchUsers

class AlexaForBusiness.Paginator.SearchUsers

paginator = client.get_paginator('search_users')

paginate(**kwargs)

Creates an iterator that will paginate through responses from AlexaForBusiness.Client.search_users().

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    SortCriteria=[
        {
            'Key': 'string',
            'Value': 'ASC'|'DESC'
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Filters (list) –

  The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

  • (dict) –

    A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria.

    • Key (string) – [REQUIRED]

      The key of a filter.

    • Values (list) – [REQUIRED]

      The values of a filter.

      • (string) –

• SortCriteria (list) –

  The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

  • (dict) –

    An object representing a sort criteria.

    • Key (string) – [REQUIRED]

      The sort key of a sort object.

    • Value (string) – [REQUIRED]

      The sort value of a sort object.

• 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

{
    'Users': [
        {
            'UserArn': 'string',
            'FirstName': 'string',
            'LastName': 'string',
            'Email': 'string',
            'EnrollmentStatus': 'INITIALIZED'|'PENDING'|'REGISTERED'|'DISASSOCIATING'|'DEREGISTERING',
            'EnrollmentId': 'string'
        },
    ],
    'TotalCount': 123
}

Response Structure

• (dict) –

  • Users (list) –

    The users that meet the specified set of filter criteria, in sort order.

    • (dict) –

      Information related to a user.

      • UserArn (string) –

        The ARN of a user.

      • FirstName (string) –

        The first name of a user.

      • LastName (string) –

        The last name of a user.

      • Email (string) –

        The email of a user.

      • EnrollmentStatus (string) –

        The enrollment status of a user.

      • EnrollmentId (string) –

        The enrollment ARN of a user.

  • TotalCount (integer) –

    The total number of users returned.