DescribeAccountAuditConfigurationCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { IoTClient, DescribeAccountAuditConfigurationCommand } from "@aws-sdk/client-iot"; // ES Modules import
// const { IoTClient, DescribeAccountAuditConfigurationCommand } = require("@aws-sdk/client-iot"); // CommonJS import
const client = new IoTClient(config);
const input = {};
const command = new DescribeAccountAuditConfigurationCommand(input);
const response = await client.send(command);
// { // DescribeAccountAuditConfigurationResponse
//   roleArn: "STRING_VALUE",
//   auditNotificationTargetConfigurations: { // AuditNotificationTargetConfigurations
//     "<keys>": { // AuditNotificationTarget
//       targetArn: "STRING_VALUE",
//       roleArn: "STRING_VALUE",
//       enabled: true || false,
//     },
//   },
//   auditCheckConfigurations: { // AuditCheckConfigurations
//     "<keys>": { // AuditCheckConfiguration
//       enabled: true || false,
//       configuration: { // CheckCustomConfiguration
//         "<keys>": "STRING_VALUE",
//       },
//     },
//   },
// };

DescribeAccountAuditConfigurationCommand Input

See DescribeAccountAuditConfigurationCommandInput for more details
DescribeAccountAuditConfigurationCommandInput extends DescribeAccountAuditConfigurationRequest

DescribeAccountAuditConfigurationCommand Output

See DescribeAccountAuditConfigurationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
auditCheckConfigurations
Record<string, AuditCheckConfiguration> | undefined

Which audit checks are enabled and disabled for this account.

auditNotificationTargetConfigurations
Partial<Record<AuditNotificationType, AuditNotificationTarget> | undefined

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

roleArn
string | undefined

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.

Throws

Name
Fault
Details
InternalFailureException
server

An unexpected error has occurred.

ThrottlingException
client

The rate exceeds the limit.

IoTServiceException
Base exception class for all service exceptions from IoT service.