StartTranscriptionJobRequest (AWS SDK for Java

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()

Constructors
Constructor and Description
`StartTranscriptionJobRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StartTranscriptionJobRequest`	`addKMSEncryptionContextEntry(String key, String value)` Add a single KMSEncryptionContext entry
`StartTranscriptionJobRequest`	`addLanguageIdSettingsEntry(String key, LanguageIdSettings value)` Add a single LanguageIdSettings entry
`StartTranscriptionJobRequest`	`clearKMSEncryptionContextEntries()` Removes all the entries added into KMSEncryptionContext.
`StartTranscriptionJobRequest`	`clearLanguageIdSettingsEntries()` Removes all the entries added into LanguageIdSettings.
`StartTranscriptionJobRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`ContentRedaction`	`getContentRedaction()` Makes it possible to redact or flag specified personally identifiable information (PII) in your transcript.
`Boolean`	`getIdentifyLanguage()` Enables automatic language identification in your transcription job request.
`Boolean`	`getIdentifyMultipleLanguages()` Enables automatic multi-language identification in your transcription job request.
`JobExecutionSettings`	`getJobExecutionSettings()` Makes it possible to control how your transcription job is processed.
`Map<String,String>`	`getKMSEncryptionContext()` A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data.
`String`	`getLanguageCode()` The language code that represents the language spoken in the input media file.
`Map<String,LanguageIdSettings>`	`getLanguageIdSettings()` If using automatic language identification in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include `LanguageIdSettings` with the relevant sub-parameters (`VocabularyName`, `LanguageModelName`, and `VocabularyFilterName`).
`List<String>`	`getLanguageOptions()` You can specify two or more language codes that represent the languages you think may be present in your media.
`Media`	`getMedia()` Describes the Amazon S3 location of the media file you want to use in your request.
`String`	`getMediaFormat()` Specify the format of your input media file.
`Integer`	`getMediaSampleRateHertz()` The sample rate, in hertz, of the audio track in your input media file.
`ModelSettings`	`getModelSettings()` Specify the custom language model you want to include with your transcription job.
`String`	`getOutputBucketName()` The name of the Amazon S3 bucket where you want your transcription output stored.
`String`	`getOutputEncryptionKMSKeyId()` The KMS key you want to use to encrypt your transcription output.
`String`	`getOutputKey()` Use in combination with `OutputBucketName` to specify the output location of your transcript and, optionally, a unique name for your output file.
`Settings`	`getSettings()` Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker partitioning.
`Subtitles`	`getSubtitles()` Produces subtitle files for your input media.
`List<Tag>`	`getTags()` Adds one or more custom tags, each in the form of a key:value pair, to a new transcription job at the time you start this new job.
`List<ToxicityDetectionSettings>`	`getToxicityDetection()` Enables toxic speech detection in your transcript.
`String`	`getTranscriptionJobName()` A unique name, chosen by you, for your transcription job.
`int`	`hashCode()`
`Boolean`	`isIdentifyLanguage()` Enables automatic language identification in your transcription job request.
`Boolean`	`isIdentifyMultipleLanguages()` Enables automatic multi-language identification in your transcription job request.
`void`	`setContentRedaction(ContentRedaction contentRedaction)` Makes it possible to redact or flag specified personally identifiable information (PII) in your transcript.
`void`	`setIdentifyLanguage(Boolean identifyLanguage)` Enables automatic language identification in your transcription job request.
`void`	`setIdentifyMultipleLanguages(Boolean identifyMultipleLanguages)` Enables automatic multi-language identification in your transcription job request.
`void`	`setJobExecutionSettings(JobExecutionSettings jobExecutionSettings)` Makes it possible to control how your transcription job is processed.
`void`	`setKMSEncryptionContext(Map<String,String> kMSEncryptionContext)` A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data.
`void`	`setLanguageCode(String languageCode)` The language code that represents the language spoken in the input media file.
`void`	`setLanguageIdSettings(Map<String,LanguageIdSettings> languageIdSettings)` If using automatic language identification in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include `LanguageIdSettings` with the relevant sub-parameters (`VocabularyName`, `LanguageModelName`, and `VocabularyFilterName`).
`void`	`setLanguageOptions(Collection<String> languageOptions)` You can specify two or more language codes that represent the languages you think may be present in your media.
`void`	`setMedia(Media media)` Describes the Amazon S3 location of the media file you want to use in your request.
`void`	`setMediaFormat(String mediaFormat)` Specify the format of your input media file.
`void`	`setMediaSampleRateHertz(Integer mediaSampleRateHertz)` The sample rate, in hertz, of the audio track in your input media file.
`void`	`setModelSettings(ModelSettings modelSettings)` Specify the custom language model you want to include with your transcription job.
`void`	`setOutputBucketName(String outputBucketName)` The name of the Amazon S3 bucket where you want your transcription output stored.
`void`	`setOutputEncryptionKMSKeyId(String outputEncryptionKMSKeyId)` The KMS key you want to use to encrypt your transcription output.
`void`	`setOutputKey(String outputKey)` Use in combination with `OutputBucketName` to specify the output location of your transcript and, optionally, a unique name for your output file.
`void`	`setSettings(Settings settings)` Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker partitioning.
`void`	`setSubtitles(Subtitles subtitles)` Produces subtitle files for your input media.
`void`	`setTags(Collection<Tag> tags)` Adds one or more custom tags, each in the form of a key:value pair, to a new transcription job at the time you start this new job.
`void`	`setToxicityDetection(Collection<ToxicityDetectionSettings> toxicityDetection)` Enables toxic speech detection in your transcript.
`void`	`setTranscriptionJobName(String transcriptionJobName)` A unique name, chosen by you, for your transcription job.
`String`	`toString()` Returns a string representation of this object.
`StartTranscriptionJobRequest`	`withContentRedaction(ContentRedaction contentRedaction)` Makes it possible to redact or flag specified personally identifiable information (PII) in your transcript.
`StartTranscriptionJobRequest`	`withIdentifyLanguage(Boolean identifyLanguage)` Enables automatic language identification in your transcription job request.
`StartTranscriptionJobRequest`	`withIdentifyMultipleLanguages(Boolean identifyMultipleLanguages)` Enables automatic multi-language identification in your transcription job request.
`StartTranscriptionJobRequest`	`withJobExecutionSettings(JobExecutionSettings jobExecutionSettings)` Makes it possible to control how your transcription job is processed.
`StartTranscriptionJobRequest`	`withKMSEncryptionContext(Map<String,String> kMSEncryptionContext)` A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data.
`StartTranscriptionJobRequest`	`withLanguageCode(LanguageCode languageCode)` The language code that represents the language spoken in the input media file.
`StartTranscriptionJobRequest`	`withLanguageCode(String languageCode)` The language code that represents the language spoken in the input media file.
`StartTranscriptionJobRequest`	`withLanguageIdSettings(Map<String,LanguageIdSettings> languageIdSettings)` If using automatic language identification in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include `LanguageIdSettings` with the relevant sub-parameters (`VocabularyName`, `LanguageModelName`, and `VocabularyFilterName`).
`StartTranscriptionJobRequest`	`withLanguageOptions(Collection<String> languageOptions)` You can specify two or more language codes that represent the languages you think may be present in your media.
`StartTranscriptionJobRequest`	`withLanguageOptions(LanguageCode... languageOptions)` You can specify two or more language codes that represent the languages you think may be present in your media.
`StartTranscriptionJobRequest`	`withLanguageOptions(String... languageOptions)` You can specify two or more language codes that represent the languages you think may be present in your media.
`StartTranscriptionJobRequest`	`withMedia(Media media)` Describes the Amazon S3 location of the media file you want to use in your request.
`StartTranscriptionJobRequest`	`withMediaFormat(MediaFormat mediaFormat)` Specify the format of your input media file.
`StartTranscriptionJobRequest`	`withMediaFormat(String mediaFormat)` Specify the format of your input media file.
`StartTranscriptionJobRequest`	`withMediaSampleRateHertz(Integer mediaSampleRateHertz)` The sample rate, in hertz, of the audio track in your input media file.
`StartTranscriptionJobRequest`	`withModelSettings(ModelSettings modelSettings)` Specify the custom language model you want to include with your transcription job.
`StartTranscriptionJobRequest`	`withOutputBucketName(String outputBucketName)` The name of the Amazon S3 bucket where you want your transcription output stored.
`StartTranscriptionJobRequest`	`withOutputEncryptionKMSKeyId(String outputEncryptionKMSKeyId)` The KMS key you want to use to encrypt your transcription output.
`StartTranscriptionJobRequest`	`withOutputKey(String outputKey)` Use in combination with `OutputBucketName` to specify the output location of your transcript and, optionally, a unique name for your output file.
`StartTranscriptionJobRequest`	`withSettings(Settings settings)` Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker partitioning.
`StartTranscriptionJobRequest`	`withSubtitles(Subtitles subtitles)` Produces subtitle files for your input media.
`StartTranscriptionJobRequest`	`withTags(Collection<Tag> tags)` Adds one or more custom tags, each in the form of a key:value pair, to a new transcription job at the time you start this new job.
`StartTranscriptionJobRequest`	`withTags(Tag... tags)` Adds one or more custom tags, each in the form of a key:value pair, to a new transcription job at the time you start this new job.
`StartTranscriptionJobRequest`	`withToxicityDetection(Collection<ToxicityDetectionSettings> toxicityDetection)` Enables toxic speech detection in your transcript.
`StartTranscriptionJobRequest`	`withToxicityDetection(ToxicityDetectionSettings... toxicityDetection)` Enables toxic speech detection in your transcript.
`StartTranscriptionJobRequest`	`withTranscriptionJobName(String transcriptionJobName)` A unique name, chosen by you, for your transcription job.

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)
```
    A unique name, chosen by you, for your transcription job. The name that you specify is also used as the default name of your transcription output file. If you want to specify a different name for your transcription output, use the OutputKey parameter.
    
    This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new job with the same name as an existing job, you get a ConflictException error.
    
    Parameters:
    
    transcriptionJobName - A unique name, chosen by you, for your transcription job. The name that you specify is also used as the default name of your transcription output file. If you want to specify a different name for your transcription output, use the OutputKey parameter.
    
    This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new job with the same name as an existing job, you get a ConflictException error.
  - getTranscriptionJobName
```
public String getTranscriptionJobName()
```
    A unique name, chosen by you, for your transcription job. The name that you specify is also used as the default name of your transcription output file. If you want to specify a different name for your transcription output, use the OutputKey parameter.
    
    This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new job with the same name as an existing job, you get a ConflictException error.
    
    Returns:
    
    A unique name, chosen by you, for your transcription job. The name that you specify is also used as the default name of your transcription output file. If you want to specify a different name for your transcription output, use the OutputKey parameter.
    
    This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new job with the same name as an existing job, you get a ConflictException error.
  - withTranscriptionJobName
```
public StartTranscriptionJobRequest withTranscriptionJobName(String transcriptionJobName)
```
    A unique name, chosen by you, for your transcription job. The name that you specify is also used as the default name of your transcription output file. If you want to specify a different name for your transcription output, use the OutputKey parameter.
    
    This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new job with the same name as an existing job, you get a ConflictException error.
    
    Parameters:
    
    transcriptionJobName - A unique name, chosen by you, for your transcription job. The name that you specify is also used as the default name of your transcription output file. If you want to specify a different name for your transcription output, use the OutputKey parameter.
    
    This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new job with the same name as an existing job, you get a ConflictException error.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLanguageCode
```
public void setLanguageCode(String languageCode)
```
    The language code that represents the language spoken in the input media file.
    
    If you're unsure of the language spoken in your media file, consider using IdentifyLanguage or IdentifyMultipleLanguages to enable automatic language identification.
    
    Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.
    
    For a list of supported languages and their associated language codes, refer to the Supported languages table.
    
    To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher.
    
    Parameters:
    
    languageCode - The language code that represents the language spoken in the input media file.
    
    If you're unsure of the language spoken in your media file, consider using IdentifyLanguage or IdentifyMultipleLanguages to enable automatic language identification.
    
    Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.
    
    For a list of supported languages and their associated language codes, refer to the Supported languages table.
    
    To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher.
    
    See Also:
    
    LanguageCode
  - getLanguageCode
```
public String getLanguageCode()
```
    The language code that represents the language spoken in the input media file.
    
    If you're unsure of the language spoken in your media file, consider using IdentifyLanguage or IdentifyMultipleLanguages to enable automatic language identification.
    
    Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.
    
    For a list of supported languages and their associated language codes, refer to the Supported languages table.
    
    To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher.
    
    Returns:
    
    The language code that represents the language spoken in the input media file.
    
    If you're unsure of the language spoken in your media file, consider using IdentifyLanguage or IdentifyMultipleLanguages to enable automatic language identification.
    
    Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.
    
    For a list of supported languages and their associated language codes, refer to the Supported languages table.
    
    To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher.
    
    See Also:
    
    LanguageCode
  - withLanguageCode
```
public StartTranscriptionJobRequest withLanguageCode(String languageCode)
```
    The language code that represents the language spoken in the input media file.
    
    If you're unsure of the language spoken in your media file, consider using IdentifyLanguage or IdentifyMultipleLanguages to enable automatic language identification.
    
    Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.
    
    For a list of supported languages and their associated language codes, refer to the Supported languages table.
    
    To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher.
    
    Parameters:
    
    languageCode - The language code that represents the language spoken in the input media file.
    
    If you're unsure of the language spoken in your media file, consider using IdentifyLanguage or IdentifyMultipleLanguages to enable automatic language identification.
    
    Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.
    
    For a list of supported languages and their associated language codes, refer to the Supported languages table.
    
    To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher.
    
    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 that represents the language spoken in the input media file.
    
    If you're unsure of the language spoken in your media file, consider using IdentifyLanguage or IdentifyMultipleLanguages to enable automatic language identification.
    
    Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.
    
    For a list of supported languages and their associated language codes, refer to the Supported languages table.
    
    To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher.
    
    Parameters:
    
    languageCode - The language code that represents the language spoken in the input media file.
    
    If you're unsure of the language spoken in your media file, consider using IdentifyLanguage or IdentifyMultipleLanguages to enable automatic language identification.
    
    Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.
    
    For a list of supported languages and their associated language codes, refer to the Supported languages table.
    
    To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher.
    
    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 your input media file.
    
    If you do not specify the media sample rate, Amazon Transcribe determines it for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe. If there's a mismatch between the value that you specify and the value detected, your job fails. In most cases, you can omit MediaSampleRateHertz and let Amazon Transcribe determine the sample rate.
    
    Parameters:
    
    mediaSampleRateHertz - The sample rate, in hertz, of the audio track in your input media file.
    
    If you do not specify the media sample rate, Amazon Transcribe determines it for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe. If there's a mismatch between the value that you specify and the value detected, your job fails. In most cases, you can omit MediaSampleRateHertz and let Amazon Transcribe determine the sample rate.
  - getMediaSampleRateHertz
```
public Integer getMediaSampleRateHertz()
```
    The sample rate, in hertz, of the audio track in your input media file.
    
    If you do not specify the media sample rate, Amazon Transcribe determines it for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe. If there's a mismatch between the value that you specify and the value detected, your job fails. In most cases, you can omit MediaSampleRateHertz and let Amazon Transcribe determine the sample rate.
    
    Returns:
    
    The sample rate, in hertz, of the audio track in your input media file.
    
    If you do not specify the media sample rate, Amazon Transcribe determines it for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe. If there's a mismatch between the value that you specify and the value detected, your job fails. In most cases, you can omit MediaSampleRateHertz and let Amazon Transcribe determine the sample rate.
  - withMediaSampleRateHertz
```
public StartTranscriptionJobRequest withMediaSampleRateHertz(Integer mediaSampleRateHertz)
```
    The sample rate, in hertz, of the audio track in your input media file.
    
    If you do not specify the media sample rate, Amazon Transcribe determines it for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe. If there's a mismatch between the value that you specify and the value detected, your job fails. In most cases, you can omit MediaSampleRateHertz and let Amazon Transcribe determine the sample rate.
    
    Parameters:
    
    mediaSampleRateHertz - The sample rate, in hertz, of the audio track in your input media file.
    
    If you do not specify the media sample rate, Amazon Transcribe determines it for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe. If there's a mismatch between the value that you specify and the value detected, your job fails. In most cases, you can omit MediaSampleRateHertz 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)
```
    Specify the format of your input media file.
    
    Parameters:
    
    mediaFormat - Specify the format of your input media file.
    
    See Also:
    
    MediaFormat
  - getMediaFormat
```
public String getMediaFormat()
```
    Specify the format of your input media file.
    
    Returns:
    
    Specify the format of your input media file.
    
    See Also:
    
    MediaFormat
  - withMediaFormat
```
public StartTranscriptionJobRequest withMediaFormat(String mediaFormat)
```
    Specify the format of your input media file.
    
    Parameters:
    
    mediaFormat - Specify the format of your 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)
```
    Specify the format of your input media file.
    
    Parameters:
    
    mediaFormat - Specify the format of your 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)
