account_subscriptions

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

Overview

Name	account_subscriptions
Type	Resource
Id	aws.quicksight.account_subscriptions

Fields

The following fields are returned by SELECT queries:

describe_account_subscription

Name	Datatype	Description
account_info	object	A structure that contains the following elements: Your Quick Sight account name. The edition of Quick Sight that your account is using. The notification email address that is associated with the Amazon Quick Sight account. The authentication type of the Quick Sight account. The status of the Quick Sight account's subscription.
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_subscription	select	aws_account_id, region		Use the DescribeAccountSubscription operation to receive a description of an Quick Sight account's subscription. A successful API call returns an AccountInfo object that includes an account's name, subscription status, authentication type, edition, and notification email address.
create_account_subscription	insert	aws_account_id, region, AuthenticationMethod, AccountName, NotificationEmail		Creates an Amazon Quick Sight account, or subscribes to Amazon Quick Sight Q. The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK. Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign up for Amazon Web Services in the Amazon Quick Sight User Guide. The person who signs up for Amazon Quick Sight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for Amazon Quick Sight in the Amazon Quick Sight User Guide. If your IAM policy includes both the Subscribe and CreateAccountSubscription actions, make sure that both actions are set to Allow. If either action is set to Deny, the Deny action prevails and your API call fails. You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to Amazon Quick Sight, see Passing IAM roles to Amazon Quick Sight in the Amazon Quick Sight User Guide. You can't set default resource access on the new account from the Amazon Quick Sight API. Instead, add default resource access from the Amazon Quick Sight console. For more information about setting default resource access to Amazon Web Services services, see Setting default resource access to Amazon Web Services services in the Amazon Quick Sight User Guide.
delete_account_subscription	delete	aws_account_id, region		Deleting your Quick Sight account subscription has permanent, irreversible consequences across all Amazon Web Services regions: Global deletion – Running this operation from any single region will delete your Quick Sight account and all data in every Amazon Web Services region where you have Quick Sight resources. Complete data loss – All dashboards, analyses, datasets, data sources, and custom visuals will be permanently deleted across all regions. Embedded content failure – All embedded dashboards and visuals in your applications will immediately stop working and display errors to end users. Shared resources removed – All shared dashboards, folders, and resources will become inaccessible to other users and external recipients. User access terminated – All Quick Sight users in your account will lose access immediately, including authors, readers, and administrators. No recovery possible – Once deleted, your Quick Sight account and all associated data cannot be restored. Consider exporting critical dashboards and data before proceeding with account deletion. Use the DeleteAccountSubscription operation to delete an Quick Sight account. This operation will result in an error message if you have configured your account termination protection settings to True. To change this setting and delete your account, call the UpdateAccountSettings API and set the value of the TerminationProtectionEnabled parameter to False, then make another call to the DeleteAccountSubscription API.

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 Amazon Web Services account ID of the account that you want to delete.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_account_subscription

Use the DescribeAccountSubscription operation to receive a description of an Quick Sight account's subscription. A successful API call returns an AccountInfo object that includes an account's name, subscription status, authentication type, edition, and notification email address.

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

INSERT examples

create_account_subscription

Creates an Amazon Quick Sight account, or subscribes to Amazon Quick Sight Q. The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK. Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign up for Amazon Web Services in the Amazon Quick Sight User Guide. The person who signs up for Amazon Quick Sight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for Amazon Quick Sight in the Amazon Quick Sight User Guide. If your IAM policy includes both the Subscribe and CreateAccountSubscription actions, make sure that both actions are set to Allow. If either action is set to Deny, the Deny action prevails and your API call fails. You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to Amazon Quick Sight, see Passing IAM roles to Amazon Quick Sight in the Amazon Quick Sight User Guide. You can't set default resource access on the new account from the Amazon Quick Sight API. Instead, add default resource access from the Amazon Quick Sight console. For more information about setting default resource access to Amazon Web Services services, see Setting default resource access to Amazon Web Services services in the Amazon Quick Sight User Guide.

