software.amazon.awssdk.services.transcribe.model

Interface StartTranscriptionJobRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<StartTranscriptionJobRequest.Builder,StartTranscriptionJobRequest>, SdkBuilder<StartTranscriptionJobRequest.Builder,StartTranscriptionJobRequest>, SdkPojo, SdkRequest.Builder, TranscribeRequest.Builder

Enclosing class:

StartTranscriptionJobRequest

public static interface StartTranscriptionJobRequest.Builder
extends TranscribeRequest.Builder, SdkPojo, CopyableBuilder<StartTranscriptionJobRequest.Builder,StartTranscriptionJobRequest>

Method Summary

Modifier and Type	Method and Description
default StartTranscriptionJobRequest.Builder	contentRedaction(Consumer<ContentRedaction.Builder> contentRedaction) An object that contains the request parameters for content redaction.
StartTranscriptionJobRequest.Builder	contentRedaction(ContentRedaction contentRedaction) An object that contains the request parameters for content redaction.
StartTranscriptionJobRequest.Builder	identifyLanguage(Boolean identifyLanguage) Set this field to true to enable automatic language identification.
default StartTranscriptionJobRequest.Builder	jobExecutionSettings(Consumer<JobExecutionSettings.Builder> jobExecutionSettings) Provides information about how a transcription job is executed.
StartTranscriptionJobRequest.Builder	jobExecutionSettings(JobExecutionSettings jobExecutionSettings) Provides information about how a transcription job is executed.
StartTranscriptionJobRequest.Builder	languageCode(LanguageCode languageCode) The language code for the language used in the input media file.
StartTranscriptionJobRequest.Builder	languageCode(String languageCode) The language code for the language used in the input media file.
StartTranscriptionJobRequest.Builder	languageOptions(Collection<LanguageCode> languageOptions) An object containing a list of languages that might be present in your collection of audio files.
StartTranscriptionJobRequest.Builder	languageOptions(LanguageCode... languageOptions) An object containing a list of languages that might be present in your collection of audio files.
StartTranscriptionJobRequest.Builder	languageOptionsWithStrings(Collection<String> languageOptions) An object containing a list of languages that might be present in your collection of audio files.
StartTranscriptionJobRequest.Builder	languageOptionsWithStrings(String... languageOptions) An object containing a list of languages that might be present in your collection of audio files.
default StartTranscriptionJobRequest.Builder	media(Consumer<Media.Builder> media) An object that describes the input media for a transcription job.
StartTranscriptionJobRequest.Builder	media(Media media) An object that describes the input media for a transcription job.
StartTranscriptionJobRequest.Builder	mediaFormat(MediaFormat mediaFormat) The format of the input media file.
StartTranscriptionJobRequest.Builder	mediaFormat(String mediaFormat) The format of the input media file.
StartTranscriptionJobRequest.Builder	mediaSampleRateHertz(Integer mediaSampleRateHertz) The sample rate, in Hertz, of the audio track in the input media file.
default StartTranscriptionJobRequest.Builder	modelSettings(Consumer<ModelSettings.Builder> modelSettings) Choose the custom language model you use for your transcription job in this parameter.
StartTranscriptionJobRequest.Builder	modelSettings(ModelSettings modelSettings) Choose the custom language model you use for your transcription job in this parameter.
StartTranscriptionJobRequest.Builder	outputBucketName(String outputBucketName) The location where the transcription is stored.
StartTranscriptionJobRequest.Builder	outputEncryptionKMSKeyId(String outputEncryptionKMSKeyId) The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job.
StartTranscriptionJobRequest.Builder	outputKey(String outputKey) You can specify a location in an Amazon S3 bucket to store the output of your transcription job.
StartTranscriptionJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
StartTranscriptionJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
default StartTranscriptionJobRequest.Builder	settings(Consumer<Settings.Builder> settings) A Settings object that provides optional settings for a transcription job.
StartTranscriptionJobRequest.Builder	settings(Settings settings) A Settings object that provides optional settings for a transcription job.
StartTranscriptionJobRequest.Builder	transcriptionJobName(String transcriptionJobName) The name of the job.

Methods inherited from interface software.amazon.awssdk.services.transcribe.model.TranscribeRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

transcriptionJobName

StartTranscriptionJobRequest.Builder transcriptionJobName(String transcriptionJobName)

The name of the job. You can't use the strings "." or ".." by themselves as the job name. The name must also be unique within an AWS account. If you try to create a transcription job with the same name as a previous transcription job, you get a ConflictException error.

Parameters:

transcriptionJobName - The name of the job. You can't use the strings "." or ".." by themselves as the job name. The name must also be unique within an AWS account. If you try to create a transcription job with the same name as a previous transcription job, you get a ConflictException error.

Returns:

Returns a reference to this object so that method calls can be chained together.

languageCode

StartTranscriptionJobRequest.Builder languageCode(String languageCode)

The language code for the language used in the input media file.

Parameters:

