get_phone_number_order

get_phone_number_order(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.get_phone_number_order(
    PhoneNumberOrderId='string'
)
Parameters
PhoneNumberOrderId (string) -- [REQUIRED]
Return type
dict
Returns
Response Syntax
{
    'PhoneNumberOrder': {
        '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)
    }
}

Response Structure

  • (dict) --
    • PhoneNumberOrder (dict) --
      • PhoneNumberOrderId (string) --
      • ProductType (string) --
      • Status (string) --
      • OrderType (string) --
      • OrderedPhoneNumbers (list) --
        • (dict) --
          • E164PhoneNumber (string) --
          • Status (string) --
      • CreatedTimestamp (datetime) --
      • UpdatedTimestamp (datetime) --

Exceptions

  • ChimeSDKVoice.Client.exceptions.UnauthorizedClientException
  • ChimeSDKVoice.Client.exceptions.NotFoundException
  • ChimeSDKVoice.Client.exceptions.ForbiddenException
  • ChimeSDKVoice.Client.exceptions.BadRequestException
  • ChimeSDKVoice.Client.exceptions.ThrottledClientException
  • ChimeSDKVoice.Client.exceptions.ServiceUnavailableException
  • ChimeSDKVoice.Client.exceptions.ServiceFailureException