Class: Aws::AlexaForBusiness::Types::SearchUsersRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::AlexaForBusiness::Types::SearchUsersRequest
- Defined in:
- gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb
Overview
When making an API call, you may pass SearchUsersRequest data as a 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
},
],
}
Constant Summary collapse
- SENSITIVE =
[]
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.
5189 5190 5191 5192 5193 5194 5195 5196 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 5189 class SearchUsersRequest < Struct.new( :next_token, :max_results, :filters, :sort_criteria) SENSITIVE = [] include Aws::Structure end |
#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.
5189 5190 5191 5192 5193 5194 5195 5196 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 5189 class SearchUsersRequest < Struct.new( :next_token, :max_results, :filters, :sort_criteria) SENSITIVE = [] include Aws::Structure end |
#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.
5189 5190 5191 5192 5193 5194 5195 5196 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 5189 class SearchUsersRequest < Struct.new( :next_token, :max_results, :filters, :sort_criteria) SENSITIVE = [] include Aws::Structure end |
#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.
5189 5190 5191 5192 5193 5194 5195 5196 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 5189 class SearchUsersRequest < Struct.new( :next_token, :max_results, :filters, :sort_criteria) SENSITIVE = [] include Aws::Structure end |