languageCode - The language code for the language used in the input media file.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LanguageCode, LanguageCode

languageCode

StartTranscriptionJobRequest.Builder languageCode(LanguageCode languageCode)

The language code for the language used in the input media file.

Parameters:

languageCode - The language code for the language used in the input media file.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LanguageCode, LanguageCode

mediaSampleRateHertz

StartTranscriptionJobRequest.Builder mediaSampleRateHertz(Integer mediaSampleRateHertz)

The sample rate, in Hertz, of the audio track in the input media file.

If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you specify the sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe determine the sample rate.

Parameters:

mediaSampleRateHertz - The sample rate, in Hertz, of the audio track in the input media file.

If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you specify the sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe determine the sample rate.

Returns:

Returns a reference to this object so that method calls can be chained together.

mediaFormat

StartTranscriptionJobRequest.Builder mediaFormat(String 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, MediaFormat

mediaFormat

StartTranscriptionJobRequest.Builder mediaFormat(MediaFormat 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, MediaFormat

media

StartTranscriptionJobRequest.Builder media(Media media)

An object that describes the input media for a transcription job.

Parameters:

media - An object that describes the input media for a transcription job.

Returns:

Returns a reference to this object so that method calls can be chained together.

media

default StartTranscriptionJobRequest.Builder media(Consumer<Media.Builder> media)

An object that describes the input media for a transcription job.

This is a convenience that creates an instance of the Media.Builder avoiding the need to create one manually via Media.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to media(Media).

Parameters:

media - a consumer that will call methods on Media.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

media(Media)

outputBucketName

StartTranscriptionJobRequest.Builder outputBucketName(String outputBucketName)

The location where the transcription is stored.

If you set the OutputBucketName, Amazon Transcribe puts the transcript in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri. If you enable content redaction and choose to output an unredacted transcript, that transcript's location still appears in the TranscriptFileUri. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles.

You can specify an AWS Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.

If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription.

Parameters:

outputBucketName - The location where the transcription is stored.

If you set the OutputBucketName, Amazon Transcribe puts the transcript in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri. If you enable content redaction and choose to output an unredacted transcript, that transcript's location still appears in the TranscriptFileUri. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles.

You can specify an AWS Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.

If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription.

Returns:

Returns a reference to this object so that method calls can be chained together.

outputKey

StartTranscriptionJobRequest.Builder outputKey(String outputKey)

You can specify a location in an Amazon S3 bucket to store the output of your transcription job.

If you don't specify an output key, Amazon Transcribe stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is "your-transcription-job-name.json".

You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you specify "my-other-job-name.json" as the output key, the object key is changed to "my-other-job-name.json". You can use an output key to change both the prefix and the file name, for example "folder/my-other-job-name.json".

If you specify an output key, you must also specify an S3 bucket in the OutputBucketName parameter.

Parameters:

outputKey - You can specify a location in an Amazon S3 bucket to store the output of your transcription job.

If you don't specify an output key, Amazon Transcribe stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is "your-transcription-job-name.json".

You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you specify "my-other-job-name.json" as the output key, the object key is changed to "my-other-job-name.json". You can use an output key to change both the prefix and the file name, for example "folder/my-other-job-name.json".

If you specify an output key, you must also specify an S3 bucket in the OutputBucketName parameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

outputEncryptionKMSKeyId

StartTranscriptionJobRequest.Builder outputEncryptionKMSKeyId(String outputEncryptionKMSKeyId)

The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartTranscriptionJob operation must have permission to use the specified KMS key.

You can use either of the following to identify a KMS key in the current account:

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

• KMS Key Alias: "alias/ExampleAlias"

You can use either of the following to identify a KMS key in the current account or another account:

• Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"

• ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"

If you don't specify an encryption key, the output of the transcription job is encrypted with the default Amazon S3 key (SSE-S3).

If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.

Parameters:

outputEncryptionKMSKeyId - The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartTranscriptionJob operation must have permission to use the specified KMS key.

You can use either of the following to identify a KMS key in the current account:

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

• KMS Key Alias: "alias/ExampleAlias"

You can use either of the following to identify a KMS key in the current account or another account:

• Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"

• ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"

If you don't specify an encryption key, the output of the transcription job is encrypted with the default Amazon S3 key (SSE-S3).

If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

settings

StartTranscriptionJobRequest.Builder settings(Settings settings)

A Settings object that provides optional settings for a transcription job.

Parameters:

settings - A Settings object that provides optional settings for a transcription job.

Returns:

Returns a reference to this object so that method calls can be chained together.

settings

default StartTranscriptionJobRequest.Builder settings(Consumer<Settings.Builder> settings)

A Settings object that provides optional settings for a transcription job.

This is a convenience that creates an instance of the Settings.Builder avoiding the need to create one manually via Settings.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to settings(Settings).

Parameters:

settings - a consumer that will call methods on Settings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

settings(Settings)

modelSettings

StartTranscriptionJobRequest.Builder modelSettings(ModelSettings modelSettings)

Choose the custom language model you use for your transcription job in this parameter.

Parameters:

modelSettings - Choose the custom language model you use for your transcription job in this parameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

modelSettings

default StartTranscriptionJobRequest.Builder modelSettings(Consumer<ModelSettings.Builder> modelSettings)

Choose the custom language model you use for your transcription job in this parameter.

This is a convenience that creates an instance of the ModelSettings.Builder avoiding the need to create one manually via ModelSettings.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to modelSettings(ModelSettings).

Parameters:

modelSettings - a consumer that will call methods on ModelSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

modelSettings(ModelSettings)

jobExecutionSettings

StartTranscriptionJobRequest.Builder jobExecutionSettings(JobExecutionSettings jobExecutionSettings)

Provides information about how a transcription job is executed. Use this field to indicate that the job can be queued for deferred execution if the concurrency limit is reached and there are no slots available to immediately run the job.

Parameters:

jobExecutionSettings - Provides information about how a transcription job is executed. Use this field to indicate that the job can be queued for deferred execution if the concurrency limit is reached and there are no slots available to immediately run the job.

Returns:

Returns a reference to this object so that method calls can be chained together.

jobExecutionSettings

default StartTranscriptionJobRequest.Builder jobExecutionSettings(Consumer<JobExecutionSettings.Builder> jobExecutionSettings)

Provides information about how a transcription job is executed. Use this field to indicate that the job can be queued for deferred execution if the concurrency limit is reached and there are no slots available to immediately run the job.

This is a convenience that creates an instance of the JobExecutionSettings.Builder avoiding the need to create one manually via JobExecutionSettings.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to jobExecutionSettings(JobExecutionSettings).

Parameters:

jobExecutionSettings - a consumer that will call methods on JobExecutionSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

jobExecutionSettings(JobExecutionSettings)

contentRedaction

StartTranscriptionJobRequest.Builder contentRedaction(ContentRedaction contentRedaction)

An object that contains the request parameters for content redaction.

Parameters:

contentRedaction - An object that contains the request parameters for content redaction.

Returns:

Returns a reference to this object so that method calls can be chained together.

contentRedaction

default StartTranscriptionJobRequest.Builder contentRedaction(Consumer<ContentRedaction.Builder> contentRedaction)

An object that contains the request parameters for content redaction.

This is a convenience that creates an instance of the ContentRedaction.Builder avoiding the need to create one manually via ContentRedaction.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to contentRedaction(ContentRedaction).

Parameters:

contentRedaction - a consumer that will call methods on ContentRedaction.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

contentRedaction(ContentRedaction)

identifyLanguage

StartTranscriptionJobRequest.Builder identifyLanguage(Boolean identifyLanguage)

Set this field to true to enable automatic language identification. Automatic language identification is disabled by default. You receive a BadRequestException error if you enter a value for a LanguageCode.

Parameters:

identifyLanguage - Set this field to true to enable automatic language identification. Automatic language identification is disabled by default. You receive a BadRequestException error if you enter a value for a LanguageCode.

Returns:

Returns a reference to this object so that method calls can be chained together.

languageOptionsWithStrings

StartTranscriptionJobRequest.Builder languageOptionsWithStrings(Collection<String> languageOptions)

An object containing a list of languages that might be present in your collection of audio files. Automatic language identification chooses a language that best matches the source audio from that list.

Parameters:

languageOptions - An object containing a list of languages that might be present in your collection of audio files. Automatic language identification chooses a language that best matches the source audio from that list.

Returns:

Returns a reference to this object so that method calls can be chained together.

languageOptionsWithStrings

StartTranscriptionJobRequest.Builder languageOptionsWithStrings(String... languageOptions)

An object containing a list of languages that might be present in your collection of audio files. Automatic language identification chooses a language that best matches the source audio from that list.

Parameters:

languageOptions - An object containing a list of languages that might be present in your collection of audio files. Automatic language identification chooses a language that best matches the source audio from that list.

Returns:

Returns a reference to this object so that method calls can be chained together.

languageOptions

StartTranscriptionJobRequest.Builder languageOptions(Collection<LanguageCode> languageOptions)

An object containing a list of languages that might be present in your collection of audio files. Automatic language identification chooses a language that best matches the source audio from that list.

Parameters:

languageOptions - An object containing a list of languages that might be present in your collection of audio files. Automatic language identification chooses a language that best matches the source audio from that list.

Returns:

Returns a reference to this object so that method calls can be chained together.

languageOptions

StartTranscriptionJobRequest.Builder languageOptions(LanguageCode... languageOptions)

An object containing a list of languages that might be present in your collection of audio files. Automatic language identification chooses a language that best matches the source audio from that list.

Parameters:

languageOptions - An object containing a list of languages that might be present in your collection of audio files. Automatic language identification chooses a language that best matches the source audio from that list.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

StartTranscriptionJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

StartTranscriptionJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder