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

Class: Aws::AlexaForBusiness::Types::SearchAddressBooksRequest

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 SearchAddressBooksRequest data as a hash:

{
  filters: [
    {
      key: "FilterKey", # required
      values: ["FilterValue"], # required
    },
  ],
  sort_criteria: [
    {
      key: "SortKey", # required
      value: "ASC", # required, accepts ASC, DESC
    },
  ],
  next_token: "NextToken",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#filtersArray<Types::Filter>

The filters to use to list a specified set of address books. The supported filter key is AddressBookName.

Returns:



4057
4058
4059
4060
4061
4062
4063
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 4057

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


4057
4058
4059
4060
4061
4062
4063
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 4057

class SearchAddressBooksRequest < Struct.new(
  :filters,
  :sort_criteria,
  :next_token,
  :max_results)
  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 only includes results beyond the token, up to the value specified by MaxResults.

Returns:

  • (String)


4057
4058
4059
4060
4061
4062
4063
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 4057

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

#sort_criteriaArray<Types::Sort>

The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName.

Returns:



4057
4058
4059
4060
4061
4062
4063
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 4057

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