INSERT INTO aws.quicksight.account_subscriptions (
Edition,
AuthenticationMethod,
AccountName,
NotificationEmail,
ActiveDirectoryName,
Realm,
DirectoryId,
AdminGroup,
AuthorGroup,
ReaderGroup,
AdminProGroup,
AuthorProGroup,
ReaderProGroup,
FirstName,
LastName,
EmailAddress,
ContactNumber,
IAMIdentityCenterInstanceArn,
aws_account_id,
region
)
SELECT 
'{{ Edition }}',
'{{ AuthenticationMethod }}' /* required */,
'{{ AccountName }}' /* required */,
'{{ NotificationEmail }}' /* required */,
'{{ ActiveDirectoryName }}',
'{{ Realm }}',
'{{ DirectoryId }}',
'{{ AdminGroup }}',
'{{ AuthorGroup }}',
'{{ ReaderGroup }}',
'{{ AdminProGroup }}',
'{{ AuthorProGroup }}',
'{{ ReaderProGroup }}',
'{{ FirstName }}',
'{{ LastName }}',
'{{ EmailAddress }}',
'{{ ContactNumber }}',
'{{ IAMIdentityCenterInstanceArn }}',
'{{ aws_account_id }}',
'{{ region }}'
RETURNING
request_id,
signup_response,
status
;

Manifest

# Description fields are for documentation purposes
- name: account_subscriptions
props:
  - name: aws_account_id
    value: "{{ aws_account_id }}"
    description: Required parameter for the account_subscriptions resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the account_subscriptions resource.
  - name: Edition
    value: "{{ Edition }}"
    valid_values: ['STANDARD', 'ENTERPRISE', 'ENTERPRISE_AND_Q']
  - name: AuthenticationMethod
    value: "{{ AuthenticationMethod }}"
    valid_values: ['IAM_AND_QUICKSIGHT', 'IAM_ONLY', 'ACTIVE_DIRECTORY', 'IAM_IDENTITY_CENTER']
  - name: AccountName
    value: "{{ AccountName }}"
  - name: NotificationEmail
    value: "{{ NotificationEmail }}"
  - name: ActiveDirectoryName
    value: "{{ ActiveDirectoryName }}"
  - name: Realm
    value: "{{ Realm }}"
  - name: DirectoryId
    value: "{{ DirectoryId }}"
  - name: AdminGroup
    value:
      - "{{ AdminGroup }}"
  - name: AuthorGroup
    value:
      - "{{ AuthorGroup }}"
  - name: ReaderGroup
    value:
      - "{{ ReaderGroup }}"
  - name: AdminProGroup
    value:
      - "{{ AdminProGroup }}"
  - name: AuthorProGroup
    value:
      - "{{ AuthorProGroup }}"
  - name: ReaderProGroup
    value:
      - "{{ ReaderProGroup }}"
  - name: FirstName
    value: "{{ FirstName }}"
  - name: LastName
    value: "{{ LastName }}"
  - name: EmailAddress
    value: "{{ EmailAddress }}"
  - name: ContactNumber
    value: "{{ ContactNumber }}"
  - name: IAMIdentityCenterInstanceArn
    value: "{{ IAMIdentityCenterInstanceArn }}"

DELETE examples

delete_account_subscription

Deleting your Quick Sight account subscription has permanent, irreversible consequences across all Amazon Web Services regions: Global deletion – Running this operation from any single region will delete your Quick Sight account and all data in every Amazon Web Services region where you have Quick Sight resources. Complete data loss – All dashboards, analyses, datasets, data sources, and custom visuals will be permanently deleted across all regions. Embedded content failure – All embedded dashboards and visuals in your applications will immediately stop working and display errors to end users. Shared resources removed – All shared dashboards, folders, and resources will become inaccessible to other users and external recipients. User access terminated – All Quick Sight users in your account will lose access immediately, including authors, readers, and administrators. No recovery possible – Once deleted, your Quick Sight account and all associated data cannot be restored. Consider exporting critical dashboards and data before proceeding with account deletion. Use the DeleteAccountSubscription operation to delete an Quick Sight account. This operation will result in an error message if you have configured your account termination protection settings to True. To change this setting and delete your account, call the UpdateAccountSettings API and set the value of the TerminationProtectionEnabled parameter to False, then make another call to the DeleteAccountSubscription API.

DELETE FROM aws.quicksight.account_subscriptions
WHERE aws_account_id = '{{ aws_account_id }}' --required
AND region = '{{ region }}' --required
;