phone_number_settings

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

Overview

Name	phone_number_settings
Type	Resource
Id	aws.chime_sdk_voice.phone_number_settings

Fields

The following fields are returned by SELECT queries:

get_phone_number_settings

Name	Datatype	Description
calling_name	string	The default outbound calling name for the account. (pattern: <code>^$|^[a-zA-Z0-9 ]{2,15}$</code>)
calling_name_updated_timestamp	string (date-time)	The updated outbound calling name timestamp, in ISO 8601 format.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_phone_number_settings	select	region		Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
update_phone_number_settings	update	region, CallingName		Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update.

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)

SELECT examples

get_phone_number_settings

Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.

SELECT
calling_name,
calling_name_updated_timestamp
FROM aws.chime_sdk_voice.phone_number_settings
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_phone_number_settings

Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update.

UPDATE aws.chime_sdk_voice.phone_number_settings
SET 
CallingName = '{{ CallingName }}'
WHERE 
region = '{{ region }}' --required
AND CallingName = '{{ CallingName }}' --required;