IoT / Client / update_account_audit_configuration

update_account_audit_configuration#

IoT.Client.update_account_audit_configuration(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.update_account_audit_configuration(
    roleArn='string',
    auditNotificationTargetConfigurations={
        'string': {
            'targetArn': 'string',
            'roleArn': 'string',
            'enabled': True|False
        }
    },
    auditCheckConfigurations={
        'string': {
            'enabled': True|False
        }
    }
)
Parameters:

  • roleArn (string) – 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.

  • auditNotificationTargetConfigurations (dict) –

    Information about the targets to which audit notifications are sent.

    • (string) –

      • (dict) –

        Information about the targets to which audit notifications are sent.

        • targetArn (string) –

          The ARN of the target (SNS topic) to which audit notifications are sent.

        • roleArn (string) –

          The ARN of the role that grants permission to send notifications to the target.

        • enabled (boolean) –

          True if notifications to the target are enabled.

  • auditCheckConfigurations (dict) –

    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.

    • (string) –

      An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

      • (dict) –

        Which audit checks are enabled and disabled for this account.

        • enabled (boolean) –

          True if this audit check is enabled for this account.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • IoT.Client.exceptions.InvalidRequestException

  • IoT.Client.exceptions.ThrottlingException

  • IoT.Client.exceptions.InternalFailureException