Synopsis
Calls the Amazon Transcribe Service StartTranscriptionJob API operation.
Syntax
Start-TRSTranscriptionJob-TranscriptionJobName <String>-Settings_ChannelIdentification <Boolean>-LanguageCode <LanguageCode>-Settings_MaxSpeakerLabel <Int32>-Media_MediaFileUri <String>-MediaFormat <MediaFormat>-MediaSampleRateHertz <Int32>-OutputBucketName <String>-Settings_ShowSpeakerLabel <Boolean>-Settings_VocabularyName <String>-Force <SwitchParameter>
Description
Starts an asynchronous job to transcribe speech to text.
Parameters
-Force <SwitchParameter>
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? | False |
-LanguageCode <LanguageCode>
The language code for the language used in the input media file.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-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? | False |
-MediaFormat <MediaFormat>
The format of the input media file.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-MediaSampleRateHertz <Int32>
The sample rate, in Hertz, of the audio track in the input media file.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-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.Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket. You can't specify your own encryption key.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? | False |
-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? | False |
-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? | False |
| Aliases | Settings_MaxSpeakerLabels |
-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? | False |
| Aliases | Settings_ShowSpeakerLabels |
-Settings_VocabularyName <String>
The name of a vocabulary to use when processing the transcription job.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-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? | False |
| Position? | 1 |
| Accept pipeline input? | True (ByValue, ) |
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? | False |
-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? | False |
-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. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.
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? | False |
-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? | False |
-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? | False |
-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? | False |
-SessionToken <String>
The session token if the access and secret keys are temporary session-based
credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-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? | False |
Inputs
You can pipe a String object to this cmdlet for the TranscriptionJobName parameter.
Outputs
This cmdlet returns a 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.
Related Links
Supported Version
AWS Tools for PowerShell: 2.x.y.z
