Class: Aws::AlexaForBusiness::Types::SearchContactsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::AlexaForBusiness::Types::SearchContactsRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-alexaforbusiness/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
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.
3881 3882 3883 3884 3885 3886 3887 3888 |
# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 3881 class SearchContactsRequest < 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.
3881 3882 3883 3884 3885 3886 3887 3888 |
# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 3881 class SearchContactsRequest < 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.
3881 3882 3883 3884 3885 3886 3887 3888 |
# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 3881 class SearchContactsRequest < 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 contacts. The supported sort keys are DisplayName, FirstName, and LastName.
3881 3882 3883 3884 3885 3886 3887 3888 |
# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 3881 class SearchContactsRequest < Struct.new( :filters, :sort_criteria, :next_token, :max_results) SENSITIVE = [] include Aws::Structure end |