Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data TranscriptionJob = TranscriptionJob' {
- completionTime :: Maybe POSIX
- contentRedaction :: Maybe ContentRedaction
- creationTime :: Maybe POSIX
- failureReason :: Maybe Text
- identifiedLanguageScore :: Maybe Double
- identifyLanguage :: Maybe Bool
- identifyMultipleLanguages :: Maybe Bool
- jobExecutionSettings :: Maybe JobExecutionSettings
- languageCode :: Maybe LanguageCode
- languageCodes :: Maybe [LanguageCodeItem]
- languageIdSettings :: Maybe (HashMap LanguageCode LanguageIdSettings)
- languageOptions :: Maybe (NonEmpty LanguageCode)
- media :: Maybe Media
- mediaFormat :: Maybe MediaFormat
- mediaSampleRateHertz :: Maybe Natural
- modelSettings :: Maybe ModelSettings
- settings :: Maybe Settings
- startTime :: Maybe POSIX
- subtitles :: Maybe SubtitlesOutput
- tags :: Maybe (NonEmpty Tag)
- transcript :: Maybe Transcript
- transcriptionJobName :: Maybe Text
- transcriptionJobStatus :: Maybe TranscriptionJobStatus
- newTranscriptionJob :: TranscriptionJob
- transcriptionJob_completionTime :: Lens' TranscriptionJob (Maybe UTCTime)
- transcriptionJob_contentRedaction :: Lens' TranscriptionJob (Maybe ContentRedaction)
- transcriptionJob_creationTime :: Lens' TranscriptionJob (Maybe UTCTime)
- transcriptionJob_failureReason :: Lens' TranscriptionJob (Maybe Text)
- transcriptionJob_identifiedLanguageScore :: Lens' TranscriptionJob (Maybe Double)
- transcriptionJob_identifyLanguage :: Lens' TranscriptionJob (Maybe Bool)
- transcriptionJob_identifyMultipleLanguages :: Lens' TranscriptionJob (Maybe Bool)
- transcriptionJob_jobExecutionSettings :: Lens' TranscriptionJob (Maybe JobExecutionSettings)
- transcriptionJob_languageCode :: Lens' TranscriptionJob (Maybe LanguageCode)
- transcriptionJob_languageCodes :: Lens' TranscriptionJob (Maybe [LanguageCodeItem])
- transcriptionJob_languageIdSettings :: Lens' TranscriptionJob (Maybe (HashMap LanguageCode LanguageIdSettings))
- transcriptionJob_languageOptions :: Lens' TranscriptionJob (Maybe (NonEmpty LanguageCode))
- transcriptionJob_media :: Lens' TranscriptionJob (Maybe Media)
- transcriptionJob_mediaFormat :: Lens' TranscriptionJob (Maybe MediaFormat)
- transcriptionJob_mediaSampleRateHertz :: Lens' TranscriptionJob (Maybe Natural)
- transcriptionJob_modelSettings :: Lens' TranscriptionJob (Maybe ModelSettings)
- transcriptionJob_settings :: Lens' TranscriptionJob (Maybe Settings)
- transcriptionJob_startTime :: Lens' TranscriptionJob (Maybe UTCTime)
- transcriptionJob_subtitles :: Lens' TranscriptionJob (Maybe SubtitlesOutput)
- transcriptionJob_tags :: Lens' TranscriptionJob (Maybe (NonEmpty Tag))
- transcriptionJob_transcript :: Lens' TranscriptionJob (Maybe Transcript)
- transcriptionJob_transcriptionJobName :: Lens' TranscriptionJob (Maybe Text)
- transcriptionJob_transcriptionJobStatus :: Lens' TranscriptionJob (Maybe TranscriptionJobStatus)
Documentation
data TranscriptionJob Source #
Provides detailed information about a transcription job.
To view the status of the specified transcription job, check the
TranscriptionJobStatus
field. If the status is COMPLETED
, the job is
finished and you can find the results at the location specified in
TranscriptFileUri
. If the status is FAILED
, FailureReason
provides
details on why your transcription job failed.
If you enabled content redaction, the redacted transcript can be found
at the location specified in RedactedTranscriptFileUri
.
See: newTranscriptionJob
smart constructor.
TranscriptionJob' | |
|
Instances
newTranscriptionJob :: TranscriptionJob Source #
Create a value of TranscriptionJob
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:completionTime:TranscriptionJob'
, transcriptionJob_completionTime
- The date and time the specified transcription job finished processing.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For
example, 2022-05-04T12:33:13.922000-07:00
represents a transcription
job that started processing at 12:33 PM UTC-7 on May 4, 2022.
$sel:contentRedaction:TranscriptionJob'
, transcriptionJob_contentRedaction
- Indicates whether redaction was enabled in your transcript.
$sel:creationTime:TranscriptionJob'
, transcriptionJob_creationTime
- The date and time the specified transcription job request was made.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For
example, 2022-05-04T12:32:58.761000-07:00
represents a transcription
job that started processing at 12:32 PM UTC-7 on May 4, 2022.
$sel:failureReason:TranscriptionJob'
, transcriptionJob_failureReason
- If TranscriptionJobStatus
is FAILED
, FailureReason
contains
information about why the transcription job request failed.
The FailureReason
field contains one of the following values:
Unsupported media format
.The media format specified in
MediaFormat
isn't valid. Refer to MediaFormat for a list of supported formats.The media format provided does not match the detected media format
.The media format specified in
MediaFormat
doesn't match the format of the input file. Check the media format of your media file and correct the specified value.Invalid sample rate for audio file
.The sample rate specified in
MediaSampleRateHertz
isn't valid. The sample rate must be between 8,000 and 48,000 hertz.The sample rate provided does not match the detected sample rate
.The sample rate specified in
MediaSampleRateHertz
doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.Invalid file size: file size too large
.The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Guidelines and quotas.
Invalid number of channels: number of channels too large
.Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Guidelines and quotas.
$sel:identifiedLanguageScore:TranscriptionJob'
, transcriptionJob_identifiedLanguageScore
- The confidence score associated with the language identified in your
media file.
Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.
$sel:identifyLanguage:TranscriptionJob'
, transcriptionJob_identifyLanguage
- Indicates whether automatic language identification was enabled (TRUE
)
for the specified transcription job.
$sel:identifyMultipleLanguages:TranscriptionJob'
, transcriptionJob_identifyMultipleLanguages
- Indicates whether automatic multi-language identification was enabled
(TRUE
) for the specified transcription job.
$sel:jobExecutionSettings:TranscriptionJob'
, transcriptionJob_jobExecutionSettings
- Provides information about how your transcription job was processed.
This parameter shows if your request was queued and what data access
role was used.
TranscriptionJob
, transcriptionJob_languageCode
- The language code used to create your transcription job. This parameter
is used with single-language identification. For multi-language
identification requests, refer to the plural version of this parameter,
LanguageCodes
.
$sel:languageCodes:TranscriptionJob'
, transcriptionJob_languageCodes
- The language codes used to create your transcription job. This parameter
is used with multi-language identification. For single-language
identification requests, refer to the singular version of this
parameter, LanguageCode
.
$sel:languageIdSettings:TranscriptionJob'
, transcriptionJob_languageIdSettings
- Provides the name and language of all custom language models, custom
vocabularies, and custom vocabulary filters that you included in your
request.
$sel:languageOptions:TranscriptionJob'
, transcriptionJob_languageOptions
- Provides the language codes you specified in your request.
$sel:media:TranscriptionJob'
, transcriptionJob_media
- Provides the Amazon S3 location of the media file you used in your
request.
$sel:mediaFormat:TranscriptionJob'
, transcriptionJob_mediaFormat
- The format of the input media file.
$sel:mediaSampleRateHertz:TranscriptionJob'
, transcriptionJob_mediaSampleRateHertz
- The sample rate, in hertz, of the audio track in your input media file.
$sel:modelSettings:TranscriptionJob'
, transcriptionJob_modelSettings
- Provides information on the custom language model you included in your
request.
$sel:settings:TranscriptionJob'
, transcriptionJob_settings
- Provides information on any additional settings that were included in
your request. Additional settings include channel identification,
alternative transcriptions, speaker partitioning, custom vocabularies,
and custom vocabulary filters.
$sel:startTime:TranscriptionJob'
, transcriptionJob_startTime
- The date and time the specified transcription job began processing.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For
example, 2022-05-04T12:32:58.789000-07:00
represents a transcription
job that started processing at 12:32 PM UTC-7 on May 4, 2022.
$sel:subtitles:TranscriptionJob'
, transcriptionJob_subtitles
- Indicates whether subtitles were generated with your transcription.
$sel:tags:TranscriptionJob'
, transcriptionJob_tags
- The tags, each in the form of a key:value pair, assigned to the
specified transcription job.
$sel:transcript:TranscriptionJob'
, transcriptionJob_transcript
- Provides you with the Amazon S3 URI you can use to access your
transcript.
$sel:transcriptionJobName:TranscriptionJob'
, transcriptionJob_transcriptionJobName
- The name of the transcription job. Job names are case sensitive and must
be unique within an Amazon Web Services account.
$sel:transcriptionJobStatus:TranscriptionJob'
, transcriptionJob_transcriptionJobStatus
- Provides the status of the specified transcription job.
If the status is COMPLETED
, the job is finished and you can find the
results at the location specified in TranscriptFileUri
(or
RedactedTranscriptFileUri
, if you requested transcript redaction). If
the status is FAILED
, FailureReason
provides details on why your
transcription job failed.
transcriptionJob_completionTime :: Lens' TranscriptionJob (Maybe UTCTime) Source #
The date and time the specified transcription job finished processing.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For
example, 2022-05-04T12:33:13.922000-07:00
represents a transcription
job that started processing at 12:33 PM UTC-7 on May 4, 2022.
transcriptionJob_contentRedaction :: Lens' TranscriptionJob (Maybe ContentRedaction) Source #
Indicates whether redaction was enabled in your transcript.
transcriptionJob_creationTime :: Lens' TranscriptionJob (Maybe UTCTime) Source #
The date and time the specified transcription job request was made.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For
example, 2022-05-04T12:32:58.761000-07:00
represents a transcription
job that started processing at 12:32 PM UTC-7 on May 4, 2022.
transcriptionJob_failureReason :: Lens' TranscriptionJob (Maybe Text) Source #
If TranscriptionJobStatus
is FAILED
, FailureReason
contains
information about why the transcription job request failed.
The FailureReason
field contains one of the following values:
Unsupported media format
.The media format specified in
MediaFormat
isn't valid. Refer to MediaFormat for a list of supported formats.The media format provided does not match the detected media format
.The media format specified in
MediaFormat
doesn't match the format of the input file. Check the media format of your media file and correct the specified value.Invalid sample rate for audio file
.The sample rate specified in
MediaSampleRateHertz
isn't valid. The sample rate must be between 8,000 and 48,000 hertz.The sample rate provided does not match the detected sample rate
.The sample rate specified in
MediaSampleRateHertz
doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.Invalid file size: file size too large
.The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Guidelines and quotas.
Invalid number of channels: number of channels too large
.Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Guidelines and quotas.
transcriptionJob_identifiedLanguageScore :: Lens' TranscriptionJob (Maybe Double) Source #
The confidence score associated with the language identified in your media file.
Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.
transcriptionJob_identifyLanguage :: Lens' TranscriptionJob (Maybe Bool) Source #
Indicates whether automatic language identification was enabled (TRUE
)
for the specified transcription job.
transcriptionJob_identifyMultipleLanguages :: Lens' TranscriptionJob (Maybe Bool) Source #
Indicates whether automatic multi-language identification was enabled
(TRUE
) for the specified transcription job.
transcriptionJob_jobExecutionSettings :: Lens' TranscriptionJob (Maybe JobExecutionSettings) Source #
Provides information about how your transcription job was processed. This parameter shows if your request was queued and what data access role was used.
transcriptionJob_languageCode :: Lens' TranscriptionJob (Maybe LanguageCode) Source #
The language code used to create your transcription job. This parameter
is used with single-language identification. For multi-language
identification requests, refer to the plural version of this parameter,
LanguageCodes
.
transcriptionJob_languageCodes :: Lens' TranscriptionJob (Maybe [LanguageCodeItem]) Source #
The language codes used to create your transcription job. This parameter
is used with multi-language identification. For single-language
identification requests, refer to the singular version of this
parameter, LanguageCode
.
transcriptionJob_languageIdSettings :: Lens' TranscriptionJob (Maybe (HashMap LanguageCode LanguageIdSettings)) Source #
Provides the name and language of all custom language models, custom vocabularies, and custom vocabulary filters that you included in your request.
transcriptionJob_languageOptions :: Lens' TranscriptionJob (Maybe (NonEmpty LanguageCode)) Source #
Provides the language codes you specified in your request.
transcriptionJob_media :: Lens' TranscriptionJob (Maybe Media) Source #
Provides the Amazon S3 location of the media file you used in your request.
transcriptionJob_mediaFormat :: Lens' TranscriptionJob (Maybe MediaFormat) Source #
The format of the input media file.
transcriptionJob_mediaSampleRateHertz :: Lens' TranscriptionJob (Maybe Natural) Source #
The sample rate, in hertz, of the audio track in your input media file.
transcriptionJob_modelSettings :: Lens' TranscriptionJob (Maybe ModelSettings) Source #
Provides information on the custom language model you included in your request.
transcriptionJob_settings :: Lens' TranscriptionJob (Maybe Settings) Source #
Provides information on any additional settings that were included in your request. Additional settings include channel identification, alternative transcriptions, speaker partitioning, custom vocabularies, and custom vocabulary filters.
transcriptionJob_startTime :: Lens' TranscriptionJob (Maybe UTCTime) Source #
The date and time the specified transcription job began processing.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For
example, 2022-05-04T12:32:58.789000-07:00
represents a transcription
job that started processing at 12:32 PM UTC-7 on May 4, 2022.
transcriptionJob_subtitles :: Lens' TranscriptionJob (Maybe SubtitlesOutput) Source #
Indicates whether subtitles were generated with your transcription.
transcriptionJob_tags :: Lens' TranscriptionJob (Maybe (NonEmpty Tag)) Source #
The tags, each in the form of a key:value pair, assigned to the specified transcription job.
transcriptionJob_transcript :: Lens' TranscriptionJob (Maybe Transcript) Source #
Provides you with the Amazon S3 URI you can use to access your transcript.
transcriptionJob_transcriptionJobName :: Lens' TranscriptionJob (Maybe Text) Source #
The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.
transcriptionJob_transcriptionJobStatus :: Lens' TranscriptionJob (Maybe TranscriptionJobStatus) Source #
Provides the status of the specified transcription job.
If the status is COMPLETED
, the job is finished and you can find the
results at the location specified in TranscriptFileUri
(or
RedactedTranscriptFileUri
, if you requested transcript redaction). If
the status is FAILED
, FailureReason
provides details on why your
transcription job failed.