Struct GetSegmentDetectionOutput

#[non_exhaustive]
pub struct GetSegmentDetectionOutput {
    pub job_status: Option<VideoJobStatus>,
    pub status_message: Option<String>,
    pub video_metadata: Option<Vec<VideoMetadata>>,
    pub audio_metadata: Option<Vec<AudioMetadata>>,
    pub next_token: Option<String>,
    pub segments: Option<Vec<SegmentDetection>>,
    pub selected_segment_types: Option<Vec<SegmentTypeInfo>>,
    pub job_id: Option<String>,
    pub video: Option<Video>,
    pub job_tag: Option<String>,
    /* private fields */
}

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.

job_status: Option<VideoJobStatus>

Current status of the segment detection job.

status_message: Option<String>

If the job fails, StatusMessage provides a descriptive error message.

video_metadata: Option<Vec<VideoMetadata>>

Currently, Amazon Rekognition Video returns a single object in the VideoMetadata array. The object contains information about the video stream in the input file that Amazon Rekognition Video chose to analyze. The VideoMetadata object includes the video codec, video format and other information. Video metadata is returned in each page of information returned by GetSegmentDetection.

audio_metadata: Option<Vec<AudioMetadata>>

An array of objects. There can be multiple audio streams. Each AudioMetadata object contains metadata for a single audio stream. Audio information in an AudioMetadata objects includes the audio codec, the number of audio channels, the duration of the audio stream, and the sample rate. Audio metadata is returned in each page of information returned by GetSegmentDetection.

next_token: Option<String>

If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of text.

segments: Option<Vec<SegmentDetection>>

An array of segments detected in a video. The array is sorted by the segment types (TECHNICAL_CUE or SHOT) specified in the SegmentTypes input parameter of StartSegmentDetection. Within each segment type the array is sorted by timestamp values.

selected_segment_types: Option<Vec<SegmentTypeInfo>>

An array containing the segment types requested in the call to StartSegmentDetection.

job_id: Option<String>

Job identifier for the segment detection operation for which you want to obtain results. The job identifer is returned by an initial call to StartSegmentDetection.

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.

job_tag: Option<String>

A job identifier specified in the call to StartSegmentDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.

Implementations

impl GetSegmentDetectionOutput

pub fn job_status(&self) -> Option<&VideoJobStatus>

Current status of the segment detection job.

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

If the job fails, StatusMessage provides a descriptive error message.

pub fn video_metadata(&self) -> &[VideoMetadata]

Currently, Amazon Rekognition Video returns a single object in the VideoMetadata array. The object contains information about the video stream in the input file that Amazon Rekognition Video chose to analyze. The VideoMetadata object includes the video codec, video format and other information. Video metadata is returned in each page of information returned by GetSegmentDetection.

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

pub fn audio_metadata(&self) -> &[AudioMetadata]

An array of objects. There can be multiple audio streams. Each AudioMetadata object contains metadata for a single audio stream. Audio information in an AudioMetadata objects includes the audio codec, the number of audio channels, the duration of the audio stream, and the sample rate. Audio metadata is returned in each page of information returned by GetSegmentDetection.

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

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

If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of text.

pub fn segments(&self) -> &[SegmentDetection]

An array of segments detected in a video. The array is sorted by the segment types (TECHNICAL_CUE or SHOT) specified in the SegmentTypes input parameter of StartSegmentDetection. Within each segment type the array is sorted by timestamp values.

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

pub fn selected_segment_types(&self) -> &[SegmentTypeInfo]

An array containing the segment types requested in the call to StartSegmentDetection.

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

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

Job identifier for the segment detection operation for which you want to obtain results. The job identifer is returned by an initial call to StartSegmentDetection.

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 job_tag(&self) -> Option<&str>

A job identifier specified in the call to StartSegmentDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.

impl GetSegmentDetectionOutput

pub fn builder() -> GetSegmentDetectionOutputBuilder

Creates a new builder-style object to manufacture GetSegmentDetectionOutput.

Trait Implementations

impl Clone for GetSegmentDetectionOutput

fn clone(&self) -> GetSegmentDetectionOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetSegmentDetectionOutput

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

Formats the value using the given formatter.

impl PartialEq for GetSegmentDetectionOutput

fn eq(&self, other: &GetSegmentDetectionOutput) -> 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 RequestId for GetSegmentDetectionOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for GetSegmentDetectionOutput