Table Of Contents

Feedback

User Guide

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

[ aws . chime ]

get-phone-number-order

Description

Retrieves details for the specified phone number order, such as order creation timestamp, phone numbers in E.164 format, product type, and order status.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-phone-number-order
--phone-number-order-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--phone-number-order-id (string)

The ID for the phone number order.

--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 get details for a phone number order

The following get-phone-number-order example displays the details of the specified phone number order.

aws chime get-phone-number-order \
    --phone-number-order-id abc12345-de67-89f0-123g-h45i678j9012

Output:

{
    "PhoneNumberOrder": {
        "PhoneNumberOrderId": "abc12345-de67-89f0-123g-h45i678j9012",
        "ProductType": "VoiceConnector",
        "Status": "Partial",
        "OrderedPhoneNumbers": [
            {
              "E164PhoneNumber": "+12065550100",
              "Status": "Acquired"
            },
            {
                "E164PhoneNumber": "+12065550101",
                "Status": "Acquired"
            },
            {
                "E164PhoneNumber": "+12065550102",
                "Status": "Failed"
            }
        ],
        "CreatedTimestamp": "2019-08-09T21:35:21.427Z",
        "UpdatedTimestamp": "2019-08-09T21:35:31.926Z"
    }
}

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

Output

PhoneNumberOrder -> (structure)

The phone number order details.

PhoneNumberOrderId -> (string)

The phone number order ID.

ProductType -> (string)

The phone number order product type.

Status -> (string)

The status of the phone number order.

OrderedPhoneNumbers -> (list)

The ordered phone number details, such as the phone number in E.164 format and the phone number status.

(structure)

A phone number for which an order has been placed.

E164PhoneNumber -> (string)

The phone number, in E.164 format.

Status -> (string)

The phone number status.

CreatedTimestamp -> (timestamp)

The phone number order creation timestamp, in ISO 8601 format.

UpdatedTimestamp -> (timestamp)

The updated phone number order timestamp, in ISO 8601 format.