account_audit_configurations

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

Overview

Name	account_audit_configurations
Type	Resource
Id	aws.iot.account_audit_configurations

Fields

The following fields are returned by SELECT queries:

describe_account_audit_configuration

Name	Datatype	Description
audit_check_configurations	object	Which audit checks are enabled and disabled for this account.
audit_notification_target_configurations	object	Information about the targets to which audit notifications are sent for this account.
role_arn	string	The ARN of the role that grants permission to IoT to access information about your devices, policies, certificates, and other items as required when performing an audit. On the first call to UpdateAccountAuditConfiguration, this parameter is required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_account_audit_configuration	select	region		Gets information about the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled. Requires permission to access the DescribeAccountAuditConfiguration action.
update_account_audit_configuration	update	region		Configures or reconfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled. Requires permission to access the UpdateAccountAuditConfiguration action.
delete_account_audit_configuration	delete	region	deleteScheduledAudits	Restores the default settings for Device Defender audits for this account. Any configuration data you entered is deleted and all audit checks are reset to disabled. Requires permission to access the DeleteAccountAuditConfiguration action.

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)
deleteScheduledAudits	boolean	If true, all scheduled audits are deleted.

SELECT examples

describe_account_audit_configuration

Gets information about the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled. Requires permission to access the DescribeAccountAuditConfiguration action.

SELECT
audit_check_configurations,
audit_notification_target_configurations,
role_arn
FROM aws.iot.account_audit_configurations
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_account_audit_configuration

Configures or reconfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled. Requires permission to access the UpdateAccountAuditConfiguration action.

UPDATE aws.iot.account_audit_configurations
SET 
roleArn = '{{ roleArn }}',
auditNotificationTargetConfigurations = '{{ auditNotificationTargetConfigurations }}',
auditCheckConfigurations = '{{ auditCheckConfigurations }}'
WHERE 
region = '{{ region }}' --required;

DELETE examples

delete_account_audit_configuration

Restores the default settings for Device Defender audits for this account. Any configuration data you entered is deleted and all audit checks are reset to disabled. Requires permission to access the DeleteAccountAuditConfiguration action.

DELETE FROM aws.iot.account_audit_configurations
WHERE region = '{{ region }}' --required
AND deleteScheduledAudits = '{{ deleteScheduledAudits }}'
;