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 ]

delete-opt-out-list

Description

Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are deleted.

If the specified opt-out list name doesn't exist or is in-use by an origination phone number or pool, an Error is returned.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

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

Options

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

The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.

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

Output

OptOutListArn -> (string)

The Amazon Resource Name (ARN) of the OptOutList that was removed.

OptOutListName -> (string)

The name of the OptOutList that was removed.

CreatedTimestamp -> (timestamp)

The time when the OptOutList was created, in UNIX epoch time format.