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

Inherits:

Struct

• Object
• Struct
• Aws::Rekognition::Types::StartLabelDetectionRequest

Includes:

Structure

Defined in:

lib/aws-sdk-rekognition/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_request_token ⇒ String

  Idempotent token used to identify the start request.

• #features ⇒ Array<String>

  The features to return after video analysis.

• #job_tag ⇒ 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.

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

• #settings ⇒ Types::LabelDetectionSettings

  The settings for a StartLabelDetection request.Contains the specified parameters for the label detection request of an asynchronous label analysis operation.

• #video ⇒ Types::Video

  The video in which you want to detect labels.

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)

# File 'lib/aws-sdk-rekognition/types.rb', line 7098

class StartLabelDetectionRequest < Struct.new(
  :video,
  :client_request_token,
  :min_confidence,
  :notification_channel,
  :job_tag,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#features ⇒ Array<String>

The features to return after video analysis. You can specify that GENERAL_LABELS are returned.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-rekognition/types.rb', line 7098

class StartLabelDetectionRequest < Struct.new(
  :video,
  :client_request_token,
  :min_confidence,
  :notification_channel,
  :job_tag,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'lib/aws-sdk-rekognition/types.rb', line 7098

class StartLabelDetectionRequest < Struct.new(
  :video,
  :client_request_token,
  :min_confidence,
  :notification_channel,
  :job_tag,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#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 and bounding boxes (if detected) with confidence values greater than or equal to 50 percent.

Returns:

• (Float)

# File 'lib/aws-sdk-rekognition/types.rb', line 7098

class StartLabelDetectionRequest < Struct.new(
  :video,
  :client_request_token,
  :min_confidence,
  :notification_channel,
  :job_tag,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#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. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.

Returns:

• (Types::NotificationChannel)

# File 'lib/aws-sdk-rekognition/types.rb', line 7098

class StartLabelDetectionRequest < Struct.new(
  :video,
  :client_request_token,
  :min_confidence,
  :notification_channel,
  :job_tag,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#settings ⇒ Types::LabelDetectionSettings

The settings for a StartLabelDetection request.Contains the specified parameters for the label detection request of an asynchronous label analysis operation. Settings can include filters for GENERAL_LABELS.

Returns:

• (Types::LabelDetectionSettings)

# File 'lib/aws-sdk-rekognition/types.rb', line 7098

class StartLabelDetectionRequest < Struct.new(
  :video,
  :client_request_token,
  :min_confidence,
  :notification_channel,
  :job_tag,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'lib/aws-sdk-rekognition/types.rb', line 7098

class StartLabelDetectionRequest < Struct.new(
  :video,
  :client_request_token,
  :min_confidence,
  :notification_channel,
  :job_tag,
  :features,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end