AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing StartFaceDetectionRequest as input to an Aws::Client method, you can use a vanilla 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)

    Idempotent token used to identify the start request.

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

Possible values:

  • DEFAULT
  • ALL

Returns:

  • (String)

    The face attributes you want returned.

#job_tagString

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)

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

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

Returns:

  • (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.

#videoTypes::Video

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

Returns:

  • (Types::Video)

    The video in which you want to detect faces.