[ aws . pinpoint-sms-voice-v2 ]

delete-opted-out-number

Description

Deletes an existing opted out destination phone number from the specified opt-out list.

Each destination phone number can only be deleted once every 30 days.

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

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

The OptOutListName or OptOutListArn to remove the phone number from.

--opted-out-number (string)

The phone number, in E.164 format, to remove from the OptOutList.

--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.

See ‘aws help’ for descriptions of global parameters.

Output

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 removed from the OptOutList.

OptedOutTimestamp -> (timestamp)

The time that the number was removed at, in UNIX epoch time format.

EndUserOptedOut -> (boolean)

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