# 审核命令
<a name="AuditCommands"></a>

## 管理审核设置
<a name="AuditCommandsManageSettings"></a>

使用`UpdateAccountAuditConfiguration` 为账户配置审核设置。通过此命令，您可以启用希望用于审核、设置可选通知及配置权限的检查。

使用 `DescribeAccountAuditConfiguration` 检查这些设置。

使用 `DeleteAccountAuditConfiguration` 删除审核设置。这会还原所有默认值，并有效地禁用审核，因为所有检查默认处于禁用状态。

### UpdateAccountAuditConfiguration
<a name="dd-api-iot-UpdateAccountAuditConfiguration"></a>

针对此账户配置或重新配置 Device Defender 审核设置。设置包括审核通知的发送方式以及启用或禁用的审核检查类型。

 **摘要**

```
aws iot  update-account-audit-configuration \
    [--role-arn <value>] \
    [--audit-notification-target-configurations <value>] \
    [--audit-check-configurations <value>]  \
    [--cli-input-json <value>] \
    [--generate-cli-skeleton]
```

 `cli-input-json` 格式

```
{
  "roleArn": "string",
  "auditNotificationTargetConfigurations": {
    "string": {
      "targetArn": "string",
      "roleArn": "string",
      "enabled": "boolean"
    }
  },
  "auditCheckConfigurations": {
    "string": {
      "enabled": "boolean"
    }
  }
}
```


**`cli-input-json` 字段**  

|  名称 |  类型 |  说明 | 
| --- | --- | --- | 
| roleArn | 字符串<br /> 最大长度：2048，最小长度：20 | 角色的 ARN，该角色授权 AWS IoT 在执行审核时访问设备、策略、证书及其它项相关信息。 | 
| auditNotificationTargetConfigurations | 映射 | 审核通知要发送到的目标的相关信息。 | 
| targetArn | 字符串 | 审核通知要发送到的目标（SNS 主题）的 ARN。 | 
| roleArn | 字符串<br /> 最大长度：2048，最小长度：20 | 可授权向目标发送通知的角色的 ARN。 | 
| 已启用 | 布尔值 | 如果已启用向目标发送通知，则为 true。 | 
| auditCheckConfigurations | 映射 | 为此账户指定要启用和禁用的审核检查。使用 `DescribeAccountAuditConfiguration` 查看所有检查的列表，包括当前已启用的检查。<br />某些检查在启用后，可能会立即启动某些数据收集。如果禁用某项检查，则将删除迄今为止收集的与该检查有关的所有数据。<br />任何计划审核所使用的检查无法禁用。必须先从计划审核中删除检查，或删除计划审核自身。<br />第一次调用 `UpdateAccountAuditConfiguration` 时，必须提供此参数，且必须至少指定一个已启用的检查。 | 
| 已启用 | 布尔值 | 如果已为此账户启用审核检查，则为 true。 | 
| 配置 | 映射 | （可选）特定审计检查的自定义配置，例如 `CERT_AGE_THRESHOLD_IN_DAYS` 和 `CERT_EXPIRATION_THRESHOLD_IN_DAYS`，可让您定义想何时收到有关证书期限和即将到期的提醒。 | 

Output

无

 **错误**

`InvalidRequestException`  
请求的内容无效。

`ThrottlingException`  
速率超过限制。

`InternalFailureException`  
出现意外错误。

### DescribeAccountAuditConfiguration
<a name="dd-api-iot-DescribeAccountAuditConfiguration"></a>

获取此账户的 Device Defender 审核设置信息。设置包括审核通知的发送方式以及启用或禁用的审核检查类型。

 **摘要**

```
aws iot  describe-account-audit-configuration  \
    [--cli-input-json <value>] \
    [--generate-cli-skeleton]
```

 `cli-input-json` 格式

```
{
}
```

Output

```
{
  "roleArn": "string",
  "auditNotificationTargetConfigurations": {
    "string": {
      "targetArn": "string",
      "roleArn": "string",
      "enabled": "boolean"
    }
  },
  "auditCheckConfigurations": {
    "string": {
      "enabled": "boolean"
    }
  }
}
```


**CLI 输出字段**  

|  名称 |  类型 |  说明 | 
| --- | --- | --- | 
| roleArn | 字符串<br /> 最大长度：2048，最小长度：20 | 角色的 ARN，该角色授权 AWS IoT 在执行审核时访问设备、策略、证书及其它项相关信息。<br />第一次调用 `UpdateAccountAuditConfiguration` 时，必须提供此参数。 | 
| auditNotificationTargetConfigurations | 映射 | 有关此账户的审核通知要发送到的目标的相关信息。 | 
| targetArn | 字符串 | 审核通知要发送到的目标（SNS 主题）的 ARN。 | 
| roleArn | 字符串<br /> 最大长度：2048，最小长度：20 | 可授权向目标发送通知的角色的 ARN。 | 
| 已启用 | 布尔值 | 如果已启用向目标发送通知，则为 true。 | 
| auditCheckConfigurations | 映射 | 针对此账户启用和禁用的审核检查。 | 
| 已启用 | 布尔值 | 如果已为此账户启用审核检查，则为 true。 | 
| 配置 | 映射 | （可选）为某些审计检查提供特定配置，例如证书支持的最大期限或应触发提醒的到期前天数。 | 

 **错误**

