aws_sdk_rekognition/client/

start_segment_detection.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`StartSegmentDetection`](crate::operation::start_segment_detection::builders::StartSegmentDetectionFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`video(Video)`](crate::operation::start_segment_detection::builders::StartSegmentDetectionFluentBuilder::video) / [`set_video(Option<Video>)`](crate::operation::start_segment_detection::builders::StartSegmentDetectionFluentBuilder::set_video):<br>required: **true**<br><p>Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as <code>StartLabelDetection</code> use <code>Video</code> to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.</p><br>
    ///   - [`client_request_token(impl Into<String>)`](crate::operation::start_segment_detection::builders::StartSegmentDetectionFluentBuilder::client_request_token) / [`set_client_request_token(Option<String>)`](crate::operation::start_segment_detection::builders::StartSegmentDetectionFluentBuilder::set_client_request_token):<br>required: **false**<br><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><br>
    ///   - [`notification_channel(NotificationChannel)`](crate::operation::start_segment_detection::builders::StartSegmentDetectionFluentBuilder::notification_channel) / [`set_notification_channel(Option<NotificationChannel>)`](crate::operation::start_segment_detection::builders::StartSegmentDetectionFluentBuilder::set_notification_channel):<br>required: **false**<br><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><br>
    ///   - [`job_tag(impl Into<String>)`](crate::operation::start_segment_detection::builders::StartSegmentDetectionFluentBuilder::job_tag) / [`set_job_tag(Option<String>)`](crate::operation::start_segment_detection::builders::StartSegmentDetectionFluentBuilder::set_job_tag):<br>required: **false**<br><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><br>
    ///   - [`filters(StartSegmentDetectionFilters)`](crate::operation::start_segment_detection::builders::StartSegmentDetectionFluentBuilder::filters) / [`set_filters(Option<StartSegmentDetectionFilters>)`](crate::operation::start_segment_detection::builders::StartSegmentDetectionFluentBuilder::set_filters):<br>required: **false**<br><p>Filters for technical cue or shot detection.</p><br>
    ///   - [`segment_types(SegmentType)`](crate::operation::start_segment_detection::builders::StartSegmentDetectionFluentBuilder::segment_types) / [`set_segment_types(Option<Vec::<SegmentType>>)`](crate::operation::start_segment_detection::builders::StartSegmentDetectionFluentBuilder::set_segment_types):<br>required: **true**<br><p>An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.</p><br>
    /// - On success, responds with [`StartSegmentDetectionOutput`](crate::operation::start_segment_detection::StartSegmentDetectionOutput) with field(s):
    ///   - [`job_id(Option<String>)`](crate::operation::start_segment_detection::StartSegmentDetectionOutput::job_id): <p>Unique identifier for the segment detection job. The <code>JobId</code> is returned from <code>StartSegmentDetection</code>.</p>
    /// - On failure, responds with [`SdkError<StartSegmentDetectionError>`](crate::operation::start_segment_detection::StartSegmentDetectionError)
    pub fn start_segment_detection(&self) -> crate::operation::start_segment_detection::builders::StartSegmentDetectionFluentBuilder {
        crate::operation::start_segment_detection::builders::StartSegmentDetectionFluentBuilder::new(self.handle.clone())
    }
}