@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class StartMedicalTranscriptionJobRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
StartMedicalTranscriptionJobRequest() |
Modifier and Type | Method and Description |
---|---|
StartMedicalTranscriptionJobRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getLanguageCode()
The language code for the language spoken in the input media file.
|
Media |
getMedia() |
String |
getMediaFormat()
The audio format of the input media file.
|
Integer |
getMediaSampleRateHertz()
The sample rate, in Hertz, of the audio track in the input media file.
|
String |
getMedicalTranscriptionJobName()
The name of the medical transcription job.
|
String |
getOutputBucketName()
The Amazon S3 location where the transcription is stored.
|
String |
getOutputEncryptionKMSKeyId()
The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the
transcription job.
|
MedicalTranscriptionSetting |
getSettings()
Optional settings for the medical transcription job.
|
String |
getSpecialty()
The medical specialty of any clinician speaking in the input media.
|
String |
getType()
The type of speech in the input audio.
|
int |
hashCode() |
void |
setLanguageCode(String languageCode)
The language code for the language spoken in the input media file.
|
void |
setMedia(Media media) |
void |
setMediaFormat(String mediaFormat)
The audio format of the input media file.
|
void |
setMediaSampleRateHertz(Integer mediaSampleRateHertz)
The sample rate, in Hertz, of the audio track in the input media file.
|
void |
setMedicalTranscriptionJobName(String medicalTranscriptionJobName)
The name of the medical transcription job.
|
void |
setOutputBucketName(String outputBucketName)
The Amazon S3 location where the transcription is stored.
|
void |
setOutputEncryptionKMSKeyId(String outputEncryptionKMSKeyId)
The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the
transcription job.
|
void |
setSettings(MedicalTranscriptionSetting settings)
Optional settings for the medical transcription job.
|
void |
setSpecialty(String specialty)
The medical specialty of any clinician speaking in the input media.
|
void |
setType(String type)
The type of speech in the input audio.
|
String |
toString()
Returns a string representation of this object.
|
StartMedicalTranscriptionJobRequest |
withLanguageCode(LanguageCode languageCode)
The language code for the language spoken in the input media file.
|
StartMedicalTranscriptionJobRequest |
withLanguageCode(String languageCode)
The language code for the language spoken in the input media file.
|
StartMedicalTranscriptionJobRequest |
withMedia(Media media) |
StartMedicalTranscriptionJobRequest |
withMediaFormat(MediaFormat mediaFormat)
The audio format of the input media file.
|
StartMedicalTranscriptionJobRequest |
withMediaFormat(String mediaFormat)
The audio format of the input media file.
|
StartMedicalTranscriptionJobRequest |
withMediaSampleRateHertz(Integer mediaSampleRateHertz)
The sample rate, in Hertz, of the audio track in the input media file.
|
StartMedicalTranscriptionJobRequest |
withMedicalTranscriptionJobName(String medicalTranscriptionJobName)
The name of the medical transcription job.
|
StartMedicalTranscriptionJobRequest |
withOutputBucketName(String outputBucketName)
The Amazon S3 location where the transcription is stored.
|
StartMedicalTranscriptionJobRequest |
withOutputEncryptionKMSKeyId(String outputEncryptionKMSKeyId)
The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the
transcription job.
|
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(String specialty)
The medical specialty of any clinician speaking in the input media.
|
StartMedicalTranscriptionJobRequest |
withType(String type)
The type of speech in the input audio.
|
StartMedicalTranscriptionJobRequest |
withType(Type type)
The type of speech in the input audio.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setMedicalTranscriptionJobName(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.
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.public 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.
.
" 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.public StartMedicalTranscriptionJobRequest withMedicalTranscriptionJobName(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.
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.public void setLanguageCode(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.
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.LanguageCode
public 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.
BadRequestException
error.LanguageCode
public StartMedicalTranscriptionJobRequest withLanguageCode(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.
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.LanguageCode
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.
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.LanguageCode
public void setMediaSampleRateHertz(Integer mediaSampleRateHertz)
The sample rate, in Hertz, of the audio track in the input media file.
If you do not specify the media sample rate, Amazon Transcribe 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.
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.
public Integer getMediaSampleRateHertz()
The sample rate, in Hertz, of the audio track in the input media file.
If you do not specify the media sample rate, Amazon Transcribe 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.
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.
public StartMedicalTranscriptionJobRequest withMediaSampleRateHertz(Integer mediaSampleRateHertz)
The sample rate, in Hertz, of the audio track in the input media file.
If you do not specify the media sample rate, Amazon Transcribe 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.
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.
public void setMediaFormat(String mediaFormat)
The audio format of the input media file.
mediaFormat
- The audio format of the input media file.MediaFormat
public String getMediaFormat()
The audio format of the input media file.
MediaFormat
public StartMedicalTranscriptionJobRequest withMediaFormat(String mediaFormat)
The audio format of the input media file.
mediaFormat
- The audio format of the input media file.MediaFormat
public StartMedicalTranscriptionJobRequest withMediaFormat(MediaFormat mediaFormat)
The audio format of the input media file.
mediaFormat
- The audio format of the input media file.MediaFormat
public void setMedia(Media media)
media
- public Media getMedia()
public StartMedicalTranscriptionJobRequest withMedia(Media media)
media
- public void setOutputBucketName(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.
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.
public 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.
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.
public StartMedicalTranscriptionJobRequest withOutputBucketName(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.
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.
public void setOutputEncryptionKMSKeyId(String outputEncryptionKMSKeyId)
The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the 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.
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.
public String getOutputEncryptionKMSKeyId()
The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the 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.
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.
public StartMedicalTranscriptionJobRequest withOutputEncryptionKMSKeyId(String outputEncryptionKMSKeyId)
The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the 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.
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.
public void setSettings(MedicalTranscriptionSetting settings)
Optional settings for the medical transcription job.
settings
- Optional settings for the medical transcription job.public MedicalTranscriptionSetting getSettings()
Optional settings for the medical transcription job.
public StartMedicalTranscriptionJobRequest withSettings(MedicalTranscriptionSetting settings)
Optional settings for the medical transcription job.
settings
- Optional settings for the medical transcription job.public void setSpecialty(String specialty)
The medical specialty of any clinician speaking in the input media.
specialty
- The medical specialty of any clinician speaking in the input media.Specialty
public String getSpecialty()
The medical specialty of any clinician speaking in the input media.
Specialty
public StartMedicalTranscriptionJobRequest withSpecialty(String specialty)
The medical specialty of any clinician speaking in the input media.
specialty
- The medical specialty of any clinician speaking in the input media.Specialty
public StartMedicalTranscriptionJobRequest withSpecialty(Specialty specialty)
The medical specialty of any clinician speaking in the input media.
specialty
- The medical specialty of any clinician speaking in the input media.Specialty
public void setType(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.
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.Type
public 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.
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.Type
public StartMedicalTranscriptionJobRequest withType(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.
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.Type
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.
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.Type
public String toString()
toString
in class Object
Object.toString()
public StartMedicalTranscriptionJobRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()