`ThrottlingException`  
速率超过限制。

`InternalFailureException`  
出现意外错误。

### DeleteAccountAuditConfiguration
<a name="dd-api-iot-DeleteAccountAuditConfiguration"></a>

还原此账户的默认 Device Defender 审核设置。您输入的所有配置数据将被删除，所有审计检查均重置为已禁用。

 **摘要**

```
aws iot  delete-account-audit-configuration \
    [--delete-scheduled-audits | --no-delete-scheduled-audits]  \
    [--cli-input-json <value>] \
    [--generate-cli-skeleton]
```

 `cli-input-json` 格式

```
{
  "deleteScheduledAudits": "boolean"
}
```


**`cli-input-json` 字段**  

|  名称 |  类型 |  说明 | 
| --- | --- | --- | 
| deleteScheduledAudits | 布尔值 | 如果为 True，则所有计划审核都将被删除。 | 

Output

无

 **错误**

`InvalidRequestException`  
请求的内容无效。

`ResourceNotFoundException`  
指定的资源不存在。

`ThrottlingException`  
速率超过限制。

`InternalFailureException`  
出现意外错误。

## 计划审核
<a name="device-defender-AuditCommandsManageSchedules"></a>

使用 `CreateScheduledAudit` 创建一个或多个计划审核。通过此命令，您可以指定在审核期间要执行的检查以及审核应该运行的频率。

使用 `ListScheduledAudits` 和 `DescribeScheduledAudit` 跟踪计划审核。

使用 `UpdateScheduledAudit` 更改现有的计划审核，或使用 `DeleteScheduledAudit` 将其删除。

### CreateScheduledAudit
<a name="dd-api-iot-CreateScheduledAudit"></a>

创建计划审核，使之按指定的时间间隔运行。

 **摘要**

```
aws iot  create-scheduled-audit \
    --frequency <value> \
    [--day-of-month <value>] \
    [--day-of-week <value>] \
    --target-check-names <value> \
    [--tags <value>] \
    --scheduled-audit-name <value>  \
    [--cli-input-json <value>] \
    [--generate-cli-skeleton]
```

 `cli-input-json` 格式

```
{
  "frequency": "string",
  "dayOfMonth": "string",
  "dayOfWeek": "string",
  "targetCheckNames": [
    "string"
  ],
  "tags": [
    {
      "Key": "string",
      "Value": "string"
    }
  ],
  "scheduledAuditName": "string"
}
```


**`cli-input-json` 字段**  

|  名称 |  类型 |  说明 | 
| --- | --- | --- | 
| frequency | 字符串 | 计划审核的运行频率。可以是以下任一值：“DAILY”、“WEEKLY”、“BIWEEKLY”或“MONTHLY”。每个审核的实际开始时间取决于系统。<br /> 枚举：DAILY \| WEEKLY \| BIWEEKLY \| MONTHLY | 
| dayOfMonth | 字符串<br /> 模式：^([1-9]\|[12][0-9]\|3[01])$\|^LAST$ | 运行计划审核当月的具体日期。可以是“1”到“31”的任意值或“LAST”。如果 `frequency` 参数设置为“MONTHLY”，则此字段为必填字段。如果指定第 29-31 日，但当月没有那么多天，那么系统会在当月的最后一天运行审核。 | 
| dayOfWeek | 字符串 | 运行计划审核当周的具体日期。可以是以下任一值：“SUN”、“MON”、“TUE”、“WED”、“THU”、“FRI”或“SAT”。如果 `frequency` 参数段设置为“WEEKLY”或“BIWEEKLY”，则此字段为必填字段。<br /> 枚举：SUN \| MON \| TUE \| WED \| THU \| FRI \| SAT | 
| targetCheckNames | 列表<br /> 成员：AuditCheckName | 计划审核期间执行的检查。账户必须已启用检查。（使用 `DescribeAccountAuditConfiguration` 查看所有检查的列表，包括已启用的检查，或使用 `UpdateAccountAuditConfiguration` 选择启用的检查。） | 
| 标签 | 列表<br /> 成员：Tag<br /> java 类：java.util.List | 可用于管理计划审核的元数据。 | 
| Key | 字符串 | 标签的键。 | 
| 值 | 字符串 | 标签的值。 | 
| scheduledAuditName | 字符串<br /> 最大长度：128，最小长度：1<br /> 模式：[a-zA-Z0-9\_-]\+ | 要为计划审核指定的名称。（最多 128 个字符） | 

Output

```
{
  "scheduledAuditArn": "string"
}
```


**CLI 输出字段**  

|  名称 |  类型 |  说明 | 
| --- | --- | --- | 
| scheduledAuditArn | 字符串 | 计划审核的 ARN。 | 

 **错误**

`InvalidRequestException`  
请求的内容无效。

`ThrottlingException`  
速率超过限制。

