Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . pinpoint-sms-voice-v2 ]



Creates an opted out destination phone number in the opt-out list.

If the destination phone number isn't valid or if the specified opt-out list doesn't exist, an Error is returned.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--opt-out-list-name <value>
--opted-out-number <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--opt-out-list-name (string)

The OptOutListName or OptOutListArn to add the phone number to.

--opted-out-number (string)

The phone number to add to the OptOutList in E.164 format.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


OptOutListArn -> (string)

The OptOutListArn that the phone number was removed from.

OptOutListName -> (string)

The OptOutListName that the phone number was removed from.

OptedOutNumber -> (string)

The phone number that was added to the OptOutList.

OptedOutTimestamp -> (timestamp)

The time that the phone number was added to the OptOutList, in UNIX epoch time format.

EndUserOptedOut -> (boolean)

This is true if it was the end user who requested their phone number be removed.