interface StartSegmentDetectionRequest {
    ClientRequestToken?: string;
    Filters?: StartSegmentDetectionFilters;
    JobTag?: string;
    NotificationChannel?: NotificationChannel;
    SegmentTypes: undefined | SegmentType[];
    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 StartSegmentDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

Filters for technical cue or shot detection.

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.

NotificationChannel?: NotificationChannel

The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the segment detection operation. 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.

SegmentTypes: undefined | SegmentType[]

An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.

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.