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

Inherits:

Struct

• Object
• Struct
• Aws::AlexaForBusiness::Types::SearchAddressBooksRequest

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

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 address books.

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

Instance Attribute Details

#filters ⇒ Array<Types::Filter>

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

Returns:

• (Array<Types::Filter>)

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

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

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

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

#sort_criteria ⇒ Array<Types::Sort>

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

Returns:

• (Array<Types::Sort>)

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

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