StartMedicalTranscriptionJobRequest (AWS SDK for Android

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class StartMedicalTranscriptionJobRequest
extends AmazonWebServiceRequest
implements java.io.Serializable
```
Starts a batch job to transcribe medical speech to text.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

StartMedicalTranscriptionJobRequest()

Constructors
Constructor and Description
`StartMedicalTranscriptionJobRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getLanguageCode()` The language code for the language spoken in the input media file.
`Media`	`getMedia()` Describes the input media file in a transcription request.
`java.lang.String`	`getMediaFormat()` The audio format of the input media file.
`java.lang.Integer`	`getMediaSampleRateHertz()` The sample rate, in Hertz, of the audio track in the input media file.
`java.lang.String`	`getMedicalTranscriptionJobName()` The name of the medical transcription job.
`java.lang.String`	`getOutputBucketName()` The Amazon S3 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 medical transcription job.
`MedicalTranscriptionSetting`	`getSettings()` Optional settings for the medical transcription job.
`java.lang.String`	`getSpecialty()` The medical specialty of any clinician speaking in the input media.
`java.lang.String`	`getType()` The type of speech in the input audio.
`int`	`hashCode()`
`void`	`setLanguageCode(LanguageCode languageCode)` The language code for the language spoken in the input media file.
`void`	`setLanguageCode(java.lang.String languageCode)` The language code for the language spoken in the input media file.
`void`	`setMedia(Media media)` Describes the input media file in a transcription request.
`void`	`setMediaFormat(MediaFormat mediaFormat)` The audio format of the input media file.
`void`	`setMediaFormat(java.lang.String mediaFormat)` The audio 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`	`setMedicalTranscriptionJobName(java.lang.String medicalTranscriptionJobName)` The name of the medical transcription job.
`void`	`setOutputBucketName(java.lang.String outputBucketName)` The Amazon S3 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 medical transcription job.
`void`	`setSettings(MedicalTranscriptionSetting settings)` Optional settings for the medical transcription job.
`void`	`setSpecialty(Specialty specialty)` The medical specialty of any clinician speaking in the input media.
`void`	`setSpecialty(java.lang.String specialty)` The medical specialty of any clinician speaking in the input media.
`void`	`setType(java.lang.String type)` The type of speech in the input audio.
`void`	`setType(Type type)` The type of speech in the input audio.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`StartMedicalTranscriptionJobRequest`	`withLanguageCode(LanguageCode languageCode)` The language code for the language spoken in the input media file.
`StartMedicalTranscriptionJobRequest`	`withLanguageCode(java.lang.String languageCode)` The language code for the language spoken in the input media file.
`StartMedicalTranscriptionJobRequest`	`withMedia(Media media)` Describes the input media file in a transcription request.
`StartMedicalTranscriptionJobRequest`	`withMediaFormat(MediaFormat mediaFormat)` The audio format of the input media file.
`StartMedicalTranscriptionJobRequest`	`withMediaFormat(java.lang.String mediaFormat)` The audio format of the input media file.
`StartMedicalTranscriptionJobRequest`	`withMediaSampleRateHertz(java.lang.Integer mediaSampleRateHertz)` The sample rate, in Hertz, of the audio track in the input media file.
`StartMedicalTranscriptionJobRequest`	`withMedicalTranscriptionJobName(java.lang.String medicalTranscriptionJobName)` The name of the medical transcription job.
`StartMedicalTranscriptionJobRequest`	`withOutputBucketName(java.lang.String outputBucketName)` The Amazon S3 location where the transcription is stored.
`StartMedicalTranscriptionJobRequest`	`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.
`StartMedicalTranscriptionJobRequest`	`withOutputKey(java.lang.String outputKey)` You can specify a location in an Amazon S3 bucket to store the output of your medical transcription job.
`StartMedicalTranscriptionJobRequest`	`withSettings(MedicalTranscriptionSetting settings)` Optional settings for the medical transcription job.
`StartMedicalTranscriptionJobRequest`	`withSpecialty(Specialty specialty)` The medical specialty of any clinician speaking in the input media.
`StartMedicalTranscriptionJobRequest`	`withSpecialty(java.lang.String specialty)` The medical specialty of any clinician speaking in the input media.
`StartMedicalTranscriptionJobRequest`	`withType(java.lang.String type)` The type of speech in the input audio.
`StartMedicalTranscriptionJobRequest`	`withType(Type type)` The type of speech in the input audio.

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
  - StartMedicalTranscriptionJobRequest
```
public StartMedicalTranscriptionJobRequest()
```
- Method Detail
  - getMedicalTranscriptionJobName
```
public java.lang.String getMedicalTranscriptionJobName()
```
    The name of the medical transcription 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 medical transcription job with the same name as a previous medical transcription job, you get a ConflictException error.
    
    Constraints:
    Length: 1 - 200
    Pattern: ^[0-9a-zA-Z._-]+
    
    Returns:
    
    The name of the medical transcription 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 medical transcription job with the same name as a previous medical transcription job, you get a ConflictException error.
  - setMedicalTranscriptionJobName
```
public void setMedicalTranscriptionJobName(java.lang.String medicalTranscriptionJobName)
```
    The name of the medical transcription 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 medical transcription job with the same name as a previous medical transcription job, you get a ConflictException error.
    
    Constraints:
    Length: 1 - 200
    Pattern: ^[0-9a-zA-Z._-]+
    
    Parameters:
    
    medicalTranscriptionJobName -
    The name of the medical transcription 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 medical transcription job with the same name as a previous medical transcription job, you get a ConflictException error.
  - withMedicalTranscriptionJobName
```
public StartMedicalTranscriptionJobRequest withMedicalTranscriptionJobName(java.lang.String medicalTranscriptionJobName)
```
    The name of the medical transcription 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 medical transcription job with the same name as a previous medical 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:
    
    medicalTranscriptionJobName -
    The name of the medical transcription 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 medical transcription job with the same name as a previous medical 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 spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.
    
    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 spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.
    
    See Also:
    
    LanguageCode
  - setLanguageCode
```
public void setLanguageCode(java.lang.String languageCode)
```
    The language code for the language spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.
    
    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 spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.
    
    See Also:
    
    LanguageCode
  - withLanguageCode
```
public StartMedicalTranscriptionJobRequest withLanguageCode(java.lang.String languageCode)
```
    The language code for the language spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.
    
    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 spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.
    
    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 spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.
    
    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 spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.
    
    See Also:
    
    LanguageCode
  - withLanguageCode
```
public StartMedicalTranscriptionJobRequest withLanguageCode(LanguageCode languageCode)
```
    The language code for the language spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.
    
    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 spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.
    
    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 Medical determines the sample rate. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe Medical 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 Medical determines the sample rate. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe Medical 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 Medical determines the sample rate. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe Medical 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 Medical determines the sample rate. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe Medical determine the sample rate.
  - withMediaSampleRateHertz
```
public StartMedicalTranscriptionJobRequest 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 Medical determines the sample rate. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe Medical 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 Medical determines the sample rate. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe Medical 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 audio format of the input media file.
    
    Constraints:
    Allowed Values: mp3, mp4, wav, flac, ogg, amr, webm
    
    Returns:
    
    The audio format of the input media file.
    
    See Also:
    
    MediaFormat
  - setMediaFormat
```
public void setMediaFormat(java.lang.String mediaFormat)
```
    The audio format of the input media file.
    
    Constraints:
    Allowed Values: mp3, mp4, wav, flac, ogg, amr, webm
    
    Parameters:
    
    mediaFormat -
    The audio format of the input media file.
    
    See Also:
    
    MediaFormat
  - withMediaFormat
```
public StartMedicalTranscriptionJobRequest withMediaFormat(java.lang.String mediaFormat)
```
    The audio 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 audio 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 audio format of the input media file.
    
    Constraints:
    Allowed Values: mp3, mp4, wav, flac, ogg, amr, webm
    
    Parameters:
    
    mediaFormat -
    The audio format of the input media file.
    
    See Also:
    
    MediaFormat
  - withMediaFormat
```
public StartMedicalTranscriptionJobRequest withMediaFormat(MediaFormat mediaFormat)
```
    The audio 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 audio 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()
```
    Describes the input media file in a transcription request.
    
    Returns:
    
    Describes the input media file in a transcription request.
  - setMedia
```
public void setMedia(Media media)
```
    Describes the input media file in a transcription request.
    
    Parameters:
    
    media -
    Describes the input media file in a transcription request.
  - withMedia
```
public StartMedicalTranscriptionJobRequest withMedia(Media media)
```
    Describes the input media file in a transcription request.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    media -
    Describes the input media file in a transcription request.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getOutputBucketName
```
public java.lang.String getOutputBucketName()
```
    The Amazon S3 location where the transcription is stored.
    
    You must set OutputBucketName for Amazon Transcribe Medical to store the transcription results. Your transcript appears in the S3 location you specify. When you call the GetMedicalTranscriptionJob, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe Medical 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 Medical uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.
    
    Constraints:
    Length: - 64
    Pattern: [a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]
    
    Returns:
    
    The Amazon S3 location where the transcription is stored.
    
    You must set OutputBucketName for Amazon Transcribe Medical to store the transcription results. Your transcript appears in the S3 location you specify. When you call the GetMedicalTranscriptionJob, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe Medical 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 Medical uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.
  - setOutputBucketName
```
public void setOutputBucketName(java.lang.String outputBucketName)
```
    The Amazon S3 location where the transcription is stored.
    
    You must set OutputBucketName for Amazon Transcribe Medical to store the transcription results. Your transcript appears in the S3 location you specify. When you call the GetMedicalTranscriptionJob, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe Medical 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 Medical uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.
    
    Constraints:
    Length: - 64
    Pattern: [a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]
    
    Parameters:
    
    outputBucketName -
    The Amazon S3 location where the transcription is stored.
    
    You must set OutputBucketName for Amazon Transcribe Medical to store the transcription results. Your transcript appears in the S3 location you specify. When you call the GetMedicalTranscriptionJob, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe Medical 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 Medical uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.
  - withOutputBucketName
```
public StartMedicalTranscriptionJobRequest withOutputBucketName(java.lang.String outputBucketName)
```
    The Amazon S3 location where the transcription is stored.
    
    You must set OutputBucketName for Amazon Transcribe Medical to store the transcription results. Your transcript appears in the S3 location you specify. When you call the GetMedicalTranscriptionJob, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe Medical 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 Medical uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.
    
    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 Amazon S3 location where the transcription is stored.
    
    You must set OutputBucketName for Amazon Transcribe Medical to store the transcription results. Your transcript appears in the S3 location you specify. When you call the GetMedicalTranscriptionJob, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe Medical 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 Medical uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.
    
    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 medical transcription job.
    
    If you don't specify an output key, Amazon Transcribe Medical 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 medical transcription job.
    
    If you don't specify an output key, Amazon Transcribe Medical 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 medical transcription job.
    
    If you don't specify an output key, Amazon Transcribe Medical 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 medical transcription job.
    
    If you don't specify an output key, Amazon Transcribe Medical 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 StartMedicalTranscriptionJobRequest withOutputKey(java.lang.String outputKey)
```
    You can specify a location in an Amazon S3 bucket to store the output of your medical transcription job.
    
    If you don't specify an output key, Amazon Transcribe Medical 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 medical transcription job.
    
    If you don't specify an output key, Amazon Transcribe Medical 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 StartMedicalTranscriptionJob operation must have permission to use the specified KMS key.
    
    You 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 in the current account or another account: "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 medical 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 StartMedicalTranscriptionJob operation must have permission to use the specified KMS key.
    
    You 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 in the current account or another account: "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 medical 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 StartMedicalTranscriptionJob operation must have permission to use the specified KMS key.
    
    You 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 in the current account or another account: "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 medical 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 StartMedicalTranscriptionJob operation must have permission to use the specified KMS key.
    
    You 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 in the current account or another account: "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 medical 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 StartMedicalTranscriptionJobRequest 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 StartMedicalTranscriptionJob operation must have permission to use the specified KMS key.
    
    You 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 in the current account or another account: "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 medical 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 StartMedicalTranscriptionJob operation must have permission to use the specified KMS key.
    
    You 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 in the current account or another account: "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 medical 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 MedicalTranscriptionSetting getSettings()
```
    Optional settings for the medical transcription job.
    
    Returns:
    
    Optional settings for the medical transcription job.
  - setSettings
```
public void setSettings(MedicalTranscriptionSetting settings)
```
    Optional settings for the medical transcription job.
    
    Parameters:
    
    settings -
    Optional settings for the medical transcription job.
  - withSettings
```
public StartMedicalTranscriptionJobRequest withSettings(MedicalTranscriptionSetting settings)
```
    Optional settings for the medical transcription job.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    settings -
    Optional settings for the medical transcription job.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSpecialty
```
public java.lang.String getSpecialty()
```
    The medical specialty of any clinician speaking in the input media.
    
    Constraints:
    Allowed Values: PRIMARYCARE
    
    Returns:
    
    The medical specialty of any clinician speaking in the input media.
    
    See Also:
    
    Specialty
  - setSpecialty
```
public void setSpecialty(java.lang.String specialty)
```
    The medical specialty of any clinician speaking in the input media.
    
    Constraints:
    Allowed Values: PRIMARYCARE
    
    Parameters:
    
    specialty -
    The medical specialty of any clinician speaking in the input media.
    
    See Also:
    
    Specialty
  - withSpecialty
```
public StartMedicalTranscriptionJobRequest withSpecialty(java.lang.String specialty)
```
    The medical specialty of any clinician speaking in the input media.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: PRIMARYCARE
    
    Parameters:
    
    specialty -
    The medical specialty of any clinician speaking in the input media.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    Specialty
  - setSpecialty
```
public void setSpecialty(Specialty specialty)
```
    The medical specialty of any clinician speaking in the input media.
    
    Constraints:
    Allowed Values: PRIMARYCARE
    
    Parameters:
    
    specialty -
    The medical specialty of any clinician speaking in the input media.
    
    See Also:
    
    Specialty
  - withSpecialty
```
public StartMedicalTranscriptionJobRequest withSpecialty(Specialty specialty)
```
    The medical specialty of any clinician speaking in the input media.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: PRIMARYCARE
    
    Parameters:
    
    specialty -
    The medical specialty of any clinician speaking in the input media.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    Specialty
  - getType
```
public java.lang.String getType()
```
    The type of speech in the input audio. CONVERSATION refers to conversations between two or more speakers, e.g., a conversations between doctors and patients. DICTATION refers to single-speaker dictated speech, e.g., for clinical notes.
    
    Constraints:
    Allowed Values: CONVERSATION, DICTATION
    
    Returns:
    
    The type of speech in the input audio. CONVERSATION refers to conversations between two or more speakers, e.g., a conversations between doctors and patients. DICTATION refers to single-speaker dictated speech, e.g., for clinical notes.
    
    See Also:
    
    Type
  - setType
```
public void setType(java.lang.String type)
```
    The type of speech in the input audio. CONVERSATION refers to conversations between two or more speakers, e.g., a conversations between doctors and patients. DICTATION refers to single-speaker dictated speech, e.g., for clinical notes.
    
    Constraints:
    Allowed Values: CONVERSATION, DICTATION
    
    Parameters:
    
    type -
    The type of speech in the input audio. CONVERSATION refers to conversations between two or more speakers, e.g., a conversations between doctors and patients. DICTATION refers to single-speaker dictated speech, e.g., for clinical notes.
    
    See Also:
    
    Type
  - withType
```
public StartMedicalTranscriptionJobRequest withType(java.lang.String type)
```
    The type of speech in the input audio. CONVERSATION refers to conversations between two or more speakers, e.g., a conversations between doctors and patients. DICTATION refers to single-speaker dictated speech, e.g., for clinical notes.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: CONVERSATION, DICTATION
    
    Parameters:
    
    type -
    The type of speech in the input audio. CONVERSATION refers to conversations between two or more speakers, e.g., a conversations between doctors and patients. DICTATION refers to single-speaker dictated speech, e.g., for clinical notes.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    Type
  - setType
```
public void setType(Type type)
```
    The type of speech in the input audio. CONVERSATION refers to conversations between two or more speakers, e.g., a conversations between doctors and patients. DICTATION refers to single-speaker dictated speech, e.g., for clinical notes.
    
    Constraints:
    Allowed Values: CONVERSATION, DICTATION
    
    Parameters:
    
    type -
    The type of speech in the input audio. CONVERSATION refers to conversations between two or more speakers, e.g., a conversations between doctors and patients. DICTATION refers to single-speaker dictated speech, e.g., for clinical notes.
    
    See Also:
    
    Type
  - withType
```
public StartMedicalTranscriptionJobRequest withType(Type type)
```
    The type of speech in the input audio. CONVERSATION refers to conversations between two or more speakers, e.g., a conversations between doctors and patients. DICTATION refers to single-speaker dictated speech, e.g., for clinical notes.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: CONVERSATION, DICTATION
    
    Parameters:
    
    type -
    The type of speech in the input audio. CONVERSATION refers to conversations between two or more speakers, e.g., a conversations between doctors and patients. DICTATION refers to single-speaker dictated speech, e.g., for clinical notes.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    Type
  - 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 StartMedicalTranscriptionJobRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

StartMedicalTranscriptionJobRequest

Method Detail

getMedicalTranscriptionJobName

setMedicalTranscriptionJobName

withMedicalTranscriptionJobName

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

getSpecialty

setSpecialty

withSpecialty

setSpecialty

withSpecialty

getType

setType

withType

setType

withType

toString

hashCode

equals