Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

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

batch-update-phone-number

Description

Updates phone number product types or calling names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem . For example, you can update either the product type or the calling name.

For product types, choose from Amazon Chime Business Calling and Amazon Chime Voice Connector. For toll-free numbers, you must use the Amazon Chime Voice Connector product type.

Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  batch-update-phone-number
--update-phone-number-request-items <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--update-phone-number-request-items (list)

The request containing the phone number IDs and product types or calling names to update.

(structure)

The phone number ID, product type, or calling name fields to update, used with the BatchUpdatePhoneNumber and UpdatePhoneNumber actions.

PhoneNumberId -> (string)

The phone number ID to update.

ProductType -> (string)

The product type to update.

CallingName -> (string)

The outbound calling name to update.

Shorthand Syntax:

PhoneNumberId=string,ProductType=string,CallingName=string ...

JSON Syntax:

[
  {
    "PhoneNumberId": "string",
    "ProductType": "BusinessCalling"|"VoiceConnector",
    "CallingName": "string"
  }
  ...
]

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

Examples

To update several phone number product types at the same time

The following batch-update-phone-number example updates the product types for all of the specified phone numbers.

aws chime batch-update-phone-number \
    --update-phone-number-request-items PhoneNumberId=%2B12065550100,ProductType=BusinessCalling PhoneNumberId=%2B12065550101,ProductType=BusinessCalling

Output:

{
    "PhoneNumberErrors": []
}

To update several phone number calling names at the same time

The following batch-update-phone-number example updates the calling names for all of the specified phone numbers.

aws chime batch-update-phone-number \
    --update-phone-number-request-items PhoneNumberId=%2B14013143874,CallingName=phonenumber1 PhoneNumberId=%2B14013144061,CallingName=phonenumber2

Output:

{
    "PhoneNumberErrors": []
}

For more information, see Working with Phone Numbers in the Amazon Chime Administration Guide.

Output

PhoneNumberErrors -> (list)

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

(structure)

If the phone number action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

PhoneNumberId -> (string)

The phone number ID for which the action failed.

ErrorCode -> (string)

The error code.

ErrorMessage -> (string)

The error message.