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 StartTranscriptionJob API operation.

Syntax

Start-TRSTranscriptionJob
-TranscriptionJobName <String>
-JobExecutionSettings_AllowDeferredExecution <Boolean>
-Settings_ChannelIdentification <Boolean>
-JobExecutionSettings_DataAccessRoleArn <String>
-LanguageCode <LanguageCode>
-Settings_MaxAlternative <Int32>
-Settings_MaxSpeakerLabel <Int32>
-Media_MediaFileUri <String>
-MediaFormat <MediaFormat>
-MediaSampleRateHertz <Int32>
-OutputBucketName <String>
-OutputEncryptionKMSKeyId <String>
-Settings_ShowAlternative <Boolean>
-Settings_ShowSpeakerLabel <Boolean>
-Settings_VocabularyFilterMethod <VocabularyFilterMethod>
-Settings_VocabularyFilterName <String>
-Settings_VocabularyName <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Starts an asynchronous job to transcribe speech to text.

Parameters

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)
-JobExecutionSettings_AllowDeferredExecution <Boolean>
Indicates whether a job should be queued by Amazon Transcribe when the concurrent execution limit is exceeded. When the AllowDeferredExecution field is true, jobs are queued and will be executed when the number of executing jobs falls below the concurrent execution limit. If the field is false, Amazon Transcribe returns a LimitExceededException exception.If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-JobExecutionSettings_DataAccessRoleArn <String>
The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains the input files. Amazon Transcribe will assume this role to read queued media files. If you have specified an output S3 bucket for the transcription results, this role should have access to the output bucket as well.If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LanguageCode <LanguageCode>
The language code for the language used in the input media file.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Media_MediaFileUri <String>
The S3 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: https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey> For example:https://s3.us-east-1.amazonaws.com/examplebucket/example.mp4https://s3.us-east-1.amazonaws.com/examplebucket/mediadocs/example.mp4For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MediaFormat <MediaFormat>
The 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 determines the sample rate. If you specify the sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe determine the sample rate.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputBucketName <String>
The location where the transcription is stored.If you set the OutputBucketName, Amazon Transcribe puts the transcription in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles.You can specify an AWS 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 uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputEncryptionKMSKeyId <String>
The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartTranscriptionJob operation must have permission to use the specified KMS key.You can 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: "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 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)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the TranscriptionJobName parameter. The -PassThru parameter is deprecated, use -Select '^TranscriptionJobName' 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 'TranscriptionJob'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.StartTranscriptionJobResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.StartTranscriptionJobResponse 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 to process each audio channel separately and then merge the transcription output of each channel into a single transcription. Amazon Transcribe 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 the item including the confidence that Amazon Transcribe has in the transcription.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 number of alternative transcriptions that the service should 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 will be 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 the transcription contains alternative transcriptions. If you set the 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 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_VocabularyFilterMethod <VocabularyFilterMethod>
Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Settings_VocabularyFilterName <String>
The name of the vocabulary filter to use when transcribing the audio. The filter that you specify must have the same language code as the transcription job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Settings_VocabularyName <String>
The name of a vocabulary to use when processing the transcription job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TranscriptionJobName <String>
The name of the job. Note that you can't use the strings "." or ".." by themselves as the job name. The name must also be unique within an AWS account.
Required?True
Position?1
Accept pipeline input?True (ByValue, 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.TranscriptionJob object. The service call response (type Amazon.TranscribeService.Model.StartTranscriptionJobResponse) 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