Copyright	(c) 2013-2021 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

Amazonka.Rekognition.StartFaceDetection

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts asynchronous detection of faces in a stored video.

Amazon 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, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the face detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceDetection and pass the job identifier (JobId) from the initial call to StartFaceDetection.

For more information, see Detecting Faces in a Stored Video in the Amazon Rekognition Developer Guide.

Synopsis

data StartFaceDetection = StartFaceDetection' {
- jobTag :: Maybe Text
- notificationChannel :: Maybe NotificationChannel
- clientRequestToken :: Maybe Text
- faceAttributes :: Maybe FaceAttributes
- video :: Video
}
newStartFaceDetection :: Video -> StartFaceDetection
startFaceDetection_jobTag :: Lens' StartFaceDetection (Maybe Text)
startFaceDetection_notificationChannel :: Lens' StartFaceDetection (Maybe NotificationChannel)
startFaceDetection_clientRequestToken :: Lens' StartFaceDetection (Maybe Text)
startFaceDetection_faceAttributes :: Lens' StartFaceDetection (Maybe FaceAttributes)
startFaceDetection_video :: Lens' StartFaceDetection Video
data StartFaceDetectionResponse = StartFaceDetectionResponse' {
- jobId :: Maybe Text
- httpStatus :: Int
}
newStartFaceDetectionResponse :: Int -> StartFaceDetectionResponse
startFaceDetectionResponse_jobId :: Lens' StartFaceDetectionResponse (Maybe Text)
startFaceDetectionResponse_httpStatus :: Lens' StartFaceDetectionResponse Int

Creating a Request

data StartFaceDetection Source #

See: newStartFaceDetection smart constructor.

Constructors

StartFaceDetection'

Fields

jobTag :: Maybe Text
An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.
notificationChannel :: Maybe NotificationChannel
The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the face detection operation. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.
clientRequestToken :: 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.
faceAttributes :: 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.
video :: Video
The video in which you want to detect faces. The video must be stored in an Amazon S3 bucket.

Instances

Instances details

