account_settings

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

Overview

Name	account_settings
Type	Resource
Id	aws.quicksight.account_settings

Fields

The following fields are returned by SELECT queries:

describe_account_settings

Name	Datatype	Description
account_settings	object	The Amazon Quick Sight settings for this Amazon Web Services account. This information includes the edition of Amazon Quick Sight that you subscribed to (Standard or Enterprise) and the notification email for the Amazon Quick Sight subscription. In the Quick Sight console, the Amazon Quick Sight subscription is sometimes referred to as a Quick Sight "account" even though it's technically not an account by itself. Instead, it's a subscription to the Amazon Quick Sight service for your Amazon Web Services account. The edition that you subscribe to applies to Quick in every Amazon Web Services Region where you use it.
request_id	string	The Amazon Web Services request ID for this operation.
status	integer	The HTTP status of the request.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_account_settings	select	aws_account_id, region		Describes the settings that were used when your Quick Sight subscription was first created in this Amazon Web Services account.
update_account_settings	update	aws_account_id, region, DefaultNamespace		Updates the Amazon Quick Sight settings in your Amazon Web Services account.

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
aws_account_id	string	The ID for the Amazon Web Services account that contains the Quick Sight settings that you want to list.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_account_settings

Describes the settings that were used when your Quick Sight subscription was first created in this Amazon Web Services account.

SELECT
account_settings,
request_id,
status
FROM aws.quicksight.account_settings
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

update_account_settings

Updates the Amazon Quick Sight settings in your Amazon Web Services account.

UPDATE aws.quicksight.account_settings
SET 
DefaultNamespace = '{{ DefaultNamespace }}',
NotificationEmail = '{{ NotificationEmail }}',
TerminationProtectionEnabled = {{ TerminationProtectionEnabled }}
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND region = '{{ region }}' --required
AND DefaultNamespace = '{{ DefaultNamespace }}' --required
RETURNING
request_id,
status;