Amazonka.Transcribe.Types.SubtitlesOutput

Documentation

data SubtitlesOutput

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

See: newSubtitlesOutput smart constructor.

Constructors

SubtitlesOutput'

Fields

• formats :: Maybe [SubtitleFormat]

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

• outputStartIndex :: Maybe Natural

  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.

• subtitleFileUris :: Maybe [Text]

  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.

Instances

FromJSON SubtitlesOutput

Defined in Amazonka.Transcribe.Types.SubtitlesOutput

Methods

parseJSON :: Value -> Parser SubtitlesOutput

parseJSONList :: Value -> Parser [SubtitlesOutput]

Generic SubtitlesOutput

Defined in Amazonka.Transcribe.Types.SubtitlesOutput

Associated Types

type Rep SubtitlesOutput :: Type -> Type

Methods

from :: SubtitlesOutput -> Rep SubtitlesOutput x

to :: Rep SubtitlesOutput x -> SubtitlesOutput

Read SubtitlesOutput

Defined in Amazonka.Transcribe.Types.SubtitlesOutput

Methods

readsPrec :: Int -> ReadS SubtitlesOutput

readList :: ReadS [SubtitlesOutput]

readPrec :: ReadPrec SubtitlesOutput

readListPrec :: ReadPrec [SubtitlesOutput]

Show SubtitlesOutput

Defined in Amazonka.Transcribe.Types.SubtitlesOutput

Methods

showsPrec :: Int -> SubtitlesOutput -> ShowS

show :: SubtitlesOutput -> String

showList :: [SubtitlesOutput] -> ShowS

NFData SubtitlesOutput

Defined in Amazonka.Transcribe.Types.SubtitlesOutput

Methods

rnf :: SubtitlesOutput -> ()

Eq SubtitlesOutput

Defined in Amazonka.Transcribe.Types.SubtitlesOutput

Methods

(==) :: SubtitlesOutput -> SubtitlesOutput -> Bool

(/=) :: SubtitlesOutput -> SubtitlesOutput -> Bool

Hashable SubtitlesOutput

Defined in Amazonka.Transcribe.Types.SubtitlesOutput

Methods

hashWithSalt :: Int -> SubtitlesOutput -> Int

hash :: SubtitlesOutput -> Int

type Rep SubtitlesOutput

Defined in Amazonka.Transcribe.Types.SubtitlesOutput

type Rep SubtitlesOutput = D1 ('MetaData "SubtitlesOutput" "Amazonka.Transcribe.Types.SubtitlesOutput" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "SubtitlesOutput'" 'PrefixI 'True) (S1 ('MetaSel ('Just "formats") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SubtitleFormat])) :*: (S1 ('MetaSel ('Just "outputStartIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "subtitleFileUris") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))

newSubtitlesOutput :: SubtitlesOutput

Create a value of SubtitlesOutput with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:formats:SubtitlesOutput', subtitlesOutput_formats - Provides the format of your subtitle files. If your request included both WebVTT (vtt) and SubRip (srt) formats, both formats are shown.

$sel:outputStartIndex:SubtitlesOutput', subtitlesOutput_outputStartIndex - 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.

$sel:subtitleFileUris:SubtitlesOutput', subtitlesOutput_subtitleFileUris - 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.

subtitlesOutput_formats :: Lens' SubtitlesOutput (Maybe [SubtitleFormat])

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

subtitlesOutput_outputStartIndex :: Lens' SubtitlesOutput (Maybe Natural)

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.

subtitlesOutput_subtitleFileUris :: Lens' SubtitlesOutput (Maybe [Text])

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.