Chime / Client / list_phone_number_orders

list_phone_number_orders#

Chime.Client.list_phone_number_orders(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.list_phone_number_orders(
    NextToken='string',
    MaxResults=123
)
Parameters:
  • NextToken (string) – The token to use to retrieve the next page of results.

  • MaxResults (integer) – The maximum number of results to return in a single call.

Return type:

dict

Returns:

Response Syntax

{
    'PhoneNumberOrders': [
        {
            'PhoneNumberOrderId': 'string',
            'ProductType': 'BusinessCalling'|'VoiceConnector'|'SipMediaApplicationDialIn',
            'Status': 'Processing'|'Successful'|'Failed'|'Partial',
            'OrderedPhoneNumbers': [
                {
                    'E164PhoneNumber': 'string',
                    'Status': 'Processing'|'Acquired'|'Failed'
                },
            ],
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • PhoneNumberOrders (list) –

      The phone number order details.

      • (dict) –

        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.

          • (dict) –

            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 (datetime) –

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

        • UpdatedTimestamp (datetime) –

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

    • NextToken (string) –

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

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException

  • Chime.Client.exceptions.ForbiddenException

  • Chime.Client.exceptions.BadRequestException

  • Chime.Client.exceptions.ThrottledClientException

  • Chime.Client.exceptions.ServiceUnavailableException

  • Chime.Client.exceptions.ServiceFailureException