Struct aws_sdk_transcribe::types::SubtitlesOutput

#[non_exhaustive]
pub struct SubtitlesOutput {
    pub formats: Option<Vec<SubtitleFormat>>,
    pub subtitle_file_uris: Option<Vec<String>>,
    pub output_start_index: Option<i32>,
}

Provides information about your subtitle file, including format, start index, and Amazon S3 location.

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.

formats: Option<Vec<SubtitleFormat>>

Provides the format of your subtitle files. If your request included both WebVTT (vtt) and SubRip (srt) formats, both formats are shown.

subtitle_file_uris: Option<Vec<String>>

The Amazon S3 location of your transcript. You can use this URI to access or download your subtitle file. Your subtitle file is stored in the same location as your transcript. If you specified both WebVTT and SubRip subtitle formats, two URIs are provided.

If you included OutputBucketName in your transcription job request, this is the URI of that bucket. If you also included OutputKey in your request, your output is located in the path you specified in your request.

If you didn't include OutputBucketName in your transcription job request, your subtitle file is stored in a service-managed bucket, and TranscriptFileUri provides you with a temporary URI you can use for secure access to your subtitle file.

Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 minutes. If you get an AccesDenied error, you can get a new temporary URI by running a GetTranscriptionJob or ListTranscriptionJob request.

output_start_index: Option<i32>

Provides the start index value for your subtitle files. If you did not specify a value in your request, the default value of 0 is used.

Implementations

impl SubtitlesOutput

pub fn formats(&self) -> &[SubtitleFormat]

Provides the format of your subtitle files. If your request included both WebVTT (vtt) and SubRip (srt) formats, both formats are shown.

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

pub fn subtitle_file_uris(&self) -> &[String]

The Amazon S3 location of your transcript. You can use this URI to access or download your subtitle file. Your subtitle file is stored in the same location as your transcript. If you specified both WebVTT and SubRip subtitle formats, two URIs are provided.

If you included OutputBucketName in your transcription job request, this is the URI of that bucket. If you also included OutputKey in your request, your output is located in the path you specified in your request.

If you didn't include OutputBucketName in your transcription job request, your subtitle file is stored in a service-managed bucket, and TranscriptFileUri provides you with a temporary URI you can use for secure access to your subtitle file.

Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 minutes. If you get an AccesDenied error, you can get a new temporary URI by running a GetTranscriptionJob or ListTranscriptionJob request.

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

pub fn output_start_index(&self) -> Option<i32>

Provides the start index value for your subtitle files. If you did not specify a value in your request, the default value of 0 is used.

impl SubtitlesOutput

pub fn builder() -> SubtitlesOutputBuilder

Creates a new builder-style object to manufacture SubtitlesOutput.

Trait Implementations

impl Clone for SubtitlesOutput

fn clone(&self) -> SubtitlesOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SubtitlesOutput

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

Formats the value using the given formatter.

impl PartialEq for SubtitlesOutput

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for SubtitlesOutput