public static interface StartMedicalTranscriptionJobRequest.Builder extends TranscribeRequest.Builder, SdkPojo, CopyableBuilder<StartMedicalTranscriptionJobRequest.Builder,StartMedicalTranscriptionJobRequest>
| Modifier and Type | Method and Description |
|---|---|
StartMedicalTranscriptionJobRequest.Builder |
contentIdentificationType(MedicalContentIdentificationType contentIdentificationType)
You can configure Amazon Transcribe Medical to label content in the transcription output.
|
StartMedicalTranscriptionJobRequest.Builder |
contentIdentificationType(String contentIdentificationType)
You can configure Amazon Transcribe Medical to label content in the transcription output.
|
StartMedicalTranscriptionJobRequest.Builder |
kmsEncryptionContext(Map<String,String> kmsEncryptionContext)
A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added
layer of security for your data.
|
StartMedicalTranscriptionJobRequest.Builder |
languageCode(LanguageCode languageCode)
The language code for the language spoken in the input media file.
|
StartMedicalTranscriptionJobRequest.Builder |
languageCode(String languageCode)
The language code for the language spoken in the input media file.
|
default StartMedicalTranscriptionJobRequest.Builder |
media(Consumer<Media.Builder> media)
Sets the value of the Media property for this object.
|
StartMedicalTranscriptionJobRequest.Builder |
media(Media media)
Sets the value of the Media property for this object.
|
StartMedicalTranscriptionJobRequest.Builder |
mediaFormat(MediaFormat mediaFormat)
The audio format of the input media file.
|
StartMedicalTranscriptionJobRequest.Builder |
mediaFormat(String mediaFormat)
The audio format of the input media file.
|
StartMedicalTranscriptionJobRequest.Builder |
mediaSampleRateHertz(Integer mediaSampleRateHertz)
The sample rate, in Hertz, of the audio track in the input media file.
|
StartMedicalTranscriptionJobRequest.Builder |
medicalTranscriptionJobName(String medicalTranscriptionJobName)
The name of the medical transcription job.
|
StartMedicalTranscriptionJobRequest.Builder |
outputBucketName(String outputBucketName)
The Amazon S3 location where the transcription is stored.
|
StartMedicalTranscriptionJobRequest.Builder |
outputEncryptionKMSKeyId(String outputEncryptionKMSKeyId)
The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS) key used to encrypt
the output of the transcription job.
|
StartMedicalTranscriptionJobRequest.Builder |
outputKey(String outputKey)
You can specify a location in an Amazon S3 bucket to store the output of your medical transcription job.
|
StartMedicalTranscriptionJobRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
StartMedicalTranscriptionJobRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
default StartMedicalTranscriptionJobRequest.Builder |
settings(Consumer<MedicalTranscriptionSetting.Builder> settings)
Optional settings for the medical transcription job.
|
StartMedicalTranscriptionJobRequest.Builder |
settings(MedicalTranscriptionSetting settings)
Optional settings for the medical transcription job.
|
StartMedicalTranscriptionJobRequest.Builder |
specialty(Specialty specialty)
The medical specialty of any clinician speaking in the input media.
|
StartMedicalTranscriptionJobRequest.Builder |
specialty(String specialty)
The medical specialty of any clinician speaking in the input media.
|
StartMedicalTranscriptionJobRequest.Builder |
tags(Collection<Tag> tags)
Add tags to an Amazon Transcribe medical transcription job.
|
StartMedicalTranscriptionJobRequest.Builder |
tags(Consumer<Tag.Builder>... tags)
Add tags to an Amazon Transcribe medical transcription job.
|
StartMedicalTranscriptionJobRequest.Builder |
tags(Tag... tags)
Add tags to an Amazon Transcribe medical transcription job.
|
StartMedicalTranscriptionJobRequest.Builder |
type(String type)
The type of speech in the input audio.
|
StartMedicalTranscriptionJobRequest.Builder |
type(Type type)
The type of speech in the input audio.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildStartMedicalTranscriptionJobRequest.Builder medicalTranscriptionJobName(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 Amazon Web Services 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 Amazon Web
Services 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.StartMedicalTranscriptionJobRequest.Builder languageCode(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,
LanguageCodeStartMedicalTranscriptionJobRequest.Builder languageCode(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,
LanguageCodeStartMedicalTranscriptionJobRequest.Builder mediaSampleRateHertz(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.
StartMedicalTranscriptionJobRequest.Builder mediaFormat(String mediaFormat)
The audio format of the input media file.
mediaFormat - The audio format of the input media file.MediaFormat,
MediaFormatStartMedicalTranscriptionJobRequest.Builder mediaFormat(MediaFormat mediaFormat)
The audio format of the input media file.
mediaFormat - The audio format of the input media file.MediaFormat,
MediaFormatStartMedicalTranscriptionJobRequest.Builder media(Media media)
media - The new value for the Media property for this object.default StartMedicalTranscriptionJobRequest.Builder media(Consumer<Media.Builder> media)
Media.Builder avoiding the need to create one
manually via Media.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result is
passed to media(Media).media - a consumer that will call methods on Media.Buildermedia(Media)StartMedicalTranscriptionJobRequest.Builder outputBucketName(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 Amazon Web Services 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 Amazon Web Services 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.
StartMedicalTranscriptionJobRequest.Builder outputKey(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.
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.
StartMedicalTranscriptionJobRequest.Builder outputEncryptionKMSKeyId(String outputEncryptionKMSKeyId)
The Amazon Resource Name (ARN) of the Amazon Web Services 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 Amazon Web Services 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.
StartMedicalTranscriptionJobRequest.Builder kmsEncryptionContext(Map<String,String> kmsEncryptionContext)
A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data.
kmsEncryptionContext - A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an
added layer of security for your data.StartMedicalTranscriptionJobRequest.Builder settings(MedicalTranscriptionSetting settings)
Optional settings for the medical transcription job.
settings - Optional settings for the medical transcription job.default StartMedicalTranscriptionJobRequest.Builder settings(Consumer<MedicalTranscriptionSetting.Builder> settings)
Optional settings for the medical transcription job.
This is a convenience that creates an instance of theMedicalTranscriptionSetting.Builder avoiding
the need to create one manually via MedicalTranscriptionSetting.builder().
When the Consumer completes, SdkBuilder.build() is called
immediately and its result is passed to settings(MedicalTranscriptionSetting).settings - a consumer that will call methods on MedicalTranscriptionSetting.Buildersettings(MedicalTranscriptionSetting)StartMedicalTranscriptionJobRequest.Builder contentIdentificationType(String contentIdentificationType)
You can configure Amazon Transcribe Medical to label content in the transcription output. If you specify
PHI, Amazon Transcribe Medical labels the personal health information (PHI) that it identifies
in the transcription output.
contentIdentificationType - You can configure Amazon Transcribe Medical to label content in the transcription output. If you
specify PHI, Amazon Transcribe Medical labels the personal health information (PHI) that
it identifies in the transcription output.MedicalContentIdentificationType,
MedicalContentIdentificationTypeStartMedicalTranscriptionJobRequest.Builder contentIdentificationType(MedicalContentIdentificationType contentIdentificationType)
You can configure Amazon Transcribe Medical to label content in the transcription output. If you specify
PHI, Amazon Transcribe Medical labels the personal health information (PHI) that it identifies
in the transcription output.
contentIdentificationType - You can configure Amazon Transcribe Medical to label content in the transcription output. If you
specify PHI, Amazon Transcribe Medical labels the personal health information (PHI) that
it identifies in the transcription output.MedicalContentIdentificationType,
MedicalContentIdentificationTypeStartMedicalTranscriptionJobRequest.Builder specialty(String specialty)
The medical specialty of any clinician speaking in the input media.
StartMedicalTranscriptionJobRequest.Builder specialty(Specialty specialty)
The medical specialty of any clinician speaking in the input media.
StartMedicalTranscriptionJobRequest.Builder type(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, such as 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, such as clinical notes.Type,
TypeStartMedicalTranscriptionJobRequest.Builder type(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, such as 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, such as clinical notes.Type,
TypeStartMedicalTranscriptionJobRequest.Builder tags(Collection<Tag> tags)
Add tags to an Amazon Transcribe medical transcription job.
tags - Add tags to an Amazon Transcribe medical transcription job.StartMedicalTranscriptionJobRequest.Builder tags(Tag... tags)
Add tags to an Amazon Transcribe medical transcription job.
tags - Add tags to an Amazon Transcribe medical transcription job.StartMedicalTranscriptionJobRequest.Builder tags(Consumer<Tag.Builder>... tags)
Add tags to an Amazon Transcribe medical transcription job.
This is a convenience that creates an instance of theList.Builder avoiding the need to create
one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and its result
is passed to #tags(List) .tags - a consumer that will call methods on List.Builder #tags(List) StartMedicalTranscriptionJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderStartMedicalTranscriptionJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2021. All rights reserved.