GetContentModeration
Gets the inappropriate, unwanted, or offensive content analysis results for a Amazon Rekognition Video analysis started by StartContentModeration. For a list of moderation labels in Amazon Rekognition, see Using the image and video moderation APIs.
Amazon Rekognition Video inappropriate or offensive content detection in a stored video is an asynchronous operation. You start analysis by calling
StartContentModeration which returns a job identifier (JobId
).
When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service
topic registered in the initial call to StartContentModeration
.
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 GetContentModeration
and pass the job identifier
(JobId
) from the initial call to StartContentModeration
.
For more information, see Working with stored videos.
GetContentModeration
returns detected inappropriate, unwanted, or offensive content moderation labels,
and the time they are detected, in an array, ModerationLabels
, of
ContentModerationDetection objects.
By default, the moderated labels are returned sorted by time, in milliseconds from the start of the
video. You can also sort them by moderated label by specifying NAME
for the SortBy
input parameter.
Since video analysis can return a large number of results, use the MaxResults
parameter to limit
the number of labels returned in a single call to GetContentModeration
. If there are more results than
specified in MaxResults
, the value of NextToken
in the operation response contains a
pagination token for getting the next set of results. To get the next page of results, call GetContentModeration
and populate the NextToken
request parameter with the value of NextToken
returned from the previous call to GetContentModeration
.
For more information, see Moderating content.
Request Syntax
{
"AggregateBy": "string
",
"JobId": "string
",
"MaxResults": number
,
"NextToken": "string
",
"SortBy": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- AggregateBy
-
Defines how to aggregate results of the StartContentModeration request. Default aggregation option is TIMESTAMPS. SEGMENTS mode aggregates moderation labels over time.
Type: String
Valid Values:
TIMESTAMPS | SEGMENTS
Required: No
- JobId
-
The identifier for the inappropriate, unwanted, or offensive content moderation job. Use
JobId
to identify the job in a subsequent call toGetContentModeration
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9-_]+$
Required: Yes
- MaxResults
-
Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
- NextToken
-
If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of content moderation labels.
Type: String
Length Constraints: Maximum length of 255.
Required: No
- SortBy
-
Sort to use for elements in the
ModerationLabelDetections
array. UseTIMESTAMP
to sort array elements by the time labels are detected. UseNAME
to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is byTIMESTAMP
.Type: String
Valid Values:
NAME | TIMESTAMP
Required: No
Response Syntax
{
"GetRequestMetadata": {
"AggregateBy": "string",
"SortBy": "string"
},
"JobId": "string",
"JobStatus": "string",
"JobTag": "string",
"ModerationLabels": [
{
"ContentTypes": [
{
"Confidence": number,
"Name": "string"
}
],
"DurationMillis": number,
"EndTimestampMillis": number,
"ModerationLabel": {
"Confidence": number,
"Name": "string",
"ParentName": "string",
"TaxonomyLevel": number
},
"StartTimestampMillis": number,
"Timestamp": number
}
],
"ModerationModelVersion": "string",
"NextToken": "string",
"StatusMessage": "string",
"Video": {
"S3Object": {
"Bucket": "string",
"Name": "string",
"Version": "string"
}
},
"VideoMetadata": {
"Codec": "string",
"ColorRange": "string",
"DurationMillis": number,
"Format": "string",
"FrameHeight": number,
"FrameRate": number,
"FrameWidth": number
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- GetRequestMetadata
-
Information about the paramters used when getting a response. Includes information on aggregation and sorting methods.
Type: GetContentModerationRequestMetadata object
- JobId
-
Job identifier for the content moderation operation for which you want to obtain results. The job identifer is returned by an initial call to StartContentModeration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9-_]+$
- JobStatus
-
The current status of the content moderation analysis job.
Type: String
Valid Values:
IN_PROGRESS | SUCCEEDED | FAILED
- JobTag
-
A job identifier specified in the call to StartContentModeration and returned in the job completion notification sent to your Amazon Simple Notification Service topic.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[a-zA-Z0-9_.\-:+=\/]+
- ModerationLabels
-
The detected inappropriate, unwanted, or offensive content moderation labels and the time(s) they were detected.
Type: Array of ContentModerationDetection objects
- ModerationModelVersion
-
Version number of the moderation detection model that was used to detect inappropriate, unwanted, or offensive content.
Type: String
- NextToken
-
If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of content moderation labels.
Type: String
Length Constraints: Maximum length of 255.
- StatusMessage
-
If the job fails,
StatusMessage
provides a descriptive error message.Type: String
- Video
-
Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as StartLabelDetection use
Video
to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.Type: Video object
- VideoMetadata
-
Information about a video that Amazon Rekognition analyzed.
Videometadata
is returned in every page of paginated responses fromGetContentModeration
.Type: VideoMetadata object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You are not authorized to perform the action.
HTTP Status Code: 400
- InternalServerError
-
Amazon Rekognition experienced a service issue. Try your call again.
HTTP Status Code: 500
- InvalidPaginationTokenException
-
Pagination token in the request is not valid.
HTTP Status Code: 400
- InvalidParameterException
-
Input parameter violated a constraint. Validate your parameter before calling the API operation again.
HTTP Status Code: 400
- ProvisionedThroughputExceededException
-
The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.
HTTP Status Code: 400
- ResourceNotFoundException
-
The resource specified in the request cannot be found.
HTTP Status Code: 400
- ThrottlingException
-
Amazon Rekognition is temporarily unable to process the request. Try your call again.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: