You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

When making an API call, you may pass StartFaceDetectionRequest data as a hash:

{
  video: { # required
    s3_object: {
      bucket: "S3Bucket",
      name: "S3ObjectName",
      version: "S3ObjectVersion",
    },
  },
  client_request_token: "ClientRequestToken",
  notification_channel: {
    sns_topic_arn: "SNSTopicArn", # required
    role_arn: "RoleArn", # required
  },
  face_attributes: "DEFAULT", # accepts DEFAULT, ALL
  job_tag: "JobTag",
}

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

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)


2739
2740
2741
2742
2743
2744
2745
2746
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2739

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

#face_attributesString

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)


2739
2740
2741
2742
2743
2744
2745
2746
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2739

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

#job_tagString

Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.

Returns:

  • (String)


2739
2740
2741
2742
2743
2744
2745
2746
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2739

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

#notification_channelTypes::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.



2739
2740
2741
2742
2743
2744
2745
2746
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2739

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

#videoTypes::Video

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

Returns:



2739
2740
2741
2742
2743
2744
2745
2746
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2739

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