amazonka-rekognition-1.6.0: 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.StartFaceDetection

Contents

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

Synopsis

Creating a Request

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 #

See: startFaceDetection smart constructor.

Instances

Eq StartFaceDetection # 
Data 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 # 
Show StartFaceDetection # 
Generic StartFaceDetection # 
Hashable StartFaceDetection # 
ToJSON StartFaceDetection # 
NFData StartFaceDetection # 

Methods

rnf :: StartFaceDetection -> () #

AWSRequest StartFaceDetection # 
ToHeaders StartFaceDetection # 
ToPath StartFaceDetection # 
ToQuery StartFaceDetection # 
type Rep StartFaceDetection # 
type Rep StartFaceDetection = D1 * (MetaData "StartFaceDetection" "Network.AWS.Rekognition.StartFaceDetection" "amazonka-rekognition-1.6.0-4TmAlrIlJHI1iGSYhkZbGT" False) (C1 * (MetaCons "StartFaceDetection'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_sfdJobTag") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_sfdNotificationChannel") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe NotificationChannel)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sfdClientRequestToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sfdFaceAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe FaceAttributes))) (S1 * (MetaSel (Just Symbol "_sfdVideo") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Video))))))
type Rs StartFaceDetection # 

Request Lenses

sfdJobTag :: Lens' StartFaceDetection (Maybe Text) #

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

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

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

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 #

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

Destructuring the Response

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 #

See: startFaceDetectionResponse smart constructor.

Instances

Eq StartFaceDetectionResponse # 
Data StartFaceDetectionResponse # 

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 # 
Show StartFaceDetectionResponse # 
Generic StartFaceDetectionResponse # 
NFData StartFaceDetectionResponse # 
type Rep StartFaceDetectionResponse # 
type Rep StartFaceDetectionResponse = D1 * (MetaData "StartFaceDetectionResponse" "Network.AWS.Rekognition.StartFaceDetection" "amazonka-rekognition-1.6.0-4TmAlrIlJHI1iGSYhkZbGT" False) (C1 * (MetaCons "StartFaceDetectionResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_sfdrsJobId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_sfdrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

sfdrsJobId :: Lens' StartFaceDetectionResponse (Maybe Text) #

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

sfdrsResponseStatus :: Lens' StartFaceDetectionResponse Int #

  • - | The response status code.