Class: Aws::AlexaForBusiness::Types::SearchProfilesRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::AlexaForBusiness::Types::SearchProfilesRequest
- Defined in:
- gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb
Overview
When making an API call, you may pass SearchProfilesRequest 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 to list a specified set of room profiles.
-
#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 specified set of room profiles.
Instance Attribute Details
#filters ⇒ Array<Types::Filter>
The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.
4954 4955 4956 4957 4958 4959 4960 4961 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 4954 class SearchProfilesRequest < 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.
4954 4955 4956 4957 4958 4959 4960 4961 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 4954 class SearchProfilesRequest < 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
.
4954 4955 4956 4957 4958 4959 4960 4961 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 4954 class SearchProfilesRequest < 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 specified set of room profiles. Supported sort keys are ProfileName and Address.
4954 4955 4956 4957 4958 4959 4960 4961 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 4954 class SearchProfilesRequest < Struct.new( :next_token, :max_results, :filters, :sort_criteria) SENSITIVE = [] include Aws::Structure end |