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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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.

<note markdown=“1”> InstanceID is a required field. The “Required: No” below is incorrect.

</note>

[1]: docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html

Returns:

  • (String) 


16405
16406
16407
16408
16409
16410
16411
16412
16413
 
# File 'lib/aws-sdk-connect/types.rb', line 16405

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) 


16405
16406
16407
16408
16409
16410
16411
16412
16413
 
# File 'lib/aws-sdk-connect/types.rb', line 16405

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) 


16405
16406
16407
16408
16409
16410
16411
16412
16413
 
# File 'lib/aws-sdk-connect/types.rb', line 16405

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.

<note markdown=“1”> 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.

</note>

Returns:



16405
16406
16407
16408
16409
16410
16411
16412
16413
 
# File 'lib/aws-sdk-connect/types.rb', line 16405

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:



16405
16406
16407
16408
16409
16410
16411
16412
16413
 
# File 'lib/aws-sdk-connect/types.rb', line 16405

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