com.amazonaws.services.transcribe.model

Class StartTranscriptionJobRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.transcribe.model.StartTranscriptionJobRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartTranscriptionJobRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StartTranscriptionJobRequest()

Method Summary

Modifier and Type	Method and Description
StartTranscriptionJobRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
JobExecutionSettings	getJobExecutionSettings() Provides information about how a transcription job is executed.
String	getLanguageCode() The language code for the language used in the input media file.
Media	getMedia() An object that describes the input media for a transcription job.
String	getMediaFormat() The format of the input media file.
Integer	getMediaSampleRateHertz() The sample rate, in Hertz, of the audio track in the input media file.
String	getOutputBucketName() The location where the transcription is stored.
String	getOutputEncryptionKMSKeyId() The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job.
Settings	getSettings() A Settings object that provides optional settings for a transcription job.
String	getTranscriptionJobName() The name of the job.
int	hashCode()
void	setJobExecutionSettings(JobExecutionSettings jobExecutionSettings) Provides information about how a transcription job is executed.
void	setLanguageCode(String languageCode) The language code for the language used in the input media file.
void	setMedia(Media media) An object that describes the input media for a transcription job.
void	setMediaFormat(String mediaFormat) The format of the input media file.
void	setMediaSampleRateHertz(Integer mediaSampleRateHertz) The sample rate, in Hertz, of the audio track in the input media file.
void	setOutputBucketName(String outputBucketName) The location where the transcription is stored.
void	setOutputEncryptionKMSKeyId(String outputEncryptionKMSKeyId) The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job.
void	setSettings(Settings settings) A Settings object that provides optional settings for a transcription job.
void	setTranscriptionJobName(String transcriptionJobName) The name of the job.
String	toString() Returns a string representation of this object.
StartTranscriptionJobRequest	withJobExecutionSettings(JobExecutionSettings jobExecutionSettings) Provides information about how a transcription job is executed.
StartTranscriptionJobRequest	withLanguageCode(LanguageCode languageCode) The language code for the language used in the input media file.
StartTranscriptionJobRequest	withLanguageCode(String languageCode) The language code for the language used in the input media file.
StartTranscriptionJobRequest	withMedia(Media media) An object that describes the input media for a transcription job.
StartTranscriptionJobRequest	withMediaFormat(MediaFormat mediaFormat) The format of the input media file.
StartTranscriptionJobRequest	withMediaFormat(String mediaFormat) The format of the input media file.
StartTranscriptionJobRequest	withMediaSampleRateHertz(Integer mediaSampleRateHertz) The sample rate, in Hertz, of the audio track in the input media file.
StartTranscriptionJobRequest	withOutputBucketName(String outputBucketName) The location where the transcription is stored.
StartTranscriptionJobRequest	withOutputEncryptionKMSKeyId(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	withSettings(Settings settings) A Settings object that provides optional settings for a transcription job.
StartTranscriptionJobRequest	withTranscriptionJobName(String transcriptionJobName) The name of the job.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartTranscriptionJobRequest

public StartTranscriptionJobRequest()

Method Detail

setTranscriptionJobName

public void setTranscriptionJobName(String transcriptionJobName)

The name of the job. Note that you can't use the strings "." or ".." by themselves as the job name. The name must also be unique within an AWS account.

Parameters:

transcriptionJobName - The name of the job. Note that you can't use the strings "." or ".." by themselves as the job name. The name must also be unique within an AWS account.

getTranscriptionJobName

public String getTranscriptionJobName()

The name of the job. Note that you can't use the strings "." or ".." by themselves as the job name. The name must also be unique within an AWS account.

Returns:

The name of the job. Note that you can't use the strings "." or ".." by themselves as the job name. The name must also be unique within an AWS account.

withTranscriptionJobName

public StartTranscriptionJobRequest withTranscriptionJobName(String transcriptionJobName)

The name of the job. Note that you can't use the strings "." or ".." by themselves as the job name. The name must also be unique within an AWS account.

Parameters:

transcriptionJobName - The name of the job. Note that you can't use the strings "." or ".." by themselves as the job name. The name must also be unique within an AWS account.

Returns:

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

setLanguageCode

public void setLanguageCode(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.

See Also:

LanguageCode

getLanguageCode

public String getLanguageCode()

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

Returns:

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

See Also:

LanguageCode

withLanguageCode

public StartTranscriptionJobRequest withLanguageCode(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

withLanguageCode

public StartTranscriptionJobRequest withLanguageCode(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

setMediaSampleRateHertz

public void setMediaSampleRateHertz(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.

getMediaSampleRateHertz

public Integer getMediaSampleRateHertz()

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.

withMediaSampleRateHertz

public StartTranscriptionJobRequest withMediaSampleRateHertz(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.

setMediaFormat

public void setMediaFormat(String mediaFormat)

The format of the input media file.

Parameters:

mediaFormat - The format of the input media file.

See Also:

MediaFormat

getMediaFormat

public String getMediaFormat()

The format of the input media file.

Returns:

The format of the input media file.

See Also:

MediaFormat

withMediaFormat

public StartTranscriptionJobRequest withMediaFormat(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

withMediaFormat

public StartTranscriptionJobRequest withMediaFormat(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

setMedia

public void setMedia(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.

getMedia

public Media getMedia()

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

Returns:

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

withMedia

public StartTranscriptionJobRequest withMedia(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.

setOutputBucketName

public void setOutputBucketName(String outputBucketName)

The location where the transcription is stored.

If you set the OutputBucketName, Amazon Transcribe puts the transcription in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. 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 transcription in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. 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.

getOutputBucketName

public String getOutputBucketName()

The location where the transcription is stored.

If you set the OutputBucketName, Amazon Transcribe puts the transcription in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. 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 transcription in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. 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.

withOutputBucketName

public StartTranscriptionJobRequest withOutputBucketName(String outputBucketName)

The location where the transcription is stored.

If you set the OutputBucketName, Amazon Transcribe puts the transcription in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. 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 transcription in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. 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.

setOutputEncryptionKMSKeyId

public void setOutputEncryptionKMSKeyId(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.

getOutputEncryptionKMSKeyId

public String getOutputEncryptionKMSKeyId()

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.

withOutputEncryptionKMSKeyId

public StartTranscriptionJobRequest withOutputEncryptionKMSKeyId(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.

setSettings

public void setSettings(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.

getSettings

public Settings getSettings()

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

Returns:

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

withSettings

public StartTranscriptionJobRequest withSettings(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.

setJobExecutionSettings

public void setJobExecutionSettings(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.

getJobExecutionSettings

public JobExecutionSettings getJobExecutionSettings()

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.

withJobExecutionSettings

public StartTranscriptionJobRequest withJobExecutionSettings(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.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StartTranscriptionJobRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()