com.amazonaws.services.transcribe.model

Class StartMedicalTranscriptionJobRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.transcribe.model.StartMedicalTranscriptionJobRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartMedicalTranscriptionJobRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StartMedicalTranscriptionJobRequest()

Method Summary

Modifier and Type	Method and Description
StartMedicalTranscriptionJobRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getContentIdentificationType() You can configure Amazon Transcribe Medical to label content in the transcription output.
String	getLanguageCode() The language code for the language spoken in the input media file.
Media	getMedia()
String	getMediaFormat() The audio format of the input media file.
Integer	getMediaSampleRateHertz() The sample rate, in Hertz, of the audio track in the input media file.
String	getMedicalTranscriptionJobName() The name of the medical transcription job.
String	getOutputBucketName() The Amazon S3 location where the transcription is stored.
String	getOutputEncryptionKMSKeyId() The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS) key used to encrypt the output of the transcription job.
String	getOutputKey() You can specify a location in an Amazon S3 bucket to store the output of your medical transcription job.
MedicalTranscriptionSetting	getSettings() Optional settings for the medical transcription job.
String	getSpecialty() The medical specialty of any clinician speaking in the input media.
List<Tag>	getTags() Add tags to an Amazon Transcribe medical transcription job.
String	getType() The type of speech in the input audio.
int	hashCode()
void	setContentIdentificationType(String contentIdentificationType) You can configure Amazon Transcribe Medical to label content in the transcription output.
void	setLanguageCode(String languageCode) The language code for the language spoken in the input media file.
void	setMedia(Media media)
void	setMediaFormat(String mediaFormat) The audio format of the input media file.
void	setMediaSampleRateHertz(Integer mediaSampleRateHertz) The sample rate, in Hertz, of the audio track in the input media file.
void	setMedicalTranscriptionJobName(String medicalTranscriptionJobName) The name of the medical transcription job.
void	setOutputBucketName(String outputBucketName) The Amazon S3 location where the transcription is stored.
void	setOutputEncryptionKMSKeyId(String outputEncryptionKMSKeyId) The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS) key used to encrypt the output of the transcription job.
void	setOutputKey(String outputKey) You can specify a location in an Amazon S3 bucket to store the output of your medical transcription job.
void	setSettings(MedicalTranscriptionSetting settings) Optional settings for the medical transcription job.
void	setSpecialty(String specialty) The medical specialty of any clinician speaking in the input media.
void	setTags(Collection<Tag> tags) Add tags to an Amazon Transcribe medical transcription job.
void	setType(String type) The type of speech in the input audio.
String	toString() Returns a string representation of this object.
StartMedicalTranscriptionJobRequest	withContentIdentificationType(MedicalContentIdentificationType contentIdentificationType) You can configure Amazon Transcribe Medical to label content in the transcription output.
StartMedicalTranscriptionJobRequest	withContentIdentificationType(String contentIdentificationType) You can configure Amazon Transcribe Medical to label content in the transcription output.
StartMedicalTranscriptionJobRequest	withLanguageCode(LanguageCode languageCode) The language code for the language spoken in the input media file.
StartMedicalTranscriptionJobRequest	withLanguageCode(String languageCode) The language code for the language spoken in the input media file.
StartMedicalTranscriptionJobRequest	withMedia(Media media)
StartMedicalTranscriptionJobRequest	withMediaFormat(MediaFormat mediaFormat) The audio format of the input media file.
StartMedicalTranscriptionJobRequest	withMediaFormat(String mediaFormat) The audio format of the input media file.
StartMedicalTranscriptionJobRequest	withMediaSampleRateHertz(Integer mediaSampleRateHertz) The sample rate, in Hertz, of the audio track in the input media file.
StartMedicalTranscriptionJobRequest	withMedicalTranscriptionJobName(String medicalTranscriptionJobName) The name of the medical transcription job.
StartMedicalTranscriptionJobRequest	withOutputBucketName(String outputBucketName) The Amazon S3 location where the transcription is stored.
StartMedicalTranscriptionJobRequest	withOutputEncryptionKMSKeyId(String outputEncryptionKMSKeyId) The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS) key used to encrypt the output of the transcription job.
StartMedicalTranscriptionJobRequest	withOutputKey(String outputKey) You can specify a location in an Amazon S3 bucket to store the output of your medical transcription job.
StartMedicalTranscriptionJobRequest	withSettings(MedicalTranscriptionSetting settings) Optional settings for the medical transcription job.
StartMedicalTranscriptionJobRequest	withSpecialty(Specialty specialty) The medical specialty of any clinician speaking in the input media.
StartMedicalTranscriptionJobRequest	withSpecialty(String specialty) The medical specialty of any clinician speaking in the input media.
StartMedicalTranscriptionJobRequest	withTags(Collection<Tag> tags) Add tags to an Amazon Transcribe medical transcription job.
StartMedicalTranscriptionJobRequest	withTags(Tag... tags) Add tags to an Amazon Transcribe medical transcription job.
StartMedicalTranscriptionJobRequest	withType(String type) The type of speech in the input audio.
StartMedicalTranscriptionJobRequest	withType(Type type) The type of speech in the input audio.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartMedicalTranscriptionJobRequest

public StartMedicalTranscriptionJobRequest()

Method Detail

setMedicalTranscriptionJobName

public void setMedicalTranscriptionJobName(String medicalTranscriptionJobName)

The name of the medical transcription job. You can't use the strings "." or ".." by themselves as the job name. The name must also be unique within an 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.

Parameters:

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.

getMedicalTranscriptionJobName

public String getMedicalTranscriptionJobName()

The name of the medical transcription job. You can't use the strings "." or ".." by themselves as the job name. The name must also be unique within an 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.

Returns:

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.

withMedicalTranscriptionJobName

public StartMedicalTranscriptionJobRequest withMedicalTranscriptionJobName(String medicalTranscriptionJobName)

The name of the medical transcription job. You can't use the strings "." or ".." by themselves as the job name. The name must also be unique within an 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setLanguageCode

public void setLanguageCode(String languageCode)

The language code for the language spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.

Parameters:

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.

See Also:

LanguageCode

getLanguageCode

public String getLanguageCode()

The language code for the language spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.

Returns:

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.

See Also:

LanguageCode

withLanguageCode

public StartMedicalTranscriptionJobRequest withLanguageCode(String languageCode)

The language code for the language spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LanguageCode

withLanguageCode

public StartMedicalTranscriptionJobRequest withLanguageCode(LanguageCode languageCode)

The language code for the language spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LanguageCode

setMediaSampleRateHertz

public void setMediaSampleRateHertz(Integer mediaSampleRateHertz)

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

If you do not specify the media sample rate, Amazon Transcribe Medical determines the sample rate. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe Medical determine the sample rate.

Parameters:

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.

getMediaSampleRateHertz

public Integer getMediaSampleRateHertz()

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

If you do not specify the media sample rate, Amazon Transcribe Medical determines the sample rate. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe Medical determine the sample rate.

Returns:

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.

withMediaSampleRateHertz

public StartMedicalTranscriptionJobRequest withMediaSampleRateHertz(Integer mediaSampleRateHertz)

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

If you do not specify the media sample rate, Amazon Transcribe Medical determines the sample rate. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe Medical determine the sample rate.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMediaFormat

public void setMediaFormat(String mediaFormat)

The audio format of the input media file.

Parameters:

mediaFormat - The audio format of the input media file.

See Also:

MediaFormat

getMediaFormat

public String getMediaFormat()

The audio format of the input media file.

Returns:

The audio format of the input media file.

See Also:

MediaFormat

withMediaFormat

public StartMedicalTranscriptionJobRequest withMediaFormat(String mediaFormat)

The audio format of the input media file.

Parameters:

mediaFormat - The audio format of the input media file.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MediaFormat

withMediaFormat

public StartMedicalTranscriptionJobRequest withMediaFormat(MediaFormat mediaFormat)

The audio format of the input media file.

Parameters:

mediaFormat - The audio format of the input media file.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MediaFormat

setMedia

public void setMedia(Media media)

Parameters:

media -

getMedia

public Media getMedia()

Returns:

withMedia

public StartMedicalTranscriptionJobRequest withMedia(Media media)

Parameters:

media -

Returns:

Returns a reference to this object so that method calls can be chained together.

setOutputBucketName

public void setOutputBucketName(String outputBucketName)

The Amazon S3 location where the transcription is stored.

You must set OutputBucketName for Amazon Transcribe Medical to store the transcription results. Your transcript appears in the S3 location you specify. When you call the GetMedicalTranscriptionJob, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe Medical to put files in the bucket. For more information, see Permissions Required for IAM User Roles.

You can specify an 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.

Parameters:

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.

getOutputBucketName

public String getOutputBucketName()

The Amazon S3 location where the transcription is stored.

You must set OutputBucketName for Amazon Transcribe Medical to store the transcription results. Your transcript appears in the S3 location you specify. When you call the GetMedicalTranscriptionJob, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe Medical to put files in the bucket. For more information, see Permissions Required for IAM User Roles.

You can specify an 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.

Returns:

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.

withOutputBucketName

public StartMedicalTranscriptionJobRequest withOutputBucketName(String outputBucketName)

The Amazon S3 location where the transcription is stored.