`InternalFailureException`  
出现意外错误。

`LimitExceededException`  
已超出限制。

### ListScheduledAudits
<a name="dd-api-iot-ListScheduledAudits"></a>

列出所有计划审核。

 **摘要**

```
aws iot  list-scheduled-audits \
    [--next-token <value>] \
    [--max-results <value>]  \
    [--cli-input-json <value>] \
    [--generate-cli-skeleton]
```

 `cli-input-json` 格式

```
{
  "nextToken": "string",
  "maxResults": "integer"
}
```


**`cli-input-json` 字段**  

|  名称 |  类型 |  说明 | 
| --- | --- | --- | 
| nextToken | 字符串 | 用于获取下一组结果的令牌。 | 
| maxResults | 整数<br /> 范围 - 最大值：250，最小值：1 | 一次性返回的最大结果数。默认值为 25。 | 

Output

```
{
  "scheduledAudits": [
    {
      "scheduledAuditName": "string",
      "scheduledAuditArn": "string",
      "frequency": "string",
      "dayOfMonth": "string",
      "dayOfWeek": "string"
    }
  ],
  "nextToken": "string"
}
```


**CLI 输出字段**  

|  名称 |  类型 |  说明 | 
| --- | --- | --- | 
| scheduledAudits | 列表<br /> 成员：ScheduledAuditMetadata<br /> java 类：java.util.List | 计划审核的列表。 | 
| scheduledAuditName | 字符串<br /> 最大长度：128，最小长度：1<br /> 模式：[a-zA-Z0-9\_-]\+ | 计划审核的名称。 | 
| scheduledAuditArn | 字符串 | 计划审核的 ARN。 | 
| frequency | 字符串 | 计划审核的运行频率。<br /> 枚举：DAILY \| WEEKLY \| BIWEEKLY \| MONTHLY | 
| dayOfMonth | 字符串<br /> 模式：^([1-9]\|[12][0-9]\|3[01])$\|^LAST$ | 运行计划审核当月的具体日期（如果 `frequency` 为“MONTHLY”）。如果指定第 29-31 日，但当月没有那么多天，那么系统会在当月的最后一天运行审核。 | 
| dayOfWeek | 字符串 | 运行计划审核当周的具体日期（如果 `frequency` 为“WEEKLY”或“BIWEEKLY”）。<br /> 枚举：SUN \| MON \| TUE \| WED \| THU \| FRI \| SAT | 
| nextToken | 字符串 | 用于检索下一组结果的令牌，没有更多结果时为 `null`。 | 

 **错误**

`InvalidRequestException`  
请求的内容无效。

`ThrottlingException`  
速率超过限制。

`InternalFailureException`  
出现意外错误。

### DescribeScheduledAudit
<a name="dd-api-iot-DescribeScheduledAudit"></a>

获取有关计划审核的信息。

 **摘要**

```
aws iot  describe-scheduled-audit \
    --scheduled-audit-name <value>  \
    [--cli-input-json <value>] \
    [--generate-cli-skeleton]
```

 `cli-input-json` 格式

```
{
  "scheduledAuditName": "string"
}
```


**`cli-input-json` 字段**  

|  名称 |  类型 |  说明 | 
| --- | --- | --- | 
| scheduledAuditName | 字符串<br /> 最大长度：128，最小长度：1<br /> 模式：[a-zA-Z0-9\_-]\+ | 要获取其信息的计划审核的名称。 | 

Output

```
{
  "frequency": "string",
  "dayOfMonth": "string",
  "dayOfWeek": "string",
  "targetCheckNames": [
    "string"
  ],
  "scheduledAuditName": "string",
  "scheduledAuditArn": "string"
}
```


**CLI 输出字段**  

|  名称 |  类型 |  说明 | 
| --- | --- | --- | 
| frequency | 字符串 | 计划审核的运行频率。可以是以下任一值：“DAILY”、“WEEKLY”、“BIWEEKLY”或“MONTHLY”。每个审核的实际开始时间取决于系统。<br /> 枚举：DAILY \| WEEKLY \| BIWEEKLY \| MONTHLY | 
| dayOfMonth | 字符串<br /> 模式：^([1-9]\|[12][0-9]\|3[01])$\|^LAST$ | 运行计划审核当月的具体日期。可以是“1”到“31”的任意值或“LAST”。如果指定第 29-31 日，但当月没有那么多天，那么系统会在当月的最后一天运行审核。 | 
| dayOfWeek | 字符串 | 运行计划审核当周的具体日期。可以是以下任一值：“SUN”、“MON”、“TUE”、“WED”、“THU”、“FRI”或“SAT”。<br /> 枚举：SUN \| MON \| TUE \| WED \| THU \| FRI \| SAT | 
| targetCheckNames | 列表<br /> 成员：AuditCheckName | 计划审核期间执行的检查。账户必须已启用检查。（使用 `DescribeAccountAuditConfiguration` 查看所有检查的列表，包括已启用的检查，或使用 `UpdateAccountAuditConfiguration` 选择启用的检查。） | 
| scheduledAuditName | 字符串<br /> 最大长度：128，最小长度：1<br /> 模式：[a-zA-Z0-9\_-]\+ | 计划审核的名称。 | 
| scheduledAuditArn | 字符串 | 计划审核的 ARN。 | 

 **错误**

`InvalidRequestException`  
请求的内容无效。

`ResourceNotFoundException`  
指定的资源不存在。

`ThrottlingException`  
速率超过限制。

`InternalFailureException`  
出现意外错误。

### UpdateScheduledAudit
<a name="dd-api-iot-UpdateScheduledAudit"></a>

更新计划审核，包括执行的检查和审核执行的频率。

 **摘要**

```
aws iot  update-scheduled-audit \
    [--frequency <value>] \
    [--day-of-month <value>] \
    [--day-of-week <value>] \
    [--target-check-names <value>] \
    --scheduled-audit-name <value>  \
    [--cli-input-json <value>] \
    [--generate-cli-skeleton]
```

 `cli-input-json` 格式

```
{
  "frequency": "string",
  "dayOfMonth": "string",
  "dayOfWeek": "string",
  "targetCheckNames": [
    "string"
  ],
  "scheduledAuditName": "string"
}
```


**`cli-input-json` 字段**  

|  名称 |  类型 |  说明 | 
| --- | --- | --- | 
| frequency | 字符串 | 计划审核的运行频率。可以是以下任一值：“DAILY”、“WEEKLY”、“BIWEEKLY”或“MONTHLY”。每个审核的实际开始时间取决于系统。<br /> 枚举：DAILY \| WEEKLY \| BIWEEKLY \| MONTHLY | 
| dayOfMonth | 字符串<br /> 模式：^([1-9]\|[12][0-9]\|3[01])$\|^LAST$ | 运行计划审核当月的具体日期。可以是“1”到“31”的任意值或“LAST”。如果 `frequency` 参数设置为“MONTHLY”，则此字段为必填字段。如果指定第 29-31 日，但当月没有那么多天，那么系统会在当月的最后一天运行审核。 | 
| dayOfWeek | 字符串 | 运行计划审核当周的具体日期。可以是以下任一值：“SUN”、“MON”、“TUE”、“WED”、“THU”、“FRI”或“SAT”。如果 `frequency` 参数段设置为“WEEKLY”或“BIWEEKLY”，则此字段为必填字段。<br /> 枚举：SUN \| MON \| TUE \| WED \| THU \| FRI \| SAT | 
| targetCheckNames | 列表<br /> 成员：AuditCheckName | 计划审核期间执行的检查。账户必须已启用检查。（使用 `DescribeAccountAuditConfiguration` 查看所有检查的列表，包括已启用的检查，或使用 `UpdateAccountAuditConfiguration` 选择启用的检查。） | 
| scheduledAuditName | 字符串<br /> 最大长度：128，最小长度：1<br /> 模式：[a-zA-Z0-9\_-]\+ | 计划审核的名称。（最多 128 个字符） | 

Output

```
{
  "scheduledAuditArn": "string"
}
```


**CLI 输出字段**  

|  名称 |  类型 |  说明 | 
| --- | --- | --- | 
| scheduledAuditArn | 字符串 | 计划审核的 ARN。 | 

 **错误**

`InvalidRequestException`  
请求的内容无效。

`ResourceNotFoundException`  
指定的资源不存在。

`ThrottlingException`  
速率超过限制。

`InternalFailureException`  
出现意外错误。

### DeleteScheduledAudit
<a name="dd-api-iot-DeleteScheduledAudit"></a>

删除计划审核。

 **摘要**

```
aws iot  delete-scheduled-audit \
    --scheduled-audit-name <value>  \
    [--cli-input-json <value>] \
    [--generate-cli-skeleton]
```

 `cli-input-json` 格式

```
{
  "scheduledAuditName": "string"
}
```


**`cli-input-json` 字段**  

|  名称 |  类型 |  说明 | 
| --- | --- | --- | 
| scheduledAuditName | 字符串<br /> 最大长度：128，最小长度：1<br /> 模式：[a-zA-Z0-9\_-]\+ | 要删除的计划审核的名称。 | 

Output

无

 **错误**

`InvalidRequestException`  
请求的内容无效。

`ResourceNotFoundException`  
指定的资源不存在。

`ThrottlingException`  
速率超过限制。

`InternalFailureException`  
出现意外错误。

## 运行按需审核
<a name="device-defender-AuditCommandsOnDemand"></a>

使用 `StartOnDemandAuditTask` 指定要执行的检查并立即开始运行审核。

### StartOnDemandAuditTask
<a name="dd-api-iot-StartOnDemandAuditTask"></a>

启动按需 Device Defender 审核。

 **摘要**

```
aws iot  start-on-demand-audit-task \
    --target-check-names <value>  \
    [--cli-input-json <value>] \
    [--generate-cli-skeleton]
```

 `cli-input-json` 格式

```
{
  "targetCheckNames": [
    "string"
  ]
}
```


**`cli-input-json` 字段**  

