Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . rekognition ]

start-face-detection

Description

Starts asynchronous detection of faces in a stored video.

Rekognition video can detect faces in a video stored in an Amazon S3 bucket. Use video to specify the bucket name and the filename of the video. start-face-detection returns a job identifier (JobId ) that you use to get the results of the operation. When face detection is finished, Rekognition video publishes a completion status to the Amazon Simple Notification Service topic that you specify in notification-channel . To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED . If so, call and pass the job identifier (JobId ) from the initial call to start-face-detection . For more information, see faces-video .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  start-face-detection
--video <value>
[--client-request-token <value>]
[--notification-channel <value>]
[--face-attributes <value>]
[--job-tag <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--video (structure)

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

Shorthand Syntax:

S3Object={Bucket=string,Name=string,Version=string}

JSON Syntax:

{
  "S3Object": {
    "Bucket": "string",
    "Name": "string",
    "Version": "string"
  }
}

--client-request-token (string)

Idempotent token used to identify the start request. If you use the same token with multiple start-face-detection requests, the same JobId is returned. Use client-request-token to prevent the same job from being accidently started more than once.

--notification-channel (structure)

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

Shorthand Syntax:

SNSTopicArn=string,RoleArn=string

JSON Syntax:

{
  "SNSTopicArn": "string",
  "RoleArn": "string"
}

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

Possible values:

  • DEFAULT
  • ALL

--job-tag (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

JobId -> (string)

The identifier for the face detection job. Use JobId to identify the job in a subsequent call to get-face-detection .