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 Pinpoint SMS Voice V2 SendVoiceMessage API operation.

Syntax

Send-SMSVVoiceMessage
-ConfigurationSetName <String>
-Context <Hashtable>
-DestinationPhoneNumber <String>
-DryRun <Boolean>
-MaxPricePerMinute <String>
-MessageBody <String>
-MessageBodyTextType <VoiceMessageBodyTextType>
-OriginationIdentity <String>
-TimeToLive <Int32>
-VoiceId <VoiceId>
-Select <String>
-Force <SwitchParameter>

Description

Allows you to send a request that sends a text message through Amazon Pinpoint. This operation uses Amazon Polly to convert a text script into a voice message.

Parameters

-ConfigurationSetName <String>
The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Context <Hashtable>
You can specify custom data in this field. If you do, that data is logged to the event destination.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DestinationPhoneNumber <String>
The destination phone number in E.164 format.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-DryRun <Boolean>
When set to true, the message is checked and validated, but isn't sent to the end recipient.
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)
-MaxPricePerMinute <String>
The maximum amount to spend per voice message, in US dollars.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MessageBody <String>
The text to convert to a voice message.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MessageBodyTextType <VoiceMessageBodyTextType>
Specifies if the MessageBody field contains text or speech synthesis markup language (SSML).
  • TEXT: This is the default value. When used the maximum character limit is 3000.
  • SSML: When used the maximum character limit is 6000 including SSML tagging.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OriginationIdentity <String>
The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointSMSVoiceV2.Model.SendVoiceMessageResponse). Specifying the name of a property of type Amazon.PinpointSMSVoiceV2.Model.SendVoiceMessageResponse 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)
-TimeToLive <Int32>
How long the voice message is valid for. By default this is 72 hours.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VoiceId <VoiceId>
The voice for the Amazon Polly service to use. By default this is set to "MATTHEW".
Required?False
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.PinpointSMSVoiceV2.Model.SendVoiceMessageResponse object containing multiple properties. The object 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