@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class StartTranscriptionJobRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP| Constructor and Description |
|---|
StartTranscriptionJobRequest() |
| 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) |
ContentRedaction |
getContentRedaction()
An object that contains the request parameters for content redaction.
|
Boolean |
getIdentifyLanguage()
Set this field to
true to enable automatic language identification. |
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.
|
List<String> |
getLanguageOptions()
An object containing a list of languages that might be present in your collection of audio files.
|
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.
|
ModelSettings |
getModelSettings()
Choose the custom language model you use for your transcription job in this parameter.
|
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.
|
String |
getOutputKey()
You can specify a location in an Amazon S3 bucket to store the output of your transcription job.
|
Settings |
getSettings()
A
Settings object that provides optional settings for a transcription job. |
String |
getTranscriptionJobName()
The name of the job.
|
int |
hashCode() |
Boolean |
isIdentifyLanguage()
Set this field to
true to enable automatic language identification. |
void |
setContentRedaction(ContentRedaction contentRedaction)
An object that contains the request parameters for content redaction.
|
void |
setIdentifyLanguage(Boolean identifyLanguage)
Set this field to
true to enable automatic language identification. |
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 |
setLanguageOptions(Collection<String> languageOptions)
An object containing a list of languages that might be present in your collection of audio files.
|
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 |
setModelSettings(ModelSettings modelSettings)
Choose the custom language model you use for your transcription job in this parameter.
|
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 |
setOutputKey(String outputKey)
You can specify a location in an Amazon S3 bucket to store the output of your 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 |
withContentRedaction(ContentRedaction contentRedaction)
An object that contains the request parameters for content redaction.
|
StartTranscriptionJobRequest |
withIdentifyLanguage(Boolean identifyLanguage)
Set this field to
true to enable automatic language identification. |
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 |
withLanguageOptions(Collection<String> languageOptions)
An object containing a list of languages that might be present in your collection of audio files.
|
StartTranscriptionJobRequest |
withLanguageOptions(LanguageCode... languageOptions)
An object containing a list of languages that might be present in your collection of audio files.
|
StartTranscriptionJobRequest |
withLanguageOptions(String... languageOptions)
An object containing a list of languages that might be present in your collection of audio files.
|
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 |
withModelSettings(ModelSettings modelSettings)
Choose the custom language model you use for your transcription job in this parameter.
|
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 |
withOutputKey(String outputKey)
You can specify a location in an Amazon S3 bucket to store the output of your 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.
|
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, withSdkRequestTimeoutpublic void setTranscriptionJobName(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.
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.public String getTranscriptionJobName()
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.
." 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.public StartTranscriptionJobRequest withTranscriptionJobName(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.
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.public void setLanguageCode(String languageCode)
The language code for the language used in the input media file.
To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16000 Hz or higher.
languageCode - The language code for the language used in the input media file.
To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16000 Hz or higher.
LanguageCodepublic String getLanguageCode()
The language code for the language used in the input media file.
To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16000 Hz or higher.
To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16000 Hz or higher.
LanguageCodepublic StartTranscriptionJobRequest withLanguageCode(String languageCode)
The language code for the language used in the input media file.
To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16000 Hz or higher.
languageCode - The language code for the language used in the input media file.
To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16000 Hz or higher.
LanguageCodepublic StartTranscriptionJobRequest withLanguageCode(LanguageCode languageCode)
The language code for the language used in the input media file.
To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16000 Hz or higher.
languageCode - The language code for the language used in the input media file.
To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16000 Hz or higher.
LanguageCodepublic 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.
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.
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.
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.
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.
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.
public void setMediaFormat(String mediaFormat)
The format of the input media file.
mediaFormat - The format of the input media file.MediaFormatpublic String getMediaFormat()
The format of the input media file.
MediaFormatpublic StartTranscriptionJobRequest withMediaFormat(String mediaFormat)
The format of the input media file.
mediaFormat - The format of the input media file.MediaFormatpublic StartTranscriptionJobRequest withMediaFormat(MediaFormat mediaFormat)
The format of the input media file.
mediaFormat - The format of the input media file.MediaFormatpublic void setMedia(Media media)
An object that describes the input media for a transcription job.
media - An object that describes the input media for a transcription job.public Media getMedia()
An object that describes the input media for a transcription job.
public StartTranscriptionJobRequest withMedia(Media media)
An object that describes the input media for a transcription job.
media - An object that describes the input media for a transcription job.public void setOutputBucketName(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.
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.
public String getOutputBucketName()
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.
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.
public StartTranscriptionJobRequest withOutputBucketName(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.
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.
public void setOutputKey(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.
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.
public String getOutputKey()
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.
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.
public StartTranscriptionJobRequest withOutputKey(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.
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.
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.
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.
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.
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.
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.
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.
public void setSettings(Settings settings)
A Settings object that provides optional settings for a transcription job.
settings - A Settings object that provides optional settings for a transcription job.public Settings getSettings()
A Settings object that provides optional settings for a transcription job.
Settings object that provides optional settings for a transcription job.public StartTranscriptionJobRequest withSettings(Settings settings)
A Settings object that provides optional settings for a transcription job.
settings - A Settings object that provides optional settings for a transcription job.public void setModelSettings(ModelSettings modelSettings)
Choose the custom language model you use for your transcription job in this parameter.
modelSettings - Choose the custom language model you use for your transcription job in this parameter.public ModelSettings getModelSettings()
Choose the custom language model you use for your transcription job in this parameter.
public StartTranscriptionJobRequest withModelSettings(ModelSettings modelSettings)
Choose the custom language model you use for your transcription job in this parameter.
modelSettings - Choose the custom language model you use for your transcription job in this parameter.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.
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.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.
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.
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.public void setContentRedaction(ContentRedaction contentRedaction)
An object that contains the request parameters for content redaction.
contentRedaction - An object that contains the request parameters for content redaction.public ContentRedaction getContentRedaction()
An object that contains the request parameters for content redaction.
public StartTranscriptionJobRequest withContentRedaction(ContentRedaction contentRedaction)
An object that contains the request parameters for content redaction.
contentRedaction - An object that contains the request parameters for content redaction.public void setIdentifyLanguage(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.
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.public Boolean getIdentifyLanguage()
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.
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.public StartTranscriptionJobRequest withIdentifyLanguage(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.
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.public Boolean isIdentifyLanguage()
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.
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.public List<String> getLanguageOptions()
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.
LanguageCodepublic void setLanguageOptions(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.
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.LanguageCodepublic StartTranscriptionJobRequest withLanguageOptions(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.
NOTE: This method appends the values to the existing list (if any). Use
setLanguageOptions(java.util.Collection) or withLanguageOptions(java.util.Collection) if you
want to override the existing values.
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.LanguageCodepublic StartTranscriptionJobRequest withLanguageOptions(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.
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.LanguageCodepublic StartTranscriptionJobRequest withLanguageOptions(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.
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.LanguageCodepublic String toString()
toString in class ObjectObject.toString()public StartTranscriptionJobRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()