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::StartCelebrityRecognitionRequest

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

Overview

Note:

When passing StartCelebrityRecognitionRequest 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
  },
  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 StartCelebrityRecognition 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.

#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 Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the celebrity recognition analysis to.

Returns:

  • (Types::NotificationChannel)

    The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the celebrity recognition analysis to.

#videoTypes::Video

The video in which you want to recognize celebrities. The video must be stored in an Amazon S3 bucket.

Returns:

  • (Types::Video)

    The video in which you want to recognize celebrities.