Synopsis
Calls the Amazon Polly StartSpeechSynthesisTask API operation.
Syntax
Start-POLSpeechSynthesisTask-Text <String>-Engine <Engine>-LanguageCode <LanguageCode>-LexiconName <String[]>-OutputFormat <OutputFormat>-OutputS3BucketName <String>-OutputS3KeyPrefix <String>-SampleRate <String>-SnsTopicArn <String>-SpeechMarkType <String[]>-TextType <TextType>-VoiceId <VoiceId>-Force <SwitchParameter>
Description
Allows the creation of an asynchronous synthesis task, by starting a new
SpeechSynthesisTask. This operation requires all the standard information needed for speech synthesis, plus the name of an Amazon S3 bucket for the service to store the output of the synthesis task and two optional parameters (OutputS3KeyPrefix and SnsTopicArn). Once the synthesis task is created, this operation will return a SpeechSynthesisTask object, which will include an identifier of this task as well as the current status. Parameters
-Engine <Engine>
Specifies the engine (
standard or neural) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-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>
Optional language code for the Speech Synthesis request. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN). If a bilingual voice is used and no language code is specified, Amazon Polly will use the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the
LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-LexiconName <String[]>
List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | LexiconNames |
-OutputFormat <OutputFormat>
The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-OutputS3BucketName <String>
Amazon S3 bucket name to which the output file will be saved.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-OutputS3KeyPrefix <String>
The Amazon S3 key prefix for the output speech file.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SampleRate <String>
The audio frequency specified in Hz.The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000".Valid values for pcm are "8000" and "16000" The default value is "16000".
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SnsTopicArn <String>
ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SpeechMarkType <String[]>
The type of speech marks returned for the input text.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | SpeechMarkTypes |
-Text <String>
The input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.
| Required? | False |
| Position? | 1 |
| Accept pipeline input? | True (ByValue, ) |
-TextType <TextType>
Specifies whether the input text is plain text or SSML. The default value is plain text.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-VoiceId <VoiceId>
Voice ID to use for the synthesis.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
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 |
| Aliases | AK |
-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 |
| Aliases | AWSProfilesLocation, 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? | False |
| Aliases | AWSProfileName, StoredCredentials |
-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 |
| Aliases | SecretAccessKey, SK |
-SessionToken <String>
The session token if the access and secret keys are temporary session-based
credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | ST |
-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 |
| Aliases | RegionToCall |
-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 Text parameter.
Outputs
This cmdlet returns a Amazon.Polly.Model.SynthesisTask object.
The service call response (type Amazon.Polly.Model.StartSpeechSynthesisTaskResponse) 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
