amazonka-rekognition-1.6.1: Amazon Rekognition SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Rekognition.StartContentModeration

Contents

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 .

Synopsis

Creating a Request

startContentModeration Source #

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 Source #

See: startContentModeration smart constructor.

Instances
Eq StartContentModeration Source # 
Instance details

Defined in Network.AWS.Rekognition.StartContentModeration

Data StartContentModeration Source # 
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 Source # 
Instance details

Defined in Network.AWS.Rekognition.StartContentModeration

Show StartContentModeration Source # 
Instance details

Defined in Network.AWS.Rekognition.StartContentModeration

Generic StartContentModeration Source # 
Instance details

Defined in Network.AWS.Rekognition.StartContentModeration

Associated Types

type Rep StartContentModeration :: Type -> Type #

Hashable StartContentModeration Source # 
Instance details

Defined in Network.AWS.Rekognition.StartContentModeration

ToJSON StartContentModeration Source # 
Instance details

Defined in Network.AWS.Rekognition.StartContentModeration

AWSRequest StartContentModeration Source # 
Instance details

Defined in Network.AWS.Rekognition.StartContentModeration

Associated Types

type Rs StartContentModeration :: Type #

ToHeaders StartContentModeration Source # 
Instance details

Defined in Network.AWS.Rekognition.StartContentModeration

ToPath StartContentModeration Source # 
Instance details

Defined in Network.AWS.Rekognition.StartContentModeration

ToQuery StartContentModeration Source # 
Instance details

Defined in Network.AWS.Rekognition.StartContentModeration

NFData StartContentModeration Source # 
Instance details

Defined in Network.AWS.Rekognition.StartContentModeration

Methods

rnf :: StartContentModeration -> () #

type Rep StartContentModeration Source # 
Instance details

Defined in Network.AWS.Rekognition.StartContentModeration

type Rep StartContentModeration = D1 (MetaData "StartContentModeration" "Network.AWS.Rekognition.StartContentModeration" "amazonka-rekognition-1.6.1-ELwOF0LSGWFp8S3Ef6QMe" 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 Source # 
Instance details

Defined in Network.AWS.Rekognition.StartContentModeration

Request Lenses

scmJobTag :: Lens' StartContentModeration (Maybe Text) Source #

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) Source #

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) Source #

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) Source #

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 Source #

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

Destructuring the Response

startContentModerationResponse Source #

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 Source #

See: startContentModerationResponse smart constructor.

Instances
Eq StartContentModerationResponse Source # 
Instance details

Defined in Network.AWS.Rekognition.StartContentModeration

Data StartContentModerationResponse Source # 
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 Source # 
Instance details

Defined in Network.AWS.Rekognition.StartContentModeration

Show StartContentModerationResponse Source # 
Instance details

Defined in Network.AWS.Rekognition.StartContentModeration

Generic StartContentModerationResponse Source # 
Instance details

Defined in Network.AWS.Rekognition.StartContentModeration

Associated Types

type Rep StartContentModerationResponse :: Type -> Type #

NFData StartContentModerationResponse Source # 
Instance details

Defined in Network.AWS.Rekognition.StartContentModeration

type Rep StartContentModerationResponse Source # 
Instance details

Defined in Network.AWS.Rekognition.StartContentModeration

type Rep StartContentModerationResponse = D1 (MetaData "StartContentModerationResponse" "Network.AWS.Rekognition.StartContentModeration" "amazonka-rekognition-1.6.1-ELwOF0LSGWFp8S3Ef6QMe" 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) Source #

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