Class: Aws::Rekognition::Types::StartFaceDetectionRequest

Inherits:

Struct

• Object
• Struct
• Aws::Rekognition::Types::StartFaceDetectionRequest

Includes:

Structure

Defined in:

lib/aws-sdk-rekognition/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_request_token ⇒ String

  Idempotent token used to identify the start request.

• #face_attributes ⇒ String

  The face attributes you want returned.

• #job_tag ⇒ String

  An identifier you specify that’s returned in the completion notification that’s published to your Amazon Simple Notification Service topic.

• #notification_channel ⇒ Types::NotificationChannel

  The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the face detection operation.

• #video ⇒ Types::Video

  The video in which you want to detect faces.

Instance Attribute Details

#client_request_token ⇒ String

Idempotent token used to identify the start request. If you use the same token with multiple ‘StartFaceDetection` requests, the same `JobId` is returned. Use `ClientRequestToken` to prevent the same job from being accidently started more than once.

Returns:

• (String)

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

class StartFaceDetectionRequest < Struct.new(
  :video,
  :client_request_token,
  :notification_channel,
  :face_attributes,
  :job_tag)
  SENSITIVE = []
  include Aws::Structure
end

#face_attributes ⇒ String

The face attributes you want returned.

‘DEFAULT` - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks.

‘ALL` - All facial attributes are returned.

Returns:

• (String)

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

class StartFaceDetectionRequest < Struct.new(
  :video,
  :client_request_token,
  :notification_channel,
  :face_attributes,
  :job_tag)
  SENSITIVE = []
  include Aws::Structure
end

#job_tag ⇒ String

An identifier you specify that’s returned in the completion notification that’s published to your Amazon Simple Notification Service topic. For example, you can use ‘JobTag` to group related jobs and identify them in the completion notification.

Returns:

• (String)

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

class StartFaceDetectionRequest < Struct.new(
  :video,
  :client_request_token,
  :notification_channel,
  :face_attributes,
  :job_tag)
  SENSITIVE = []
  include Aws::Structure
end

#notification_channel ⇒ Types::NotificationChannel

The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the face detection operation. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.

Returns:

• (Types::NotificationChannel)

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

class StartFaceDetectionRequest < Struct.new(
  :video,
  :client_request_token,
  :notification_channel,
  :face_attributes,
  :job_tag)
  SENSITIVE = []
  include Aws::Structure
end

#video ⇒ Types::Video

The video in which you want to detect faces. The video must be stored in an Amazon S3 bucket.

Returns:

• (Types::Video)

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

class StartFaceDetectionRequest < Struct.new(
  :video,
  :client_request_token,
  :notification_channel,
  :face_attributes,
  :job_tag)
  SENSITIVE = []
  include Aws::Structure
end