You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::AlexaForBusiness::Types::SearchProfilesRequest

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

Overview

Note:

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
    },
  ],
}

See Also:

Instance Attribute Summary collapse

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.

Returns:



2001
2002
2003
2004
2005
2006
2007
 
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 2001

class SearchProfilesRequest < Struct.new(
  :next_token,
  :max_results,
  :filters,
  :sort_criteria)
  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) 


2001
2002
2003
2004
2005
2006
2007
 
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 2001

class SearchProfilesRequest < Struct.new(
  :next_token,
  :max_results,
  :filters,
  :sort_criteria)
  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) 


2001
2002
2003
2004
2005
2006
2007
 
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 2001

class SearchProfilesRequest < Struct.new(
  :next_token,
  :max_results,
  :filters,
  :sort_criteria)
  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.

Returns:



2001
2002
2003
2004
2005
2006
2007
 
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 2001

class SearchProfilesRequest < Struct.new(
  :next_token,
  :max_results,
  :filters,
  :sort_criteria)
  include Aws::Structure
end