Struct StartSegmentDetectionInput

#[non_exhaustive]
pub struct StartSegmentDetectionInput {
    pub video: Option<Video>,
    pub client_request_token: Option<String>,
    pub notification_channel: Option<NotificationChannel>,
    pub job_tag: Option<String>,
    pub filters: Option<StartSegmentDetectionFilters>,
    pub segment_types: Option<Vec<SegmentType>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

video: Option<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.

client_request_token: Option<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.

notification_channel: Option<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.

job_tag: Option<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.

filters: Option<StartSegmentDetectionFilters>

Filters for technical cue or shot detection.

segment_types: Option<Vec<SegmentType>>

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

Implementations

impl StartSegmentDetectionInput

pub fn video(&self) -> Option<&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.

pub fn client_request_token(&self) -> Option<&str>

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.

pub fn notification_channel(&self) -> Option<&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.

pub fn job_tag(&self) -> Option<&str>

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.

pub fn filters(&self) -> Option<&StartSegmentDetectionFilters>

Filters for technical cue or shot detection.

pub fn segment_types(&self) -> &[SegmentType]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .segment_types.is_none().

impl StartSegmentDetectionInput

pub fn builder() -> StartSegmentDetectionInputBuilder

Creates a new builder-style object to manufacture StartSegmentDetectionInput.

Trait Implementations

impl Clone for StartSegmentDetectionInput

fn clone(&self) -> StartSegmentDetectionInput

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StartSegmentDetectionInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for StartSegmentDetectionInput

fn eq(&self, other: &StartSegmentDetectionInput) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StartSegmentDetectionInput