|  名称 |  类型 |  说明 | 
| --- | --- | --- | 
| targetCheckNames | 列表<br /> 成员：AuditCheckName | 在审核过程中执行的检查。必须为账户启用指定的检查，否则会出现异常。（使用 `DescribeAccountAuditConfiguration` 查看所有检查的列表，包括已启用的检查，或使用 `UpdateAccountAuditConfiguration` 选择启用的检查。） | 

Output

```
{
  "taskId": "string"
}
```


**CLI 输出字段**  

|  名称 |  类型 |  说明 | 
| --- | --- | --- | 
| taskId | 字符串<br /> 最大长度：40，最小长度：1<br /> 模式：[a-zA-Z0-9-]\+ | 启动的按需审核的 ID。 | 

 **错误**

`InvalidRequestException`  
请求的内容无效。

`ThrottlingException`  
速率超过限制。

`InternalFailureException`  
出现意外错误。

`LimitExceededException`  
已超出限制。

## 管理审核实例
<a name="device-defender-AuditCommandsManageInstances"></a>

使用 `DescribeAuditTask` 获取关于特定审核实例的信息。如果审核已经运行，则结果会包括失败的检查、通过的检查、系统无法完成的检查，以及仍在运行中的检查（如果审核仍在进行中）。

使用 `ListAuditTasks` 查找在特定时间间隔内运行的审核。

使用 `CancelAuditTask` 停止正在进行的审核。

### DescribeAuditTask
<a name="dd-api-iot-DescribeAuditTask"></a>

获取有关 Device Defender 审核的信息。

 **摘要**

```
aws iot  describe-audit-task \
    --task-id <value>  \
    [--cli-input-json <value>] \
    [--generate-cli-skeleton]
```

 `cli-input-json` 格式

```
{
  "taskId": "string"
}
```


**`cli-input-json` 字段**  

|  名称 |  类型 |  说明 | 
| --- | --- | --- | 
| taskId | 字符串<br /> 最大长度：40，最小长度：1<br /> 模式：[a-zA-Z0-9-]\+ | 要获取其信息的审核的 ID。 | 

Output

```
{
  "taskStatus": "string",
  "taskType": "string",
  "taskStartTime": "timestamp",
  "taskStatistics": {
    "totalChecks": "integer",
    "inProgressChecks": "integer",
    "waitingForDataCollectionChecks": "integer",
    "compliantChecks": "integer",
    "nonCompliantChecks": "integer",
    "failedChecks": "integer",
    "canceledChecks": "integer"
  },
  "scheduledAuditName": "string",
  "auditDetails": {
    "string": {
      "checkRunStatus": "string",
      "checkCompliant": "boolean",
      "totalResourcesCount": "long",
      "nonCompliantResourcesCount": "long",
      "errorCode": "string",
      "message": "string"
    }
  }
}
```


**CLI 输出字段**  

|  名称 |  类型 |  说明 | 
| --- | --- | --- | 
| taskStatus | 字符串 | 审核的状态，可以是以下任一值：“IN\_PROGRESS”、“COMPLETED”、“FAILED”或“CANCELED”。<br /> 枚举：IN\_PROGRESS \| COMPLETED \| FAILED \| CANCELED | 
| taskType | 字符串 | 审核的类型：“ON\_DEMAND\_AUDIT\_TASK”或“SCHEDULED\_AUDIT\_TASK”。<br /> 枚举：ON\_DEMAND\_AUDIT\_TASK \| SCHEDULED\_AUDIT\_TASK | 
| taskStartTime | timestamp | 审核的开始时间。 | 
| taskStatistics | TaskStatistics | 有关审核的统计信息。 | 
| totalChecks | 整数 | 此审核中检查的数量。 | 
| inProgressChecks | 整数 | 正在进行的检查的数量。 | 
| waitingForDataCollectionChecks | 整数 | 等待数据收集的检查的数量。 | 
| compliantChecks | 整数 | 发现合规资源的检查的数量。 | 
| nonCompliantChecks | 整数 | 发现不合规资源的检查的数量。 | 
| failedChecks | 整数 | 检查的数量。 | 
| canceledChecks | 整数 | 因审核取消而未运行的检查的数量。 | 
| scheduledAuditName | 字符串<br /> 最大长度：128，最小长度：1<br /> 模式：[a-zA-Z0-9\_-]\+ | 计划审核的名称（仅当审核是计划审核时）。 | 
| auditDetails | 映射 | 有关在此审核过程中执行的每项检查的详细信息。 | 
| checkRunStatus | 字符串 | 此检查的完成状态，可以是以下任一值：“IN\_PROGRESS”、“WAITING\_FOR\_DATA\_COLLECTION”、“CANCELED”、“COMPLETED\_COMPLIANT”、“COMPLETED\_NON\_COMPLIANT”或“FAILED”。<br /> 枚举：IN\_PROGRESS \| WAITING\_FOR\_DATA\_COLLECTION \| CANCELED \| COMPLETED\_COMPLIANT \| COMPLETED\_NON\_COMPLIANT \| FAILED | 
| checkCompliant | 布尔值 | 如果检查完成并找到所有合规资源，则为 True。 | 
| totalResourcesCount | 长整数 | 已执行检查的资源的数量。 | 
| nonCompliantResourcesCount | 长整数 | 检查发现不合规的资源的数量。 | 
| errorCode | 字符串 | 在此审核过程中执行此检查时遇到的所有错误代码。可以是以下任一值：“INSUFFICIENT\_PERMISSIONS”或“AUDIT\_CHECK\_DISABLED”。 | 
| message | 字符串<br /> 最大长度：2048 | 与在此审核过程中执行此检查时遇到的所有错误相关的消息。 | 

 **错误**

`InvalidRequestException`  
请求的内容无效。

`ResourceNotFoundException`  
指定的资源不存在。

`ThrottlingException`  
速率超过限制。

`InternalFailureException`  
出现意外错误。

### ListAuditTasks
<a name="dd-api-iot-ListAuditTasks"></a>

列出已在指定时间段内执行的 Device Defender 审核。

 **摘要**

```
aws iot  list-audit-tasks \
    --start-time <value> \
    --end-time <value> \
    [--task-type <value>] \
    [--task-status <value>] \
    [--next-token <value>] \
    [--max-results <value>]  \
    [--cli-input-json <value>] \
    [--generate-cli-skeleton]
```

 `cli-input-json` 格式

```
{
  "startTime": "timestamp",
  "endTime": "timestamp",
  "taskType": "string",
  "taskStatus": "string",
  "nextToken": "string",
  "maxResults": "integer"
}
```


**`cli-input-json` 字段**  

|  名称 |  类型 |  说明 | 
| --- | --- | --- | 
| startTime | timestamp | 时间段的开始时间。审核信息只保留有限的时间（180 天）。在保留信息之前请求开始时间将引发 `InvalidRequestException`。 | 
| endTime | timestamp | 时间段的结束时间。 | 
| taskType | 字符串 | 筛选条件，用于将输出限定到指定审核类型，可以是以下任一值：“ON\_DEMAND\_AUDIT\_TASK”或“SCHEDULED\_\_AUDIT\_TASK”。<br /> 枚举：ON\_DEMAND\_AUDIT\_TASK \| SCHEDULED\_AUDIT\_TASK | 
| taskStatus | 字符串 | 筛选条件，用于将输出限定到具有指定完成状态的审核，可以是以下任一值：“IN\_PROGRESS”、“COMPLETED”、“FAILED”或“CANCELED”。<br /> 枚举：IN\_PROGRESS \| COMPLETED \| FAILED \| CANCELED | 
| nextToken | 字符串 | 用于获取下一组结果的令牌。 | 
| maxResults | 整数<br /> 范围 - 最大值：250，最小值：1 | 一次性返回的最大结果数。默认值为 25。 | 

Output

```
{
  "tasks": [
    {
      "taskId": "string",
      "taskStatus": "string",
      "taskType": "string"
    }
  ],
  "nextToken": "string"
}
```


**CLI 输出字段**  

|  名称 |  类型 |  说明 | 
| --- | --- | --- | 
| 任务 | 列表<br /> 成员：AuditTaskMetadata<br /> java 类：java.util.List | 在指定时间段内执行的审核。 | 
| taskId | 字符串<br /> 最大长度：40，最小长度：1<br /> 模式：[a-zA-Z0-9-]\+ | 此审核的 ID。 | 
| taskStatus | 字符串 | 此审核的状态，可以是以下任一值：“IN\_PROGRESS”、“COMPLETED”、“FAILED”或“CANCELED”。<br /> 枚举：IN\_PROGRESS \| COMPLETED \| FAILED \| CANCELED | 
| taskType | 字符串 | 此审核的类型，可以是以下任一值：“ON\_DEMAND\_AUDIT\_TASK”或“SCHEDULED\_AUDIT\_TASK”。<br /> 枚举：ON\_DEMAND\_AUDIT\_TASK \| SCHEDULED\_AUDIT\_TASK | 
| nextToken | 字符串 | 用于检索下一组结果的令牌，没有更多结果时为 `null`。 | 

 **错误**

`InvalidRequestException`  
请求的内容无效。

`ThrottlingException`  
速率超过限制。

`InternalFailureException`  
出现意外错误。

### CancelAuditTask
<a name="dd-api-iot-CancelAuditTask"></a>

取消正在进行的审核。审核可能是计划审核，也可能是按需审核。如果审核未处于进行中，则将引发 `InvalidRequestException`。

 **摘要**

```
aws iot  cancel-audit-task \
    --task-id <value>  \
    [--cli-input-json <value>] \
    [--generate-cli-skeleton]
```

 `cli-input-json` 格式

```
{
  "taskId": "string"
}
```


**`cli-input-json` 字段**  

|  名称 |  类型 |  说明 | 
| --- | --- | --- | 
| taskId | 字符串<br /> 最大长度：40，最小长度：1<br /> 模式：[a-zA-Z0-9-]\+ | 要取消的审核的 ID。只能取消状态为“IN\_PROGRESS”的审核。 | 

Output

无

 **错误**

`ResourceNotFoundException`  
指定的资源不存在。

