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.StartFaceDetection

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts asynchronous detection of faces in a stored video.

Rekognition Video can detect faces in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceDetection returns a job identifier (JobId ) that you use to get the results of the operation. When face detection 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 label detection operation, 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 StartFaceDetection . For more information, see 'faces-video' .

Creating a Request

startFaceDetection Source #

Arguments

:: Video	`sfdVideo`
-> StartFaceDetection

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

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

sfdJobTag - Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.
sfdNotificationChannel - The ARN of the Amazon SNS topic to which you want Rekognition Video to publish the completion status of the face detection operation.
sfdClientRequestToken - Idempotent token used to identify the start request. If you use the same token with multiple StartFaceDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.
sfdFaceAttributes - The face attributes you want returned. DEFAULT - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks. ALL - All facial attributes are returned.
sfdVideo - The video in which you want to detect faces. The video must be stored in an Amazon S3 bucket.

data StartFaceDetection Source #

See: startFaceDetection smart constructor.

Instances

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

Request Lenses

sfdJobTag :: Lens' StartFaceDetection (Maybe Text) Source #

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

sfdNotificationChannel :: Lens' StartFaceDetection (Maybe NotificationChannel) Source #

The ARN of the Amazon SNS topic to which you want Rekognition Video to publish the completion status of the face detection operation.

sfdClientRequestToken :: Lens' StartFaceDetection (Maybe Text) Source #

Idempotent token used to identify the start request. If you use the same token with multiple StartFaceDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

sfdFaceAttributes :: Lens' StartFaceDetection (Maybe FaceAttributes) Source #

The face attributes you want returned. DEFAULT - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks. ALL - All facial attributes are returned.

sfdVideo :: Lens' StartFaceDetection Video Source #

The video in which you want to detect faces. The video must be stored in an Amazon S3 bucket.

Destructuring the Response

startFaceDetectionResponse Source #

Arguments

:: Int	`sfdrsResponseStatus`
-> StartFaceDetectionResponse

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

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

sfdrsJobId - The identifier for the face detection job. Use JobId to identify the job in a subsequent call to GetFaceDetection .
sfdrsResponseStatus - -- | The response status code.

data StartFaceDetectionResponse Source #

See: startFaceDetectionResponse smart constructor.

Instances

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

Response Lenses

sfdrsJobId :: Lens' StartFaceDetectionResponse (Maybe Text) Source #

The identifier for the face detection job. Use JobId to identify the job in a subsequent call to GetFaceDetection .

sfdrsResponseStatus :: Lens' StartFaceDetectionResponse Int Source #

- | The response status code.