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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb

Overview

Note:

When making an API call, you may pass StartLabelDetectionRequest data as a 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_tokenString

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)


2885
2886
2887
2888
2889
2890
2891
2892
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2885

class StartLabelDetectionRequest < Struct.new(
  :video,
  :client_request_token,
  :min_confidence,
  :notification_channel,
  :job_tag)
  include Aws::Structure
end

#job_tagString

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

Returns:

  • (String)


2885
2886
2887
2888
2889
2890
2891
2892
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2885

class StartLabelDetectionRequest < Struct.new(
  :video,
  :client_request_token,
  :min_confidence,
  :notification_channel,
  :job_tag)
  include Aws::Structure
end

#min_confidenceFloat

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)


2885
2886
2887
2888
2889
2890
2891
2892
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2885

class StartLabelDetectionRequest < Struct.new(
  :video,
  :client_request_token,
  :min_confidence,
  :notification_channel,
  :job_tag)
  include Aws::Structure
end

#notification_channelTypes::NotificationChannel

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



2885
2886
2887
2888
2889
2890
2891
2892
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2885

class StartLabelDetectionRequest < Struct.new(
  :video,
  :client_request_token,
  :min_confidence,
  :notification_channel,
  :job_tag)
  include Aws::Structure
end

#videoTypes::Video

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

Returns:



2885
2886
2887
2888
2889
2890
2891
2892
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2885

class StartLabelDetectionRequest < Struct.new(
  :video,
  :client_request_token,
  :min_confidence,
  :notification_channel,
  :job_tag)
  include Aws::Structure
end