The input for StartTextDetectionCommand.

interface StartTextDetectionCommandInput {
    ClientRequestToken?: string;
    Filters?: StartTextDetectionFilters;
    JobTag?: string;
    NotificationChannel?: NotificationChannel;
    Video: undefined | Video;
}

Hierarchy (view full)

Properties

ClientRequestToken?: string

Idempotent token used to identify the start request. If you use the same token with multiple StartTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentaly started more than once.

Optional parameters that let you set criteria the text must meet to be included in your response.

JobTag?: string

An identifier returned in the completion status published by your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

NotificationChannel?: NotificationChannel

The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see Calling Amazon Rekognition Video operations. Note that the Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic. For more information, see Giving access to multiple Amazon SNS topics.

Video: undefined | Video

Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as StartLabelDetection use Video to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.