[ aws . pinpoint-sms-voice-v2 ]

update-phone-number

Description

Updates the configuration of an existing origination phone number. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, and enable or disable deletion protection.

If the origination phone number is associated with a pool, an Error is returned.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-phone-number
--phone-number-id <value>
[--two-way-enabled | --no-two-way-enabled]
[--two-way-channel-arn <value>]
[--self-managed-opt-outs-enabled | --no-self-managed-opt-outs-enabled]
[--opt-out-list-name <value>]
[--deletion-protection-enabled | --no-deletion-protection-enabled]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--phone-number-id (string)

The unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.

--two-way-enabled | --no-two-way-enabled (boolean)

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

--two-way-channel-arn (string)

The Amazon Resource Name (ARN) of the two way channel.

--self-managed-opt-outs-enabled | --no-self-managed-opt-outs-enabled (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.

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

The OptOutList to add the phone number to. Valid values for this field can be either the OutOutListName or OutOutListArn.

--deletion-protection-enabled | --no-deletion-protection-enabled (boolean)

By default this is set to false. When set to true the phone number can’t be deleted.

--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 Amazon Resource Name (ARN) of the updated phone number.

PhoneNumberId -> (string)

The unique identifier of the phone number.

PhoneNumber -> (string)

The phone number that was updated.

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 type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren’t critical or time-sensitive.

NumberCapabilities -> (list)

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

(string)

NumberType -> (string)

The type of number that was requested.

MonthlyLeasingPrice -> (string)

The monthly leasing 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 two way channel.

SelfManagedOptOutsEnabled -> (boolean)

This is true if self managed opt-out are enabled.

OptOutListName -> (string)

The name of the OptOutList associated with the phone number.

DeletionProtectionEnabled -> (boolean)

When set to true the phone number can’t be deleted.

CreatedTimestamp -> (timestamp)

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