Class: Aws::Connect::Types::SearchUsersRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Connect::Types::SearchUsersRequest
- Defined in:
- gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#instance_id ⇒ String
The identifier of the Amazon Connect instance.
-
#max_results ⇒ Integer
The maximum number of results to return per page.
-
#next_token ⇒ String
The token for the next set of results.
-
#search_criteria ⇒ Types::UserSearchCriteria
The search criteria to be used to return users.
-
#search_filter ⇒ Types::UserSearchFilter
Filters to be applied to search results.
Instance Attribute Details
#instance_id ⇒ String
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
17218 17219 17220 17221 17222 17223 17224 17225 17226 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 17218 class SearchUsersRequest < Struct.new( :instance_id, :next_token, :max_results, :search_filter, :search_criteria) SENSITIVE = [] include Aws::Structure end |
#max_results ⇒ Integer
The maximum number of results to return per page.
17218 17219 17220 17221 17222 17223 17224 17225 17226 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 17218 class SearchUsersRequest < Struct.new( :instance_id, :next_token, :max_results, :search_filter, :search_criteria) 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.
17218 17219 17220 17221 17222 17223 17224 17225 17226 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 17218 class SearchUsersRequest < Struct.new( :instance_id, :next_token, :max_results, :search_filter, :search_criteria) SENSITIVE = [] include Aws::Structure end |
#search_criteria ⇒ Types::UserSearchCriteria
The search criteria to be used to return users.
name
and description
fields support "contains" queries
with a minimum of 2 characters and a maximum of 25 characters. Any
queries with character lengths outside of this range will throw
invalid results.
17218 17219 17220 17221 17222 17223 17224 17225 17226 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 17218 class SearchUsersRequest < Struct.new( :instance_id, :next_token, :max_results, :search_filter, :search_criteria) SENSITIVE = [] include Aws::Structure end |
#search_filter ⇒ Types::UserSearchFilter
Filters to be applied to search results.
17218 17219 17220 17221 17222 17223 17224 17225 17226 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 17218 class SearchUsersRequest < Struct.new( :instance_id, :next_token, :max_results, :search_filter, :search_criteria) SENSITIVE = [] include Aws::Structure end |