```
    Describes the Amazon S3 location of the media file you want to use in your request.
    
    Parameters:
    
    media - Describes the Amazon S3 location of the media file you want to use in your request.
  - getMedia
```
public Media getMedia()
```
    Describes the Amazon S3 location of the media file you want to use in your request.
    
    Returns:
    
    Describes the Amazon S3 location of the media file you want to use in your request.
  - withMedia
```
public StartTranscriptionJobRequest withMedia(Media media)
```
    Describes the Amazon S3 location of the media file you want to use in your request.
    
    Parameters:
    
    media - Describes the Amazon S3 location of the media file you want to use in your request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOutputBucketName
```
public void setOutputBucketName(String outputBucketName)
```
    The name of the Amazon S3 bucket where you want your transcription output stored. Do not include the S3:// prefix of the specified bucket.
    
    If you want your output to go to a sub-folder of this bucket, specify it using the OutputKey parameter; OutputBucketName only accepts the name of a bucket.
    
    For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET, set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to DOC-EXAMPLE-BUCKET and OutputKey to test-files/.
    
    Note that Amazon Transcribe must have permission to use the specified location. You can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.
    
    If you do not specify OutputBucketName, your transcript is placed in a service-managed Amazon S3 bucket and you are provided with a URI to access your transcript.
    
    Parameters:
    
    outputBucketName - The name of the Amazon S3 bucket where you want your transcription output stored. Do not include the S3:// prefix of the specified bucket.
    
    If you want your output to go to a sub-folder of this bucket, specify it using the OutputKey parameter; OutputBucketName only accepts the name of a bucket.
    
    For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET, set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to DOC-EXAMPLE-BUCKET and OutputKey to test-files/.
    
    Note that Amazon Transcribe must have permission to use the specified location. You can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.
    
    If you do not specify OutputBucketName, your transcript is placed in a service-managed Amazon S3 bucket and you are provided with a URI to access your transcript.
  - getOutputBucketName
```
public String getOutputBucketName()
```
    The name of the Amazon S3 bucket where you want your transcription output stored. Do not include the S3:// prefix of the specified bucket.
    
    If you want your output to go to a sub-folder of this bucket, specify it using the OutputKey parameter; OutputBucketName only accepts the name of a bucket.
    
    For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET, set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to DOC-EXAMPLE-BUCKET and OutputKey to test-files/.
    
    Note that Amazon Transcribe must have permission to use the specified location. You can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.
    
    If you do not specify OutputBucketName, your transcript is placed in a service-managed Amazon S3 bucket and you are provided with a URI to access your transcript.
    
    Returns:
    
    The name of the Amazon S3 bucket where you want your transcription output stored. Do not include the S3:// prefix of the specified bucket.
    
    If you want your output to go to a sub-folder of this bucket, specify it using the OutputKey parameter; OutputBucketName only accepts the name of a bucket.
    
    For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET, set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to DOC-EXAMPLE-BUCKET and OutputKey to test-files/.
    
    Note that Amazon Transcribe must have permission to use the specified location. You can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.
    
    If you do not specify OutputBucketName, your transcript is placed in a service-managed Amazon S3 bucket and you are provided with a URI to access your transcript.
  - withOutputBucketName
```
public StartTranscriptionJobRequest withOutputBucketName(String outputBucketName)
```
    The name of the Amazon S3 bucket where you want your transcription output stored. Do not include the S3:// prefix of the specified bucket.
    
    If you want your output to go to a sub-folder of this bucket, specify it using the OutputKey parameter; OutputBucketName only accepts the name of a bucket.
    
    For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET, set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to DOC-EXAMPLE-BUCKET and OutputKey to test-files/.
    
    Note that Amazon Transcribe must have permission to use the specified location. You can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.
    
    If you do not specify OutputBucketName, your transcript is placed in a service-managed Amazon S3 bucket and you are provided with a URI to access your transcript.
    
    Parameters:
    
    outputBucketName - The name of the Amazon S3 bucket where you want your transcription output stored. Do not include the S3:// prefix of the specified bucket.
    
    If you want your output to go to a sub-folder of this bucket, specify it using the OutputKey parameter; OutputBucketName only accepts the name of a bucket.
    
    For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET, set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to DOC-EXAMPLE-BUCKET and OutputKey to test-files/.
    
    Note that Amazon Transcribe must have permission to use the specified location. You can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.
    
    If you do not specify OutputBucketName, your transcript is placed in a service-managed Amazon S3 bucket and you are provided with a URI to access your transcript.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOutputKey
```
public void setOutputKey(String outputKey)
```
    Use in combination with OutputBucketName to specify the output location of your transcript and, optionally, a unique name for your output file. The default name for your transcription output is the same as the name you specified for your transcription job (TranscriptionJobName).
    
    Here are some examples of how you can use OutputKey:
    - If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'my-transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json .
    - If you specify 'my-first-transcription' as the TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'my-transcript' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.
    - If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'test-files/my-transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.
    - If you specify 'my-first-transcription' as the TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'test-files/my-transcript' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.
    If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for you.
    Parameters:
    outputKey - Use in combination with OutputBucketName to specify the output location of your transcript and, optionally, a unique name for your output file. The default name for your transcription output is the same as the name you specified for your transcription job (TranscriptionJobName).
    
    Here are some examples of how you can use OutputKey:
    
    If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'my-transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json.
    
    If you specify 'my-first-transcription' as the TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'my-transcript' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.
    
    If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'test-files/my-transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.
    
    If you specify 'my-first-transcription' as the TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'test-files/my-transcript' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.
    
    If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for you.
  - getOutputKey
```
public String getOutputKey()
```
    Use in combination with OutputBucketName to specify the output location of your transcript and, optionally, a unique name for your output file. The default name for your transcription output is the same as the name you specified for your transcription job (TranscriptionJobName).
    
    Here are some examples of how you can use OutputKey:
    - If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'my-transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json .
    - If you specify 'my-first-transcription' as the TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'my-transcript' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.
    - If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'test-files/my-transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.
    - If you specify 'my-first-transcription' as the TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'test-files/my-transcript' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.
    If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for you.
    Returns:
    Use in combination with OutputBucketName to specify the output location of your transcript and, optionally, a unique name for your output file. The default name for your transcription output is the same as the name you specified for your transcription job (TranscriptionJobName).
    
    Here are some examples of how you can use OutputKey:
    
    If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'my-transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json.
    
    If you specify 'my-first-transcription' as the TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'my-transcript' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.
    
    If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'test-files/my-transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.
    
    If you specify 'my-first-transcription' as the TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'test-files/my-transcript' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.
    
    If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for you.
  - withOutputKey
```
public StartTranscriptionJobRequest withOutputKey(String outputKey)
```
    Use in combination with OutputBucketName to specify the output location of your transcript and, optionally, a unique name for your output file. The default name for your transcription output is the same as the name you specified for your transcription job (TranscriptionJobName).
    
    Here are some examples of how you can use OutputKey:
    - If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'my-transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json .
    - If you specify 'my-first-transcription' as the TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'my-transcript' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.
    - If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'test-files/my-transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.
    - If you specify 'my-first-transcription' as the TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'test-files/my-transcript' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.
    If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for you.
    Parameters:
    outputKey - Use in combination with OutputBucketName to specify the output location of your transcript and, optionally, a unique name for your output file. The default name for your transcription output is the same as the name you specified for your transcription job (TranscriptionJobName).
    
    Here are some examples of how you can use OutputKey:
    
    If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'my-transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json.
    
    If you specify 'my-first-transcription' as the TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'my-transcript' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.
    
    If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'test-files/my-transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.
    
    If you specify 'my-first-transcription' as the TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'test-files/my-transcript' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.
    
    If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for you.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOutputEncryptionKMSKeyId
```
public void setOutputEncryptionKMSKeyId(String outputEncryptionKMSKeyId)
```
    The KMS key you want to use to encrypt your transcription output.
    
    If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:
    1. Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
    2. Use an alias for the KMS key ID. For example, alias/ExampleAlias.
    3. Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
    4. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
    If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:
    1. Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
    2. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
    If you do not specify an encryption key, your output 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 using the OutputLocation parameter.
    
    Note that the role making the request must have permission to use the specified KMS key.
    Parameters:
    outputEncryptionKMSKeyId - The KMS key you want to use to encrypt your transcription output.
    
    If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:
    
    Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
    
    Use an alias for the KMS key ID. For example, alias/ExampleAlias.
    
    Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
    
    Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
    
    If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:
    
    Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
    
    Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
    
    If you do not specify an encryption key, your output 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 using the OutputLocation parameter.
    
    Note that the role making the request must have permission to use the specified KMS key.
  - getOutputEncryptionKMSKeyId
```
public String getOutputEncryptionKMSKeyId()
```
    The KMS key you want to use to encrypt your transcription output.
    
    If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:
    1. Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
    2. Use an alias for the KMS key ID. For example, alias/ExampleAlias.
    3. Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
    4. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
    If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:
    1. Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
    2. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
    If you do not specify an encryption key, your output 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 using the OutputLocation parameter.
    
    Note that the role making the request must have permission to use the specified KMS key.
    Returns:
    The KMS key you want to use to encrypt your transcription output.
    
    If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:
    
    Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
    
    Use an alias for the KMS key ID. For example, alias/ExampleAlias.
    
    Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
    
    Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
    
    If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:
    
    Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
    
    Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
    
    If you do not specify an encryption key, your output 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 using the OutputLocation parameter.
    
    Note that the role making the request must have permission to use the specified KMS key.
  - withOutputEncryptionKMSKeyId
```
public StartTranscriptionJobRequest withOutputEncryptionKMSKeyId(String outputEncryptionKMSKeyId)
```
    The KMS key you want to use to encrypt your transcription output.
    
    If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:
    1. Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
    2. Use an alias for the KMS key ID. For example, alias/ExampleAlias.
    3. Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
    4. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
    If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:
    1. Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
    2. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
    If you do not specify an encryption key, your output 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 using the OutputLocation parameter.
    
    Note that the role making the request must have permission to use the specified KMS key.
    Parameters:
    outputEncryptionKMSKeyId - The KMS key you want to use to encrypt your transcription output.
    
    If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:
    
    Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
    
    Use an alias for the KMS key ID. For example, alias/ExampleAlias.
    
    Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
    
    Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
    
    If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:
    
    Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
    
    Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
    
    If you do not specify an encryption key, your output 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 using the OutputLocation parameter.
    
    Note that the role making the request must have permission to use the specified KMS key.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getKMSEncryptionContext
```
public Map<String,String> getKMSEncryptionContext()
```
    A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context and Asymmetric keys in KMS.
    
    Returns:
    
    A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context and Asymmetric keys in KMS.
  - setKMSEncryptionContext
```
public void setKMSEncryptionContext(Map<String,String> kMSEncryptionContext)
```
    A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context and Asymmetric keys in KMS.
    
    Parameters:
    
    kMSEncryptionContext - A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context and Asymmetric keys in KMS.
  - withKMSEncryptionContext
```
public StartTranscriptionJobRequest withKMSEncryptionContext(Map<String,String> kMSEncryptionContext)
```
    A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context and Asymmetric keys in KMS.
    
    Parameters:
    
    kMSEncryptionContext - A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context and Asymmetric keys in KMS.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addKMSEncryptionContextEntry
```
public StartTranscriptionJobRequest addKMSEncryptionContextEntry(String key,
                                                                 String value)
