AWS CLI Command Reference

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 ]

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

Synopsis

  update-phone-number
--phone-number-id <value>
[--two-way-enabled | --no-two-way-enabled]
[--two-way-channel-arn <value>]
[--two-way-channel-role <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 <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <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.

Warning

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

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

--two-way-channel-role (string)

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

--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, AWS End User Messaging SMS and Voice 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 (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.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

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.

TwoWayChannelRole -> (string)

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

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.

RegistrationId -> (string)

The unique identifier for the registration.

CreatedTimestamp -> (timestamp)

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