| 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.StartPersonTracking
Description
Starts the asynchronous tracking of a person's path in a stored video.
Amazon Rekognition Video can track the path of people in a video stored
in an Amazon S3 bucket. Use Video to specify the bucket name and the
filename of the video. StartPersonTracking returns a job identifier
(JobId) which you use to get the results of the operation. When label
detection is finished, Amazon Rekognition publishes a completion status
to the Amazon Simple Notification Service topic that you specify in
NotificationChannel.
To get the results of the person detection operation, first check that
the status value published to the Amazon SNS topic is SUCCEEDED. If
so, call GetPersonTracking and pass the job identifier (JobId) from
the initial call to StartPersonTracking.
Synopsis
- data StartPersonTracking = StartPersonTracking' {}
- newStartPersonTracking :: Video -> StartPersonTracking
- startPersonTracking_jobTag :: Lens' StartPersonTracking (Maybe Text)
- startPersonTracking_notificationChannel :: Lens' StartPersonTracking (Maybe NotificationChannel)
- startPersonTracking_clientRequestToken :: Lens' StartPersonTracking (Maybe Text)
- startPersonTracking_video :: Lens' StartPersonTracking Video
- data StartPersonTrackingResponse = StartPersonTrackingResponse' {
- jobId :: Maybe Text
- httpStatus :: Int
- newStartPersonTrackingResponse :: Int -> StartPersonTrackingResponse
- startPersonTrackingResponse_jobId :: Lens' StartPersonTrackingResponse (Maybe Text)
- startPersonTrackingResponse_httpStatus :: Lens' StartPersonTrackingResponse Int
Creating a Request
data StartPersonTracking Source #
See: newStartPersonTracking smart constructor.
Constructors
| StartPersonTracking' | |
Fields
| |
Instances
newStartPersonTracking Source #
Arguments
| :: Video | |
| -> StartPersonTracking |
Create a value of StartPersonTracking 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:StartPersonTracking', startPersonTracking_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:StartPersonTracking', startPersonTracking_notificationChannel - The Amazon SNS topic ARN you want Amazon Rekognition Video to publish
the completion status of the people detection operation to. The Amazon
SNS topic must have a topic name that begins with AmazonRekognition if
you are using the AmazonRekognitionServiceRole permissions policy.
$sel:clientRequestToken:StartPersonTracking', startPersonTracking_clientRequestToken - Idempotent token used to identify the start request. If you use the same
token with multiple StartPersonTracking requests, the same JobId is
returned. Use ClientRequestToken to prevent the same job from being
accidently started more than once.
$sel:video:StartPersonTracking', startPersonTracking_video - The video in which you want to detect people. The video must be stored
in an Amazon S3 bucket.
Request Lenses
startPersonTracking_jobTag :: Lens' StartPersonTracking (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.
startPersonTracking_notificationChannel :: Lens' StartPersonTracking (Maybe NotificationChannel) Source #
The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the people detection operation to. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.
startPersonTracking_clientRequestToken :: Lens' StartPersonTracking (Maybe Text) Source #
Idempotent token used to identify the start request. If you use the same
token with multiple StartPersonTracking requests, the same JobId is
returned. Use ClientRequestToken to prevent the same job from being
accidently started more than once.
startPersonTracking_video :: Lens' StartPersonTracking Video Source #
The video in which you want to detect people. The video must be stored in an Amazon S3 bucket.
Destructuring the Response
data StartPersonTrackingResponse Source #
See: newStartPersonTrackingResponse smart constructor.
Constructors
| StartPersonTrackingResponse' | |
Fields
| |
Instances
newStartPersonTrackingResponse Source #
Create a value of StartPersonTrackingResponse 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:StartPersonTrackingResponse', startPersonTrackingResponse_jobId - The identifier for the person detection job. Use JobId to identify the
job in a subsequent call to GetPersonTracking.
$sel:httpStatus:StartPersonTrackingResponse', startPersonTrackingResponse_httpStatus - The response's http status code.
Response Lenses
startPersonTrackingResponse_jobId :: Lens' StartPersonTrackingResponse (Maybe Text) Source #
The identifier for the person detection job. Use JobId to identify the
job in a subsequent call to GetPersonTracking.
startPersonTrackingResponse_httpStatus :: Lens' StartPersonTrackingResponse Int Source #
The response's http status code.