StartTranscriptionJobRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.transcribe.model.StartTranscriptionJobRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class StartTranscriptionJobRequest
extends AmazonWebServiceRequest
implements java.io.Serializable
```
Starts an asynchronous job to transcribe speech to text.

See Also:

Serialized Form

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
`boolean`	`equals(java.lang.Object obj)`
`ContentRedaction`	`getContentRedaction()` An object that contains the request parameters for content redaction.
`java.lang.Boolean`	`getIdentifyLanguage()` Set this field to `true` to enable automatic language identification.
`JobExecutionSettings`	`getJobExecutionSettings()` Provides information about how a transcription job is executed.
`java.lang.String`	`getLanguageCode()` The language code for the language used in the input media file.
`java.util.List<java.lang.String>`	`getLanguageOptions()` An object containing a list of languages that might be present in your collection of audio files.
`Media`	`getMedia()` An object that describes the input media for a transcription job.
`java.lang.String`	`getMediaFormat()` The format of the input media file.
`java.lang.Integer`	`getMediaSampleRateHertz()` The sample rate, in Hertz, of the audio track in the input media file.
`ModelSettings`	`getModelSettings()` Choose the custom language model you use for your transcription job in this parameter.
`java.lang.String`	`getOutputBucketName()` The location where the transcription is stored.
`java.lang.String`	`getOutputEncryptionKMSKeyId()` The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job.
`java.lang.String`	`getOutputKey()` You can specify a location in an Amazon S3 bucket to store the output of your transcription job.
`Settings`	`getSettings()` A `Settings` object that provides optional settings for a transcription job.
`java.lang.String`	`getTranscriptionJobName()` The name of the job.
`int`	`hashCode()`
`java.lang.Boolean`	`isIdentifyLanguage()` Set this field to `true` to enable automatic language identification.
`void`	`setContentRedaction(ContentRedaction contentRedaction)` An object that contains the request parameters for content redaction.
`void`	`setIdentifyLanguage(java.lang.Boolean identifyLanguage)` Set this field to `true` to enable automatic language identification.
`void`	`setJobExecutionSettings(JobExecutionSettings jobExecutionSettings)` Provides information about how a transcription job is executed.
`void`	`setLanguageCode(LanguageCode languageCode)` The language code for the language used in the input media file.
`void`	`setLanguageCode(java.lang.String languageCode)` The language code for the language used in the input media file.
`void`	`setLanguageOptions(java.util.Collection<java.lang.String> languageOptions)` An object containing a list of languages that might be present in your collection of audio files.
`void`	`setMedia(Media media)` An object that describes the input media for a transcription job.
`void`	`setMediaFormat(MediaFormat mediaFormat)` The format of the input media file.
`void`	`setMediaFormat(java.lang.String mediaFormat)` The format of the input media file.
`void`	`setMediaSampleRateHertz(java.lang.Integer mediaSampleRateHertz)` The sample rate, in Hertz, of the audio track in the input media file.
`void`	`setModelSettings(ModelSettings modelSettings)` Choose the custom language model you use for your transcription job in this parameter.
`void`	`setOutputBucketName(java.lang.String outputBucketName)` The location where the transcription is stored.
`void`	`setOutputEncryptionKMSKeyId(java.lang.String outputEncryptionKMSKeyId)` The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job.
`void`	`setOutputKey(java.lang.String outputKey)` You can specify a location in an Amazon S3 bucket to store the output of your transcription job.
`void`	`setSettings(Settings settings)` A `Settings` object that provides optional settings for a transcription job.
`void`	`setTranscriptionJobName(java.lang.String transcriptionJobName)` The name of the job.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`StartTranscriptionJobRequest`	`withContentRedaction(ContentRedaction contentRedaction)` An object that contains the request parameters for content redaction.
`StartTranscriptionJobRequest`	`withIdentifyLanguage(java.lang.Boolean identifyLanguage)` Set this field to `true` to enable automatic language identification.
`StartTranscriptionJobRequest`	`withJobExecutionSettings(JobExecutionSettings jobExecutionSettings)` Provides information about how a transcription job is executed.
`StartTranscriptionJobRequest`	`withLanguageCode(LanguageCode languageCode)` The language code for the language used in the input media file.
`StartTranscriptionJobRequest`	`withLanguageCode(java.lang.String languageCode)` The language code for the language used in the input media file.
`StartTranscriptionJobRequest`	`withLanguageOptions(java.util.Collection<java.lang.String> languageOptions)` An object containing a list of languages that might be present in your collection of audio files.
`StartTranscriptionJobRequest`	`withLanguageOptions(java.lang.String... languageOptions)` An object containing a list of languages that might be present in your collection of audio files.
`StartTranscriptionJobRequest`	`withMedia(Media media)` An object that describes the input media for a transcription job.
`StartTranscriptionJobRequest`	`withMediaFormat(MediaFormat mediaFormat)` The format of the input media file.
`StartTranscriptionJobRequest`	`withMediaFormat(java.lang.String mediaFormat)` The format of the input media file.
`StartTranscriptionJobRequest`	`withMediaSampleRateHertz(java.lang.Integer mediaSampleRateHertz)` The sample rate, in Hertz, of the audio track in the input media file.
`StartTranscriptionJobRequest`	`withModelSettings(ModelSettings modelSettings)` Choose the custom language model you use for your transcription job in this parameter.
`StartTranscriptionJobRequest`	`withOutputBucketName(java.lang.String outputBucketName)` The location where the transcription is stored.
`StartTranscriptionJobRequest`	`withOutputEncryptionKMSKeyId(java.lang.String outputEncryptionKMSKeyId)` The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job.
`StartTranscriptionJobRequest`	`withOutputKey(java.lang.String outputKey)` You can specify a location in an Amazon S3 bucket to store the output of your transcription job.
`StartTranscriptionJobRequest`	`withSettings(Settings settings)` A `Settings` object that provides optional settings for a transcription job.
`StartTranscriptionJobRequest`	`withTranscriptionJobName(java.lang.String transcriptionJobName)` The name of the job.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - StartTranscriptionJobRequest
```
public StartTranscriptionJobRequest()
```
- Method Detail
  - getTranscriptionJobName
```
public java.lang.String getTranscriptionJobName()
```
    The name of the job. You can't use the strings "." or " .." by themselves as the job name. The name must also be unique within an AWS account. If you try to create a transcription job with the same name as a previous transcription job, you get a ConflictException error.
    
    Constraints:
    Length: 1 - 200
    Pattern: ^[0-9a-zA-Z._-]+
    
    Returns:
    
    The name of the job. You can't use the strings ". " or ".." by themselves as the job name. The name must also be unique within an AWS account. If you try to create a transcription job with the same name as a previous transcription job, you get a ConflictException error.
  - setTranscriptionJobName
```
public void setTranscriptionJobName(java.lang.String transcriptionJobName)
```
    The name of the job. You can't use the strings "." or " .." by themselves as the job name. The name must also be unique within an AWS account. If you try to create a transcription job with the same name as a previous transcription job, you get a ConflictException error.
    
    Constraints:
    Length: 1 - 200
    Pattern: ^[0-9a-zA-Z._-]+
    
    Parameters:
    
    transcriptionJobName -
    The name of the job. You can't use the strings ". " or ".." by themselves as the job name. The name must also be unique within an AWS account. If you try to create a transcription job with the same name as a previous transcription job, you get a ConflictException error.
  - withTranscriptionJobName
```
public StartTranscriptionJobRequest withTranscriptionJobName(java.lang.String transcriptionJobName)
```
    The name of the job. You can't use the strings "." or " .." by themselves as the job name. The name must also be unique within an AWS account. If you try to create a transcription job with the same name as a previous transcription job, you get a ConflictException error.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 200
    Pattern: ^[0-9a-zA-Z._-]+
    
    Parameters:
    
    transcriptionJobName -
    The name of the job. You can't use the strings ". " or ".." by themselves as the job name. The name must also be unique within an AWS account. If you try to create a transcription job with the same name as a previous transcription job, you get a ConflictException error.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getLanguageCode
```
public java.lang.String getLanguageCode()
```
    The language code for the language used in the input media file.
    
    Constraints:
    Allowed Values: af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN
    
    Returns:
    
    The language code for the language used in the input media file.
    
    See Also:
    
    LanguageCode
  - setLanguageCode
```
public void setLanguageCode(java.lang.String languageCode)
```
    The language code for the language used in the input media file.
    
    Constraints:
    Allowed Values: af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN
    
    Parameters:
    
    languageCode -
    The language code for the language used in the input media file.
    
    See Also:
    
    LanguageCode
  - withLanguageCode
```
public StartTranscriptionJobRequest withLanguageCode(java.lang.String languageCode)
```
    The language code for the language used in the input media file.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN
    
    Parameters:
    
    languageCode -
    The language code for the language used in the input media file.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    LanguageCode
  - setLanguageCode
```
public void setLanguageCode(LanguageCode languageCode)
```
    The language code for the language used in the input media file.
    
    Constraints:
    Allowed Values: af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN
    
    Parameters:
    
    languageCode -
    The language code for the language used in the input media file.
    
    See Also:
    
    LanguageCode
  - withLanguageCode
```
public StartTranscriptionJobRequest withLanguageCode(LanguageCode languageCode)
```
    The language code for the language used in the input media file.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN
    
    Parameters:
    
    languageCode -
    The language code for the language used in the input media file.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    LanguageCode
  - getMediaSampleRateHertz
```
public java.lang.Integer getMediaSampleRateHertz()
```
    The sample rate, in Hertz, of the audio track in the input media file.
    
    If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you specify the sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe determine the sample rate.
    
    Constraints:
    Range: 8000 - 48000
    
    Returns:
    
    The sample rate, in Hertz, of the audio track in the input media file.
    
    If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you specify the sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe determine the sample rate.
  - setMediaSampleRateHertz
```
public void setMediaSampleRateHertz(java.lang.Integer mediaSampleRateHertz)
```
    The sample rate, in Hertz, of the audio track in the input media file.
    
    If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you specify the sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe determine the sample rate.
    
    Constraints:
    Range: 8000 - 48000
    
    Parameters:
    
    mediaSampleRateHertz -
    The sample rate, in Hertz, of the audio track in the input media file.
    
    If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you specify the sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe determine the sample rate.
  - withMediaSampleRateHertz
```
public StartTranscriptionJobRequest withMediaSampleRateHertz(java.lang.Integer mediaSampleRateHertz)
```
    The sample rate, in Hertz, of the audio track in the input media file.
    
    If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you specify the sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe determine the sample rate.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 8000 - 48000
    
    Parameters:
    
    mediaSampleRateHertz -
    The sample rate, in Hertz, of the audio track in the input media file.
    
    If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you specify the sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe determine the sample rate.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getMediaFormat
```
public java.lang.String getMediaFormat()
```
    The format of the input media file.
    
    Constraints:
    Allowed Values: mp3, mp4, wav, flac, ogg, amr, webm
    
    Returns:
    
    The format of the input media file.
    
    See Also:
    
    MediaFormat
  - setMediaFormat
```
public void setMediaFormat(java.lang.String mediaFormat)
```
    The format of the input media file.
    
    Constraints:
    Allowed Values: mp3, mp4, wav, flac, ogg, amr, webm
    
    Parameters:
    
    mediaFormat -
    The format of the input media file.
    
    See Also:
    
    MediaFormat
  - withMediaFormat
```
public StartTranscriptionJobRequest withMediaFormat(java.lang.String mediaFormat)
```
    The format of the input media file.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: mp3, mp4, wav, flac, ogg, amr, webm
    
    Parameters:
    
    mediaFormat -
    The format of the input media file.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    MediaFormat
  - setMediaFormat
```
public void setMediaFormat(MediaFormat mediaFormat)
```
    The format of the input media file.
    
    Constraints:
    Allowed Values: mp3, mp4, wav, flac, ogg, amr, webm
    
    Parameters:
    
    mediaFormat -
    The format of the input media file.
    
    See Also:
    
    MediaFormat
  - withMediaFormat
```
public StartTranscriptionJobRequest withMediaFormat(MediaFormat mediaFormat)
```
    The format of the input media file.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: mp3, mp4, wav, flac, ogg, amr, webm
    
    Parameters:
    
    mediaFormat -
    The format of the input media file.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    MediaFormat
  - getMedia
```
public Media getMedia()
```
    An object that describes the input media for a transcription job.
    
    Returns:
    
    An object that describes the input media for a transcription job.
  - setMedia
```
public void setMedia(Media media)
```
    An object that describes the input media for a transcription job.
    
    Parameters:
    
    media -
    An object that describes the input media for a transcription job.
  - withMedia
```
public StartTranscriptionJobRequest withMedia(Media media)
```
    An object that describes the input media for a transcription job.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    media -
    An object that describes the input media for a transcription job.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getOutputBucketName
```
public java.lang.String getOutputBucketName()
```
    The location where the transcription is stored.
    
    If you set the OutputBucketName, Amazon Transcribe puts the transcript in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri. If you enable content redaction and choose to output an unredacted transcript, that transcript's location still appears in the TranscriptFileUri. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles.
    
    You can specify an AWS Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.
    
    If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription.
    
    Constraints:
    Length: - 64
    Pattern: [a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]
    
    Returns:
    
    The location where the transcription is stored.
    
    If you set the OutputBucketName, Amazon Transcribe puts the transcript in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri. If you enable content redaction and choose to output an unredacted transcript, that transcript's location still appears in the TranscriptFileUri. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles.
    
    You can specify an AWS Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.
    
    If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription.
  - setOutputBucketName
```
public void setOutputBucketName(java.lang.String outputBucketName)
```
    The location where the transcription is stored.
    
    If you set the OutputBucketName, Amazon Transcribe puts the transcript in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri. If you enable content redaction and choose to output an unredacted transcript, that transcript's location still appears in the TranscriptFileUri. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles.
    
    You can specify an AWS Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.
    
    If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription.
    
    Constraints:
    Length: - 64
    Pattern: [a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]
    
    Parameters:
    
    outputBucketName -
    The location where the transcription is stored.
    
    If you set the OutputBucketName, Amazon Transcribe puts the transcript in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri. If you enable content redaction and choose to output an unredacted transcript, that transcript's location still appears in the TranscriptFileUri. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles.
    
    You can specify an AWS Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.
    
    If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription.
  - withOutputBucketName
```
public StartTranscriptionJobRequest withOutputBucketName(java.lang.String outputBucketName)
```
    The location where the transcription is stored.
    
    If you set the OutputBucketName, Amazon Transcribe puts the transcript in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri. If you enable content redaction and choose to output an unredacted transcript, that transcript's location still appears in the TranscriptFileUri. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles.
    
    You can specify an AWS Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.
    
    If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: - 64
    Pattern: [a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]
    
    Parameters:
    
    outputBucketName -
    The location where the transcription is stored.
    
    If you set the OutputBucketName, Amazon Transcribe puts the transcript in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri. If you enable content redaction and choose to output an unredacted transcript, that transcript's location still appears in the TranscriptFileUri. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles.
    
    You can specify an AWS Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.
    
    If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getOutputKey
```
public java.lang.String getOutputKey()
```
    You can specify a location in an Amazon S3 bucket to store the output of your transcription job.
    
    If you don't specify an output key, Amazon Transcribe stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is "your-transcription-job-name.json".
    
    You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you specify "my-other-job-name.json" as the output key, the object key is changed to "my-other-job-name.json". You can use an output key to change both the prefix and the file name, for example "folder/my-other-job-name.json".
    
    If you specify an output key, you must also specify an S3 bucket in the OutputBucketName parameter.
    
    Constraints:
    Length: 1 - 1024
    Pattern: [a-zA-Z0-9-_.!*'()/]{1,1024}$
    
    Returns:
    
    You can specify a location in an Amazon S3 bucket to store the output of your transcription job.
    
    If you don't specify an output key, Amazon Transcribe stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is "your-transcription-job-name.json".
    
    You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you specify "my-other-job-name.json" as the output key, the object key is changed to "my-other-job-name.json". You can use an output key to change both the prefix and the file name, for example "folder/my-other-job-name.json".
    
    If you specify an output key, you must also specify an S3 bucket in the OutputBucketName parameter.
  - setOutputKey
```
public void setOutputKey(java.lang.String outputKey)
```
    You can specify a location in an Amazon S3 bucket to store the output of your transcription job.
    
    If you don't specify an output key, Amazon Transcribe stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is "your-transcription-job-name.json".
    
    You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you specify "my-other-job-name.json" as the output key, the object key is changed to "my-other-job-name.json". You can use an output key to change both the prefix and the file name, for example "folder/my-other-job-name.json".
    
    If you specify an output key, you must also specify an S3 bucket in the OutputBucketName parameter.
    
    Constraints:
    Length: 1 - 1024
    Pattern: [a-zA-Z0-9-_.!*'()/]{1,1024}$
    
    Parameters:
    
    outputKey -
    You can specify a location in an Amazon S3 bucket to store the output of your transcription job.
    
    If you don't specify an output key, Amazon Transcribe stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is "your-transcription-job-name.json".
    
    You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you specify "my-other-job-name.json" as the output key, the object key is changed to "my-other-job-name.json". You can use an output key to change both the prefix and the file name, for example "folder/my-other-job-name.json".
    
    If you specify an output key, you must also specify an S3 bucket in the OutputBucketName parameter.
  - withOutputKey
```
public StartTranscriptionJobRequest withOutputKey(java.lang.String outputKey)
```
    You can specify a location in an Amazon S3 bucket to store the output of your transcription job.
    
    If you don't specify an output key, Amazon Transcribe stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is "your-transcription-job-name.json".
    
    You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you specify "my-other-job-name.json" as the output key, the object key is changed to "my-other-job-name.json". You can use an output key to change both the prefix and the file name, for example "folder/my-other-job-name.json".
    
    If you specify an output key, you must also specify an S3 bucket in the OutputBucketName parameter.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 1024
    Pattern: [a-zA-Z0-9-_.!*'()/]{1,1024}$
    
    Parameters:
    
    outputKey -
    You can specify a location in an Amazon S3 bucket to store the output of your transcription job.
    
    If you don't specify an output key, Amazon Transcribe stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is "your-transcription-job-name.json".
    
    You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you specify "my-other-job-name.json" as the output key, the object key is changed to "my-other-job-name.json". You can use an output key to change both the prefix and the file name, for example "folder/my-other-job-name.json".
    
    If you specify an output key, you must also specify an S3 bucket in the OutputBucketName parameter.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getOutputEncryptionKMSKeyId
```
public java.lang.String getOutputEncryptionKMSKeyId()
```
    The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartTranscriptionJob operation must have permission to use the specified KMS key.
    
    You can use either of the following to identify a KMS key in the current account:
    - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    - KMS Key Alias: "alias/ExampleAlias"
    You can use either of the following to identify a KMS key in the current account or another account:
    - Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    - ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"
    If you don't specify an encryption key, the output of the transcription job is encrypted with the default Amazon S3 key (SSE-S3).
    
    If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.
    
    Constraints:
    Length: 1 - 2048
    Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$
    Returns:
    The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartTranscriptionJob operation must have permission to use the specified KMS key.
    
    You can use either of the following to identify a KMS key in the current account:
    
    KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    
    KMS Key Alias: "alias/ExampleAlias"
    
    You can use either of the following to identify a KMS key in the current account or another account:
    
    Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    
    ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"
    
    If you don't specify an encryption key, the output of the transcription job is encrypted with the default Amazon S3 key (SSE-S3).
    
    If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.
  - setOutputEncryptionKMSKeyId
```
public void setOutputEncryptionKMSKeyId(java.lang.String outputEncryptionKMSKeyId)
```
    The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartTranscriptionJob operation must have permission to use the specified KMS key.
    
    You can use either of the following to identify a KMS key in the current account:
    - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    - KMS Key Alias: "alias/ExampleAlias"
    You can use either of the following to identify a KMS key in the current account or another account:
    - Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    - ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"
    If you don't specify an encryption key, the output of the transcription job is encrypted with the default Amazon S3 key (SSE-S3).
    
    If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.
    
    Constraints:
    Length: 1 - 2048
    Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$
    Parameters:
    outputEncryptionKMSKeyId -
    The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartTranscriptionJob operation must have permission to use the specified KMS key.
    
    You can use either of the following to identify a KMS key in the current account:
    
    KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    
    KMS Key Alias: "alias/ExampleAlias"
    
    You can use either of the following to identify a KMS key in the current account or another account:
    
    Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    
    ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"
    
    If you don't specify an encryption key, the output of the transcription job is encrypted with the default Amazon S3 key (SSE-S3).
    
    If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.
  - withOutputEncryptionKMSKeyId
```
public StartTranscriptionJobRequest withOutputEncryptionKMSKeyId(java.lang.String outputEncryptionKMSKeyId)
```
    The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartTranscriptionJob operation must have permission to use the specified KMS key.
    
    You can use either of the following to identify a KMS key in the current account:
    - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    - KMS Key Alias: "alias/ExampleAlias"
    You can use either of the following to identify a KMS key in the current account or another account:
    - Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    - ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"
    If you don't specify an encryption key, the output of the transcription job is encrypted with the default Amazon S3 key (SSE-S3).
    
    If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 2048
    Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$
    Parameters:
    outputEncryptionKMSKeyId -
    The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartTranscriptionJob operation must have permission to use the specified KMS key.
    
    You can use either of the following to identify a KMS key in the current account:
    
    KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    
    KMS Key Alias: "alias/ExampleAlias"
    
    You can use either of the following to identify a KMS key in the current account or another account:
    
    Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    
    ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"
    
    If you don't specify an encryption key, the output of the transcription job is encrypted with the default Amazon S3 key (SSE-S3).
    
    If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSettings
```
public Settings getSettings()
```
    A Settings object that provides optional settings for a transcription job.
    
    Returns:
    
    A Settings object that provides optional settings for a transcription job.
  - setSettings
```
public void setSettings(Settings settings)
```
    A Settings object that provides optional settings for a transcription job.
    
    Parameters:
    
    settings -
    A Settings object that provides optional settings for a transcription job.
  - withSettings
```
public StartTranscriptionJobRequest withSettings(Settings settings)
```
    A Settings object that provides optional settings for a transcription job.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    settings -
    A Settings object that provides optional settings for a transcription job.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getModelSettings
```
public ModelSettings getModelSettings()
```
    Choose the custom language model you use for your transcription job in this parameter.
    
    Returns:
    
    Choose the custom language model you use for your transcription job in this parameter.
  - setModelSettings
```
public void setModelSettings(ModelSettings modelSettings)
```
    Choose the custom language model you use for your transcription job in this parameter.
    
    Parameters:
    
    modelSettings -
    Choose the custom language model you use for your transcription job in this parameter.
  - withModelSettings
```
public StartTranscriptionJobRequest withModelSettings(ModelSettings modelSettings)
```
    Choose the custom language model you use for your transcription job in this parameter.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    modelSettings -
    Choose the custom language model you use for your transcription job in this parameter.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getJobExecutionSettings
```
public JobExecutionSettings getJobExecutionSettings()
```
    Provides information about how a transcription job is executed. Use this field to indicate that the job can be queued for deferred execution if the concurrency limit is reached and there are no slots available to immediately run the job.
    
    Returns:
    
    Provides information about how a transcription job is executed. Use this field to indicate that the job can be queued for deferred execution if the concurrency limit is reached and there are no slots available to immediately run the job.
  - setJobExecutionSettings
```
public void setJobExecutionSettings(JobExecutionSettings jobExecutionSettings)
```
    Provides information about how a transcription job is executed. Use this field to indicate that the job can be queued for deferred execution if the concurrency limit is reached and there are no slots available to immediately run the job.
    
    Parameters:
    
    jobExecutionSettings -
    Provides information about how a transcription job is executed. Use this field to indicate that the job can be queued for deferred execution if the concurrency limit is reached and there are no slots available to immediately run the job.
  - withJobExecutionSettings
```
public StartTranscriptionJobRequest withJobExecutionSettings(JobExecutionSettings jobExecutionSettings)
```
    Provides information about how a transcription job is executed. Use this field to indicate that the job can be queued for deferred execution if the concurrency limit is reached and there are no slots available to immediately run the job.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    jobExecutionSettings -
    Provides information about how a transcription job is executed. Use this field to indicate that the job can be queued for deferred execution if the concurrency limit is reached and there are no slots available to immediately run the job.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getContentRedaction
```
public ContentRedaction getContentRedaction()
```
    An object that contains the request parameters for content redaction.
    
    Returns:
    
    An object that contains the request parameters for content redaction.
  - setContentRedaction
```
public void setContentRedaction(ContentRedaction contentRedaction)
```
    An object that contains the request parameters for content redaction.
    
    Parameters:
    
    contentRedaction -
    An object that contains the request parameters for content redaction.
  - withContentRedaction
```
public StartTranscriptionJobRequest withContentRedaction(ContentRedaction contentRedaction)
```
    An object that contains the request parameters for content redaction.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    contentRedaction -
    An object that contains the request parameters for content redaction.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - isIdentifyLanguage
```
public java.lang.Boolean isIdentifyLanguage()
```
    Set this field to true to enable automatic language identification. Automatic language identification is disabled by default. You receive a BadRequestException error if you enter a value for a LanguageCode.
    
    Returns:
    
    Set this field to true to enable automatic language identification. Automatic language identification is disabled by default. You receive a BadRequestException error if you enter a value for a LanguageCode.
  - getIdentifyLanguage
```
public java.lang.Boolean getIdentifyLanguage()
```
    Set this field to true to enable automatic language identification. Automatic language identification is disabled by default. You receive a BadRequestException error if you enter a value for a LanguageCode.
    
    Returns:
    
    Set this field to true to enable automatic language identification. Automatic language identification is disabled by default. You receive a BadRequestException error if you enter a value for a LanguageCode.
  - setIdentifyLanguage
```
public void setIdentifyLanguage(java.lang.Boolean identifyLanguage)
```
    Set this field to true to enable automatic language identification. Automatic language identification is disabled by default. You receive a BadRequestException error if you enter a value for a LanguageCode.
    
    Parameters:
    
    identifyLanguage -
    Set this field to true to enable automatic language identification. Automatic language identification is disabled by default. You receive a BadRequestException error if you enter a value for a LanguageCode.
  - withIdentifyLanguage
```
public StartTranscriptionJobRequest withIdentifyLanguage(java.lang.Boolean identifyLanguage)
```
    Set this field to true to enable automatic language identification. Automatic language identification is disabled by default. You receive a BadRequestException error if you enter a value for a LanguageCode.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    identifyLanguage -
    Set this field to true to enable automatic language identification. Automatic language identification is disabled by default. You receive a BadRequestException error if you enter a value for a LanguageCode.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getLanguageOptions
```
public java.util.List<java.lang.String> getLanguageOptions()
```
    An object containing a list of languages that might be present in your collection of audio files. Automatic language identification chooses a language that best matches the source audio from that list.
    
    Returns:
    
    An object containing a list of languages that might be present in your collection of audio files. Automatic language identification chooses a language that best matches the source audio from that list.
  - setLanguageOptions
```
public void setLanguageOptions(java.util.Collection<java.lang.String> languageOptions)
```
    An object containing a list of languages that might be present in your collection of audio files. Automatic language identification chooses a language that best matches the source audio from that list.
    
    Parameters:
    
    languageOptions -
    An object containing a list of languages that might be present in your collection of audio files. Automatic language identification chooses a language that best matches the source audio from that list.
  - withLanguageOptions
```
public StartTranscriptionJobRequest withLanguageOptions(java.lang.String... languageOptions)
```
    An object containing a list of languages that might be present in your collection of audio files. Automatic language identification chooses a language that best matches the source audio from that list.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    languageOptions -
    An object containing a list of languages that might be present in your collection of audio files. Automatic language identification chooses a language that best matches the source audio from that list.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withLanguageOptions
```
public StartTranscriptionJobRequest withLanguageOptions(java.util.Collection<java.lang.String> languageOptions)
```
    An object containing a list of languages that might be present in your collection of audio files. Automatic language identification chooses a language that best matches the source audio from that list.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    languageOptions -
    An object containing a list of languages that might be present in your collection of audio files. Automatic language identification chooses a language that best matches the source audio from that list.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class StartTranscriptionJobRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

StartTranscriptionJobRequest

Method Detail

getTranscriptionJobName

setTranscriptionJobName

withTranscriptionJobName

getLanguageCode

setLanguageCode

withLanguageCode

setLanguageCode

withLanguageCode

getMediaSampleRateHertz

setMediaSampleRateHertz

withMediaSampleRateHertz

getMediaFormat

setMediaFormat

withMediaFormat

setMediaFormat

withMediaFormat

getMedia

setMedia

withMedia

getOutputBucketName

setOutputBucketName

withOutputBucketName

getOutputKey

setOutputKey

withOutputKey

getOutputEncryptionKMSKeyId

setOutputEncryptionKMSKeyId

withOutputEncryptionKMSKeyId

getSettings

setSettings

withSettings

getModelSettings

setModelSettings

withModelSettings

getJobExecutionSettings

setJobExecutionSettings

withJobExecutionSettings

getContentRedaction

setContentRedaction

withContentRedaction

isIdentifyLanguage

getIdentifyLanguage

setIdentifyLanguage

withIdentifyLanguage

getLanguageOptions

setLanguageOptions

withLanguageOptions

withLanguageOptions

toString

hashCode

equals