Note
End of support notice: On October 31, 2025, AWS will discontinue
support for Amazon Rekognition People Pathing. After October 31, 2025, you will no
longer be able to use the Rekognition People Pathing capability. For more information,
visit this blog post
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.
Request Syntax
{
"ClientRequestToken": "string",
"JobTag": "string",
"NotificationChannel": {
"RoleArn": "string",
"SNSTopicArn": "string"
},
"Video": {
"S3Object": {
"Bucket": "string",
"Name": "string",
"Version": "string"
}
}
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ClientRequestToken
-
Idempotent token used to identify the start request. If you use the same token with multiple
StartPersonTrackingrequests, the sameJobIdis returned. UseClientRequestTokento prevent the same job from being accidently started more than once.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9-_]+$Required: No
- 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
JobTagto group related jobs and identify them in the completion notification.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[a-zA-Z0-9_.\-:+=\/]+Required: No
- 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.
Type: NotificationChannel object
Required: No
- Video
-
The video in which you want to detect people. The video must be stored in an Amazon S3 bucket.
Type: Video object
Required: Yes
Response Syntax
{
"JobId": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- JobId
-
The identifier for the person detection job. Use
JobIdto identify the job in a subsequent call toGetPersonTracking.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9-_]+$
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You are not authorized to perform the action.
HTTP Status Code: 400
- IdempotentParameterMismatchException
-
A
ClientRequestTokeninput parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.HTTP Status Code: 400
- InternalServerError
-
Amazon Rekognition experienced a service issue. Try your call again.
HTTP Status Code: 500
- InvalidParameterException
-
Input parameter violated a constraint. Validate your parameter before calling the API operation again.
HTTP Status Code: 400
- InvalidS3ObjectException
-
Amazon Rekognition is unable to access the S3 object specified in the request.
HTTP Status Code: 400
- LimitExceededException
-
An Amazon Rekognition service limit was exceeded. For example, if you start too many jobs concurrently, subsequent calls to start operations (ex:
StartLabelDetection) will raise aLimitExceededExceptionexception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Rekognition service limit.HTTP Status Code: 400
- ProvisionedThroughputExceededException
-
The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.
HTTP Status Code: 400
- ThrottlingException
-
Amazon Rekognition is temporarily unable to process the request. Try your call again.
HTTP Status Code: 500
- VideoTooLargeException
-
The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum duration is 6 hours.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