`InvalidRequestException`  
请求的内容无效。

`ThrottlingException`  
速率超过限制。

`InternalFailureException`  
出现意外错误。

## 检查审核结果
<a name="device-defender-AuditCommandsFindings"></a>

使用 `ListAuditFindings` 查看审核结果。可以按照检查类型、特定资源或审核时间筛选结果。您可以使用此信息来解决发现的任何问题。

您可以定义缓解操作并将其应用于审核的结果。有关更多信息，请参阅 [缓解操作](dd-mitigation-actions.md)。

### ListAuditFindings
<a name="dd-api-iot-ListAuditFindings"></a>

列出 Device Defender 审核的结果或在指定时间段内审核执行的结果。（结果保留 180 天。）

 **摘要**

```
aws iot  list-audit-findings \
    [--task-id <value>] \
    [--check-name <value>] \
    [--resource-identifier <value>] \
    [--max-results <value>] \
    [--next-token <value>] \
    [--start-time <value>] \
    [--end-time <value>]  \
    [--cli-input-json <value>] \
    [--generate-cli-skeleton]
```

 `cli-input-json` 格式

```
{
  "taskId": "string",
  "checkName": "string",
  "resourceIdentifier": {
    "deviceCertificateId": "string",
    "caCertificateId": "string",
    "cognitoIdentityPoolId": "string",
    "clientId": "string",
    "policyVersionIdentifier": {
      "policyName": "string",
      "policyVersionId": "string"
    },
   
    "roleAliasArn": "string",
    "account": "string"
  },
  "maxResults": "integer",
  "nextToken": "string",
  "startTime": "timestamp",
  "endTime": "timestamp"
}
```


**`cli-input-json` 字段**  

|  名称 |  类型 |  说明 | 
| --- | --- | --- | 
| taskId | 字符串<br /> 最大长度：40，最小长度：1<br /> 模式：[a-zA-Z0-9-]\+ | 筛选条件，用于将结果限定到具有指定 ID 的审核。必须指定 taskId 或 startTime 和 endTime，但不能同时指定这两项。 | 
| checkName | 字符串 | 筛选条件，用于将结果限定到指定审核检查结果。 | 
| resourceIdentifier | ResourceIdentifier | 用于标识不合规资源的信息。 | 
| deviceCertificateId | 字符串<br /> 最大长度：64，最小长度：64<br /> 模式：(0x)?[a-fA-F0-9]\+ | 附加到资源的证书的 ID。 | 
| caCertificateId | 字符串<br /> 最大长度：64，最小长度：64<br /> 模式：(0x)?[a-fA-F0-9]\+ | 授权证书所用的 CA 证书的 ID。 | 
| cognitoIdentityPoolId | 字符串 | Amazon Cognito 身份池的 ID。 | 
| clientId | 字符串 | 客户端 ID。 | 
| policyVersionIdentifier | PolicyVersionIdentifier | 与资源关联的策略的版本。 | 
| policyName | 字符串<br /> 最大长度：128，最小长度：1<br /> 模式：[w\+=,.@-]\+ | 策略的名称。 | 
| policyVersionId | 字符串<br /> 模式：[0-9]\+ | 与资源关联的策略的版本 ID。 | 
| roleAliasArn | 字符串 | 具有过于宽松操作的角色别名的 ARN。<br /> 最大长度：2048，最小长度：1 | 
| 账户 | 字符串<br /> 最大长度：12，最小长度：12<br /> 模式：[0-9]\+ | 资源所关联的账户。 | 
| maxResults | 整数<br /> 范围 - 最大值：250，最小值：1 | 一次性返回的最大结果数。默认值为 25。 | 
| nextToken | 字符串 | 用于获取下一组结果的令牌。 | 
| startTime | timestamp | 筛选条件，用于将结果限定到在指定时间之后发现的结果。必须指定 startTime 和 endTime 或 taskId，但不能同时指定这两项。 | 
| endTime | timestamp | 筛选条件，用于将结果限定到在指定时间之前发现的结果。必须指定 startTime 和 endTime 或 taskId，但不能同时指定这两项。 | 

Output

```
{
  "findings": [
    {
      "taskId": "string",
      "checkName": "string",
      "taskStartTime": "timestamp",
      "findingTime": "timestamp",
      "severity": "string",
      "nonCompliantResource": {
        "resourceType": "string",
        "resourceIdentifier": {
          "deviceCertificateId": "string",
          "caCertificateId": "string",
          "cognitoIdentityPoolId": "string",
          "clientId": "string",
          "policyVersionIdentifier": {
            "policyName": "string",
            "policyVersionId": "string"
          },
          "account": "string"
        },
        "additionalInfo": {
          "string": "string"
        }
      },
      "relatedResources": [
        {
          "resourceType": "string",
          "resourceIdentifier": {
            "deviceCertificateId": "string",
            "caCertificateId": "string",
            "cognitoIdentityPoolId": "string",
            "clientId": "string",
    
            "iamRoleArn": "string",
    
            "policyVersionIdentifier": {
              "policyName": "string",
              "policyVersionId": "string"
            },
            "account": "string"
          },
    
          "roleAliasArn": "string",
    
          "additionalInfo": {
            "string": "string"
          }
        }
      ],
      "reasonForNonCompliance": "string",
      "reasonForNonComplianceCode": "string"
    }
  ],
  "nextToken": "string"
}
```


