| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Rekognition.GetContentModeration
Description
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 in the Amazon Rekognition Devlopers Guide.
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 Content moderation in the Amazon Rekognition Developer Guide.
Synopsis
- data GetContentModeration = GetContentModeration' {}
- newGetContentModeration :: Text -> GetContentModeration
- getContentModeration_nextToken :: Lens' GetContentModeration (Maybe Text)
- getContentModeration_maxResults :: Lens' GetContentModeration (Maybe Natural)
- getContentModeration_sortBy :: Lens' GetContentModeration (Maybe ContentModerationSortBy)
- getContentModeration_jobId :: Lens' GetContentModeration Text
- data GetContentModerationResponse = GetContentModerationResponse' {}
- newGetContentModerationResponse :: Int -> GetContentModerationResponse
- getContentModerationResponse_nextToken :: Lens' GetContentModerationResponse (Maybe Text)
- getContentModerationResponse_videoMetadata :: Lens' GetContentModerationResponse (Maybe VideoMetadata)
- getContentModerationResponse_statusMessage :: Lens' GetContentModerationResponse (Maybe Text)
- getContentModerationResponse_jobStatus :: Lens' GetContentModerationResponse (Maybe VideoJobStatus)
- getContentModerationResponse_moderationModelVersion :: Lens' GetContentModerationResponse (Maybe Text)
- getContentModerationResponse_moderationLabels :: Lens' GetContentModerationResponse (Maybe [ContentModerationDetection])
- getContentModerationResponse_httpStatus :: Lens' GetContentModerationResponse Int
Creating a Request
data GetContentModeration Source #
See: newGetContentModeration smart constructor.
Constructors
| GetContentModeration' | |
Fields
| |
Instances
newGetContentModeration Source #
Arguments
| :: Text | |
| -> GetContentModeration |
Create a value of GetContentModeration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:GetContentModeration', getContentModeration_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.
$sel:maxResults:GetContentModeration', getContentModeration_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.
$sel:sortBy:GetContentModeration', getContentModeration_sortBy - Sort to use for elements in the ModerationLabelDetections array. Use
TIMESTAMP to sort array elements by the time labels are detected. Use
NAME to alphabetically group elements for a label together. Within
each label group, the array element are sorted by detection confidence.
The default sort is by TIMESTAMP.
$sel:jobId:GetContentModeration', getContentModeration_jobId - The identifier for the inappropriate, unwanted, or offensive content
moderation job. Use JobId to identify the job in a subsequent call to
GetContentModeration.
Request Lenses
getContentModeration_nextToken :: Lens' GetContentModeration (Maybe Text) Source #
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.
getContentModeration_maxResults :: Lens' GetContentModeration (Maybe Natural) Source #
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.
getContentModeration_sortBy :: Lens' GetContentModeration (Maybe ContentModerationSortBy) Source #
Sort to use for elements in the ModerationLabelDetections array. Use
TIMESTAMP to sort array elements by the time labels are detected. Use
NAME to alphabetically group elements for a label together. Within
each label group, the array element are sorted by detection confidence.
The default sort is by TIMESTAMP.
getContentModeration_jobId :: Lens' GetContentModeration Text Source #
The identifier for the inappropriate, unwanted, or offensive content
moderation job. Use JobId to identify the job in a subsequent call to
GetContentModeration.
Destructuring the Response
data GetContentModerationResponse Source #
See: newGetContentModerationResponse smart constructor.
Constructors
| GetContentModerationResponse' | |
Fields
| |
Instances
newGetContentModerationResponse Source #
Create a value of GetContentModerationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:GetContentModeration', getContentModerationResponse_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.
$sel:videoMetadata:GetContentModerationResponse', getContentModerationResponse_videoMetadata - Information about a video that Amazon Rekognition analyzed.
Videometadata is returned in every page of paginated responses from
GetContentModeration.
$sel:statusMessage:GetContentModerationResponse', getContentModerationResponse_statusMessage - If the job fails, StatusMessage provides a descriptive error message.
$sel:jobStatus:GetContentModerationResponse', getContentModerationResponse_jobStatus - The current status of the content moderation analysis job.
$sel:moderationModelVersion:GetContentModerationResponse', getContentModerationResponse_moderationModelVersion - Version number of the moderation detection model that was used to detect
inappropriate, unwanted, or offensive content.
$sel:moderationLabels:GetContentModerationResponse', getContentModerationResponse_moderationLabels - The detected inappropriate, unwanted, or offensive content moderation
labels and the time(s) they were detected.
$sel:httpStatus:GetContentModerationResponse', getContentModerationResponse_httpStatus - The response's http status code.
Response Lenses
getContentModerationResponse_nextToken :: Lens' GetContentModerationResponse (Maybe Text) Source #
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.
getContentModerationResponse_videoMetadata :: Lens' GetContentModerationResponse (Maybe VideoMetadata) Source #
Information about a video that Amazon Rekognition analyzed.
Videometadata is returned in every page of paginated responses from
GetContentModeration.
getContentModerationResponse_statusMessage :: Lens' GetContentModerationResponse (Maybe Text) Source #
If the job fails, StatusMessage provides a descriptive error message.
getContentModerationResponse_jobStatus :: Lens' GetContentModerationResponse (Maybe VideoJobStatus) Source #
The current status of the content moderation analysis job.
getContentModerationResponse_moderationModelVersion :: Lens' GetContentModerationResponse (Maybe Text) Source #
Version number of the moderation detection model that was used to detect inappropriate, unwanted, or offensive content.
getContentModerationResponse_moderationLabels :: Lens' GetContentModerationResponse (Maybe [ContentModerationDetection]) Source #
The detected inappropriate, unwanted, or offensive content moderation labels and the time(s) they were detected.
getContentModerationResponse_httpStatus :: Lens' GetContentModerationResponse Int Source #
The response's http status code.