software.amazon.awssdk.services.transcribe.model

Class StartMedicalTranscriptionJobRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.transcribe.model.TranscribeRequest

software.amazon.awssdk.services.transcribe.model.StartMedicalTranscriptionJobRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartMedicalTranscriptionJobRequest.Builder,StartMedicalTranscriptionJobRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class StartMedicalTranscriptionJobRequest
extends TranscribeRequest
implements ToCopyableBuilder<StartMedicalTranscriptionJobRequest.Builder,StartMedicalTranscriptionJobRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartMedicalTranscriptionJobRequest.Builder

Method Summary

Modifier and Type	Method and Description
static StartMedicalTranscriptionJobRequest.Builder	builder()
MedicalContentIdentificationType	contentIdentificationType() Labels all personal health information (PHI) identified in your transcript.
String	contentIdentificationTypeAsString() Labels all personal health information (PHI) identified in your transcript.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasKmsEncryptionContext() For responses, this returns true if the service returned a value for the KMSEncryptionContext property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
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	languageCode() The language code that represents the language spoken in the input media file.
String	languageCodeAsString() The language code that represents the language spoken in the input media file.
Media	media() Returns the value of the Media property for this object.
MediaFormat	mediaFormat() Specify the format of your input media file.
String	mediaFormatAsString() Specify the format of your input media file.
Integer	mediaSampleRateHertz() The sample rate, in hertz, of the audio track in your input media file.
String	medicalTranscriptionJobName() A unique name, chosen by you, for your medical transcription job.
String	outputBucketName() The name of the Amazon S3 bucket where you want your medical transcription output stored.
String	outputEncryptionKMSKeyId() The KMS key you want to use to encrypt your medical transcription output.
String	outputKey() Use in combination with OutputBucketName to specify the output location of your transcript and, optionally, a unique name for your output file.
List<SdkField<?>>	sdkFields()
static Class<? extends StartMedicalTranscriptionJobRequest.Builder>	serializableBuilderClass()
MedicalTranscriptionSetting	settings() Specify additional optional settings in your request, including channel identification, alternative transcriptions, and speaker partitioning.
Specialty	specialty() Specify the predominant medical specialty represented in your media.
String	specialtyAsString() Specify the predominant medical specialty represented in your media.
List<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.
StartMedicalTranscriptionJobRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Type	type() Specify whether your input media contains only one person (DICTATION) or contains a conversation between two people (CONVERSATION).
String	typeAsString() 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 class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

medicalTranscriptionJobName

public final 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.

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

public final LanguageCode 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 a BadRequestException error.

If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

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 a BadRequestException error.

See Also:

LanguageCode

languageCodeAsString

public final String 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 a BadRequestException error.

If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

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 a BadRequestException error.

See Also:

LanguageCode

mediaSampleRateHertz

public final Integer mediaSampleRateHertz()

The sample rate, in hertz, of the audio track in your input media file.

If you don't 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 don't 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

public final MediaFormat 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 return MediaFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mediaFormatAsString().

Returns:

Specify the format of your input media file.

See Also:

MediaFormat

mediaFormatAsString

public final String 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 return MediaFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mediaFormatAsString().

Returns:

Specify the format of your input media file.

See Also:

MediaFormat

media

public final Media media()

Returns the value of the Media property for this object.

Returns:

The value of the Media property for this object.

outputBucketName

public final String 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, set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to DOC-EXAMPLE-BUCKET and OutputKey to test-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, set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to DOC-EXAMPLE-BUCKET and OutputKey to test-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

public final String 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 the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json .

• If you specify 'my-first-transcription' as the MedicalTranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'my-transcript' as the OutputKey, your transcription output path is s3://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 the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.

• If you specify 'my-first-transcription' as the MedicalTranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'test-files/my-transcript' as the OutputKey, your transcription output path is s3://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 the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json.

• If you specify 'my-first-transcription' as the MedicalTranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'my-transcript' as the OutputKey, your transcription output path is s3://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 the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.

• If you specify 'my-first-transcription' as the MedicalTranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'test-files/my-transcript' as the OutputKey, your transcription output path is s3://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

public final 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:

1. Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

2. Use an alias for the KMS key ID. For example, alias/ExampleAlias.

3. 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.

4. 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:

1. Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

2. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.

If you don't 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:

1. Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

2. Use an alias for the KMS key ID. For example, alias/ExampleAlias.

3. 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.

4. 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:

1. Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

2. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.

If you don't 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 the isEmpty() 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

public final 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.

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

public final MedicalTranscriptionSetting 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

public final MedicalContentIdentificationType 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 return MedicalContentIdentificationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentIdentificationTypeAsString().

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:

MedicalContentIdentificationType

contentIdentificationTypeAsString

public final String 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 return MedicalContentIdentificationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentIdentificationTypeAsString().

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:

MedicalContentIdentificationType

specialty

public final Specialty 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 return Specialty.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from specialtyAsString().

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:

Specialty

specialtyAsString

public final String 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 return Specialty.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from specialtyAsString().

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:

Specialty

type

public final Type 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 return Type.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

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:

Type

typeAsString

public final String 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 return Type.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

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:

Type

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 the isEmpty() 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

public final List<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.

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

public StartMedicalTranscriptionJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartMedicalTranscriptionJobRequest.Builder,StartMedicalTranscriptionJobRequest>

Specified by:

toBuilder in class TranscribeRequest

builder

public static StartMedicalTranscriptionJobRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartMedicalTranscriptionJobRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo