available_phone_numbers

Creates, updates, deletes, gets or lists an available_phone_numbers resource.

Overview

Name	available_phone_numbers
Type	Resource
Id	aws.chime_sdk_voice.available_phone_numbers

Fields

The following fields are returned by SELECT queries:

search_available_phone_numbers

Name	Datatype	Description
e164_phone_number	string	Confines a search to just the phone numbers in the E.164 format.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
search_available_phone_numbers	select	region	area-code, city, country, state, toll-free-prefix, phone-number-type, max-results, next-token	Searches the provisioned phone numbers in an organization.

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
region	string	AWS region (default: us-east-1)
area-code	string	Confines a search to just the phone numbers associated with the specified area code.
city	string	Confines a search to just the phone numbers associated with the specified city.
country	string	Confines a search to just the phone numbers associated with the specified country.
max-results	integer	The maximum number of results to return.
next-token	string	The token used to return the next page of results.
phone-number-type	string	Confines a search to just the phone numbers associated with the specified phone number type, either local or toll-free.
state	string	Confines a search to just the phone numbers associated with the specified state.
toll-free-prefix	string	Confines a search to just the phone numbers associated with the specified toll-free prefix.

SELECT examples

search_available_phone_numbers

Searches the provisioned phone numbers in an organization.

SELECT
e164_phone_number
FROM aws.chime_sdk_voice.available_phone_numbers
WHERE region = '{{ region }}' -- required
AND `area-code` = '{{ area-code }}'
AND city = '{{ city }}'
AND country = '{{ country }}'
AND state = '{{ state }}'
AND `toll-free-prefix` = '{{ toll-free-prefix }}'
AND `phone-number-type` = '{{ phone-number-type }}'
AND `max-results` = '{{ max-results }}'
AND `next-token` = '{{ next-token }}'
;