AWS Tools for Windows PowerShell
Command Reference

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.

Synopsis

Calls the Amazon Transcribe Service StartMedicalTranscriptionJob API operation.

Syntax

Start-TRSMedicalTranscriptionJob
-MedicalTranscriptionJobName <String>
-Settings_ChannelIdentification <Boolean>
-ContentIdentificationType <MedicalContentIdentificationType>
-KMSEncryptionContext <Hashtable>
-LanguageCode <LanguageCode>
-Settings_MaxAlternative <Int32>
-Settings_MaxSpeakerLabel <Int32>
-Media_MediaFileUri <String>
-MediaFormat <MediaFormat>
-MediaSampleRateHertz <Int32>
-OutputBucketName <String>
-OutputEncryptionKMSKeyId <String>
-OutputKey <String>
-Media_RedactedMediaFileUri <String>
-Settings_ShowAlternative <Boolean>
-Settings_ShowSpeakerLabel <Boolean>
-Specialty <Specialty>
-Tag <Tag[]>
-Type <Type>
-Settings_VocabularyName <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Starts a batch job to transcribe medical speech to text.

Parameters

-ContentIdentificationType <MedicalContentIdentificationType>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KMSEncryptionContext <Hashtable>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Media_MediaFileUri <String>
The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:For example:For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Media_RedactedMediaFileUri <String>
The S3 object location for your redacted output media file. This is only supported for call analytics jobs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MediaFormat <MediaFormat>
The audio format of the input media file.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MediaSampleRateHertz <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MedicalTranscriptionJobName <String>
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.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-OutputBucketName <String>
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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputEncryptionKMSKeyId <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputKey <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the MedicalTranscriptionJobName parameter. The -PassThru parameter is deprecated, use -Select '^MedicalTranscriptionJobName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'MedicalTranscriptionJob'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.StartMedicalTranscriptionJobResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.StartMedicalTranscriptionJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Settings_ChannelIdentification <Boolean>
Instructs Amazon Transcribe Medical to process each audio channel separately and then merge the transcription output of each channel into a single transcription.Amazon Transcribe Medical also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of item. The alternative transcriptions also come with confidence scores provided by Amazon Transcribe Medical.You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Settings_MaxAlternative <Int32>
The maximum number of alternatives that you tell the service to return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_MaxAlternatives
-Settings_MaxSpeakerLabel <Int32>
The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_MaxSpeakerLabels
-Settings_ShowAlternative <Boolean>
Determines whether alternative transcripts are generated along with the transcript that has the highest confidence. If you set ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_ShowAlternatives
-Settings_ShowSpeakerLabel <Boolean>
Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels in the MaxSpeakerLabels field.You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_ShowSpeakerLabels
-Settings_VocabularyName <String>
The name of the vocabulary to use when processing a medical transcription job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Specialty <Specialty>
The medical specialty of any clinician speaking in the input media.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
Add tags to an Amazon Transcribe medical transcription job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

This cmdlet returns an Amazon.TranscribeService.Model.MedicalTranscriptionJob object. The service call response (type Amazon.TranscribeService.Model.StartMedicalTranscriptionJobResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z