Interface StartMedicalTranscriptionJobRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<StartMedicalTranscriptionJobRequest.Builder,
,StartMedicalTranscriptionJobRequest> SdkBuilder<StartMedicalTranscriptionJobRequest.Builder,
,StartMedicalTranscriptionJobRequest> SdkPojo
,SdkRequest.Builder
,TranscribeRequest.Builder
- Enclosing class:
StartMedicalTranscriptionJobRequest
-
Method Summary
Modifier and TypeMethodDescriptioncontentIdentificationType
(String contentIdentificationType) Labels all personal health information (PHI) identified in your transcript.contentIdentificationType
(MedicalContentIdentificationType contentIdentificationType) Labels all personal health information (PHI) identified in your transcript.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.languageCode
(String languageCode) The language code that represents the language spoken in the input media file.languageCode
(LanguageCode languageCode) The language code that represents the language spoken in the input media file.media
(Consumer<Media.Builder> media) Sets the value of the Media property for this object.Sets the value of the Media property for this object.mediaFormat
(String mediaFormat) Specify the format of your input media file.mediaFormat
(MediaFormat mediaFormat) Specify the format of your input media file.mediaSampleRateHertz
(Integer mediaSampleRateHertz) The sample rate, in hertz, of the audio track in your input media file.medicalTranscriptionJobName
(String medicalTranscriptionJobName) A unique name, chosen by you, for your medical transcription job.outputBucketName
(String outputBucketName) The name of the Amazon S3 bucket where you want your medical transcription output stored.outputEncryptionKMSKeyId
(String outputEncryptionKMSKeyId) The KMS key you want to use to encrypt your medical transcription output.Use in combination withOutputBucketName
to specify the output location of your transcript and, optionally, a unique name for your output file.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.settings
(Consumer<MedicalTranscriptionSetting.Builder> settings) Specify additional optional settings in your request, including channel identification, alternative transcriptions, and speaker partitioning.settings
(MedicalTranscriptionSetting settings) Specify additional optional settings in your request, including channel identification, alternative transcriptions, and speaker partitioning.Specify the predominant medical specialty represented in your media.Specify the predominant medical specialty represented in your media.tags
(Collection<Tag> tags) Adds one or more custom tags, each in the form of a key:value pair, to a new medical transcription job at the time you start this new job.tags
(Consumer<Tag.Builder>... tags) Adds one or more custom tags, each in the form of a key:value pair, to a new medical transcription job at the time you start this new job.Adds one or more custom tags, each in the form of a key:value pair, to a new medical transcription job at the time you start this new job.Specify whether your input media contains only one person (DICTATION
) or contains a conversation between two people (CONVERSATION
).Specify whether your input media contains only one person (DICTATION
) or contains a conversation between two people (CONVERSATION
).Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.services.transcribe.model.TranscribeRequest.Builder
build
-
Method Details
-
medicalTranscriptionJobName
StartMedicalTranscriptionJobRequest.Builder medicalTranscriptionJobName(String medicalTranscriptionJobName) A unique name, chosen by you, for your medical transcription job. The name that you specify is also used as the default name of your transcription output file. If you want to specify a different name for your transcription output, use the
OutputKey
parameter.This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new job with the same name as an existing job, you get a
ConflictException
error.- Parameters:
medicalTranscriptionJobName
- A unique name, chosen by you, for your medical transcription job. The name that you specify is also used as the default name of your transcription output file. If you want to specify a different name for your transcription output, use theOutputKey
parameter.This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new job with the same name as an existing job, you get a
ConflictException
error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
languageCode
The language code that represents the language spoken in the input media file. US English (
en-US
) is the only valid value for medical transcription jobs. Any other value you enter for language code results in aBadRequestException
error.- Parameters:
languageCode
- The language code that represents the language spoken in the input media file. US English (en-US
) is the only valid value for medical transcription jobs. Any other value you enter for language code results in aBadRequestException
error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
languageCode
The language code that represents the language spoken in the input media file. US English (
en-US
) is the only valid value for medical transcription jobs. Any other value you enter for language code results in aBadRequestException
error.- Parameters:
languageCode
- The language code that represents the language spoken in the input media file. US English (en-US
) is the only valid value for medical transcription jobs. Any other value you enter for language code results in aBadRequestException
error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
mediaSampleRateHertz
The sample rate, in hertz, of the audio track in your input media file.
If you do not specify the media sample rate, Amazon Transcribe Medical determines it for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical; if there's a mismatch between the value that you specify and the value detected, your job fails. Therefore, in most cases, it's advised to omit
MediaSampleRateHertz
and let Amazon Transcribe Medical determine the sample rate.- Parameters:
mediaSampleRateHertz
- The sample rate, in hertz, of the audio track in your input media file.If you do not specify the media sample rate, Amazon Transcribe Medical determines it for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical; if there's a mismatch between the value that you specify and the value detected, your job fails. Therefore, in most cases, it's advised to omit
MediaSampleRateHertz
and let Amazon Transcribe Medical determine the sample rate.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mediaFormat
Specify the format of your input media file.
- Parameters:
mediaFormat
- Specify the format of your input media file.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
mediaFormat
Specify the format of your input media file.
- Parameters:
mediaFormat
- Specify the format of your input media file.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
media
Sets the value of the Media property for this object.- Parameters:
media
- The new value for the Media property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
media
Sets the value of the Media property for this object. This is a convenience method that creates an instance of theMedia.Builder
avoiding the need to create one manually viaMedia.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomedia(Media)
.- Parameters:
media
- a consumer that will call methods onMedia.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
outputBucketName
The name of the Amazon S3 bucket where you want your medical transcription output stored. Do not include the
S3://
prefix of the specified bucket.If you want your output to go to a sub-folder of this bucket, specify it using the
OutputKey
parameter;OutputBucketName
only accepts the name of a bucket.For example, if you want your output stored in
S3://DOC-EXAMPLE-BUCKET
, setOutputBucketName
toDOC-EXAMPLE-BUCKET
. However, if you want your output stored inS3://DOC-EXAMPLE-BUCKET/test-files/
, setOutputBucketName
toDOC-EXAMPLE-BUCKET
andOutputKey
totest-files/
.Note that Amazon Transcribe must have permission to use the specified location. You can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.
- Parameters:
outputBucketName
- The name of the Amazon S3 bucket where you want your medical transcription output stored. Do not include theS3://
prefix of the specified bucket.If you want your output to go to a sub-folder of this bucket, specify it using the
OutputKey
parameter;OutputBucketName
only accepts the name of a bucket.For example, if you want your output stored in
S3://DOC-EXAMPLE-BUCKET
, setOutputBucketName
toDOC-EXAMPLE-BUCKET
. However, if you want your output stored inS3://DOC-EXAMPLE-BUCKET/test-files/
, setOutputBucketName
toDOC-EXAMPLE-BUCKET
andOutputKey
totest-files/
.Note that Amazon Transcribe must have permission to use the specified location. You can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
outputKey
Use in combination with
OutputBucketName
to specify the output location of your transcript and, optionally, a unique name for your output file. The default name for your transcription output is the same as the name you specified for your medical transcription job (MedicalTranscriptionJobName
).Here are some examples of how you can use
OutputKey
:-
If you specify 'DOC-EXAMPLE-BUCKET' as the
OutputBucketName
and 'my-transcript.json' as theOutputKey
, your transcription output path iss3://DOC-EXAMPLE-BUCKET/my-transcript.json
. -
If you specify 'my-first-transcription' as the
MedicalTranscriptionJobName
, 'DOC-EXAMPLE-BUCKET' as theOutputBucketName
, and 'my-transcript' as theOutputKey
, your transcription output path iss3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json
. -
If you specify 'DOC-EXAMPLE-BUCKET' as the
OutputBucketName
and 'test-files/my-transcript.json' as theOutputKey
, your transcription output path iss3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json
. -
If you specify 'my-first-transcription' as the
MedicalTranscriptionJobName
, 'DOC-EXAMPLE-BUCKET' as theOutputBucketName
, and 'test-files/my-transcript' as theOutputKey
, your transcription output path iss3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json
.
If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for you.
- Parameters:
outputKey
- Use in combination withOutputBucketName
to specify the output location of your transcript and, optionally, a unique name for your output file. The default name for your transcription output is the same as the name you specified for your medical transcription job (MedicalTranscriptionJobName
).Here are some examples of how you can use
OutputKey
:-
If you specify 'DOC-EXAMPLE-BUCKET' as the
OutputBucketName
and 'my-transcript.json' as theOutputKey
, your transcription output path iss3://DOC-EXAMPLE-BUCKET/my-transcript.json
. -
If you specify 'my-first-transcription' as the
MedicalTranscriptionJobName
, 'DOC-EXAMPLE-BUCKET' as theOutputBucketName
, and 'my-transcript' as theOutputKey
, your transcription output path iss3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json
. -
If you specify 'DOC-EXAMPLE-BUCKET' as the
OutputBucketName
and 'test-files/my-transcript.json' as theOutputKey
, your transcription output path iss3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json
. -
If you specify 'my-first-transcription' as the
MedicalTranscriptionJobName
, 'DOC-EXAMPLE-BUCKET' as theOutputBucketName
, and 'test-files/my-transcript' as theOutputKey
, your transcription output path iss3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json
.
If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for you.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
outputEncryptionKMSKeyId
StartMedicalTranscriptionJobRequest.Builder outputEncryptionKMSKeyId(String outputEncryptionKMSKeyId) The KMS key you want to use to encrypt your medical transcription output.
If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:
-
Use the KMS key ID itself. For example,
1234abcd-12ab-34cd-56ef-1234567890ab
. -
Use an alias for the KMS key ID. For example,
alias/ExampleAlias
. -
Use the Amazon Resource Name (ARN) for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab
. -
Use the ARN for the KMS key alias. For example,
arn:aws:kms:region:account-ID:alias/ExampleAlias
.
If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:
-
Use the ARN for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab
. -
Use the ARN for the KMS key alias. For example,
arn:aws:kms:region:account-ID:alias/ExampleAlias
.
If you do not specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).
If you specify a KMS key to encrypt your output, you must also specify an output location using the
OutputLocation
parameter.Note that the role making the request must have permission to use the specified KMS key.
- Parameters:
outputEncryptionKMSKeyId
- The KMS key you want to use to encrypt your medical transcription output.If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:
-
Use the KMS key ID itself. For example,
1234abcd-12ab-34cd-56ef-1234567890ab
. -
Use an alias for the KMS key ID. For example,
alias/ExampleAlias
. -
Use the Amazon Resource Name (ARN) for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab
. -
Use the ARN for the KMS key alias. For example,
arn:aws:kms:region:account-ID:alias/ExampleAlias
.
If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:
-
Use the ARN for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab
. -
Use the ARN for the KMS key alias. For example,
arn:aws:kms:region:account-ID:alias/ExampleAlias
.
If you do not specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).
If you specify a KMS key to encrypt your output, you must also specify an output location using the
OutputLocation
parameter.Note that the role making the request must have permission to use the specified KMS key.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
kmsEncryptionContext
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. For more information, see KMS encryption context and Asymmetric keys in KMS.
- Parameters:
kmsEncryptionContext
- A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context and Asymmetric keys in KMS.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
settings
Specify additional optional settings in your request, including channel identification, alternative transcriptions, and speaker partitioning. You can use that to apply custom vocabularies to your transcription job.
- Parameters:
settings
- Specify additional optional settings in your request, including channel identification, alternative transcriptions, and speaker partitioning. You can use that to apply custom vocabularies to your transcription job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
settings
default StartMedicalTranscriptionJobRequest.Builder settings(Consumer<MedicalTranscriptionSetting.Builder> settings) Specify additional optional settings in your request, including channel identification, alternative transcriptions, and speaker partitioning. You can use that to apply custom vocabularies to your transcription job.
This is a convenience method that creates an instance of theMedicalTranscriptionSetting.Builder
avoiding the need to create one manually viaMedicalTranscriptionSetting.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosettings(MedicalTranscriptionSetting)
.- Parameters:
settings
- a consumer that will call methods onMedicalTranscriptionSetting.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
contentIdentificationType
StartMedicalTranscriptionJobRequest.Builder contentIdentificationType(String contentIdentificationType) Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.
- Parameters:
contentIdentificationType
- Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
contentIdentificationType
StartMedicalTranscriptionJobRequest.Builder contentIdentificationType(MedicalContentIdentificationType contentIdentificationType) Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.
- Parameters:
contentIdentificationType
- Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
specialty
Specify the predominant medical specialty represented in your media. For batch transcriptions,
PRIMARYCARE
is the only valid value. If you require additional specialties, refer to .- Parameters:
specialty
- Specify the predominant medical specialty represented in your media. For batch transcriptions,PRIMARYCARE
is the only valid value. If you require additional specialties, refer to .- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
specialty
Specify the predominant medical specialty represented in your media. For batch transcriptions,
PRIMARYCARE
is the only valid value. If you require additional specialties, refer to .- Parameters:
specialty
- Specify the predominant medical specialty represented in your media. For batch transcriptions,PRIMARYCARE
is the only valid value. If you require additional specialties, refer to .- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
type
Specify whether your input media contains only one person (
DICTATION
) or contains a conversation between two people (CONVERSATION
).For example,
DICTATION
could be used for a medical professional wanting to transcribe voice memos;CONVERSATION
could be used for transcribing the doctor-patient dialogue during the patient's office visit.- Parameters:
type
- Specify whether your input media contains only one person (DICTATION
) or contains a conversation between two people (CONVERSATION
).For example,
DICTATION
could be used for a medical professional wanting to transcribe voice memos;CONVERSATION
could be used for transcribing the doctor-patient dialogue during the patient's office visit.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
type
Specify whether your input media contains only one person (
DICTATION
) or contains a conversation between two people (CONVERSATION
).For example,
DICTATION
could be used for a medical professional wanting to transcribe voice memos;CONVERSATION
could be used for transcribing the doctor-patient dialogue during the patient's office visit.- Parameters:
type
- Specify whether your input media contains only one person (DICTATION
) or contains a conversation between two people (CONVERSATION
).For example,
DICTATION
could be used for a medical professional wanting to transcribe voice memos;CONVERSATION
could be used for transcribing the doctor-patient dialogue during the patient's office visit.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tags
Adds one or more custom tags, each in the form of a key:value pair, to a new medical transcription job at the time you start this new job.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
- Parameters:
tags
- Adds one or more custom tags, each in the form of a key:value pair, to a new medical transcription job at the time you start this new job.To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Adds one or more custom tags, each in the form of a key:value pair, to a new medical transcription job at the time you start this new job.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
- Parameters:
tags
- Adds one or more custom tags, each in the form of a key:value pair, to a new medical transcription job at the time you start this new job.To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Adds one or more custom tags, each in the form of a key:value pair, to a new medical transcription job at the time you start this new job.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
StartMedicalTranscriptionJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
StartMedicalTranscriptionJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-