AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the StartMedicalTranscriptionJob operation. 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 Amazon S3 location of
the file using the Media
parameter.
You must include the following parameters in your StartMedicalTranscriptionJob
request:
region
: The Amazon Web Services Region where you are making your request.
For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer
to Amazon
Transcribe endpoints and quotas.
MedicalTranscriptionJobName
: A custom name you create for your transcription
job that is unique within your Amazon Web Services account.
Media
(MediaFileUri
): The Amazon S3 location of your media file.
LanguageCode
: This must be en-US
.
OutputBucketName
: The Amazon S3 bucket where you want your transcript stored.
If you want your output stored in a sub-folder of this bucket, you must also include
OutputKey
.
Specialty
: This must be PRIMARYCARE
.
Type
: Choose whether your audio is a conversation or a dictation.
Namespace: Amazon.TranscribeService.Model
Assembly: AWSSDK.TranscribeService.dll
Version: 3.x.y.z
public class StartMedicalTranscriptionJobRequest : AmazonTranscribeServiceRequest IAmazonWebServiceRequest
The StartMedicalTranscriptionJobRequest type exposes the following members
Name | Description | |
---|---|---|
StartMedicalTranscriptionJobRequest() |
Name | Type | Description | |
---|---|---|---|
ContentIdentificationType | Amazon.TranscribeService.MedicalContentIdentificationType |
Gets and sets the property ContentIdentificationType. Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription. |
|
KMSEncryptionContext | System.Collections.Generic.Dictionary<System.String, System.String> |
Gets and sets the property 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. |
|
LanguageCode | Amazon.TranscribeService.LanguageCode |
Gets and sets the property LanguageCode.
The language code that represents the language spoken in the input media file. US
English ( |
|
Media | Amazon.TranscribeService.Model.Media |
Gets and sets the property Media. |
|
MediaFormat | Amazon.TranscribeService.MediaFormat |
Gets and sets the property MediaFormat. Specify the format of your input media file. |
|
MediaSampleRateHertz | System.Int32 |
Gets and sets the property MediaSampleRateHertz. The sample rate, in hertz, of the audio track in your input media file.
If you do not specify the media sample rate, Amazon Transcribe Medical determines
it for you. If you specify the sample rate, it must match the rate detected by Amazon
Transcribe Medical; if there's a mismatch between the value that you specify and the
value detected, your job fails. Therefore, in most cases, it's advised to omit |
|
MedicalTranscriptionJobName | System.String |
Gets and sets the property 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
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 |
|
OutputBucketName | System.String |
Gets and sets the property OutputBucketName.
The name of the Amazon S3 bucket where you want your medical transcription output
stored. Do not include the
If you want your output to go to a sub-folder of this bucket, specify it using the
For example, if you want your output stored in 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. |
|
OutputEncryptionKMSKeyId | System.String |
Gets and sets the property 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:
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:
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 Note that the role making the request must have permission to use the specified KMS key. |
|
OutputKey | System.String |
Gets and sets the property OutputKey.
Use in combination with
Here are some examples of how you can use
If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for you. |
|
Settings | Amazon.TranscribeService.Model.MedicalTranscriptionSetting |
Gets and sets the property 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. |
|
Specialty | Amazon.TranscribeService.Specialty |
Gets and sets the property Specialty.
Specify the predominant medical specialty represented in your media. For batch transcriptions,
|
|
Tags | System.Collections.Generic.List<Amazon.TranscribeService.Model.Tag> |
Gets and sets the property 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. |
|
Type | Amazon.TranscribeService.Type |
Gets and sets the property Type.
Specify whether your input media contains only one person (
For example, |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5