/* * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.transcribe.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *

* Transcribes the audio from a medical dictation or conversation and applies * any additional Request Parameters you choose to include in your request. *

*

* In addition to many standard transcription features, Amazon Transcribe * Medical provides you with a robust medical vocabulary and, optionally, * content identification, which adds flags to personal health information * (PHI). To learn more about these features, refer to How * Amazon Transcribe Medical works. *

*

* To make a StartMedicalTranscriptionJob request, you must first * upload your media file into an Amazon S3 bucket; you can then specify the S3 * location of the file using the Media parameter. *

*

* You must include the following parameters in your * StartMedicalTranscriptionJob request: *

* */ public class StartMedicalTranscriptionJobRequest extends AmazonWebServiceRequest implements Serializable { /** *

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

*

* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
*/ private String medicalTranscriptionJobName; /** *

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

*

* Constraints:
* Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, * en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, * fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, * pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ, * vi-VN, sv-SE */ private String languageCode; /** *

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

*

* Constraints:
* Range: 16000 - 48000
*/ private Integer mediaSampleRateHertz; /** *

* Specify the format of your input media file. *

*

* Constraints:
* Allowed Values: mp3, mp4, wav, flac, ogg, amr, webm */ private String mediaFormat; /** *

* Describes the Amazon S3 location of the media file you want to use in * your request. *

*

* For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide. *

*/ private Media media; /** *

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

*

* Constraints:
* Length: - 64
* Pattern: [a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]
*/ private String outputBucketName; /** *

* 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 the name of an Amazon S3 bucket sub-folder that doesn't * exist, one is created for you. *

*

* Constraints:
* Length: 1 - 1024
* Pattern: [a-zA-Z0-9-_.!*'()/]{1,1024}$
*/ private String outputKey; /** *

* 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. *
  2. *

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

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

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

    *
    5. *
*

* 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. *
  2. *

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

    *
    3. *
*

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

*

* Constraints:
* Length: 1 - 2048
* Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$
*/ private String outputEncryptionKMSKeyId; /** *

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

*/ private java.util.Map kMSEncryptionContext; /** *

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

*/ private MedicalTranscriptionSetting settings; /** *

* Labels all personal health information (PHI) identified in your * transcript. For more information, see Identifying personal health information (PHI) in a transcription. *

*

* Constraints:
* Allowed Values: PHI */ private String contentIdentificationType; /** *

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

*

* Constraints:
* Allowed Values: PRIMARYCARE */ private String specialty; /** *

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

*

* Constraints:
* Allowed Values: CONVERSATION, DICTATION */ private String type; /** *

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

*/ private java.util.List tags; /** *

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

*

* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
* * @return

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

*/ public String getMedicalTranscriptionJobName() { return 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. *

*

* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
* * @param 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. *

*/ public void setMedicalTranscriptionJobName(String medicalTranscriptionJobName) { this.medicalTranscriptionJobName = 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 reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
* * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public StartMedicalTranscriptionJobRequest withMedicalTranscriptionJobName( String medicalTranscriptionJobName) { this.medicalTranscriptionJobName = medicalTranscriptionJobName; return this; } /** *

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

*

* Constraints:
* Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, * en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, * fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, * pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ, * vi-VN, sv-SE * * @return

* 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 LanguageCode */ public String getLanguageCode() { return 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. *

*

* Constraints:
* Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, * en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, * fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, * pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ, * vi-VN, sv-SE * * @param 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. *

* @see LanguageCode */ public void setLanguageCode(String languageCode) { this.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. *

*

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

* Constraints:
* Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, * en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, * fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, * pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ, * vi-VN, sv-SE * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. * @see LanguageCode */ public StartMedicalTranscriptionJobRequest withLanguageCode(String languageCode) { this.languageCode = languageCode; return this; } /** *

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

*

* Constraints:
* Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, * en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, * fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, * pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ, * vi-VN, sv-SE * * @param 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. *

* @see LanguageCode */ public void setLanguageCode(LanguageCode languageCode) { this.languageCode = languageCode.toString(); } /** *

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

*

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

* Constraints:
* Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, * en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, * fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, * pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ, * vi-VN, sv-SE * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. * @see LanguageCode */ public StartMedicalTranscriptionJobRequest withLanguageCode(LanguageCode languageCode) { this.languageCode = languageCode.toString(); return this; } /** *

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

*

* Constraints:
* Range: 16000 - 48000
* * @return

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

*/ public Integer getMediaSampleRateHertz() { return 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. *

*

* Constraints:
* Range: 16000 - 48000
* * @param 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. *

*/ public void setMediaSampleRateHertz(Integer mediaSampleRateHertz) { this.mediaSampleRateHertz = 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 a reference to this object so that method calls can be chained * together. *

* Constraints:
* Range: 16000 - 48000
* * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public StartMedicalTranscriptionJobRequest withMediaSampleRateHertz(Integer mediaSampleRateHertz) { this.mediaSampleRateHertz = mediaSampleRateHertz; return this; } /** *

* Specify the format of your input media file. *

*

* Constraints:
* Allowed Values: mp3, mp4, wav, flac, ogg, amr, webm * * @return

* Specify the format of your input media file. *

* @see MediaFormat */ public String getMediaFormat() { return mediaFormat; } /** *

* Specify the format of your input media file. *

*

* Constraints:
* Allowed Values: mp3, mp4, wav, flac, ogg, amr, webm * * @param mediaFormat

* Specify the format of your input media file. *

* @see MediaFormat */ public void setMediaFormat(String mediaFormat) { this.mediaFormat = mediaFormat; } /** *

* Specify the format of your input media file. *

*

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

* Constraints:
* Allowed Values: mp3, mp4, wav, flac, ogg, amr, webm * * @param mediaFormat

* Specify the format of your input media file. *

* @return A reference to this updated object so that method calls can be * chained together. * @see MediaFormat */ public StartMedicalTranscriptionJobRequest withMediaFormat(String mediaFormat) { this.mediaFormat = mediaFormat; return this; } /** *

* Specify the format of your input media file. *

*

* Constraints:
* Allowed Values: mp3, mp4, wav, flac, ogg, amr, webm * * @param mediaFormat

* Specify the format of your input media file. *

* @see MediaFormat */ public void setMediaFormat(MediaFormat mediaFormat) { this.mediaFormat = mediaFormat.toString(); } /** *

* Specify the format of your input media file. *

*

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

* Constraints:
* Allowed Values: mp3, mp4, wav, flac, ogg, amr, webm * * @param mediaFormat

* Specify the format of your input media file. *

* @return A reference to this updated object so that method calls can be * chained together. * @see MediaFormat */ public StartMedicalTranscriptionJobRequest withMediaFormat(MediaFormat mediaFormat) { this.mediaFormat = mediaFormat.toString(); return this; } /** *

* Describes the Amazon S3 location of the media file you want to use in * your request. *

*

* For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide. *

* * @return

* Describes the Amazon S3 location of the media file you want to * use in your request. *

*

* For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide. *

*/ public Media getMedia() { return media; } /** *

* Describes the Amazon S3 location of the media file you want to use in * your request. *

*

* For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide. *

* * @param media

* Describes the Amazon S3 location of the media file you want to * use in your request. *

*

* For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide. *

*/ public void setMedia(Media media) { this.media = media; } /** *

* Describes the Amazon S3 location of the media file you want to use in * your request. *

*

* For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param media

* Describes the Amazon S3 location of the media file you want to * use in your request. *

*

* For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide. *

* @return A reference to this updated object so that method calls can be * chained together. */ public StartMedicalTranscriptionJobRequest withMedia(Media media) { this.media = media; return this; } /** *

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

*

* Constraints:
* Length: - 64
* Pattern: [a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]
* * @return

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

*/ public String getOutputBucketName() { return 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. *

*

* Constraints:
* Length: - 64
* Pattern: [a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]
* * @param 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. *

*/ public void setOutputBucketName(String outputBucketName) { this.outputBucketName = 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 a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: - 64
* Pattern: [a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]
* * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public StartMedicalTranscriptionJobRequest withOutputBucketName(String outputBucketName) { this.outputBucketName = outputBucketName; return this; } /** *

* 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 the name of an Amazon S3 bucket sub-folder that doesn't * exist, one is created for you. *

*

* Constraints:
* Length: 1 - 1024
* Pattern: [a-zA-Z0-9-_.!*'()/]{1,1024}$
* * @return

* 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 the name of an Amazon S3 bucket sub-folder that * doesn't exist, one is created for you. *

*/ public String getOutputKey() { return 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 the name of an Amazon S3 bucket sub-folder that doesn't * exist, one is created for you. *

*

* Constraints:
* Length: 1 - 1024
* Pattern: [a-zA-Z0-9-_.!*'()/]{1,1024}$
* * @param 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 the name of an Amazon S3 bucket sub-folder that * doesn't exist, one is created for you. *

*/ public void setOutputKey(String outputKey) { this.outputKey = 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 the name of an Amazon S3 bucket sub-folder that doesn't * exist, one is created for you. *

*

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

* Constraints:
* Length: 1 - 1024
* Pattern: [a-zA-Z0-9-_.!*'()/]{1,1024}$
* * @param 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 the name of an Amazon S3 bucket sub-folder that * doesn't exist, one is created for you. *

* @return A reference to this updated object so that method calls can be * chained together. */ public StartMedicalTranscriptionJobRequest withOutputKey(String outputKey) { this.outputKey = outputKey; return this; } /** *

* 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. *
  2. *

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

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

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

    *
    5. *
*

* 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. *
  2. *

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

    *
    3. *
*

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

*

* Constraints:
* Length: 1 - 2048
* Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$
* * @return

* 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. *
  2. *

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

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

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

    *
    5. *
*

* 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. *
  2. *

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

    *
    3. *
*

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

*/ public String getOutputEncryptionKMSKeyId() { return 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. *
  2. *

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

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

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

    *
    5. *
*

* 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. *
  2. *

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

    *
    3. *
*

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

*

* Constraints:
* Length: 1 - 2048
* Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$
* * @param 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. *
  2. *

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

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

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

    *
    5. *
*

* 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. *
  2. *

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

    *
    3. *
*

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

*/ public void setOutputEncryptionKMSKeyId(String outputEncryptionKMSKeyId) { this.outputEncryptionKMSKeyId = 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. *
  2. *

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

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

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

    *
    5. *
*

* 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. *
  2. *

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

    *
    3. *
*

* 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 a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 2048
* Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$
* * @param 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. *
  2. *

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

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

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

    *
    5. *
*

* 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. *
  2. *

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

    *
    3. *
*

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

* @return A reference to this updated object so that method calls can be * chained together. */ public StartMedicalTranscriptionJobRequest withOutputEncryptionKMSKeyId( String outputEncryptionKMSKeyId) { this.outputEncryptionKMSKeyId = outputEncryptionKMSKeyId; return this; } /** *

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

* * @return

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

*/ public java.util.Map getKMSEncryptionContext() { return 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. *

* * @param 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. *

*/ public void setKMSEncryptionContext(java.util.Map kMSEncryptionContext) { this.kMSEncryptionContext = kMSEncryptionContext; } /** *

* A map of plain text, non-secret key:value pairs, known as encryption * context pairs, that provide an added layer of security for your data. For * more information, see KMS encryption context and Asymmetric keys in KMS. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public StartMedicalTranscriptionJobRequest withKMSEncryptionContext( java.util.Map kMSEncryptionContext) { this.kMSEncryptionContext = kMSEncryptionContext; return this; } /** *

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

*

* The method adds a new key-value pair into KMSEncryptionContext parameter, * and returns a reference to this object so that method calls can be * chained together. * * @param key The key of the entry to be added into KMSEncryptionContext. * @param value The corresponding value of the entry to be added into * KMSEncryptionContext. * @return A reference to this updated object so that method calls can be * chained together. */ public StartMedicalTranscriptionJobRequest addKMSEncryptionContextEntry(String key, String value) { if (null == this.kMSEncryptionContext) { this.kMSEncryptionContext = new java.util.HashMap(); } if (this.kMSEncryptionContext.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.kMSEncryptionContext.put(key, value); return this; } /** * Removes all the entries added into KMSEncryptionContext. *

* Returns a reference to this object so that method calls can be chained * together. */ public StartMedicalTranscriptionJobRequest clearKMSEncryptionContextEntries() { this.kMSEncryptionContext = null; return this; } /** *

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

* * @return

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

*/ public MedicalTranscriptionSetting getSettings() { return 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. *

* * @param 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. *

*/ public void setSettings(MedicalTranscriptionSetting settings) { this.settings = 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 a reference to this object so that method calls can be chained * together. * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public StartMedicalTranscriptionJobRequest withSettings(MedicalTranscriptionSetting settings) { this.settings = settings; return this; } /** *

* Labels all personal health information (PHI) identified in your * transcript. For more information, see Identifying personal health information (PHI) in a transcription. *

*

* Constraints:
* Allowed Values: PHI * * @return

* Labels all personal health information (PHI) identified in your * transcript. For more information, see Identifying personal health information (PHI) in a * transcription. *

* @see MedicalContentIdentificationType */ public String getContentIdentificationType() { return contentIdentificationType; } /** *

* Labels all personal health information (PHI) identified in your * transcript. For more information, see Identifying personal health information (PHI) in a transcription. *

*

* Constraints:
* Allowed Values: PHI * * @param contentIdentificationType

* Labels all personal health information (PHI) identified in * your transcript. For more information, see Identifying personal health information (PHI) in a * transcription. *

* @see MedicalContentIdentificationType */ public void setContentIdentificationType(String contentIdentificationType) { this.contentIdentificationType = contentIdentificationType; } /** *

* Labels all personal health information (PHI) identified in your * transcript. For more information, see Identifying personal health information (PHI) in a transcription. *

*

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

* Constraints:
* Allowed Values: PHI * * @param contentIdentificationType

* Labels all personal health information (PHI) identified in * your transcript. For more information, see Identifying personal health information (PHI) in a * transcription. *

* @return A reference to this updated object so that method calls can be * chained together. * @see MedicalContentIdentificationType */ public StartMedicalTranscriptionJobRequest withContentIdentificationType( String contentIdentificationType) { this.contentIdentificationType = contentIdentificationType; return this; } /** *

* Labels all personal health information (PHI) identified in your * transcript. For more information, see Identifying personal health information (PHI) in a transcription. *

*

* Constraints:
* Allowed Values: PHI * * @param contentIdentificationType

* Labels all personal health information (PHI) identified in * your transcript. For more information, see Identifying personal health information (PHI) in a * transcription. *

* @see MedicalContentIdentificationType */ public void setContentIdentificationType( MedicalContentIdentificationType contentIdentificationType) { this.contentIdentificationType = contentIdentificationType.toString(); } /** *

* Labels all personal health information (PHI) identified in your * transcript. For more information, see Identifying personal health information (PHI) in a transcription. *

*

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

* Constraints:
* Allowed Values: PHI * * @param contentIdentificationType

* Labels all personal health information (PHI) identified in * your transcript. For more information, see Identifying personal health information (PHI) in a * transcription. *

* @return A reference to this updated object so that method calls can be * chained together. * @see MedicalContentIdentificationType */ public StartMedicalTranscriptionJobRequest withContentIdentificationType( MedicalContentIdentificationType contentIdentificationType) { this.contentIdentificationType = contentIdentificationType.toString(); return this; } /** *

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

*

* Constraints:
* Allowed Values: PRIMARYCARE * * @return

* 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 Specialty */ public String getSpecialty() { return 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 . *

*

* Constraints:
* Allowed Values: PRIMARYCARE * * @param 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 . *

* @see Specialty */ public void setSpecialty(String specialty) { this.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 . *

*

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

* Constraints:
* Allowed Values: PRIMARYCARE * * @param 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 . *

* @return A reference to this updated object so that method calls can be * chained together. * @see Specialty */ public StartMedicalTranscriptionJobRequest withSpecialty(String specialty) { this.specialty = specialty; return this; } /** *

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

*

* Constraints:
* Allowed Values: PRIMARYCARE * * @param 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 . *

* @see Specialty */ public void setSpecialty(Specialty specialty) { this.specialty = specialty.toString(); } /** *

* Specify the predominant medical specialty represented in your media. For * batch transcriptions, PRIMARYCARE is the only valid value. * If you require additional specialties, refer to . *

*

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

* Constraints:
* Allowed Values: PRIMARYCARE * * @param 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 . *

* @return A reference to this updated object so that method calls can be * chained together. * @see Specialty */ public StartMedicalTranscriptionJobRequest withSpecialty(Specialty specialty) { this.specialty = specialty.toString(); return this; } /** *

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

*

* Constraints:
* Allowed Values: CONVERSATION, DICTATION * * @return

* 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 Type */ public String getType() { return 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. *

*

* Constraints:
* Allowed Values: CONVERSATION, DICTATION * * @param 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. *

* @see Type */ public void setType(String type) { this.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. *

*

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

* Constraints:
* Allowed Values: CONVERSATION, DICTATION * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. * @see Type */ public StartMedicalTranscriptionJobRequest withType(String type) { this.type = type; return this; } /** *

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

*

* Constraints:
* Allowed Values: CONVERSATION, DICTATION * * @param 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. *

* @see Type */ public void setType(Type type) { this.type = type.toString(); } /** *

* Specify whether your input media contains only one person ( * DICTATION) or contains a conversation between two people ( * CONVERSATION). *

*

* For example, DICTATION could be used for a medical * professional wanting to transcribe voice memos; CONVERSATION * could be used for transcribing the doctor-patient dialogue during the * patient's office visit. *

*

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

* Constraints:
* Allowed Values: CONVERSATION, DICTATION * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. * @see Type */ public StartMedicalTranscriptionJobRequest withType(Type type) { this.type = type.toString(); return this; } /** *

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

* * @return

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

*/ public java.util.List getTags() { return 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. *

* * @param 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. *

*/ public void setTags(java.util.Collection tags) { if (tags == null) { this.tags = null; return; } this.tags = new java.util.ArrayList(tags); } /** *

* Adds one or more custom tags, each in the form of a key:value pair, to a * new medical transcription job at the time you start this new job. *

*

* To learn more about using tags with Amazon Transcribe, refer to Tagging resources. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public StartMedicalTranscriptionJobRequest withTags(Tag... tags) { if (getTags() == null) { this.tags = new java.util.ArrayList(tags.length); } for (Tag value : tags) { this.tags.add(value); } return this; } /** *

* Adds one or more custom tags, each in the form of a key:value pair, to a * new medical transcription job at the time you start this new job. *

*

* To learn more about using tags with Amazon Transcribe, refer to Tagging resources. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public StartMedicalTranscriptionJobRequest withTags(java.util.Collection tags) { setTags(tags); return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getMedicalTranscriptionJobName() != null) sb.append("MedicalTranscriptionJobName: " + getMedicalTranscriptionJobName() + ","); if (getLanguageCode() != null) sb.append("LanguageCode: " + getLanguageCode() + ","); if (getMediaSampleRateHertz() != null) sb.append("MediaSampleRateHertz: " + getMediaSampleRateHertz() + ","); if (getMediaFormat() != null) sb.append("MediaFormat: " + getMediaFormat() + ","); if (getMedia() != null) sb.append("Media: " + getMedia() + ","); if (getOutputBucketName() != null) sb.append("OutputBucketName: " + getOutputBucketName() + ","); if (getOutputKey() != null) sb.append("OutputKey: " + getOutputKey() + ","); if (getOutputEncryptionKMSKeyId() != null) sb.append("OutputEncryptionKMSKeyId: " + getOutputEncryptionKMSKeyId() + ","); if (getKMSEncryptionContext() != null) sb.append("KMSEncryptionContext: " + getKMSEncryptionContext() + ","); if (getSettings() != null) sb.append("Settings: " + getSettings() + ","); if (getContentIdentificationType() != null) sb.append("ContentIdentificationType: " + getContentIdentificationType() + ","); if (getSpecialty() != null) sb.append("Specialty: " + getSpecialty() + ","); if (getType() != null) sb.append("Type: " + getType() + ","); if (getTags() != null) sb.append("Tags: " + getTags()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getMedicalTranscriptionJobName() == null) ? 0 : getMedicalTranscriptionJobName().hashCode()); hashCode = prime * hashCode + ((getLanguageCode() == null) ? 0 : getLanguageCode().hashCode()); hashCode = prime * hashCode + ((getMediaSampleRateHertz() == null) ? 0 : getMediaSampleRateHertz().hashCode()); hashCode = prime * hashCode + ((getMediaFormat() == null) ? 0 : getMediaFormat().hashCode()); hashCode = prime * hashCode + ((getMedia() == null) ? 0 : getMedia().hashCode()); hashCode = prime * hashCode + ((getOutputBucketName() == null) ? 0 : getOutputBucketName().hashCode()); hashCode = prime * hashCode + ((getOutputKey() == null) ? 0 : getOutputKey().hashCode()); hashCode = prime * hashCode + ((getOutputEncryptionKMSKeyId() == null) ? 0 : getOutputEncryptionKMSKeyId() .hashCode()); hashCode = prime * hashCode + ((getKMSEncryptionContext() == null) ? 0 : getKMSEncryptionContext().hashCode()); hashCode = prime * hashCode + ((getSettings() == null) ? 0 : getSettings().hashCode()); hashCode = prime * hashCode + ((getContentIdentificationType() == null) ? 0 : getContentIdentificationType() .hashCode()); hashCode = prime * hashCode + ((getSpecialty() == null) ? 0 : getSpecialty().hashCode()); hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode()); hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof StartMedicalTranscriptionJobRequest == false) return false; StartMedicalTranscriptionJobRequest other = (StartMedicalTranscriptionJobRequest) obj; if (other.getMedicalTranscriptionJobName() == null ^ this.getMedicalTranscriptionJobName() == null) return false; if (other.getMedicalTranscriptionJobName() != null && other.getMedicalTranscriptionJobName().equals( this.getMedicalTranscriptionJobName()) == false) return false; if (other.getLanguageCode() == null ^ this.getLanguageCode() == null) return false; if (other.getLanguageCode() != null && other.getLanguageCode().equals(this.getLanguageCode()) == false) return false; if (other.getMediaSampleRateHertz() == null ^ this.getMediaSampleRateHertz() == null) return false; if (other.getMediaSampleRateHertz() != null && other.getMediaSampleRateHertz().equals(this.getMediaSampleRateHertz()) == false) return false; if (other.getMediaFormat() == null ^ this.getMediaFormat() == null) return false; if (other.getMediaFormat() != null && other.getMediaFormat().equals(this.getMediaFormat()) == false) return false; if (other.getMedia() == null ^ this.getMedia() == null) return false; if (other.getMedia() != null && other.getMedia().equals(this.getMedia()) == false) return false; if (other.getOutputBucketName() == null ^ this.getOutputBucketName() == null) return false; if (other.getOutputBucketName() != null && other.getOutputBucketName().equals(this.getOutputBucketName()) == false) return false; if (other.getOutputKey() == null ^ this.getOutputKey() == null) return false; if (other.getOutputKey() != null && other.getOutputKey().equals(this.getOutputKey()) == false) return false; if (other.getOutputEncryptionKMSKeyId() == null ^ this.getOutputEncryptionKMSKeyId() == null) return false; if (other.getOutputEncryptionKMSKeyId() != null && other.getOutputEncryptionKMSKeyId().equals(this.getOutputEncryptionKMSKeyId()) == false) return false; if (other.getKMSEncryptionContext() == null ^ this.getKMSEncryptionContext() == null) return false; if (other.getKMSEncryptionContext() != null && other.getKMSEncryptionContext().equals(this.getKMSEncryptionContext()) == false) return false; if (other.getSettings() == null ^ this.getSettings() == null) return false; if (other.getSettings() != null && other.getSettings().equals(this.getSettings()) == false) return false; if (other.getContentIdentificationType() == null ^ this.getContentIdentificationType() == null) return false; if (other.getContentIdentificationType() != null && other.getContentIdentificationType().equals(this.getContentIdentificationType()) == false) return false; if (other.getSpecialty() == null ^ this.getSpecialty() == null) return false; if (other.getSpecialty() != null && other.getSpecialty().equals(this.getSpecialty()) == false) return false; if (other.getType() == null ^ this.getType() == null) return false; if (other.getType() != null && other.getType().equals(this.getType()) == false) return false; if (other.getTags() == null ^ this.getTags() == null) return false; if (other.getTags() != null && other.getTags().equals(this.getTags()) == false) return false; return true; } }