Interface TranscriptionJob.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<TranscriptionJob.Builder,
,TranscriptionJob> SdkBuilder<TranscriptionJob.Builder,
,TranscriptionJob> SdkPojo
- Enclosing class:
TranscriptionJob
-
Method Summary
Modifier and TypeMethodDescriptioncompletionTime
(Instant completionTime) The date and time the specified transcription job finished processing.default TranscriptionJob.Builder
contentRedaction
(Consumer<ContentRedaction.Builder> contentRedaction) Indicates whether redaction was enabled in your transcript.contentRedaction
(ContentRedaction contentRedaction) Indicates whether redaction was enabled in your transcript.creationTime
(Instant creationTime) The date and time the specified transcription job request was made.failureReason
(String failureReason) IfTranscriptionJobStatus
isFAILED
,FailureReason
contains information about why the transcription job request failed.identifiedLanguageScore
(Float identifiedLanguageScore) The confidence score associated with the language identified in your media file.identifyLanguage
(Boolean identifyLanguage) Indicates whether automatic language identification was enabled (TRUE
) for the specified transcription job.identifyMultipleLanguages
(Boolean identifyMultipleLanguages) Indicates whether automatic multi-language identification was enabled (TRUE
) for the specified transcription job.default TranscriptionJob.Builder
jobExecutionSettings
(Consumer<JobExecutionSettings.Builder> jobExecutionSettings) Provides information about how your transcription job was processed.jobExecutionSettings
(JobExecutionSettings jobExecutionSettings) Provides information about how your transcription job was processed.languageCode
(String languageCode) The language code used to create your transcription job.languageCode
(LanguageCode languageCode) The language code used to create your transcription job.languageCodes
(Collection<LanguageCodeItem> languageCodes) The language codes used to create your transcription job.languageCodes
(Consumer<LanguageCodeItem.Builder>... languageCodes) The language codes used to create your transcription job.languageCodes
(LanguageCodeItem... languageCodes) The language codes used to create your transcription job.languageIdSettings
(Map<LanguageCode, LanguageIdSettings> languageIdSettings) Provides the name and language of all custom language models, custom vocabularies, and custom vocabulary filters that you included in your request.languageIdSettingsWithStrings
(Map<String, LanguageIdSettings> languageIdSettings) Provides the name and language of all custom language models, custom vocabularies, and custom vocabulary filters that you included in your request.languageOptions
(Collection<LanguageCode> languageOptions) Provides the language codes you specified in your request.languageOptions
(LanguageCode... languageOptions) Provides the language codes you specified in your request.languageOptionsWithStrings
(String... languageOptions) Provides the language codes you specified in your request.languageOptionsWithStrings
(Collection<String> languageOptions) Provides the language codes you specified in your request.default TranscriptionJob.Builder
media
(Consumer<Media.Builder> media) Provides the Amazon S3 location of the media file you used in your request.Provides the Amazon S3 location of the media file you used in your request.mediaFormat
(String mediaFormat) The format of the input media file.mediaFormat
(MediaFormat mediaFormat) The format of the input media file.mediaSampleRateHertz
(Integer mediaSampleRateHertz) The sample rate, in hertz, of the audio track in your input media file.default TranscriptionJob.Builder
modelSettings
(Consumer<ModelSettings.Builder> modelSettings) Provides information on the custom language model you included in your request.modelSettings
(ModelSettings modelSettings) Provides information on the custom language model you included in your request.default TranscriptionJob.Builder
settings
(Consumer<Settings.Builder> settings) Provides information on any additional settings that were included in your request.Provides information on any additional settings that were included in your request.The date and time the specified transcription job began processing.default TranscriptionJob.Builder
subtitles
(Consumer<SubtitlesOutput.Builder> subtitles) Indicates whether subtitles were generated with your transcription.subtitles
(SubtitlesOutput subtitles) Indicates whether subtitles were generated with your transcription.tags
(Collection<Tag> tags) The tags, each in the form of a key:value pair, assigned to the specified transcription job.tags
(Consumer<Tag.Builder>... tags) The tags, each in the form of a key:value pair, assigned to the specified transcription job.The tags, each in the form of a key:value pair, assigned to the specified transcription job.toxicityDetection
(Collection<ToxicityDetectionSettings> toxicityDetection) Provides information about the toxicity detection settings applied to your transcription.toxicityDetection
(Consumer<ToxicityDetectionSettings.Builder>... toxicityDetection) Provides information about the toxicity detection settings applied to your transcription.toxicityDetection
(ToxicityDetectionSettings... toxicityDetection) Provides information about the toxicity detection settings applied to your transcription.default TranscriptionJob.Builder
transcript
(Consumer<Transcript.Builder> transcript) Provides you with the Amazon S3 URI you can use to access your transcript.transcript
(Transcript transcript) Provides you with the Amazon S3 URI you can use to access your transcript.transcriptionJobName
(String transcriptionJobName) The name of the transcription job.transcriptionJobStatus
(String transcriptionJobStatus) Provides the status of the specified transcription job.transcriptionJobStatus
(TranscriptionJobStatus transcriptionJobStatus) Provides the status of the specified transcription job.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
transcriptionJobName
The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.
- Parameters:
transcriptionJobName
- The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 inTranscriptFileUri
(orRedactedTranscriptFileUri
, if you requested transcript redaction). If the status isFAILED
,FailureReason
provides details on why your transcription job failed.- Parameters:
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 inTranscriptFileUri
(orRedactedTranscriptFileUri
, if you requested transcript redaction). If the status isFAILED
,FailureReason
provides details on why your transcription job failed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 inTranscriptFileUri
(orRedactedTranscriptFileUri
, if you requested transcript redaction). If the status isFAILED
,FailureReason
provides details on why your transcription job failed.- Parameters:
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 inTranscriptFileUri
(orRedactedTranscriptFileUri
, if you requested transcript redaction). If the status isFAILED
,FailureReason
provides details on why your transcription job failed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
.- Parameters:
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
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
.- Parameters:
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
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
mediaSampleRateHertz
The sample rate, in hertz, of the audio track in your input media file.
- Parameters:
mediaSampleRateHertz
- The sample rate, in hertz, of the audio track in your input media file.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mediaFormat
The format of the input media file.
- Parameters:
mediaFormat
- The format of the input media file.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
mediaFormat
The format of the input media file.
- Parameters:
mediaFormat
- The format of the input media file.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
media
Provides the Amazon S3 location of the media file you used in your request.
- Parameters:
media
- Provides the Amazon S3 location of the media file you used in your request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
media
Provides the Amazon S3 location of the media file you used in your request.
This is a convenience method that creates an instance of theMedia.Builder
avoiding the need to create one manually viaMedia.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomedia(Media)
.- Parameters:
media
- a consumer that will call methods onMedia.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
transcript
Provides you with the Amazon S3 URI you can use to access your transcript.
- Parameters:
transcript
- Provides you with the Amazon S3 URI you can use to access your transcript.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
transcript
Provides you with the Amazon S3 URI you can use to access your transcript.
This is a convenience method that creates an instance of theTranscript.Builder
avoiding the need to create one manually viaTranscript.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totranscript(Transcript)
.- Parameters:
transcript
- a consumer that will call methods onTranscript.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
failureReason
If
TranscriptionJobStatus
isFAILED
,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 refer to theMediaFormat
parameter 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 Service 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 Service quotas.
- Parameters:
failureReason
- IfTranscriptionJobStatus
isFAILED
,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 refer to theMediaFormat
parameter 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 Service 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 Service quotas.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
This is a convenience method that creates an instance of theSettings.Builder
avoiding the need to create one manually viaSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosettings(Settings)
.- Parameters:
settings
- a consumer that will call methods onSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
modelSettings
Provides information on the custom language model you included in your request.
- Parameters:
modelSettings
- Provides information on the custom language model you included in your request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
modelSettings
Provides information on the custom language model you included in your request.
This is a convenience method that creates an instance of theModelSettings.Builder
avoiding the need to create one manually viaModelSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomodelSettings(ModelSettings)
.- Parameters:
modelSettings
- a consumer that will call methods onModelSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
jobExecutionSettings
default TranscriptionJob.Builder jobExecutionSettings(Consumer<JobExecutionSettings.Builder> 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.
This is a convenience method that creates an instance of theJobExecutionSettings.Builder
avoiding the need to create one manually viaJobExecutionSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tojobExecutionSettings(JobExecutionSettings)
.- Parameters:
jobExecutionSettings
- a consumer that will call methods onJobExecutionSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
contentRedaction
Indicates whether redaction was enabled in your transcript.
- Parameters:
contentRedaction
- Indicates whether redaction was enabled in your transcript.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
contentRedaction
default TranscriptionJob.Builder contentRedaction(Consumer<ContentRedaction.Builder> contentRedaction) Indicates whether redaction was enabled in your transcript.
This is a convenience method that creates an instance of theContentRedaction.Builder
avoiding the need to create one manually viaContentRedaction.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocontentRedaction(ContentRedaction)
.- Parameters:
contentRedaction
- a consumer that will call methods onContentRedaction.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
identifyLanguage
Indicates whether automatic language identification was enabled (
TRUE
) for the specified transcription job.- Parameters:
identifyLanguage
- Indicates whether automatic language identification was enabled (TRUE
) for the specified transcription job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
identifyMultipleLanguages
Indicates whether automatic multi-language identification was enabled (
TRUE
) for the specified transcription job.- Parameters:
identifyMultipleLanguages
- Indicates whether automatic multi-language identification was enabled (TRUE
) for the specified transcription job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
languageOptionsWithStrings
Provides the language codes you specified in your request.
- Parameters:
languageOptions
- Provides the language codes you specified in your request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
languageOptionsWithStrings
Provides the language codes you specified in your request.
- Parameters:
languageOptions
- Provides the language codes you specified in your request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
languageOptions
Provides the language codes you specified in your request.
- Parameters:
languageOptions
- Provides the language codes you specified in your request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
languageOptions
Provides the language codes you specified in your request.
- Parameters:
languageOptions
- Provides the language codes you specified in your request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
.- Parameters:
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
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
.- Parameters:
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
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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,
This is a convenience method that creates an instance of theLanguageCode
.LanguageCodeItem.Builder
avoiding the need to create one manually viaLanguageCodeItem.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tolanguageCodes(List<LanguageCodeItem>)
.- Parameters:
languageCodes
- a consumer that will call methods onLanguageCodeItem.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tags
The tags, each in the form of a key:value pair, assigned to the specified transcription job.
- Parameters:
tags
- The tags, each in the form of a key:value pair, assigned to the specified transcription job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
The tags, each in the form of a key:value pair, assigned to the specified transcription job.
- Parameters:
tags
- The tags, each in the form of a key:value pair, assigned to the specified transcription job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
The tags, each in the form of a key:value pair, assigned to the specified transcription job.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
subtitles
Indicates whether subtitles were generated with your transcription.
- Parameters:
subtitles
- Indicates whether subtitles were generated with your transcription.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subtitles
Indicates whether subtitles were generated with your transcription.
This is a convenience method that creates an instance of theSubtitlesOutput.Builder
avoiding the need to create one manually viaSubtitlesOutput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosubtitles(SubtitlesOutput)
.- Parameters:
subtitles
- a consumer that will call methods onSubtitlesOutput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
languageIdSettingsWithStrings
TranscriptionJob.Builder languageIdSettingsWithStrings(Map<String, LanguageIdSettings> languageIdSettings) Provides the name and language of all custom language models, custom vocabularies, and custom vocabulary filters that you included in your request.
- Parameters:
languageIdSettings
- Provides the name and language of all custom language models, custom vocabularies, and custom vocabulary filters that you included in your request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
languageIdSettings
TranscriptionJob.Builder languageIdSettings(Map<LanguageCode, LanguageIdSettings> languageIdSettings) Provides the name and language of all custom language models, custom vocabularies, and custom vocabulary filters that you included in your request.
- Parameters:
languageIdSettings
- Provides the name and language of all custom language models, custom vocabularies, and custom vocabulary filters that you included in your request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toxicityDetection
Provides information about the toxicity detection settings applied to your transcription.
- Parameters:
toxicityDetection
- Provides information about the toxicity detection settings applied to your transcription.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toxicityDetection
Provides information about the toxicity detection settings applied to your transcription.
- Parameters:
toxicityDetection
- Provides information about the toxicity detection settings applied to your transcription.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toxicityDetection
TranscriptionJob.Builder toxicityDetection(Consumer<ToxicityDetectionSettings.Builder>... toxicityDetection) Provides information about the toxicity detection settings applied to your transcription.
This is a convenience method that creates an instance of theToxicityDetectionSettings.Builder
avoiding the need to create one manually viaToxicityDetectionSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totoxicityDetection(List<ToxicityDetectionSettings>)
.- Parameters:
toxicityDetection
- a consumer that will call methods onToxicityDetectionSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-