Start Content Moderation
rekognition_start_content_moderation | R Documentation |
Starts asynchronous detection of inappropriate, unwanted, or offensive content in a stored video¶
Description¶
Starts asynchronous detection of inappropriate, unwanted, or offensive content in a stored video. For a list of moderation labels in Amazon Rekognition, see Using the image and video moderation APIs.
Amazon Rekognition Video can moderate content in a video stored in an
Amazon S3 bucket. Use Video to specify the bucket name and the filename
of the video. start_content_moderation
returns a job identifier
(JobId
) which you use to get the results of the analysis. When content
analysis is finished, Amazon Rekognition Video publishes a completion
status to the Amazon Simple Notification Service topic that you specify
in NotificationChannel
.
To get the results of the content analysis, first check that the status
value published to the Amazon SNS topic is SUCCEEDED
. If so, call
get_content_moderation
and pass the job identifier (JobId
) from the
initial call to start_content_moderation
.
For more information, see Moderating content in the Amazon Rekognition Developer Guide.
Usage¶
rekognition_start_content_moderation(Video, MinConfidence,
ClientRequestToken, NotificationChannel, JobTag)
Arguments¶
Video
[required] The video in which you want to detect inappropriate, unwanted, or offensive content. The video must be stored in an Amazon S3 bucket.
MinConfidence
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. If you don't specify
MinConfidence
,get_content_moderation
returns labels with confidence values greater than or equal to 50 percent.ClientRequestToken
Idempotent token used to identify the start request. If you use the same token with multiple
start_content_moderation
requests, the sameJobId
is returned. UseClientRequestToken
to prevent the same job from being accidently started more than once.NotificationChannel
The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the content analysis to. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.
JobTag
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.
Value¶
A list with the following syntax: