Class: Aws::AlexaForBusiness::Types::SearchRoomsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::AlexaForBusiness::Types::SearchRoomsRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-alexaforbusiness/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#filters ⇒ Array<Types::Filter>
The filters to use to list a specified set of rooms.
-
#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 rooms.
Instance Attribute Details
#filters ⇒ Array<Types::Filter>
The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.
4122 4123 4124 4125 4126 4127 4128 4129 |
# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 4122 class SearchRoomsRequest < 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.
4122 4123 4124 4125 4126 4127 4128 4129 |
# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 4122 class SearchRoomsRequest < 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`.
4122 4123 4124 4125 4126 4127 4128 4129 |
# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 4122 class SearchRoomsRequest < 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 rooms. The supported sort keys are RoomName and ProfileName.
4122 4123 4124 4125 4126 4127 4128 4129 |
# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 4122 class SearchRoomsRequest < Struct.new( :next_token, :max_results, :filters, :sort_criteria) SENSITIVE = [] include Aws::Structure end |