Copyright	(c) 2013-2018 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
Language	Haskell2010

Network.AWS.Rekognition.StartContentModeration

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts asynchronous detection of explicit or suggestive adult content in a stored video.

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. StartContentModeration returns a job identifier (JobId ) which you use to get the results of the analysis. When content moderation analysis is finished, 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 moderation analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED . If so, call and pass the job identifier (JobId ) from the initial call to StartContentModeration . For more information, see moderation .

Creating a Request

startContentModeration #

Arguments

:: Video	`scmVideo`
-> StartContentModeration

Creates a value of StartContentModeration with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

scmJobTag - Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.
scmNotificationChannel - The Amazon SNS topic ARN that you want Rekognition Video to publish the completion status of the content moderation analysis to.
scmClientRequestToken - 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.
scmMinConfidence - 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.
scmVideo - The video in which you want to moderate content. The video must be stored in an Amazon S3 bucket.

data StartContentModeration #

See: startContentModeration smart constructor.

Instances

Eq StartContentModeration #
Instance details Defined in Network.AWS.Rekognition.StartContentModeration Methods (==) :: StartContentModeration -> StartContentModeration -> Bool # (/=) :: StartContentModeration -> StartContentModeration -> Bool #
Data StartContentModeration #
Instance details Defined in Network.AWS.Rekognition.StartContentModeration Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StartContentModeration -> c StartContentModeration # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StartContentModeration # toConstr :: StartContentModeration -> Constr # dataTypeOf :: StartContentModeration -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c StartContentModeration) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StartContentModeration) # gmapT :: (forall b. Data b => b -> b) -> StartContentModeration -> StartContentModeration # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StartContentModeration -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StartContentModeration -> r # gmapQ :: (forall d. Data d => d -> u) -> StartContentModeration -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> StartContentModeration -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> StartContentModeration -> m StartContentModeration # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StartContentModeration -> m StartContentModeration # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StartContentModeration -> m StartContentModeration #
Read StartContentModeration #
Instance details Defined in Network.AWS.Rekognition.StartContentModeration Methods readsPrec :: Int -> ReadS StartContentModeration # readList :: ReadS [StartContentModeration] # readPrec :: ReadPrec StartContentModeration # readListPrec :: ReadPrec [StartContentModeration] #
Show StartContentModeration #
Instance details Defined in Network.AWS.Rekognition.StartContentModeration Methods showsPrec :: Int -> StartContentModeration -> ShowS # show :: StartContentModeration -> String # showList :: [StartContentModeration] -> ShowS #
Generic StartContentModeration #
Instance details Defined in Network.AWS.Rekognition.StartContentModeration Associated Types type Rep StartContentModeration :: Type -> Type # Methods from :: StartContentModeration -> Rep StartContentModeration x # to :: Rep StartContentModeration x -> StartContentModeration #
Hashable StartContentModeration #
Instance details Defined in Network.AWS.Rekognition.StartContentModeration Methods hashWithSalt :: Int -> StartContentModeration -> Int # hash :: StartContentModeration -> Int #
ToJSON StartContentModeration #
Instance details Defined in Network.AWS.Rekognition.StartContentModeration Methods toJSON :: StartContentModeration -> Value # toEncoding :: StartContentModeration -> Encoding # toJSONList :: [StartContentModeration] -> Value # toEncodingList :: [StartContentModeration] -> Encoding #
AWSRequest StartContentModeration #
Instance details Defined in Network.AWS.Rekognition.StartContentModeration Associated Types type Rs StartContentModeration :: Type # Methods request :: StartContentModeration -> Request StartContentModeration # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy StartContentModeration -> ClientResponse -> m (Response StartContentModeration) #
ToHeaders StartContentModeration #
Instance details Defined in Network.AWS.Rekognition.StartContentModeration Methods toHeaders :: StartContentModeration -> [Header] #
ToPath StartContentModeration #
Instance details Defined in Network.AWS.Rekognition.StartContentModeration Methods toPath :: StartContentModeration -> ByteString #
ToQuery StartContentModeration #
Instance details Defined in Network.AWS.Rekognition.StartContentModeration Methods toQuery :: StartContentModeration -> QueryString #
NFData StartContentModeration #
Instance details Defined in Network.AWS.Rekognition.StartContentModeration Methods rnf :: StartContentModeration -> () #
type Rep StartContentModeration #
Instance details Defined in Network.AWS.Rekognition.StartContentModeration type Rep StartContentModeration = D1 (MetaData "StartContentModeration" "Network.AWS.Rekognition.StartContentModeration" "amazonka-rekognition-1.6.1-LJYoSuoGbtd78kiYOWkJFK" False) (C1 (MetaCons "StartContentModeration'" PrefixI True) ((S1 (MetaSel (Just "_scmJobTag") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_scmNotificationChannel") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe NotificationChannel))) :: (S1 (MetaSel (Just "_scmClientRequestToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_scmMinConfidence") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Double)) :: S1 (MetaSel (Just "_scmVideo") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Video)))))
type Rs StartContentModeration #
Instance details Defined in Network.AWS.Rekognition.StartContentModeration type Rs StartContentModeration = StartContentModerationResponse

Request Lenses

scmJobTag :: Lens' StartContentModeration (Maybe Text) #

Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.

scmNotificationChannel :: Lens' StartContentModeration (Maybe NotificationChannel) #

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

scmClientRequestToken :: Lens' StartContentModeration (Maybe Text) #

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.

scmMinConfidence :: Lens' StartContentModeration (Maybe Double) #

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.

scmVideo :: Lens' StartContentModeration Video #

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

Destructuring the Response

startContentModerationResponse #

Arguments

:: Int	`scmrsResponseStatus`
-> StartContentModerationResponse

Creates a value of StartContentModerationResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

scmrsJobId - The identifier for the content moderation analysis job. Use JobId to identify the job in a subsequent call to GetContentModeration .
scmrsResponseStatus - -- | The response status code.

data StartContentModerationResponse #

See: startContentModerationResponse smart constructor.

Instances

Eq StartContentModerationResponse #
Instance details Defined in Network.AWS.Rekognition.StartContentModeration Methods (==) :: StartContentModerationResponse -> StartContentModerationResponse -> Bool # (/=) :: StartContentModerationResponse -> StartContentModerationResponse -> Bool #
Data StartContentModerationResponse #
Instance details Defined in Network.AWS.Rekognition.StartContentModeration Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StartContentModerationResponse -> c StartContentModerationResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StartContentModerationResponse # toConstr :: StartContentModerationResponse -> Constr # dataTypeOf :: StartContentModerationResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c StartContentModerationResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StartContentModerationResponse) # gmapT :: (forall b. Data b => b -> b) -> StartContentModerationResponse -> StartContentModerationResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StartContentModerationResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StartContentModerationResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> StartContentModerationResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> StartContentModerationResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> StartContentModerationResponse -> m StartContentModerationResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StartContentModerationResponse -> m StartContentModerationResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StartContentModerationResponse -> m StartContentModerationResponse #
Read StartContentModerationResponse #
Instance details Defined in Network.AWS.Rekognition.StartContentModeration Methods readsPrec :: Int -> ReadS StartContentModerationResponse # readList :: ReadS [StartContentModerationResponse] # readPrec :: ReadPrec StartContentModerationResponse # readListPrec :: ReadPrec [StartContentModerationResponse] #
Show StartContentModerationResponse #
Instance details Defined in Network.AWS.Rekognition.StartContentModeration Methods showsPrec :: Int -> StartContentModerationResponse -> ShowS # show :: StartContentModerationResponse -> String # showList :: [StartContentModerationResponse] -> ShowS #
Generic StartContentModerationResponse #
Instance details Defined in Network.AWS.Rekognition.StartContentModeration Associated Types type Rep StartContentModerationResponse :: Type -> Type # Methods from :: StartContentModerationResponse -> Rep StartContentModerationResponse x # to :: Rep StartContentModerationResponse x -> StartContentModerationResponse #
NFData StartContentModerationResponse #
Instance details Defined in Network.AWS.Rekognition.StartContentModeration Methods rnf :: StartContentModerationResponse -> () #
type Rep StartContentModerationResponse #
Instance details Defined in Network.AWS.Rekognition.StartContentModeration type Rep StartContentModerationResponse = D1 (MetaData "StartContentModerationResponse" "Network.AWS.Rekognition.StartContentModeration" "amazonka-rekognition-1.6.1-LJYoSuoGbtd78kiYOWkJFK" False) (C1 (MetaCons "StartContentModerationResponse'" PrefixI True) (S1 (MetaSel (Just "_scmrsJobId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_scmrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

scmrsJobId :: Lens' StartContentModerationResponse (Maybe Text) #

The identifier for the content moderation analysis job. Use JobId to identify the job in a subsequent call to GetContentModeration .

scmrsResponseStatus :: Lens' StartContentModerationResponse Int #

- | The response status code.