Class: Aws::Connect::Types::UserSearchCriteria

Inherits:

Struct

• Object
• Struct
• Aws::Connect::Types::UserSearchCriteria

Defined in:

gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb

Overview

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #and_conditions ⇒ Array<Types::UserSearchCriteria>

  A list of conditions which would be applied together with an AND condition.

• #hierarchy_group_condition ⇒ Types::HierarchyGroupCondition

  A leaf node condition which can be used to specify a hierarchy group condition.

• #list_condition ⇒ Types::ListCondition

  A leaf node condition which can be used to specify a List condition to search users with attributes included in Lists like Proficiencies.

• #or_conditions ⇒ Array<Types::UserSearchCriteria>

  A list of conditions which would be applied together with an OR condition.

• #string_condition ⇒ Types::StringCondition

  A leaf node condition which can be used to specify a string condition.

Instance Attribute Details

#and_conditions ⇒ Array<Types::UserSearchCriteria>

A list of conditions which would be applied together with an AND condition.

Returns:

• (Array<Types::UserSearchCriteria>)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 26364

class UserSearchCriteria < Struct.new(
  :or_conditions,
  :and_conditions,
  :string_condition,
  :list_condition,
  :hierarchy_group_condition)
  SENSITIVE = []
  include Aws::Structure
end

#hierarchy_group_condition ⇒ Types::HierarchyGroupCondition

A leaf node condition which can be used to specify a hierarchy group condition.

Returns:

• (Types::HierarchyGroupCondition)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 26364

class UserSearchCriteria < Struct.new(
  :or_conditions,
  :and_conditions,
  :string_condition,
  :list_condition,
  :hierarchy_group_condition)
  SENSITIVE = []
  include Aws::Structure
end

#list_condition ⇒ Types::ListCondition

A leaf node condition which can be used to specify a List condition to search users with attributes included in Lists like Proficiencies.

Returns:

• (Types::ListCondition)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 26364

class UserSearchCriteria < Struct.new(
  :or_conditions,
  :and_conditions,
  :string_condition,
  :list_condition,
  :hierarchy_group_condition)
  SENSITIVE = []
  include Aws::Structure
end

#or_conditions ⇒ Array<Types::UserSearchCriteria>

A list of conditions which would be applied together with an OR condition.

Returns:

• (Array<Types::UserSearchCriteria>)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 26364

class UserSearchCriteria < Struct.new(
  :or_conditions,
  :and_conditions,
  :string_condition,
  :list_condition,
  :hierarchy_group_condition)
  SENSITIVE = []
  include Aws::Structure
end

#string_condition ⇒ Types::StringCondition

A leaf node condition which can be used to specify a string condition.

The currently supported values for FieldName are Username, FirstName, LastName, RoutingProfileId, SecurityProfileId, ResourceId.

Returns:

• (Types::StringCondition)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 26364

class UserSearchCriteria < Struct.new(
  :or_conditions,
  :and_conditions,
  :string_condition,
  :list_condition,
  :hierarchy_group_condition)
  SENSITIVE = []
  include Aws::Structure
end