Class: Aws::AlexaForBusiness::Types::SearchRoomsRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-alexaforbusiness/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filtersArray<Types::Filter>

The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.

Returns:



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_resultsInteger

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.

Returns:

  • (Integer)


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_tokenString

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`.

Returns:

  • (String)


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_criteriaArray<Types::Sort>

The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.

Returns:



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