```
    Add a single KMSEncryptionContext entry
    
    See Also:
    
    withKMSEncryptionContext(java.util.Map<java.lang.String, java.lang.String>)
  - clearKMSEncryptionContextEntries
```
public StartTranscriptionJobRequest clearKMSEncryptionContextEntries()
```
    Removes all the entries added into KMSEncryptionContext.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSettings
```
public void setSettings(Settings settings)
```
    Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker partitioning. You can use that to apply custom vocabularies and vocabulary filters.
    
    If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use Settings with the VocabularyName or VocabularyFilterName (or both) sub-parameter.
    
    If you're using automatic language identification with your request and want to include a custom language model, a custom vocabulary, or a custom vocabulary filter, use instead the parameter with the LanguageModelName, VocabularyName or VocabularyFilterName sub-parameters.
    Parameters: settings - Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker partitioning. You can use that to apply custom vocabularies and vocabulary filters. If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use Settings with the VocabularyName or VocabularyFilterName (or both) sub-parameter. If you're using automatic language identification with your request and want to include a custom language model, a custom vocabulary, or a custom vocabulary filter, use instead the parameter with the LanguageModelName, VocabularyName or VocabularyFilterName sub-parameters.
  getSettings public Settings getSettings() Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker partitioning. You can use that to apply custom vocabularies and vocabulary filters. If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use Settings with the VocabularyName or VocabularyFilterName (or both) sub-parameter. If you're using automatic language identification with your request and want to include a custom language model, a custom vocabulary, or a custom vocabulary filter, use instead the parameter with the LanguageModelName, VocabularyName or VocabularyFilterName sub-parameters. Returns: Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker partitioning. You can use that to apply custom vocabularies and vocabulary filters. If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use Settings with the VocabularyName or VocabularyFilterName (or both) sub-parameter. If you're using automatic language identification with your request and want to include a custom language model, a custom vocabulary, or a custom vocabulary filter, use instead the parameter with the LanguageModelName, VocabularyName or VocabularyFilterName sub-parameters. withSettings public StartTranscriptionJobRequest withSettings(Settings settings) Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker partitioning. You can use that to apply custom vocabularies and vocabulary filters. If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use Settings with the VocabularyName or VocabularyFilterName (or both) sub-parameter. If you're using automatic language identification with your request and want to include a custom language model, a custom vocabulary, or a custom vocabulary filter, use instead the parameter with the LanguageModelName, VocabularyName or VocabularyFilterName sub-parameters. Parameters: settings - Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker partitioning. You can use that to apply custom vocabularies and vocabulary filters. If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use Settings with the VocabularyName or VocabularyFilterName (or both) sub-parameter. If you're using automatic language identification with your request and want to include a custom language model, a custom vocabulary, or a custom vocabulary filter, use instead the parameter with the LanguageModelName, VocabularyName or VocabularyFilterName sub-parameters. Returns: Returns a reference to this object so that method calls can be chained together. setModelSettings public void setModelSettings(ModelSettings modelSettings) Specify the custom language model you want to include with your transcription job. If you include ModelSettings in your request, you must include the LanguageModelName sub-parameter. For more information, see Custom language models. Parameters: modelSettings - Specify the custom language model you want to include with your transcription job. If you include ModelSettings in your request, you must include the LanguageModelName sub-parameter. For more information, see Custom language models. getModelSettings public ModelSettings getModelSettings() Specify the custom language model you want to include with your transcription job. If you include ModelSettings in your request, you must include the LanguageModelName sub-parameter. For more information, see Custom language models. Returns: Specify the custom language model you want to include with your transcription job. If you include ModelSettings in your request, you must include the LanguageModelName sub-parameter. For more information, see Custom language models. withModelSettings public StartTranscriptionJobRequest withModelSettings(ModelSettings modelSettings) Specify the custom language model you want to include with your transcription job. If you include ModelSettings in your request, you must include the LanguageModelName sub-parameter. For more information, see Custom language models. Parameters: modelSettings - Specify the custom language model you want to include with your transcription job. If you include ModelSettings in your request, you must include the LanguageModelName sub-parameter. For more information, see Custom language models. Returns: Returns a reference to this object so that method calls can be chained together. setJobExecutionSettings public void setJobExecutionSettings(JobExecutionSettings jobExecutionSettings) Makes it possible to control how your transcription job is processed. Currently, the only JobExecutionSettings modification you can choose is enabling job queueing using the AllowDeferredExecution sub-parameter. If you include JobExecutionSettings in your request, you must also include the sub-parameters: AllowDeferredExecution and DataAccessRoleArn. Parameters: jobExecutionSettings - Makes it possible to control how your transcription job is processed. Currently, the only JobExecutionSettings modification you can choose is enabling job queueing using the AllowDeferredExecution sub-parameter. If you include JobExecutionSettings in your request, you must also include the sub-parameters: AllowDeferredExecution and DataAccessRoleArn. getJobExecutionSettings public JobExecutionSettings getJobExecutionSettings() Makes it possible to control how your transcription job is processed. Currently, the only JobExecutionSettings modification you can choose is enabling job queueing using the AllowDeferredExecution sub-parameter. If you include JobExecutionSettings in your request, you must also include the sub-parameters: AllowDeferredExecution and DataAccessRoleArn. Returns: Makes it possible to control how your transcription job is processed. Currently, the only JobExecutionSettings modification you can choose is enabling job queueing using the AllowDeferredExecution sub-parameter. If you include JobExecutionSettings in your request, you must also include the sub-parameters: AllowDeferredExecution and DataAccessRoleArn. withJobExecutionSettings public StartTranscriptionJobRequest withJobExecutionSettings(JobExecutionSettings jobExecutionSettings) Makes it possible to control how your transcription job is processed. Currently, the only JobExecutionSettings modification you can choose is enabling job queueing using the AllowDeferredExecution sub-parameter. If you include JobExecutionSettings in your request, you must also include the sub-parameters: AllowDeferredExecution and DataAccessRoleArn. Parameters: jobExecutionSettings - Makes it possible to control how your transcription job is processed. Currently, the only JobExecutionSettings modification you can choose is enabling job queueing using the AllowDeferredExecution sub-parameter. If you include JobExecutionSettings in your request, you must also include the sub-parameters: AllowDeferredExecution and DataAccessRoleArn. Returns: Returns a reference to this object so that method calls can be chained together. setContentRedaction public void setContentRedaction(ContentRedaction contentRedaction) Makes it possible to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction, you must also include the sub-parameters: RedactionOutput and RedactionType. You can optionally include PiiEntityTypes to choose which types of PII you want to redact. If you do not include PiiEntityTypes in your request, all PII is redacted. Parameters: contentRedaction - Makes it possible to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction, you must also include the sub-parameters: RedactionOutput and RedactionType. You can optionally include PiiEntityTypes to choose which types of PII you want to redact. If you do not include PiiEntityTypes in your request, all PII is redacted. getContentRedaction public ContentRedaction getContentRedaction() Makes it possible to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction, you must also include the sub-parameters: RedactionOutput and RedactionType. You can optionally include PiiEntityTypes to choose which types of PII you want to redact. If you do not include PiiEntityTypes in your request, all PII is redacted. Returns: Makes it possible to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction, you must also include the sub-parameters: RedactionOutput and RedactionType. You can optionally include PiiEntityTypes to choose which types of PII you want to redact. If you do not include PiiEntityTypes in your request, all PII is redacted. withContentRedaction public StartTranscriptionJobRequest withContentRedaction(ContentRedaction contentRedaction) Makes it possible to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction, you must also include the sub-parameters: RedactionOutput and RedactionType. You can optionally include PiiEntityTypes to choose which types of PII you want to redact. If you do not include PiiEntityTypes in your request, all PII is redacted. Parameters: contentRedaction - Makes it possible to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction, you must also include the sub-parameters: RedactionOutput and RedactionType. You can optionally include PiiEntityTypes to choose which types of PII you want to redact. If you do not include PiiEntityTypes in your request, all PII is redacted. Returns: Returns a reference to this object so that method calls can be chained together. setIdentifyLanguage public void setIdentifyLanguage(Boolean identifyLanguage) Enables automatic language identification in your transcription job request. Use this parameter if your media file contains only one language. If your media contains multiple languages, use IdentifyMultipleLanguages instead. If you include IdentifyLanguage, you can optionally include a list of language codes, using LanguageOptions, that you think may be present in your media file. Including LanguageOptions restricts IdentifyLanguage to only the language options that you specify, which can improve transcription accuracy. If you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter to your automatic language identification request, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName). If you include LanguageIdSettings, also include LanguageOptions. Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails. Parameters: identifyLanguage - Enables automatic language identification in your transcription job request. Use this parameter if your media file contains only one language. If your media contains multiple languages, use IdentifyMultipleLanguages instead. If you include IdentifyLanguage, you can optionally include a list of language codes, using LanguageOptions, that you think may be present in your media file. Including LanguageOptions restricts IdentifyLanguage to only the language options that you specify, which can improve transcription accuracy. If you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter to your automatic language identification request, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName). If you include LanguageIdSettings, also include LanguageOptions. Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails. getIdentifyLanguage public Boolean getIdentifyLanguage() Enables automatic language identification in your transcription job request. Use this parameter if your media file contains only one language. If your media contains multiple languages, use IdentifyMultipleLanguages instead. If you include IdentifyLanguage, you can optionally include a list of language codes, using LanguageOptions, that you think may be present in your media file. Including LanguageOptions restricts IdentifyLanguage to only the language options that you specify, which can improve transcription accuracy. If you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter to your automatic language identification request, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName). If you include LanguageIdSettings, also include LanguageOptions. Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails. Returns: Enables automatic language identification in your transcription job request. Use this parameter if your media file contains only one language. If your media contains multiple languages, use IdentifyMultipleLanguages instead. If you include IdentifyLanguage, you can optionally include a list of language codes, using LanguageOptions, that you think may be present in your media file. Including LanguageOptions restricts IdentifyLanguage to only the language options that you specify, which can improve transcription accuracy. If you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter to your automatic language identification request, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName). If you include LanguageIdSettings, also include LanguageOptions. Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails. withIdentifyLanguage public StartTranscriptionJobRequest withIdentifyLanguage(Boolean identifyLanguage) Enables automatic language identification in your transcription job request. Use this parameter if your media file contains only one language. If your media contains multiple languages, use IdentifyMultipleLanguages instead. If you include IdentifyLanguage, you can optionally include a list of language codes, using LanguageOptions, that you think may be present in your media file. Including LanguageOptions restricts IdentifyLanguage to only the language options that you specify, which can improve transcription accuracy. If you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter to your automatic language identification request, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName). If you include LanguageIdSettings, also include LanguageOptions. Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails. Parameters: identifyLanguage - Enables automatic language identification in your transcription job request. Use this parameter if your media file contains only one language. If your media contains multiple languages, use IdentifyMultipleLanguages instead. If you include IdentifyLanguage, you can optionally include a list of language codes, using LanguageOptions, that you think may be present in your media file. Including LanguageOptions restricts IdentifyLanguage to only the language options that you specify, which can improve transcription accuracy. If you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter to your automatic language identification request, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName). If you include LanguageIdSettings, also include LanguageOptions. Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails. Returns: Returns a reference to this object so that method calls can be chained together. isIdentifyLanguage public Boolean isIdentifyLanguage() Enables automatic language identification in your transcription job request. Use this parameter if your media file contains only one language. If your media contains multiple languages, use IdentifyMultipleLanguages instead. If you include IdentifyLanguage, you can optionally include a list of language codes, using LanguageOptions, that you think may be present in your media file. Including LanguageOptions restricts IdentifyLanguage to only the language options that you specify, which can improve transcription accuracy. If you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter to your automatic language identification request, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName). If you include LanguageIdSettings, also include LanguageOptions. Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails. Returns: Enables automatic language identification in your transcription job request. Use this parameter if your media file contains only one language. If your media contains multiple languages, use IdentifyMultipleLanguages instead. If you include IdentifyLanguage, you can optionally include a list of language codes, using LanguageOptions, that you think may be present in your media file. Including LanguageOptions restricts IdentifyLanguage to only the language options that you specify, which can improve transcription accuracy. If you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter to your automatic language identification request, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName). If you include LanguageIdSettings, also include LanguageOptions. Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails. setIdentifyMultipleLanguages public void setIdentifyMultipleLanguages(Boolean identifyMultipleLanguages) Enables automatic multi-language identification in your transcription job request. Use this parameter if your media file contains more than one language. If your media contains only one language, use IdentifyLanguage instead. If you include IdentifyMultipleLanguages, you can optionally include a list of language codes, using LanguageOptions, that you think may be present in your media file. Including LanguageOptions restricts IdentifyLanguage to only the language options that you specify, which can improve transcription accuracy. If you want to apply a custom vocabulary or a custom vocabulary filter to your automatic language identification request, include LanguageIdSettings with the relevant sub-parameters (VocabularyName and VocabularyFilterName). If you include LanguageIdSettings, also include LanguageOptions. Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails. Parameters: identifyMultipleLanguages - Enables automatic multi-language identification in your transcription job request. Use this parameter if your media file contains more than one language. If your media contains only one language, use IdentifyLanguage instead. If you include IdentifyMultipleLanguages, you can optionally include a list of language codes, using LanguageOptions, that you think may be present in your media file. Including LanguageOptions restricts IdentifyLanguage to only the language options that you specify, which can improve transcription accuracy. If you want to apply a custom vocabulary or a custom vocabulary filter to your automatic language identification request, include LanguageIdSettings with the relevant sub-parameters ( VocabularyName and VocabularyFilterName). If you include LanguageIdSettings, also include LanguageOptions. Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails. getIdentifyMultipleLanguages public Boolean getIdentifyMultipleLanguages() Enables automatic multi-language identification in your transcription job request. Use this parameter if your media file contains more than one language. If your media contains only one language, use IdentifyLanguage instead. If you include IdentifyMultipleLanguages, you can optionally include a list of language codes, using LanguageOptions, that you think may be present in your media file. Including LanguageOptions restricts IdentifyLanguage to only the language options that you specify, which can improve transcription accuracy. If you want to apply a custom vocabulary or a custom vocabulary filter to your automatic language identification request, include LanguageIdSettings with the relevant sub-parameters (VocabularyName and VocabularyFilterName). If you include LanguageIdSettings, also include LanguageOptions. Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails. Returns: Enables automatic multi-language identification in your transcription job request. Use this parameter if your media file contains more than one language. If your media contains only one language, use IdentifyLanguage instead. If you include IdentifyMultipleLanguages, you can optionally include a list of language codes, using LanguageOptions, that you think may be present in your media file. Including LanguageOptions restricts IdentifyLanguage to only the language options that you specify, which can improve transcription accuracy. If you want to apply a custom vocabulary or a custom vocabulary filter to your automatic language identification request, include LanguageIdSettings with the relevant sub-parameters ( VocabularyName and VocabularyFilterName). If you include LanguageIdSettings, also include LanguageOptions. Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails. withIdentifyMultipleLanguages public StartTranscriptionJobRequest withIdentifyMultipleLanguages(Boolean identifyMultipleLanguages) Enables automatic multi-language identification in your transcription job request. Use this parameter if your media file contains more than one language. If your media contains only one language, use IdentifyLanguage instead. If you include IdentifyMultipleLanguages, you can optionally include a list of language codes, using LanguageOptions, that you think may be present in your media file. Including LanguageOptions restricts IdentifyLanguage to only the language options that you specify, which can improve transcription accuracy. If you want to apply a custom vocabulary or a custom vocabulary filter to your automatic language identification request, include LanguageIdSettings with the relevant sub-parameters (VocabularyName and VocabularyFilterName). If you include LanguageIdSettings, also include LanguageOptions. Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails. Parameters: identifyMultipleLanguages - Enables automatic multi-language identification in your transcription job request. Use this parameter if your media file contains more than one language. If your media contains only one language, use IdentifyLanguage instead. If you include IdentifyMultipleLanguages, you can optionally include a list of language codes, using LanguageOptions, that you think may be present in your media file. Including LanguageOptions restricts IdentifyLanguage to only the language options that you specify, which can improve transcription accuracy. If you want to apply a custom vocabulary or a custom vocabulary filter to your automatic language identification request, include LanguageIdSettings with the relevant sub-parameters ( VocabularyName and VocabularyFilterName). If you include LanguageIdSettings, also include LanguageOptions. Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails. Returns: Returns a reference to this object so that method calls can be chained together. isIdentifyMultipleLanguages public Boolean isIdentifyMultipleLanguages() Enables automatic multi-language identification in your transcription job request. Use this parameter if your media file contains more than one language. If your media contains only one language, use IdentifyLanguage instead. If you include IdentifyMultipleLanguages, you can optionally include a list of language codes, using LanguageOptions, that you think may be present in your media file. Including LanguageOptions restricts IdentifyLanguage to only the language options that you specify, which can improve transcription accuracy. If you want to apply a custom vocabulary or a custom vocabulary filter to your automatic language identification request, include LanguageIdSettings with the relevant sub-parameters (VocabularyName and VocabularyFilterName). If you include LanguageIdSettings, also include LanguageOptions. Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails. Returns: Enables automatic multi-language identification in your transcription job request. Use this parameter if your media file contains more than one language. If your media contains only one language, use IdentifyLanguage instead. If you include IdentifyMultipleLanguages, you can optionally include a list of language codes, using LanguageOptions, that you think may be present in your media file. Including LanguageOptions restricts IdentifyLanguage to only the language options that you specify, which can improve transcription accuracy. If you want to apply a custom vocabulary or a custom vocabulary filter to your automatic language identification request, include LanguageIdSettings with the relevant sub-parameters ( VocabularyName and VocabularyFilterName). If you include LanguageIdSettings, also include LanguageOptions. Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails. getLanguageOptions public List<String> getLanguageOptions() You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter. If you include LanguageOptions in your request, you must also include IdentifyLanguage. For more information, refer to Supported languages. To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher. Returns: You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter. If you include LanguageOptions in your request, you must also include IdentifyLanguage. For more information, refer to Supported languages. To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher. See Also: LanguageCode setLanguageOptions public void setLanguageOptions(Collection<String> languageOptions) You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter. If you include LanguageOptions in your request, you must also include IdentifyLanguage. For more information, refer to Supported languages. To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher. Parameters: languageOptions - You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter. If you include LanguageOptions in your request, you must also include IdentifyLanguage. For more information, refer to Supported languages. To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher. See Also: LanguageCode withLanguageOptions public StartTranscriptionJobRequest withLanguageOptions(String... languageOptions) You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter. If you include LanguageOptions in your request, you must also include IdentifyLanguage. For more information, refer to Supported languages. To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher. 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. Parameters: languageOptions - You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter. If you include LanguageOptions in your request, you must also include IdentifyLanguage. For more information, refer to Supported languages. To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher. Returns: Returns a reference to this object so that method calls can be chained together. See Also: LanguageCode withLanguageOptions public StartTranscriptionJobRequest withLanguageOptions(Collection<String> languageOptions) You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter. If you include LanguageOptions in your request, you must also include IdentifyLanguage. For more information, refer to Supported languages. To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher. Parameters: languageOptions - You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter. If you include LanguageOptions in your request, you must also include IdentifyLanguage. For more information, refer to Supported languages. To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher. Returns: Returns a reference to this object so that method calls can be chained together. See Also: LanguageCode withLanguageOptions public StartTranscriptionJobRequest withLanguageOptions(LanguageCode... languageOptions) You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter. If you include LanguageOptions in your request, you must also include IdentifyLanguage. For more information, refer to Supported languages. To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher. Parameters: languageOptions - You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter. If you include LanguageOptions in your request, you must also include IdentifyLanguage. For more information, refer to Supported languages. To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher. Returns: Returns a reference to this object so that method calls can be chained together. See Also: LanguageCode setSubtitles public void setSubtitles(Subtitles subtitles) Produces subtitle files for your input media. You can specify WebVTT (*.vtt) and SubRip (*.srt) formats. Parameters: subtitles - Produces subtitle files for your input media. You can specify WebVTT (*.vtt) and SubRip (*.srt) formats. getSubtitles public Subtitles getSubtitles() Produces subtitle files for your input media. You can specify WebVTT (*.vtt) and SubRip (*.srt) formats. Returns: Produces subtitle files for your input media. You can specify WebVTT (*.vtt) and SubRip (*.srt) formats. withSubtitles public StartTranscriptionJobRequest withSubtitles(Subtitles subtitles) Produces subtitle files for your input media. You can specify WebVTT (*.vtt) and SubRip (*.srt) formats. Parameters: subtitles - Produces subtitle files for your input media. You can specify WebVTT (*.vtt) and SubRip (*.srt) formats. Returns: Returns a reference to this object so that method calls can be chained together. getTags public List<Tag> getTags() Adds one or more custom tags, each in the form of a key:value pair, to a new transcription job at the time you start this new job. To learn more about using tags with Amazon Transcribe, refer to Tagging resources. Returns: Adds one or more custom tags, each in the form of a key:value pair, to a new transcription job at the time you start this new job. To learn more about using tags with Amazon Transcribe, refer to Tagging resources. setTags public void setTags(Collection<Tag> tags) Adds one or more custom tags, each in the form of a key:value pair, to a new transcription job at the time you start this new job. To learn more about using tags with Amazon Transcribe, refer to Tagging resources. Parameters: tags - Adds one or more custom tags, each in the form of a key:value pair, to a new transcription job at the time you start this new job. To learn more about using tags with Amazon Transcribe, refer to Tagging resources. withTags public StartTranscriptionJobRequest withTags(Tag... tags) Adds one or more custom tags, each in the form of a key:value pair, to a new transcription job at the time you start this new job. To learn more about using tags with Amazon Transcribe, refer to Tagging resources. NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values. Parameters: tags - Adds one or more custom tags, each in the form of a key:value pair, to a new transcription job at the time you start this new job. To learn more about using tags with Amazon Transcribe, refer to Tagging resources. Returns: Returns a reference to this object so that method calls can be chained together. withTags public StartTranscriptionJobRequest withTags(Collection<Tag> tags) Adds one or more custom tags, each in the form of a key:value pair, to a new transcription job at the time you start this new job. To learn more about using tags with Amazon Transcribe, refer to Tagging resources. Parameters: tags - Adds one or more custom tags, each in the form of a key:value pair, to a new transcription job at the time you start this new job. To learn more about using tags with Amazon Transcribe, refer to Tagging resources. Returns: Returns a reference to this object so that method calls can be chained together. getLanguageIdSettings public Map<String,LanguageIdSettings> getLanguageIdSettings() If using automatic language identification in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName). Note that multi-language identification ( IdentifyMultipleLanguages) doesn't support custom language models. LanguageIdSettings supports two to five language codes. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The language codes that you specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary filters. It's recommended that you include LanguageOptions when using LanguageIdSettings to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is in en-US but Amazon Transcribe determines that the language spoken in your media is en-AU, your custom vocabulary is not applied to your transcription. If you include LanguageOptions and include en-US as the only English language dialect, your custom vocabulary is applied to your transcription. If you want to include a custom language model with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName sub-parameter. If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use instead the parameter with the VocabularyName or VocabularyFilterName (or both) sub-parameter. Returns: If using automatic language identification in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName). Note that multi-language identification ( IdentifyMultipleLanguages) doesn't support custom language models. LanguageIdSettings supports two to five language codes. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The language codes that you specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary filters. It's recommended that you include LanguageOptions when using LanguageIdSettings to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is in en-US but Amazon Transcribe determines that the language spoken in your media is en-AU, your custom vocabulary is not applied to your transcription. If you include LanguageOptions and include en-US as the only English language dialect, your custom vocabulary is applied to your transcription. If you want to include a custom language model with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName sub-parameter. If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use instead the parameter with the VocabularyName or VocabularyFilterName (or both) sub-parameter. setLanguageIdSettings public void setLanguageIdSettings(Map<String,LanguageIdSettings> languageIdSettings) If using automatic language identification in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName). Note that multi-language identification ( IdentifyMultipleLanguages) doesn't support custom language models. LanguageIdSettings supports two to five language codes. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The language codes that you specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary filters. It's recommended that you include LanguageOptions when using LanguageIdSettings to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is in en-US but Amazon Transcribe determines that the language spoken in your media is en-AU, your custom vocabulary is not applied to your transcription. If you include LanguageOptions and include en-US as the only English language dialect, your custom vocabulary is applied to your transcription. If you want to include a custom language model with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName sub-parameter. If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use instead the parameter with the VocabularyName or VocabularyFilterName (or both) sub-parameter. Parameters: languageIdSettings - If using automatic language identification in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName). Note that multi-language identification ( IdentifyMultipleLanguages) doesn't support custom language models. LanguageIdSettings supports two to five language codes. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The language codes that you specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary filters. It's recommended that you include LanguageOptions when using LanguageIdSettings to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is in en-US but Amazon Transcribe determines that the language spoken in your media is en-AU, your custom vocabulary is not applied to your transcription. If you include LanguageOptions and include en-US as the only English language dialect, your custom vocabulary is applied to your transcription. If you want to include a custom language model with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName sub-parameter. If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use instead the parameter with the VocabularyName or VocabularyFilterName (or both) sub-parameter. withLanguageIdSettings public StartTranscriptionJobRequest withLanguageIdSettings(Map<String,LanguageIdSettings> languageIdSettings) If using automatic language identification in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName). Note that multi-language identification ( IdentifyMultipleLanguages) doesn't support custom language models. LanguageIdSettings supports two to five language codes. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The language codes that you specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary filters. It's recommended that you include LanguageOptions when using LanguageIdSettings to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is in en-US but Amazon Transcribe determines that the language spoken in your media is en-AU, your custom vocabulary is not applied to your transcription. If you include LanguageOptions and include en-US as the only English language dialect, your custom vocabulary is applied to your transcription. If you want to include a custom language model with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName sub-parameter. If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use instead the parameter with the VocabularyName or VocabularyFilterName (or both) sub-parameter. Parameters: languageIdSettings - If using automatic language identification in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName). Note that multi-language identification ( IdentifyMultipleLanguages) doesn't support custom language models. LanguageIdSettings supports two to five language codes. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The language codes that you specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary filters. It's recommended that you include LanguageOptions when using LanguageIdSettings to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is in en-US but Amazon Transcribe determines that the language spoken in your media is en-AU, your custom vocabulary is not applied to your transcription. If you include LanguageOptions and include en-US as the only English language dialect, your custom vocabulary is applied to your transcription. If you want to include a custom language model with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName sub-parameter. If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use instead the parameter with the VocabularyName or VocabularyFilterName (or both) sub-parameter. Returns: Returns a reference to this object so that method calls can be chained together. addLanguageIdSettingsEntry public StartTranscriptionJobRequest addLanguageIdSettingsEntry(String key, LanguageIdSettings value) Add a single LanguageIdSettings entry See Also: withLanguageIdSettings(java.util.Map<java.lang.String, com.amazonaws.services.transcribe.model.LanguageIdSettings>) clearLanguageIdSettingsEntries public StartTranscriptionJobRequest clearLanguageIdSettingsEntries() Removes all the entries added into LanguageIdSettings. Returns: Returns a reference to this object so that method calls can be chained together. getToxicityDetection public List<ToxicityDetectionSettings> getToxicityDetection() Enables toxic speech detection in your transcript. If you include ToxicityDetection in your request, you must also include ToxicityCategories. For information on the types of toxic speech Amazon Transcribe can detect, see Detecting toxic speech. Returns: Enables toxic speech detection in your transcript. If you include ToxicityDetection in your request, you must also include ToxicityCategories. For information on the types of toxic speech Amazon Transcribe can detect, see Detecting toxic speech. setToxicityDetection public void setToxicityDetection(Collection<ToxicityDetectionSettings> toxicityDetection) Enables toxic speech detection in your transcript. If you include ToxicityDetection in your request, you must also include ToxicityCategories. For information on the types of toxic speech Amazon Transcribe can detect, see Detecting toxic speech. Parameters: toxicityDetection - Enables toxic speech detection in your transcript. If you include ToxicityDetection in your request, you must also include ToxicityCategories. For information on the types of toxic speech Amazon Transcribe can detect, see Detecting toxic speech. withToxicityDetection public StartTranscriptionJobRequest withToxicityDetection(ToxicityDetectionSettings... toxicityDetection) Enables toxic speech detection in your transcript. If you include ToxicityDetection in your request, you must also include ToxicityCategories. For information on the types of toxic speech Amazon Transcribe can detect, see Detecting toxic speech. NOTE: This method appends the values to the existing list (if any). Use setToxicityDetection(java.util.Collection) or withToxicityDetection(java.util.Collection) if you want to override the existing values. Parameters: toxicityDetection - Enables toxic speech detection in your transcript. If you include ToxicityDetection in your request, you must also include ToxicityCategories. For information on the types of toxic speech Amazon Transcribe can detect, see Detecting toxic speech. Returns: Returns a reference to this object so that method calls can be chained together. withToxicityDetection public StartTranscriptionJobRequest withToxicityDetection(Collection<ToxicityDetectionSettings> toxicityDetection) Enables toxic speech detection in your transcript. If you include ToxicityDetection in your request, you must also include ToxicityCategories. For information on the types of toxic speech Amazon Transcribe can detect, see Detecting toxic speech. Parameters: toxicityDetection - Enables toxic speech detection in your transcript. If you include ToxicityDetection in your request, you must also include ToxicityCategories. For information on the types of toxic speech Amazon Transcribe can detect, see Detecting toxic speech. 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()

AWS SDK for Java 1.x API Reference - 1.12.779

Class StartTranscriptionJobRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

StartTranscriptionJobRequest

Method Detail

setTranscriptionJobName

getTranscriptionJobName

withTranscriptionJobName

setLanguageCode

getLanguageCode

withLanguageCode

withLanguageCode

setMediaSampleRateHertz

getMediaSampleRateHertz

withMediaSampleRateHertz

setMediaFormat

getMediaFormat

withMediaFormat

withMediaFormat

setMedia

getMedia

withMedia

setOutputBucketName

getOutputBucketName

withOutputBucketName

setOutputKey

getOutputKey

withOutputKey

setOutputEncryptionKMSKeyId

getOutputEncryptionKMSKeyId

withOutputEncryptionKMSKeyId

getKMSEncryptionContext

setKMSEncryptionContext

withKMSEncryptionContext

addKMSEncryptionContextEntry

clearKMSEncryptionContextEntries

setSettings

getSettings

withSettings

setModelSettings

getModelSettings

withModelSettings

setJobExecutionSettings

getJobExecutionSettings

withJobExecutionSettings

setContentRedaction

getContentRedaction

withContentRedaction

setIdentifyLanguage

getIdentifyLanguage

withIdentifyLanguage

isIdentifyLanguage

setIdentifyMultipleLanguages

getIdentifyMultipleLanguages

withIdentifyMultipleLanguages

isIdentifyMultipleLanguages

getLanguageOptions

setLanguageOptions

withLanguageOptions

withLanguageOptions

withLanguageOptions

setSubtitles

getSubtitles

withSubtitles

getTags

setTags

withTags

withTags

getLanguageIdSettings

setLanguageIdSettings

withLanguageIdSettings

addLanguageIdSettingsEntry

clearLanguageIdSettingsEntries

getToxicityDetection