software.amazon.awssdk.services.transcribe.model

Class StartTranscriptionJobRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.transcribe.model.TranscribeRequest

software.amazon.awssdk.services.transcribe.model.StartTranscriptionJobRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartTranscriptionJobRequest.Builder,StartTranscriptionJobRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class StartTranscriptionJobRequest
extends TranscribeRequest
implements ToCopyableBuilder<StartTranscriptionJobRequest.Builder,StartTranscriptionJobRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartTranscriptionJobRequest.Builder

Method Summary

Modifier and Type	Method and Description
static StartTranscriptionJobRequest.Builder	builder()
ContentRedaction	contentRedaction() An object that contains the request parameters for content redaction.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasLanguageOptions() Returns true if the LanguageOptions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Boolean	identifyLanguage() Set this field to true to enable automatic language identification.
JobExecutionSettings	jobExecutionSettings() Provides information about how a transcription job is executed.
LanguageCode	languageCode() The language code for the language used in the input media file.
String	languageCodeAsString() The language code for the language used in the input media file.
List<LanguageCode>	languageOptions() An object containing a list of languages that might be present in your collection of audio files.
List<String>	languageOptionsAsStrings() An object containing a list of languages that might be present in your collection of audio files.
Media	media() An object that describes the input media for a transcription job.
MediaFormat	mediaFormat() The format of the input media file.
String	mediaFormatAsString() The format of the input media file.
Integer	mediaSampleRateHertz() The sample rate, in Hertz, of the audio track in the input media file.
ModelSettings	modelSettings() Choose the custom language model you use for your transcription job in this parameter.
String	outputBucketName() The location where the transcription is stored.
String	outputEncryptionKMSKeyId() The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job.
String	outputKey() You can specify a location in an Amazon S3 bucket to store the output of your transcription job.
List<SdkField<?>>	sdkFields()
static Class<? extends StartTranscriptionJobRequest.Builder>	serializableBuilderClass()
Settings	settings() A Settings object that provides optional settings for a transcription job.
StartTranscriptionJobRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	transcriptionJobName() The name of the job.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

transcriptionJobName

public 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.

Returns:

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.

languageCode

public LanguageCode languageCode()

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

If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

Returns:

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

See Also:

LanguageCode

languageCodeAsString

public String languageCodeAsString()

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

If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

Returns:

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

See Also:

LanguageCode

mediaSampleRateHertz

public 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.

Returns:

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.

mediaFormat

public MediaFormat mediaFormat()

The format of the input media file.

If the service returns an enum value that is not available in the current SDK version, mediaFormat will return MediaFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mediaFormatAsString().

Returns:

The format of the input media file.

See Also:

MediaFormat

mediaFormatAsString

public String mediaFormatAsString()

The format of the input media file.

If the service returns an enum value that is not available in the current SDK version, mediaFormat will return MediaFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mediaFormatAsString().

Returns:

The format of the input media file.

See Also:

MediaFormat

media

public Media media()

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

Returns:

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

outputBucketName

public 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.

Returns:

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.

outputKey

public 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.

Returns:

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.

outputEncryptionKMSKeyId

public 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.

Returns:

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.

settings

public Settings settings()

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

Returns:

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

modelSettings

public ModelSettings modelSettings()

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

Returns:

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

jobExecutionSettings

public 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.

Returns:

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.

contentRedaction

public ContentRedaction contentRedaction()

An object that contains the request parameters for content redaction.

Returns:

An object that contains the request parameters for content redaction.

identifyLanguage

public 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.

Returns:

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.

languageOptions

public List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasLanguageOptions() to see if a value was sent in this field.

Returns:

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.

hasLanguageOptions

public boolean hasLanguageOptions()

Returns true if the LanguageOptions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

languageOptionsAsStrings

public List<String> languageOptionsAsStrings()

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasLanguageOptions() to see if a value was sent in this field.

Returns:

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.

toBuilder

public StartTranscriptionJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartTranscriptionJobRequest.Builder,StartTranscriptionJobRequest>

Specified by:

toBuilder in class TranscribeRequest

builder

public static StartTranscriptionJobRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartTranscriptionJobRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo