Copyright (c) 2013-2018 Brendan Hay Mozilla Public License, v. 2.0. Brendan Hay auto-generated non-portable (GHC extensions) None Haskell2010

Description

Searches users and lists the ones that meet a set of filter and sort criteria.

This operation returns paginated results.

Synopsis

# Creating a Request

Creates a value of SearchUsers with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• suFilters - The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
• suSortCriteria - The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
• suNextToken - An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults . Required.
• suMaxResults - The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved. Required.

See: searchUsers smart constructor.

Instances

# Request Lenses

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

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

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults . Required.

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved. Required.

# Destructuring the Response

Arguments

 :: Int sursResponseStatus -> SearchUsersResponse

Creates a value of SearchUsersResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sursUsers - The users that meet the specified set of filter criteria, in sort order.
• sursNextToken - The token returned to indicate that there is more data available.
• sursTotalCount - The total number of users returned.
• sursResponseStatus - -- | The response status code.

See: searchUsersResponse smart constructor.

Instances