Class: Aws::Connect::Types::SearchContactsRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#instance_id ⇒ String

The identifier of Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

  • (String) 


16156
16157
16158
16159
16160
16161
16162
16163
16164
16165
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 16156

class SearchContactsRequest < Struct.new(
  :instance_id,
  :time_range,
  :search_criteria,
  :max_results,
  :next_token,
  :sort)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to return per page.

Returns:

  • (Integer) 


16156
16157
16158
16159
16160
16161
16162
16163
16164
16165
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 16156

class SearchContactsRequest < Struct.new(
  :instance_id,
  :time_range,
  :search_criteria,
  :max_results,
  :next_token,
  :sort)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

  • (String) 


16156
16157
16158
16159
16160
16161
16162
16163
16164
16165
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 16156

class SearchContactsRequest < Struct.new(
  :instance_id,
  :time_range,
  :search_criteria,
  :max_results,
  :next_token,
  :sort)
  SENSITIVE = []
  include Aws::Structure
end

#search_criteria ⇒ Types::SearchCriteria

The search criteria to be used to return contacts.

Returns:



16156
16157
16158
16159
16160
16161
16162
16163
16164
16165
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 16156

class SearchContactsRequest < Struct.new(
  :instance_id,
  :time_range,
  :search_criteria,
  :max_results,
  :next_token,
  :sort)
  SENSITIVE = []
  include Aws::Structure
end

#sort ⇒ Types::Sort

Specifies a field to sort by and a sort order.

Returns:



16156
16157
16158
16159
16160
16161
16162
16163
16164
16165
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 16156

class SearchContactsRequest < Struct.new(
  :instance_id,
  :time_range,
  :search_criteria,
  :max_results,
  :next_token,
  :sort)
  SENSITIVE = []
  include Aws::Structure
end

#time_range ⇒ Types::SearchContactsTimeRange

Time range that you want to search results.

Returns:



16156
16157
16158
16159
16160
16161
16162
16163
16164
16165
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 16156

class SearchContactsRequest < Struct.new(
  :instance_id,
  :time_range,
  :search_criteria,
  :max_results,
  :next_token,
  :sort)
  SENSITIVE = []
  include Aws::Structure
end