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

Class: Aws::Rekognition::Types::StartContentModerationRequest

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 StartContentModerationRequest data as a hash:

{
  video: { # required
    s3_object: {
      bucket: "S3Bucket",
      name: "S3ObjectName",
      version: "S3ObjectVersion",
    },
  },
  min_confidence: 1.0,
  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 StartContentModeration requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

Returns:

  • (String)


2668
2669
2670
2671
2672
2673
2674
2675
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2668

class StartContentModerationRequest < Struct.new(
  :video,
  :min_confidence,
  :client_request_token,
  :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)


2668
2669
2670
2671
2672
2673
2674
2675
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2668

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

#min_confidenceFloat

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

Returns:

  • (Float)


2668
2669
2670
2671
2672
2673
2674
2675
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2668

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

#notification_channelTypes::NotificationChannel

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



2668
2669
2670
2671
2672
2673
2674
2675
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2668

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

#videoTypes::Video

The video in which you want to moderate content. The video must be stored in an Amazon S3 bucket.

Returns:



2668
2669
2670
2671
2672
2673
2674
2675
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2668

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