IoT / Client / describe_account_audit_configuration

describe_account_audit_configuration#

IoT.Client.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.

See also: AWS API Documentation

Request Syntax

response = client.describe_account_audit_configuration()
Return type:

dict

Returns:

Response Syntax

{
    'roleArn': 'string',
    'auditNotificationTargetConfigurations': {
        'string': {
            'targetArn': 'string',
            'roleArn': 'string',
            'enabled': True|False
        }
    },
    'auditCheckConfigurations': {
        'string': {
            'enabled': True|False
        }
    }
}

Response Structure

  • (dict) –

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

    • auditNotificationTargetConfigurations (dict) –

      Information about the targets to which audit notifications are sent for this account.

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

      Which audit checks are enabled and disabled for this account.

      • (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.

Exceptions

  • IoT.Client.exceptions.ThrottlingException

  • IoT.Client.exceptions.InternalFailureException