Eq StartFaceDetection Source #
Instance details Defined in Amazonka.Rekognition.StartFaceDetection Methods (==) :: StartFaceDetection -> StartFaceDetection -> Bool # (/=) :: StartFaceDetection -> StartFaceDetection -> Bool #
Read StartFaceDetection Source #
Instance details Defined in Amazonka.Rekognition.StartFaceDetection Methods readsPrec :: Int -> ReadS StartFaceDetection # readList :: ReadS [StartFaceDetection] # readPrec :: ReadPrec StartFaceDetection # readListPrec :: ReadPrec [StartFaceDetection] #
Show StartFaceDetection Source #
Instance details Defined in Amazonka.Rekognition.StartFaceDetection Methods showsPrec :: Int -> StartFaceDetection -> ShowS # show :: StartFaceDetection -> String # showList :: [StartFaceDetection] -> ShowS #
Generic StartFaceDetection Source #
Instance details Defined in Amazonka.Rekognition.StartFaceDetection Associated Types type Rep StartFaceDetection :: Type -> Type # Methods from :: StartFaceDetection -> Rep StartFaceDetection x # to :: Rep StartFaceDetection x -> StartFaceDetection #
NFData StartFaceDetection Source #
Instance details Defined in Amazonka.Rekognition.StartFaceDetection Methods rnf :: StartFaceDetection -> () #
Hashable StartFaceDetection Source #
Instance details Defined in Amazonka.Rekognition.StartFaceDetection Methods hashWithSalt :: Int -> StartFaceDetection -> Int # hash :: StartFaceDetection -> Int #
ToJSON StartFaceDetection Source #
Instance details Defined in Amazonka.Rekognition.StartFaceDetection Methods toJSON :: StartFaceDetection -> Value # toEncoding :: StartFaceDetection -> Encoding # toJSONList :: [StartFaceDetection] -> Value # toEncodingList :: [StartFaceDetection] -> Encoding #
AWSRequest StartFaceDetection Source #
Instance details Defined in Amazonka.Rekognition.StartFaceDetection Associated Types type AWSResponse StartFaceDetection # Methods request :: StartFaceDetection -> Request StartFaceDetection # response :: MonadResource m => Logger -> Service -> Proxy StartFaceDetection -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartFaceDetection))) #
ToHeaders StartFaceDetection Source #
Instance details Defined in Amazonka.Rekognition.StartFaceDetection Methods toHeaders :: StartFaceDetection -> [Header] #
ToPath StartFaceDetection Source #
Instance details Defined in Amazonka.Rekognition.StartFaceDetection Methods toPath :: StartFaceDetection -> ByteString #
ToQuery StartFaceDetection Source #
Instance details Defined in Amazonka.Rekognition.StartFaceDetection Methods toQuery :: StartFaceDetection -> QueryString #
type Rep StartFaceDetection Source #
Instance details Defined in Amazonka.Rekognition.StartFaceDetection type Rep StartFaceDetection = D1 ('MetaData "StartFaceDetection" "Amazonka.Rekognition.StartFaceDetection" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" 'False) (C1 ('MetaCons "StartFaceDetection'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "jobTag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "notificationChannel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NotificationChannel))) :: (S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "faceAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FaceAttributes)) :: S1 ('MetaSel ('Just "video") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Video)))))
type AWSResponse StartFaceDetection Source #
Instance details Defined in Amazonka.Rekognition.StartFaceDetection type AWSResponse StartFaceDetection = StartFaceDetectionResponse

newStartFaceDetection Source #

Arguments

:: Video	`$sel:video:StartFaceDetection'`
-> StartFaceDetection

Create a value of StartFaceDetection 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:jobTag:StartFaceDetection', startFaceDetection_jobTag - An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

$sel:notificationChannel:StartFaceDetection', startFaceDetection_notificationChannel - The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the face detection operation. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.

$sel:clientRequestToken:StartFaceDetection', startFaceDetection_clientRequestToken - 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.

$sel:faceAttributes:StartFaceDetection', startFaceDetection_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.

$sel:video:StartFaceDetection', startFaceDetection_video - The video in which you want to detect faces. The video must be stored in an Amazon S3 bucket.

Request Lenses

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

An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

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

The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the face detection operation. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.

startFaceDetection_clientRequestToken :: 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.

startFaceDetection_faceAttributes :: 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.

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

data StartFaceDetectionResponse Source #

See: newStartFaceDetectionResponse smart constructor.

Constructors

StartFaceDetectionResponse'
Fields jobId :: Maybe Text The identifier for the face detection job. Use `JobId` to identify the job in a subsequent call to `GetFaceDetection`. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq StartFaceDetectionResponse Source #
Instance details Defined in Amazonka.Rekognition.StartFaceDetection Methods (==) :: StartFaceDetectionResponse -> StartFaceDetectionResponse -> Bool # (/=) :: StartFaceDetectionResponse -> StartFaceDetectionResponse -> Bool #
Read StartFaceDetectionResponse Source #
Instance details Defined in Amazonka.Rekognition.StartFaceDetection Methods readsPrec :: Int -> ReadS StartFaceDetectionResponse # readList :: ReadS [StartFaceDetectionResponse] # readPrec :: ReadPrec StartFaceDetectionResponse # readListPrec :: ReadPrec [StartFaceDetectionResponse] #
Show StartFaceDetectionResponse Source #
Instance details Defined in Amazonka.Rekognition.StartFaceDetection Methods showsPrec :: Int -> StartFaceDetectionResponse -> ShowS # show :: StartFaceDetectionResponse -> String # showList :: [StartFaceDetectionResponse] -> ShowS #
Generic StartFaceDetectionResponse Source #
Instance details Defined in Amazonka.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 Amazonka.Rekognition.StartFaceDetection Methods rnf :: StartFaceDetectionResponse -> () #
type Rep StartFaceDetectionResponse Source #
Instance details Defined in Amazonka.Rekognition.StartFaceDetection type Rep StartFaceDetectionResponse = D1 ('MetaData "StartFaceDetectionResponse" "Amazonka.Rekognition.StartFaceDetection" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" 'False) (C1 ('MetaCons "StartFaceDetectionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartFaceDetectionResponse Source #

Arguments

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

Create a value of StartFaceDetectionResponse 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:jobId:StartFaceDetectionResponse', startFaceDetectionResponse_jobId - The identifier for the face detection job. Use JobId to identify the job in a subsequent call to GetFaceDetection.

$sel:httpStatus:StartFaceDetectionResponse', startFaceDetectionResponse_httpStatus - The response's http status code.

Response Lenses

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

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

startFaceDetectionResponse_httpStatus :: Lens' StartFaceDetectionResponse Int Source #

The response's http status code.