/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.

curl --location -g --request PATCH 'https://api.iotwireless.{region}.amazonaws.com/audit/configuration' \ --header 'Content-Type: application/json' \ --data-raw '{ "roleArn": "stringstringstringst", "auditNotificationTargetConfigurations": { "property1": { "targetArn": "string", "roleArn": "string", "enabled": true } }, "auditCheckConfigurations": { "property1": { "enabled": true } } }'

Request

Body Params application/json

roleArn

string

optional

The Amazon Resource Name (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.

>= 20 characters<= 2048 characters

auditNotificationTargetConfigurations

object

optional

Information about the targets to which audit notifications are sent.

Additional properties

object (AuditNotificationTarget)

optional

Information about the targets to which audit notifications are sent.

auditCheckConfigurations

object

optional

Specifies which audit checks are enabled and disabled for this account. Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are currently enabled.

Some data collection might start immediately when certain checks are enabled. When a check is disabled, any data collected so far in relation to the check is deleted.

You cannot disable a check if it's used by any scheduled audit. You must first delete the check from the scheduled audit or delete the scheduled audit itself.

On the first call to UpdateAccountAuditConfiguration, this parameter is required and must specify at least one enabled check.

Additional properties

object (AuditCheckConfiguration)

optional

Which audit checks are enabled and disabled for this account.

Examples

Request

Responses