accounts

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

Overview

Name	accounts
Type	Resource
Id	aws.auditmanager.accounts

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
register_account	insert	region		Enables Audit Manager for the specified Amazon Web Services account.
deregister_account	delete	region		Deregisters an account in Audit Manager. Before you deregister, you can use the UpdateSettings API operation to set your preferred data retention policy. By default, Audit Manager retains your data. If you want to delete your data, you can use the DeregistrationPolicy attribute to request the deletion of your data. For more information about data retention, see Data Protection in the Audit Manager User 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.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

INSERT examples

register_account

Enables Audit Manager for the specified Amazon Web Services account.

INSERT INTO aws.auditmanager.accounts (
kmsKey,
delegatedAdminAccount,
region
)
SELECT 
'{{ kmsKey }}',
'{{ delegatedAdminAccount }}',
'{{ region }}'
RETURNING
status
;

Manifest

# Description fields are for documentation purposes
- name: accounts
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the accounts resource.
  - name: kmsKey
    value: "{{ kmsKey }}"
  - name: delegatedAdminAccount
    value: "{{ delegatedAdminAccount }}"

DELETE examples

deregister_account

Deregisters an account in Audit Manager. Before you deregister, you can use the UpdateSettings API operation to set your preferred data retention policy. By default, Audit Manager retains your data. If you want to delete your data, you can use the DeregistrationPolicy attribute to request the deletion of your data. For more information about data retention, see Data Protection in the Audit Manager User Guide.

DELETE FROM aws.auditmanager.accounts
WHERE region = '{{ region }}' --required
;