[ aws . chime ]

list-phone-number-orders

Description

Lists the phone number orders for the administrator’s Amazon Chime account.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-phone-number-orders
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--next-token (string)

The token to use to retrieve the next page of results.

--max-results (integer)

The maximum number of results to return in a single call.

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

Examples

To list phone number orders

The following list-phone-number-orders example lists the phone number orders associated with the Amazon Chime administrator’s account.

aws chime list-phone-number-orders

Output:

{
    "PhoneNumberOrders": [
        {
            "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"
        }
        {
            "PhoneNumberOrderId": "cba54321-ed76-09f5-321g-h54i876j2109",
            "ProductType": "BusinessCalling",
            "Status": "Partial",
            "OrderedPhoneNumbers": [
                {
                    "E164PhoneNumber": "+12065550103",
                    "Status": "Acquired"
                },
                {
                    "E164PhoneNumber": "+12065550104",
                    "Status": "Acquired"
                },
                {
                    "E164PhoneNumber": "+12065550105",
                    "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

PhoneNumberOrders -> (list)

The phone number order details.

(structure)

The details of a phone number order created for Amazon Chime.

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 time stamp, in ISO 8601 format.

UpdatedTimestamp -> (timestamp)

The updated phone number order time stamp, in ISO 8601 format.

NextToken -> (string)

The token to use to retrieve the next page of results.