Transcribes the audio from a medical dictation or conversation and applies any additional Request Parameters you choose to include in your request.
See https://www.paws-r-sdk.com/docs/transcribeservice_start_medical_transcription_job/ for full documentation.
transcribeservice_start_medical_transcription_job(
MedicalTranscriptionJobName,
LanguageCode,
MediaSampleRateHertz = NULL,
MediaFormat = NULL,
Media,
OutputBucketName,
OutputKey = NULL,
OutputEncryptionKMSKeyId = NULL,
KMSEncryptionContext = NULL,
Settings = NULL,
ContentIdentificationType = NULL,
Specialty,
Type,
Tags = NULL
)[required] 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.
[required] 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.
The sample rate, in hertz, of the audio track in your input media file.
If you do not specify the media sample rate, Amazon Transcribe Medical
determines it for you. If you specify the sample rate, it must match the
rate detected by Amazon Transcribe Medical; if there's a mismatch
between the value that you specify and the value detected, your job
fails. Therefore, in most cases, it's advised to omit
MediaSampleRateHertz and let Amazon Transcribe Medical determine the
sample rate.
Specify the format of your input media file.
[required]
[required] 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.
Use in combination with OutputBucketName to specify the output
location of your transcript and, optionally, a unique name for your
output file. The default name for your transcription output is the same
as the name you specified for your medical transcription job
(MedicalTranscriptionJobName).
Here are some examples of how you can use OutputKey:
If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and
'my-transcript.json' as the OutputKey, your transcription output
path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json.
If you specify 'my-first-transcription' as the
MedicalTranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the
OutputBucketName, and 'my-transcript' as the OutputKey, your
transcription output path is
s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.
If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and
'test-files/my-transcript.json' as the OutputKey, your
transcription output path is
s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.
If you specify 'my-first-transcription' as the
MedicalTranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the
OutputBucketName, and 'test-files/my-transcript' as the
OutputKey, your transcription output path is
s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.
If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for you.
The KMS key you want to use to encrypt your medical transcription output.
If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:
Use the KMS key ID itself. For example,
1234abcd-12ab-34cd-56ef-1234567890ab.
Use an alias for the KMS key ID. For example, alias/ExampleAlias.
Use the Amazon Resource Name (ARN) for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Use the ARN for the KMS key alias. For example,
arn:aws:kms:region:account-ID:alias/ExampleAlias.
If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:
Use the ARN for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Use the ARN for the KMS key alias. For example,
arn:aws:kms:region:account-ID:alias/ExampleAlias.
If you do not specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).
If you specify a KMS key to encrypt your output, you must also specify
an output location using the OutputLocation parameter.
Note that the role making the request must have permission to use the specified KMS key.
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.
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.
Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.
[required] 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 .
[required] 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.
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.