**CLI 输出字段**  

|  名称 |  类型 |  说明 | 
| --- | --- | --- | 
| findings | 列表<br /> 成员：AuditFinding | 审核的结果。 | 
| taskId | 字符串<br /> 最大长度：40，最小长度：1<br /> 模式：[a-zA-Z0-9-]\+ | 生成此结果的审核的 ID。 | 
| checkName | 字符串 | 生成此结果的审核检查。 | 
| taskStartTime | timestamp | 审核的开始时间。 | 
| findingTime | timestamp | 结果的发现时间。 | 
| severity | 字符串 | 结果的严重性。<br /> 枚举：CRITICAL \| HIGH \| MEDIUM \| LOW | 
| nonCompliantResource | NonCompliantResource | 经发现不符合审核检查规定的资源。 | 
| resourceType | 字符串 | 不合规资源的类型。<br /> 枚举：DEVICE\_CERTIFICATE \| CA\_CERTIFICATE \| IOT\_POLICY \| COGNITO\_IDENTITY\_POOL \| CLIENT\_ID \| ACCOUNT\_SETTINGS | 
| resourceIdentifier | ResourceIdentifier | 用于标识不合规资源的信息。 | 
| deviceCertificateId | 字符串<br /> 最大长度：64，最小长度：64<br /> 模式：(0x)?[a-fA-F0-9]\+ | 附加到资源的证书的 ID。 | 
| caCertificateId | 字符串<br /> 最大长度：64，最小长度：64<br /> 模式：(0x)?[a-fA-F0-9]\+ | 授权证书所用的 CA 证书的 ID。 | 
| cognitoIdentityPoolId | 字符串 | Amazon Cognito 身份池的 ID。 | 
| clientId | 字符串 | 客户端 ID。 | 
| policyVersionIdentifier | PolicyVersionIdentifier | 与资源关联的策略的版本。 | 
| policyName | 字符串<br /> 最大长度：128，最小长度：1<br /> 模式：[w\+=,.@-]\+ | 策略的名称。 | 
| policyVersionId | 字符串<br /> 模式：[0-9]\+ | 与资源关联的策略的版本 ID。 | 
| 账户 | 字符串<br /> 最大长度：12，最小长度：12<br /> 模式：[0-9]\+ | 资源所关联的账户。 | 
| additionalInfo | 映射 | 有关不合规资源的其它信息。 | 
| relatedResources | 列表<br /> 成员：RelatedResource | 相关资源的列表。 | 
| resourceType | 字符串 | 资源的类型。<br /> 枚举：DEVICE\_CERTIFICATE \| CA\_CERTIFICATE \| IOT\_POLICY \| COGNITO\_IDENTITY\_POOL \| CLIENT\_ID \| ACCOUNT\_SETTINGS | 
| resourceIdentifier | ResourceIdentifier | 用于标识资源的信息。 | 
| deviceCertificateId | 字符串<br /> 最大长度：64，最小长度：64<br /> 模式：(0x)?[a-fA-F0-9]\+ | 附加到资源的证书的 ID。 | 
| caCertificateId | 字符串<br /> 最大长度：64，最小长度：64<br /> 模式：(0x)?[a-fA-F0-9]\+ | 授权证书所用的 CA 证书的 ID。 | 
| cognitoIdentityPoolId | 字符串 | Amazon Cognito 身份池的 ID。 | 
| clientId | 字符串 | 客户端 ID。 | 
| policyVersionIdentifier | PolicyVersionIdentifier | 与资源关联的策略的版本。 | 
| iamRoleArn | 字符串<br /> 最大长度：2048，最小长度：20 | 具有过于宽松操作的 IAM 角色的 ARN。 | 
| policyName | 字符串<br /> 最大长度：128，最小长度：1<br /> 模式：[w\+=,.@-]\+ | 策略的名称。 | 
| policyVersionId | 字符串<br /> 模式：[0-9]\+ | 与资源关联的策略的版本 ID。 | 
| roleAliasArn | 字符串<br /> 最大长度：2048，最小长度：1 | 具有过于宽松操作的角色别名的 ARN。 | 
| 账户 | 字符串<br /> 最大长度：12，最小长度：12<br /> 模式：[0-9]\+ | 资源所关联的账户。 | 
| additionalInfo | 映射 | 有关资源的其它信息。 | 
| reasonForNonCompliance | 字符串 | 资源不合规的原因。 | 
| reasonForNonComplianceCode | 字符串 | 用于表明资源不合规原因的代码。 | 
| nextToken | 字符串 | 用于检索下一组结果的令牌，没有更多结果时为 `null`。 | 

 **错误**

`InvalidRequestException`  
请求的内容无效。

`ThrottlingException`  
速率超过限制。

`InternalFailureException`  
出现意外错误。