Skip to main content

account_settings

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

Overview

Nameaccount_settings
TypeResource
Idaws.chime.account_settings

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
disable_remote_controlbooleanSetting that stops or starts remote control of shared screens during meetings.
enable_dial_outbooleanSetting that allows meeting participants to choose the Call me at a phone number option. For more information, see Join a Meeting without the Amazon Chime App.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_account_settingsselectaccount_id, regionRetrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
update_account_settingsupdateaccount_id, region, AccountSettingsUpdates the settings for the specified Amazon Chime account. You can update settings for remote control of shared screens, or for the dial-out option. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.

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.

NameDatatypeDescription
account_idstringThe Amazon Chime account ID.
regionstringAWS region (default: us-east-1)

SELECT examples

Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.

SELECT
disable_remote_control,
enable_dial_out
FROM aws.chime.account_settings
WHERE account_id = '{{ account_id }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

Updates the settings for the specified Amazon Chime account. You can update settings for remote control of shared screens, or for the dial-out option. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.

UPDATE aws.chime.account_settings
SET
AccountSettings = '{{ AccountSettings }}'
WHERE
account_id = '{{ account_id }}' --required
AND region = '{{ region }}' --required
AND AccountSettings = '{{ AccountSettings }}' --required;