Skip to content

StartSegmentDetectionRequest

Source code in docs_src/capo_rekognition/types/start_segment_detection_request.py
class StartSegmentDetectionRequest(TypedDict, closed=True):
    video: "capo_rekognition.types.video.Video"
    client_request_token: NotRequired[
        "capo_rekognition.types.client_request_token.ClientRequestToken"
    ]
    """<p>Idempotent token used to identify the start request. If you use the same token with multiple <code>StartSegmentDetection</code> requests, the same <code>JobId</code> is returned. Use <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once. </p>"""
    notification_channel: NotRequired[
        "capo_rekognition.types.notification_channel.NotificationChannel"
    ]
    """<p>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 <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.</p>"""
    job_tag: NotRequired["capo_rekognition.types.job_tag.JobTag"]
    """<p>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 <code>JobTag</code> to group related jobs and identify them in the completion notification.</p>"""
    filters: NotRequired[
        "capo_rekognition.types.start_segment_detection_filters.StartSegmentDetectionFilters"
    ]
    """<p>Filters for technical cue or shot detection.</p>"""
    segment_types: "capo_rekognition.types.segment_types.SegmentTypes"
    """<p>An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.</p>"""

client_request_token instance-attribute

client_request_token: NotRequired[ClientRequestToken]

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 instance-attribute

filters: NotRequired[StartSegmentDetectionFilters]

Filters for technical cue or shot detection.

job_tag instance-attribute

job_tag: NotRequired[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 JobTag to group related jobs and identify them in the completion notification.

notification_channel instance-attribute

notification_channel: NotRequired[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.

segment_types instance-attribute

segment_types: SegmentTypes

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

video instance-attribute

video: Video