[ aws . pinpoint-sms-voice-v2 ]

release-phone-number

Description

Releases an existing origination phone number in your account. Once released, a phone number is no longer available for sending messages.

If the origination phone number has deletion protection enabled or is associated with a pool, an Error is returned.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  release-phone-number
--phone-number-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--phone-number-id (string)

The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use DescribePhoneNumbers to get the values for PhoneNumberId and PhoneNumberArn.

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

See ‘aws help’ for descriptions of global parameters.

Output

PhoneNumberArn -> (string)

The PhoneNumberArn of the phone number that was released.

PhoneNumberId -> (string)

The PhoneNumberId of the phone number that was released.

PhoneNumber -> (string)

The phone number that was released.

Status -> (string)

The current status of the request.

IsoCountryCode -> (string)

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

MessageType -> (string)

The message type that was associated with the phone number.

NumberCapabilities -> (list)

Specifies if the number could be used for text messages, voice, or both.

(string)

NumberType -> (string)

The type of number that was released.

MonthlyLeasingPrice -> (string)

The monthly price of the phone number, in US dollars.

TwoWayEnabled -> (boolean)

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

TwoWayChannelArn -> (string)

The Amazon Resource Name (ARN) of the TwoWayChannel.

SelfManagedOptOutsEnabled -> (boolean)

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you’re responsible for responding to HELP and STOP requests. You’re also responsible for tracking and honoring opt-out requests.

OptOutListName -> (string)

The name of the OptOutList that was associated with the phone number.

CreatedTimestamp -> (timestamp)

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