Class: Aws::Rekognition::Types::SearchUsersRequest

Inherits:

Struct

• Object
• Struct
• Aws::Rekognition::Types::SearchUsersRequest

Includes:

Structure

Defined in:

lib/aws-sdk-rekognition/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #collection_id ⇒ String

  The ID of an existing collection containing the UserID, used with a UserId or FaceId.

• #face_id ⇒ String

  ID for the existing face.

• #max_users ⇒ Integer

  Maximum number of identities to return.

• #user_id ⇒ String

  ID for the existing User.

• #user_match_threshold ⇒ Float

  Optional value that specifies the minimum confidence in the matched UserID to return.

Instance Attribute Details

#collection_id ⇒ String

The ID of an existing collection containing the UserID, used with a UserId or FaceId. If a FaceId is provided, UserId isn’t required to be present in the Collection.

Returns:

• (String)

# File 'lib/aws-sdk-rekognition/types.rb', line 6573

class SearchUsersRequest < Struct.new(
  :collection_id,
  :user_id,
  :face_id,
  :user_match_threshold,
  :max_users)
  SENSITIVE = []
  include Aws::Structure
end

#face_id ⇒ String

ID for the existing face.

Returns:

• (String)

# File 'lib/aws-sdk-rekognition/types.rb', line 6573

class SearchUsersRequest < Struct.new(
  :collection_id,
  :user_id,
  :face_id,
  :user_match_threshold,
  :max_users)
  SENSITIVE = []
  include Aws::Structure
end

#max_users ⇒ Integer

Maximum number of identities to return.

Returns:

• (Integer)

# File 'lib/aws-sdk-rekognition/types.rb', line 6573

class SearchUsersRequest < Struct.new(
  :collection_id,
  :user_id,
  :face_id,
  :user_match_threshold,
  :max_users)
  SENSITIVE = []
  include Aws::Structure
end

#user_id ⇒ String

ID for the existing User.

Returns:

• (String)

# File 'lib/aws-sdk-rekognition/types.rb', line 6573

class SearchUsersRequest < Struct.new(
  :collection_id,
  :user_id,
  :face_id,
  :user_match_threshold,
  :max_users)
  SENSITIVE = []
  include Aws::Structure
end

#user_match_threshold ⇒ Float

Optional value that specifies the minimum confidence in the matched UserID to return. Default value of 80.

Returns:

• (Float)

# File 'lib/aws-sdk-rekognition/types.rb', line 6573

class SearchUsersRequest < Struct.new(
  :collection_id,
  :user_id,
  :face_id,
  :user_match_threshold,
  :max_users)
  SENSITIVE = []
  include Aws::Structure
end