Class: Aws::Connect::Types::SearchUsersRequest

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 the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

InstanceID is a required field. The "Required: No" below is incorrect.

Returns:

  • (String) 


16824
16825
16826
16827
16828
16829
16830
16831
16832
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 16824

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.

Returns:

  • (Integer) 


16824
16825
16826
16827
16828
16829
16830
16831
16832
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 16824

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.

Returns:

  • (String) 


16824
16825
16826
16827
16828
16829
16830
16831
16832
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 16824

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.

The 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.

Returns:



16824
16825
16826
16827
16828
16829
16830
16831
16832
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 16824

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.

Returns:



16824
16825
16826
16827
16828
16829
16830
16831
16832
 
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 16824

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