phone_number_orders

Creates, updates, deletes, gets or lists a phone_number_orders resource.

Overview

Name	phone_number_orders
Type	Resource
Id	aws.chime.phone_number_orders

Fields

The following fields are returned by SELECT queries:

get_phone_number_order

Name	Datatype	Description
created_timestamp	string (date-time)	The phone number order creation time stamp, in ISO 8601 format.
ordered_phone_numbers	array	The ordered phone number details, such as the phone number in E.164 format and the phone number status.
phone_number_order_id	string	The phone number order ID. (pattern: <code>[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}</code>)
product_type	string	The phone number order product type. (BusinessCalling, VoiceConnector, SipMediaApplicationDialIn)
status	string	The status of the phone number order. (Processing, Successful, Failed, Partial)
updated_timestamp	string (date-time)	The updated phone number order time stamp, in ISO 8601 format.

list_phone_number_orders

Name	Datatype	Description
next_token	string	The token to use to retrieve the next page of results.
phone_number_orders	array	The phone number order details.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_phone_number_order	select	phone_number_order_id, region		Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.
list_phone_number_orders	select	region	next-token, max-results	Lists the phone number orders for the administrator's Amazon Chime account.
create_phone_number_order	insert	region, ProductType, E164PhoneNumbers		Creates an order for phone numbers to be provisioned. For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
phone_number_order_id	string	The ID for the phone number order.
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of results to return in a single call.
next-token	string	The token to use to retrieve the next page of results.

SELECT examples

get_phone_number_order

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

SELECT
created_timestamp,
ordered_phone_numbers,
phone_number_order_id,
product_type,
status,
updated_timestamp
FROM aws.chime.phone_number_orders
WHERE phone_number_order_id = '{{ phone_number_order_id }}' -- required
AND region = '{{ region }}' -- required
;

list_phone_number_orders

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

SELECT
next_token,
phone_number_orders
FROM aws.chime.phone_number_orders
WHERE region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `max-results` = '{{ max-results }}'
;

INSERT examples

create_phone_number_order

Creates an order for phone numbers to be provisioned. For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.

INSERT INTO aws.chime.phone_number_orders (
ProductType,
E164PhoneNumbers,
region
)
SELECT 
'{{ ProductType }}' /* required */,
'{{ E164PhoneNumbers }}' /* required */,
'{{ region }}'
RETURNING
phone_number_order
;

Manifest

# Description fields are for documentation purposes
- name: phone_number_orders
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the phone_number_orders resource.
  - name: ProductType
    value: "{{ ProductType }}"
    valid_values: ['BusinessCalling', 'VoiceConnector', 'SipMediaApplicationDialIn']
  - name: E164PhoneNumbers
    value:
      - "{{ E164PhoneNumbers }}"