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.StartPersonTracking
Description
Starts the asynchronous tracking of persons in a stored video.
Rekognition Video can track persons 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 and pass the job identifier (JobId
) from the initial call to StartPersonTracking
.
- startPersonTracking :: Video -> StartPersonTracking
- data StartPersonTracking
- sptJobTag :: Lens' StartPersonTracking (Maybe Text)
- sptNotificationChannel :: Lens' StartPersonTracking (Maybe NotificationChannel)
- sptClientRequestToken :: Lens' StartPersonTracking (Maybe Text)
- sptVideo :: Lens' StartPersonTracking Video
- startPersonTrackingResponse :: Int -> StartPersonTrackingResponse
- data StartPersonTrackingResponse
- sptrsJobId :: Lens' StartPersonTrackingResponse (Maybe Text)
- sptrsResponseStatus :: Lens' StartPersonTrackingResponse Int
Creating a Request
Arguments
:: Video | |
-> StartPersonTracking |
Creates a value of StartPersonTracking
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sptJobTag
- Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.sptNotificationChannel
- The Amazon SNS topic ARN you want Rekognition Video to publish the completion status of the people detection operation to.sptClientRequestToken
- Idempotent token used to identify the start request. If you use the same token with multipleStartPersonTracking
requests, the sameJobId
is returned. UseClientRequestToken
to prevent the same job from being accidently started more than once.sptVideo
- The video in which you want to detect people. The video must be stored in an Amazon S3 bucket.
data StartPersonTracking #
See: startPersonTracking
smart constructor.
Instances
Request Lenses
sptJobTag :: Lens' StartPersonTracking (Maybe Text) #
Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.
sptNotificationChannel :: Lens' StartPersonTracking (Maybe NotificationChannel) #
The Amazon SNS topic ARN you want Rekognition Video to publish the completion status of the people detection operation to.
sptClientRequestToken :: Lens' StartPersonTracking (Maybe Text) #
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.
sptVideo :: Lens' StartPersonTracking Video #
The video in which you want to detect people. The video must be stored in an Amazon S3 bucket.
Destructuring the Response
Arguments
:: Int | |
-> StartPersonTrackingResponse |
Creates a value of StartPersonTrackingResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sptrsJobId
- The identifier for the person detection job. UseJobId
to identify the job in a subsequent call toGetPersonTracking
.sptrsResponseStatus
- -- | The response status code.
data StartPersonTrackingResponse #
See: startPersonTrackingResponse
smart constructor.
Response Lenses
sptrsJobId :: Lens' StartPersonTrackingResponse (Maybe Text) #
The identifier for the person detection job. Use JobId
to identify the job in a subsequent call to GetPersonTracking
.
sptrsResponseStatus :: Lens' StartPersonTrackingResponse Int #
- - | The response status code.