send-voice-message¶

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.

Synopsis¶

  send-voice-message
--destination-phone-number <value>
--origination-identity <value>
[--message-body <value>]
[--message-body-text-type <value>]
[--voice-id <value>]
[--configuration-set-name <value>]
[--max-price-per-minute <value>]
[--time-to-live <value>]
[--context <value>]
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--destination-phone-number (string)

The destination phone number in E.164 format.

--origination-identity (string)

The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.

--message-body (string)

The text to convert to a voice message.

--message-body-text-type (string)

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.

Possible values:

TEXT

SSML

--voice-id (string)

The voice for the Amazon Polly service to use. By default this is set to “MATTHEW”.

Possible values:

AMY

ASTRID

BIANCA

BRIAN

CAMILA

CARLA

CARMEN

CELINE

CHANTAL

CONCHITA

CRISTIANO

DORA

EMMA

ENRIQUE

EWA

FILIZ

GERAINT

GIORGIO

GWYNETH

HANS

INES

IVY

JACEK

JAN

JOANNA

JOEY

JUSTIN

KARL

KENDRA

KIMBERLY

LEA

LIV

LOTTE

LUCIA

LUPE

MADS

MAJA

MARLENE

MATHIEU

MATTHEW

MAXIM

MIA

MIGUEL

MIZUKI

NAJA

NICOLE

PENELOPE

RAVEENA

RICARDO

RUBEN

RUSSELL

SALLI

SEOYEON

TAKUMI

TATYANA

VICKI

VITORIA

ZEINA

ZHIYU

--configuration-set-name (string)

The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

--max-price-per-minute (string)

The maximum amount to spend per voice message, in US dollars.

--time-to-live (integer)

How long the voice message is valid for. By default this is 72 hours.

--context (map)

You can specify custom data in this field. If you do, that data is logged to the event destination.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--dry-run | --no-dry-run (boolean)

When set to true, the message is checked and validated, but isn’t sent to the end recipient.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

MessageId -> (string)

The unique identifier for the message.

Table of Contents

Feedback

User Guide