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 |
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' .
- startFaceDetection :: Video -> StartFaceDetection
- data StartFaceDetection
- sfdJobTag :: Lens' StartFaceDetection (Maybe Text)
- sfdNotificationChannel :: Lens' StartFaceDetection (Maybe NotificationChannel)
- sfdClientRequestToken :: Lens' StartFaceDetection (Maybe Text)
- sfdFaceAttributes :: Lens' StartFaceDetection (Maybe FaceAttributes)
- sfdVideo :: Lens' StartFaceDetection Video
- startFaceDetectionResponse :: Int -> StartFaceDetectionResponse
- data StartFaceDetectionResponse
- sfdrsJobId :: Lens' StartFaceDetectionResponse (Maybe Text)
- sfdrsResponseStatus :: Lens' StartFaceDetectionResponse Int
Creating a Request
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 multipleStartFaceDetection
requests, the sameJobId
is returned. UseClientRequestToken
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.
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 #
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. UseJobId
to identify the job in a subsequent call toGetFaceDetection
.sfdrsResponseStatus
- -- | The response status code.
data StartFaceDetectionResponse Source #
See: startFaceDetectionResponse
smart constructor.
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.