ChimeSDKVoice / Client / list_phone_number_orders

list_phone_number_orders#

ChimeSDKVoice.Client.list_phone_number_orders(**kwargs)#

See also: AWS API Documentation

Request Syntax

response = client.list_phone_number_orders(
    NextToken='string',
    MaxResults=123
)
Parameters:
  • NextToken (string) –

  • MaxResults (integer) –

Return type:

dict

Returns:

Response Syntax

{
    'PhoneNumberOrders': [
        {
            'PhoneNumberOrderId': 'string',
            'ProductType': 'VoiceConnector'|'SipMediaApplicationDialIn',
            'Status': 'Processing'|'Successful'|'Failed'|'Partial'|'PendingDocuments'|'Submitted'|'FOC'|'ChangeRequested'|'Exception'|'CancelRequested'|'Cancelled',
            'OrderType': 'New'|'Porting',
            'OrderedPhoneNumbers': [
                {
                    'E164PhoneNumber': 'string',
                    'Status': 'Processing'|'Acquired'|'Failed'
                },
            ],
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • PhoneNumberOrders (list) –

      • (dict) –

        • PhoneNumberOrderId (string) –

        • ProductType (string) –

        • Status (string) –

        • OrderType (string) –

        • OrderedPhoneNumbers (list) –

          • (dict) –

            • E164PhoneNumber (string) –

            • Status (string) –

        • CreatedTimestamp (datetime) –

        • UpdatedTimestamp (datetime) –

    • NextToken (string) –

Exceptions

  • ChimeSDKVoice.Client.exceptions.UnauthorizedClientException

  • ChimeSDKVoice.Client.exceptions.ForbiddenException

  • ChimeSDKVoice.Client.exceptions.BadRequestException

  • ChimeSDKVoice.Client.exceptions.ThrottledClientException

  • ChimeSDKVoice.Client.exceptions.ServiceUnavailableException

  • ChimeSDKVoice.Client.exceptions.ServiceFailureException