You must set OutputBucketName for Amazon Transcribe Medical to store the transcription results. Your transcript appears in the S3 location you specify. When you call the GetMedicalTranscriptionJob, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe Medical to put files in the bucket. For more information, see Permissions Required for IAM User Roles.

You can specify an 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setOutputKey

public void setOutputKey(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.

Parameters:

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.

getOutputKey

public String getOutputKey()

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.

Returns:

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.

withOutputKey

public StartMedicalTranscriptionJobRequest withOutputKey(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setOutputEncryptionKMSKeyId

public void setOutputEncryptionKMSKeyId(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.

Parameters:

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.

getOutputEncryptionKMSKeyId

public String getOutputEncryptionKMSKeyId()

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.

Returns:

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.

withOutputEncryptionKMSKeyId

public StartMedicalTranscriptionJobRequest withOutputEncryptionKMSKeyId(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSettings

public void setSettings(MedicalTranscriptionSetting settings)

Optional settings for the medical transcription job.

Parameters:

settings - Optional settings for the medical transcription job.

getSettings

public MedicalTranscriptionSetting getSettings()

Optional settings for the medical transcription job.

Returns:

Optional settings for the medical transcription job.

withSettings

public StartMedicalTranscriptionJobRequest withSettings(MedicalTranscriptionSetting settings)

Optional settings for the medical transcription job.

Parameters:

settings - Optional settings for the medical transcription job.

Returns:

Returns a reference to this object so that method calls can be chained together.

setContentIdentificationType

public void setContentIdentificationType(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.

Parameters:

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.

See Also:

MedicalContentIdentificationType

getContentIdentificationType

public String getContentIdentificationType()

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.

Returns:

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.

See Also:

MedicalContentIdentificationType

withContentIdentificationType

public StartMedicalTranscriptionJobRequest withContentIdentificationType(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MedicalContentIdentificationType

withContentIdentificationType

public StartMedicalTranscriptionJobRequest withContentIdentificationType(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MedicalContentIdentificationType

setSpecialty

public void setSpecialty(String specialty)

The medical specialty of any clinician speaking in the input media.

Parameters:

specialty - The medical specialty of any clinician speaking in the input media.

See Also:

Specialty

getSpecialty

public String getSpecialty()

The medical specialty of any clinician speaking in the input media.

Returns:

The medical specialty of any clinician speaking in the input media.

See Also:

Specialty

withSpecialty

public StartMedicalTranscriptionJobRequest withSpecialty(String specialty)

The medical specialty of any clinician speaking in the input media.

Parameters:

specialty - The medical specialty of any clinician speaking in the input media.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Specialty

withSpecialty

public StartMedicalTranscriptionJobRequest withSpecialty(Specialty specialty)

The medical specialty of any clinician speaking in the input media.

Parameters:

specialty - The medical specialty of any clinician speaking in the input media.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Specialty

setType

public void setType(String type)

The type of speech in the input audio. CONVERSATION refers to conversations between two or more speakers, e.g., a conversations between doctors and patients. DICTATION refers to single-speaker dictated speech, such as clinical notes.

Parameters:

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.

See Also:

Type

getType

public String getType()

The type of speech in the input audio. CONVERSATION refers to conversations between two or more speakers, e.g., a conversations between doctors and patients. DICTATION refers to single-speaker dictated speech, such as clinical notes.

Returns:

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.

See Also:

Type

withType

public StartMedicalTranscriptionJobRequest withType(String type)

The type of speech in the input audio. CONVERSATION refers to conversations between two or more speakers, e.g., a conversations between doctors and patients. DICTATION refers to single-speaker dictated speech, such as clinical notes.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Type

withType

public StartMedicalTranscriptionJobRequest withType(Type type)

The type of speech in the input audio. CONVERSATION refers to conversations between two or more speakers, e.g., a conversations between doctors and patients. DICTATION refers to single-speaker dictated speech, such as clinical notes.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Type

getTags

public List<Tag> getTags()

Add tags to an Amazon Transcribe medical transcription job.

Returns:

Add tags to an Amazon Transcribe medical transcription job.

setTags

public void setTags(Collection<Tag> tags)

Add tags to an Amazon Transcribe medical transcription job.

Parameters:

tags - Add tags to an Amazon Transcribe medical transcription job.

withTags

public StartMedicalTranscriptionJobRequest withTags(Tag... tags)

Add tags to an Amazon Transcribe medical transcription job.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - Add tags to an Amazon Transcribe medical transcription job.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public StartMedicalTranscriptionJobRequest withTags(Collection<Tag> tags)

Add tags to an Amazon Transcribe medical transcription job.

Parameters:

tags - Add tags to an Amazon Transcribe medical transcription job.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StartMedicalTranscriptionJobRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()