Class: Aws::Rekognition::Types::AssociateFacesRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_token ⇒ String

Idempotent token used to identify the request to AssociateFaces. If you use the same token with multiple AssociateFaces requests, the same response is returned. Use ClientRequestToken to prevent the same request from being processed more than once.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String) 


81
82
83
84
85
86
87
88
89
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 81

class AssociateFacesRequest < Struct.new(
  :collection_id,
  :user_id,
  :face_ids,
  :user_match_threshold,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#collection_id ⇒ String

The ID of an existing collection containing the UserID.

Returns:

  • (String) 


81
82
83
84
85
86
87
88
89
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 81

class AssociateFacesRequest < Struct.new(
  :collection_id,
  :user_id,
  :face_ids,
  :user_match_threshold,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#face_ids ⇒ Array<String>

An array of FaceIDs to associate with the UserID.

Returns:

  • (Array<String>) 


81
82
83
84
85
86
87
88
89
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 81

class AssociateFacesRequest < Struct.new(
  :collection_id,
  :user_id,
  :face_ids,
  :user_match_threshold,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#user_id ⇒ String

The ID for the existing UserID.

Returns:

  • (String) 


81
82
83
84
85
86
87
88
89
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 81

class AssociateFacesRequest < Struct.new(
  :collection_id,
  :user_id,
  :face_ids,
  :user_match_threshold,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#user_match_threshold ⇒ Float

An optional value specifying the minimum confidence in the UserID match to return. The default value is 75.

Returns:

  • (Float) 


81
82
83
84
85
86
87
88
89
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 81

class AssociateFacesRequest < Struct.new(
  :collection_id,
  :user_id,
  :face_ids,
  :user_match_threshold,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end