You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::AlexaForBusiness::Types::SearchUsersRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::AlexaForBusiness::Types::SearchUsersRequest
- Defined in:
- (unknown)
Overview
When passing SearchUsersRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
next_token: "NextToken",
max_results: 1,
filters: [
{
key: "FilterKey", # required
values: ["FilterValue"], # required
},
],
sort_criteria: [
{
key: "SortKey", # required
value: "ASC", # required, accepts ASC, DESC
},
],
}
Instance Attribute Summary collapse
-
#filters ⇒ Array<Types::Filter>
The filters to use for listing a specific set of users.
-
#max_results ⇒ Integer
The maximum number of results to include in the response.
-
#next_token ⇒ String
An optional token returned from a prior request.
-
#sort_criteria ⇒ Array<Types::Sort>
The sort order to use in listing the filtered set of users.
Instance Attribute Details
#filters ⇒ Array<Types::Filter>
The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
#max_results ⇒ Integer
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.
#next_token ⇒ String
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.
#sort_criteria ⇒ Array<Types::Sort>
The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.