user_settings

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

Overview

Name	user_settings
Type	Resource
Id	aws.chime.user_settings

Fields

The following fields are returned by SELECT queries:

get_user_settings

Name	Datatype	Description
telephony	object	The telephony settings associated with the user.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_user_settings	select	account_id, user_id, region		Retrieves settings for the specified user ID, such as any associated phone number settings.
update_user_settings	update	account_id, user_id, region, UserSettings		Updates the settings for the specified user, such as phone number settings.

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
account_id	string	The Amazon Chime account ID.
region	string	AWS region (default: us-east-1)
user_id	string	The user ID.

SELECT examples

get_user_settings

Retrieves settings for the specified user ID, such as any associated phone number settings.

SELECT
telephony
FROM aws.chime.user_settings
WHERE account_id = '{{ account_id }}' -- required
AND user_id = '{{ user_id }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

update_user_settings

Updates the settings for the specified user, such as phone number settings.

UPDATE aws.chime.user_settings
SET 
UserSettings = '{{ UserSettings }}'
WHERE 
account_id = '{{ account_id }}' --required
AND user_id = '{{ user_id }}' --required
AND region = '{{ region }}' --required
AND UserSettings = '{{ UserSettings }}' --required;