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

Inherits:

Struct

• Object
• Struct
• Aws::AlexaForBusiness::Types::SearchRoomsRequest

Defined in:

gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb

Overview

Note:

When making an API call, you may pass SearchRoomsRequest 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
    },
  ],
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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.

Returns:

• (Array<Types::Filter>)

# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 5032

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.

Returns:

• (Integer)

# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 5032

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.

Returns:

• (String)

# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 5032

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.

Returns:

• (Array<Types::Sort>)

# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 5032

class SearchRoomsRequest < Struct.new(
  :next_token,
  :max_results,
  :filters,
  :sort_criteria)
  SENSITIVE = []
  include Aws::Structure
end