Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Rekognition.GetContentModeration

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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 moderating content in the Amazon Rekognition Developer Guide.

Synopsis

Creating a Request

data GetContentModeration Source #

See: newGetContentModeration smart constructor.

Constructors

GetContentModeration'

Fields

maxResults :: Maybe Natural
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.
nextToken :: Maybe Text
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.
sortBy :: Maybe ContentModerationSortBy
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.
jobId :: Text
The identifier for the inappropriate, unwanted, or offensive content moderation job. Use JobId to identify the job in a subsequent call to GetContentModeration.

Instances

Instances details

ToJSON GetContentModeration Source #
Instance details Defined in Amazonka.Rekognition.GetContentModeration Methods toJSON :: GetContentModeration -> Value # toEncoding :: GetContentModeration -> Encoding # toJSONList :: [GetContentModeration] -> Value # toEncodingList :: [GetContentModeration] -> Encoding #
ToHeaders GetContentModeration Source #
Instance details Defined in Amazonka.Rekognition.GetContentModeration Methods toHeaders :: GetContentModeration -> [Header] #
ToPath GetContentModeration Source #
Instance details Defined in Amazonka.Rekognition.GetContentModeration Methods toPath :: GetContentModeration -> ByteString #
ToQuery GetContentModeration Source #
Instance details Defined in Amazonka.Rekognition.GetContentModeration Methods toQuery :: GetContentModeration -> QueryString #
AWSRequest GetContentModeration Source #
Instance details Defined in Amazonka.Rekognition.GetContentModeration Associated Types type AWSResponse GetContentModeration # Methods request :: (Service -> Service) -> GetContentModeration -> Request GetContentModeration # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetContentModeration -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetContentModeration))) #
Generic GetContentModeration Source #
Instance details Defined in Amazonka.Rekognition.GetContentModeration Associated Types type Rep GetContentModeration :: Type -> Type # Methods from :: GetContentModeration -> Rep GetContentModeration x # to :: Rep GetContentModeration x -> GetContentModeration #
Read GetContentModeration Source #
Instance details Defined in Amazonka.Rekognition.GetContentModeration Methods readsPrec :: Int -> ReadS GetContentModeration # readList :: ReadS [GetContentModeration] # readPrec :: ReadPrec GetContentModeration # readListPrec :: ReadPrec [GetContentModeration] #
Show GetContentModeration Source #
Instance details Defined in Amazonka.Rekognition.GetContentModeration Methods showsPrec :: Int -> GetContentModeration -> ShowS # show :: GetContentModeration -> String # showList :: [GetContentModeration] -> ShowS #
NFData GetContentModeration Source #
Instance details Defined in Amazonka.Rekognition.GetContentModeration Methods rnf :: GetContentModeration -> () #
Eq GetContentModeration Source #
Instance details Defined in Amazonka.Rekognition.GetContentModeration Methods (==) :: GetContentModeration -> GetContentModeration -> Bool # (/=) :: GetContentModeration -> GetContentModeration -> Bool #
Hashable GetContentModeration Source #
Instance details Defined in Amazonka.Rekognition.GetContentModeration Methods hashWithSalt :: Int -> GetContentModeration -> Int # hash :: GetContentModeration -> Int #
type AWSResponse GetContentModeration Source #
Instance details Defined in Amazonka.Rekognition.GetContentModeration type AWSResponse GetContentModeration = GetContentModerationResponse
type Rep GetContentModeration Source #
Instance details Defined in Amazonka.Rekognition.GetContentModeration type Rep GetContentModeration = D1 ('MetaData "GetContentModeration" "Amazonka.Rekognition.GetContentModeration" "amazonka-rekognition-2.0-EaCrS9R3rWADqefEZvOx5B" 'False) (C1 ('MetaCons "GetContentModeration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContentModerationSortBy)) :*: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetContentModeration Source #

Arguments

:: Text	`$sel:jobId:GetContentModeration'`
-> 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: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.

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: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_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_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_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

jobStatus :: Maybe VideoJobStatus
The current status of the content moderation analysis job.
moderationLabels :: Maybe [ContentModerationDetection]
The detected inappropriate, unwanted, or offensive content moderation labels and the time(s) they were detected.
moderationModelVersion :: Maybe Text
Version number of the moderation detection model that was used to detect inappropriate, unwanted, or offensive content.
nextToken :: Maybe Text
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.
statusMessage :: Maybe Text
If the job fails, StatusMessage provides a descriptive error message.
videoMetadata :: Maybe VideoMetadata
Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from GetContentModeration.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetContentModerationResponse Source #
Instance details Defined in Amazonka.Rekognition.GetContentModeration Associated Types type Rep GetContentModerationResponse :: Type -> Type # Methods from :: GetContentModerationResponse -> Rep GetContentModerationResponse x # to :: Rep GetContentModerationResponse x -> GetContentModerationResponse #
Read GetContentModerationResponse Source #
Instance details Defined in Amazonka.Rekognition.GetContentModeration Methods readsPrec :: Int -> ReadS GetContentModerationResponse # readList :: ReadS [GetContentModerationResponse] # readPrec :: ReadPrec GetContentModerationResponse # readListPrec :: ReadPrec [GetContentModerationResponse] #
Show GetContentModerationResponse Source #
Instance details Defined in Amazonka.Rekognition.GetContentModeration Methods showsPrec :: Int -> GetContentModerationResponse -> ShowS # show :: GetContentModerationResponse -> String # showList :: [GetContentModerationResponse] -> ShowS #
NFData GetContentModerationResponse Source #
Instance details Defined in Amazonka.Rekognition.GetContentModeration Methods rnf :: GetContentModerationResponse -> () #
Eq GetContentModerationResponse Source #
Instance details Defined in Amazonka.Rekognition.GetContentModeration Methods (==) :: GetContentModerationResponse -> GetContentModerationResponse -> Bool # (/=) :: GetContentModerationResponse -> GetContentModerationResponse -> Bool #
type Rep GetContentModerationResponse Source #
Instance details Defined in Amazonka.Rekognition.GetContentModeration type Rep GetContentModerationResponse = D1 ('MetaData "GetContentModerationResponse" "Amazonka.Rekognition.GetContentModeration" "amazonka-rekognition-2.0-EaCrS9R3rWADqefEZvOx5B" 'False) (C1 ('MetaCons "GetContentModerationResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VideoJobStatus)) :: (S1 ('MetaSel ('Just "moderationLabels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ContentModerationDetection])) :: S1 ('MetaSel ('Just "moderationModelVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "videoMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VideoMetadata)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetContentModerationResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetContentModerationResponse'`
-> GetContentModerationResponse

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:jobStatus:GetContentModerationResponse', getContentModerationResponse_jobStatus - The current status of the content moderation analysis job.

$sel:moderationLabels:GetContentModerationResponse', getContentModerationResponse_moderationLabels - The detected inappropriate, unwanted, or offensive content moderation labels and the time(s) they were detected.

$sel:moderationModelVersion:GetContentModerationResponse', getContentModerationResponse_moderationModelVersion - Version number of the moderation detection model that was used to detect inappropriate, unwanted, or offensive content.

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.

GetContentModerationResponse, getContentModerationResponse_statusMessage - If the job fails, StatusMessage provides a descriptive error message.

$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:httpStatus:GetContentModerationResponse', getContentModerationResponse_httpStatus - The response's http status code.

Response Lenses

getContentModerationResponse_jobStatus :: Lens' GetContentModerationResponse (Maybe VideoJobStatus) Source #

The current status of the content moderation analysis job.

getContentModerationResponse_moderationLabels :: Lens' GetContentModerationResponse (Maybe [ContentModerationDetection]) Source #

The detected inappropriate, unwanted, or offensive content moderation labels and the time(s) they were detected.

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_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_statusMessage :: Lens' GetContentModerationResponse (Maybe Text) Source #

If the job fails, StatusMessage provides a descriptive error message.

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_httpStatus :: Lens' GetContentModerationResponse Int Source #

The response's http status code.