/audit/configuration

The AWS IoT Wireless multi-region endpoint

https://api.iotwireless.{region}.amazonaws.com

GET

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 Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://api.iotwireless.{region}.amazonaws.com/audit/configuration'

Response Example

200 - Example 1

{
    "roleArn": "string",
    "auditNotificationTargetConfigurations": {
        "property1": {
            "targetArn": "string",
            "roleArn": "string",
            "enabled": true
        }
    },
    "auditCheckConfigurations": {
        "property1": {
            "enabled": true
        }
    }
}

Request

None

Responses

🟢200Success

application/json

Body

roleArn

string

optional

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.

>= 20 characters<= 2048 characters

auditNotificationTargetConfigurations

object

optional

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

auditCheckConfigurations

object

optional

Which audit checks are enabled and disabled for this account.

🟠480ThrottlingException

🟠481InternalFailureException

Modified at 2022-09-10 23:12:15

/audit/configuration