Class StartMedicalTranscriptionJobRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<StartMedicalTranscriptionJobRequest.Builder,
StartMedicalTranscriptionJobRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Labels all personal health information (PHI) identified in your transcript.final String
Labels all personal health information (PHI) identified in your transcript.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the KMSEncryptionContext property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.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.final LanguageCode
The language code that represents the language spoken in the input media file.final String
The language code that represents the language spoken in the input media file.final Media
media()
Returns the value of the Media property for this object.final MediaFormat
Specify the format of your input media file.final String
Specify the format of your input media file.final Integer
The sample rate, in hertz, of the audio track in your input media file.final String
A unique name, chosen by you, for your medical transcription job.final String
The name of the Amazon S3 bucket where you want your medical transcription output stored.final String
The KMS key you want to use to encrypt your medical transcription output.final String
Use in combination withOutputBucketName
to specify the output location of your transcript and, optionally, a unique name for your output file.static Class
<? extends StartMedicalTranscriptionJobRequest.Builder> settings()
Specify additional optional settings in your request, including channel identification, alternative transcriptions, and speaker partitioning.final Specialty
Specify the predominant medical specialty represented in your media.final String
Specify the predominant medical specialty represented in your media.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.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Type
type()
Specify whether your input media contains only one person (DICTATION
) or contains a conversation between two people (CONVERSATION
).final String
Specify whether your input media contains only one person (DICTATION
) or contains a conversation between two people (CONVERSATION
).Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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.- Returns:
- 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.
-
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.If the service returns an enum value that is not available in the current SDK version,
languageCode
will returnLanguageCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlanguageCodeAsString()
.- Returns:
- 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. - See Also:
-
languageCodeAsString
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.If the service returns an enum value that is not available in the current SDK version,
languageCode
will returnLanguageCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlanguageCodeAsString()
.- Returns:
- 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. - 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.- Returns:
- 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.
-
mediaFormat
Specify the format of your input media file.
If the service returns an enum value that is not available in the current SDK version,
mediaFormat
will returnMediaFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommediaFormatAsString()
.- Returns:
- Specify the format of your input media file.
- See Also:
-
mediaFormatAsString
Specify the format of your input media file.
If the service returns an enum value that is not available in the current SDK version,
mediaFormat
will returnMediaFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommediaFormatAsString()
.- Returns:
- Specify the format of your input media file.
- See Also:
-
media
Returns the value of the Media property for this object.- Returns:
- The value of the Media property for this object.
-
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.
- Returns:
- 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.
-
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.
- Returns:
- 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.
-
-
-
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:
- 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.
-
-
-
hasKmsEncryptionContext
public final boolean hasKmsEncryptionContext()For responses, this returns true if the service returned a value for the KMSEncryptionContext property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasKmsEncryptionContext()
method.- Returns:
- 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.
-
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:
- 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.
-
contentIdentificationType
Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.
If the service returns an enum value that is not available in the current SDK version,
contentIdentificationType
will returnMedicalContentIdentificationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcontentIdentificationTypeAsString()
.- Returns:
- Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.
- See Also:
-
contentIdentificationTypeAsString
Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.
If the service returns an enum value that is not available in the current SDK version,
contentIdentificationType
will returnMedicalContentIdentificationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcontentIdentificationTypeAsString()
.- Returns:
- Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.
- 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 .If the service returns an enum value that is not available in the current SDK version,
specialty
will returnSpecialty.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromspecialtyAsString()
.- Returns:
- 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 . - See Also:
-
specialtyAsString
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 .If the service returns an enum value that is not available in the current SDK version,
specialty
will returnSpecialty.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromspecialtyAsString()
.- Returns:
- 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 . - 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.If the service returns an enum value that is not available in the current SDK version,
type
will returnType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- 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. - See Also:
-
typeAsString
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.If the service returns an enum value that is not available in the current SDK version,
type
will returnType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- 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. - See Also:
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<StartMedicalTranscriptionJobRequest.Builder,
StartMedicalTranscriptionJobRequest> - Specified by:
toBuilder
in classTranscribeRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends StartMedicalTranscriptionJobRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-