start_person_tracking

Rekognition.Client.start_person_tracking(**kwargs)

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 .

See also: AWS API Documentation

Request Syntax

response = client.start_person_tracking(
    Video={
        'S3Object': {
            'Bucket': 'string',
            'Name': 'string',
            'Version': 'string'
        }
    },
    ClientRequestToken='string',
    NotificationChannel={
        'SNSTopicArn': 'string',
        'RoleArn': 'string'
    },
    JobTag='string'
)

Parameters

• Video (dict) --

  [REQUIRED]

  The video in which you want to detect people. The video must be stored in an Amazon S3 bucket.

  • S3Object (dict) --

    The Amazon S3 bucket name and file name for the video.

    • Bucket (string) --

      Name of the S3 bucket.

    • Name (string) --

      S3 object key name.

    • Version (string) --

      If the bucket is versioning enabled, you can specify the object version.

• ClientRequestToken (string) -- 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.
• NotificationChannel (dict) --

  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.

  • SNSTopicArn (string) -- [REQUIRED]

    The Amazon SNS topic to which Amazon Rekognition posts the completion status.

  • RoleArn (string) -- [REQUIRED]

    The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic.

• JobTag (string) -- 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.

Return type

dict

Returns

Response Syntax

{
    'JobId': 'string'
}

Response Structure

• (dict) --

  • JobId (string) --

    The identifier for the person detection job. Use JobId to identify the job in a subsequent call to GetPersonTracking .

Exceptions

• Rekognition.Client.exceptions.AccessDeniedException
• Rekognition.Client.exceptions.IdempotentParameterMismatchException
• Rekognition.Client.exceptions.InvalidParameterException
• Rekognition.Client.exceptions.InvalidS3ObjectException
• Rekognition.Client.exceptions.InternalServerError
• Rekognition.Client.exceptions.VideoTooLargeException
• Rekognition.Client.exceptions.ProvisionedThroughputExceededException
• Rekognition.Client.exceptions.LimitExceededException
• Rekognition.Client.exceptions.ThrottlingException