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

Class: Aws::Rekognition::Types::StartLabelDetectionRequest

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

Overview

Note:

When passing StartLabelDetectionRequest 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",
  min_confidence: 1.0,
  notification_channel: {
    sns_topic_arn: "SNSTopicArn", # required
    role_arn: "RoleArn", # required
  },
  job_tag: "JobTag",
}

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_token ⇒ String

Idempotent token used to identify the start request. If you use the same token with multiple StartLabelDetection 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_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) —

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

#min_confidence ⇒ Float

Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected label. Confidence represents how certain Amazon Rekognition is that a label is correctly identified.0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition Video doesn\'t return any labels with a confidence level lower than this specified value.

If you don\'t specify MinConfidence, the operation returns labels with confidence values greater than or equal to 50 percent.

Returns:

  • (Float) —

    Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected label.

#notification_channel ⇒ Types::NotificationChannel

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

Returns:

  • (Types::NotificationChannel) —

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

#video ⇒ Types::Video

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

Returns:

  • (Types::Video) —

    The video in which you want to detect labels.