DescribeAccountAuditConfiguration
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.
Request Syntax
GET /audit/configuration HTTP/1.1
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"auditCheckConfigurations": {
"string" : {
"enabled": boolean
}
},
"auditNotificationTargetConfigurations": {
"string" : {
"enabled": boolean,
"roleArn": "string",
"targetArn": "string"
}
},
"roleArn": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- auditCheckConfigurations
-
Which audit checks are enabled and disabled for this account.
Type: String to AuditCheckConfiguration object map
- auditNotificationTargetConfigurations
-
Information about the targets to which audit notifications are sent for this account.
Type: String to AuditNotificationTarget object map
Valid Keys:
SNS - roleArn
-
The ARN of the role that grants permission to Amazon 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.Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Errors
- InternalFailureException
-
An unexpected error has occurred.
HTTP Status Code: 500
- ThrottlingException
-
The rate exceeds the limit.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: