You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::AlexaForBusiness::Types::SearchContactsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::AlexaForBusiness::Types::SearchContactsRequest
- Defined in:
- (unknown)
Overview
When passing SearchContactsRequest as input to an Aws::Client method, you can use a vanilla 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
-
#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 contacts.
Instance Attribute Details
#filters ⇒ Array<Types::Filter>
The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.
#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.
#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.
#sort_criteria ⇒ Array<Types::Sort>
The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.