AWS IoT
开发人员指南
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

缓解操作命令

您可以使用这些缓解操作命令为您的 AWS 账户定义一组操作,以后可以将这些操作应用于一组或多组审核结果。有两种命令类别:

  • 用于定义和管理操作的命令。

  • 用于启动和管理将这些操作应用于审核结果的命令。

CreateMitigationAction

通过使用 StartAuditMitigationActionsTask定义可应用于审核结果的操作。每个缓解操作只能应用一种类型的更改。定义一个操作并不应用此操作。

摘要

aws iot create-mitigation-action \ --action-name <value] --role-arn <value> \ [--tags <value>] \ --action-params <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "actionParams": { "addThingsToThingGroupParams": { "overrideDynamicGroups": boolean, "thingGroupNames": [ "string" ] }, "enableIoTLoggingParams": { "logLevel": "string", "roleArnForLogging": "string" }, "publishFindingToSnsParams": { "topicArn": "string" }, "replaceDefaultPolicyVersionParams": { "templateName": "string" }, "updateCACertificateParams": { "action": "string" }, "updateDeviceCertificateParams": { "action": "string" } }, "roleArn": "string", "tags": [ { "Key": "string", "Value": "string" } ] }

cli-input-json 字段

名称

类型

描述

roleArn

string

最大长度:2048,最小长度:20

角色的 ARN,该角色授权 AWS IoT 在应用此操作时访问有关设备、策略、证书及其他项的信息。

tags

标签对象数组

可用于管理缓解操作的元数据。

actionParams

映射

定义要应用的操作类型和该缓解操作的参数。对于每个缓解操作,只能包含一种类型的参数。

您必须为要定义的操作类型提供参数。您可以仅提供一个活动类型及其参数。以下是支持的操作类型:

  • ADD_THINGS_TO_THING_GROUP

  • ENABLE_IOT_LOGGING

  • PUBLISH_FINDING_TO_SNS

  • REPLACE_DEFAULT_POLICY_VERSION

  • UPDATE_CA_CERTIFICATE

  • UPDATE_DEVICE_CERTIFICATE

AddThingsToThingGroup 的参数

名称 类型 描述

overrideDynamicGroups

boolean

可选。指定此缓解操作是否可以将触发缓解操作的事物移出一个或多个动态事物组。仅当事物已在最大数量的组中时才使用此设置。

thingGroupNames

字符串数组

必需。要向其中添加触发缓解操作的事物的组列表。

您可以将一个事物添加到最多 10 个组,但您无法将事物添加到相同层次结构的多个组。

您必须提供至少一个组名称。

长度约束:最小长度为 1。最大长度为 128。

模式:[a-zA-Z0-9:_-]+

EnableIoTLogging 的参数

名称 类型 描述

logLevel

string

必需。指定记录哪些类型的信息。

有效值(按详细程度从高到低)为 DEBUGINFOERRORWARN。您不能指定 DISABLED 日志记录级别。

roleArnForLogging

string

必需。用于日志记录的 IAM 角色的 ARN。

最小长度为 20。最大长度为 2048。

PublishingFindingToSns 的参数

名称 类型 描述

topicArn

string

必需。要将结果发布到的主题的 ARN。

最小长度为 20。最大长度为 2048。

ReplaceDefaultPolicyVersion 的参数

名称 类型 描述

templateName

string

必需。要应用的模板的名称。

BLANK_POLICY 是唯一受支持的值。

UpdateCACertificate 的参数

名称 类型 描述

action

string

必需。要应用于 CA 证书的操作。

DEACTIVATE 是唯一受支持的值。

UpdateDeviceCertificate 的参数

名称 类型 描述

action

string

必需。要应用于设备证书的操作。

DEACTIVATE 是唯一受支持的值。

CLI 输出字段:

名称

类型

描述

actionArn

string

新缓解操作的 ARN。

actionId

string

新缓解操作的唯一标识符。

错误

InvalidRequestException

请求的内容无效。

LimitExceededException

已超出限制。有关缓解操作限制的信息,请参阅服务限制

RequestAlreadyExistsException

已存在具有此名称的缓解操作。仅当存在具有相同名称但不同参数的其他缓解操作时,才会发生此错误。

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

示例

此示例定义(在应用时)停用设备证书的缓解操作。

$ aws iot create-mitigation-action --action-name "UpdateCACertName" --role-arn arn:aws:iam::123456789012:role/MitigationActionsValidRole --action-params "updateDeviceCertificateParams={action=DEACTIVATE}"

响应类似于以下内容:

{ "actionArn": "arn:aws:iot:us-east-1:123456789012:mitigationaction/UpdateCACertName", "actionId": "6a22b98e-0e27-4396-9b25-637d04959429" }

UpdateMitigationAction

通过使用 StartAuditMitigationActionsTask更新可应用于审核结果的操作的定义。每个缓解操作只能应用一种类型的更改。

摘要

aws iot update-mitigation-action \ --action-name <value> --role-arn <value> \ --action-params <value] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "actionParams": { "addThingsToThingGroupParams": { "overrideDynamicGroups": boolean, "thingGroupNames": [ "string" ] }, "enableIoTLoggingParams": { "logLevel": "string", "roleArnForLogging": "string" }, "publishFindingToSnsParams": { "topicArn": "string" }, "replaceDefaultPolicyVersionParams": { "templateName": "string" }, "updateCACertificateParams": { "action": "string" }, "updateDeviceCertificateParams": { "action": "string" } }, "roleArn": "string" ] }

cli-input-json 字段

名称

类型

描述

roleArn

string

最大长度:2048,最小长度:20

角色的 ARN,该角色授权 AWS IoT 在应用此操作时访问有关设备、策略、证书及其他项的信息。

actionParams

映射

定义要应用的操作类型和该缓解操作的参数。您只能指定一种类型的操作及其参数。

您必须为要定义的操作类型提供参数。您可以仅提供一个活动类型及其参数。以下是支持的操作类型:

  • ADD_THINGS_TO_THING_GROUP

  • ENABLE_IOT_LOGGING

  • PUBLISH_FINDING_TO_SNS

  • REPLACE_DEFAULT_POLICY_VERSION

  • UPDATE_CA_CERTIFICATE

  • UPDATE_DEVICE_CERTIFICATE

AddThingsToThingGroup 的参数

名称 类型 描述

overrideDynamicGroups

boolean

可选。指定此缓解操作是否可以将触发缓解操作的事物移出一个或多个动态事物组。仅当事物已在最大数量的组中时才使用此设置。

thingGroupNames

字符串数组

必需。要向其中添加触发缓解操作的事物的组列表。

您可以将一个事物添加到最多 10 个组,但您无法将事物添加到相同层次结构的多个组。

您必须提供至少一个组名称。

长度约束:最小长度为 1。最大长度为 128。

模式:[a-zA-Z0-9:_-]+

EnableIoTLogging 的参数

名称 类型 描述

logLevel

string

必需。指定要记录哪些类型的信息。

有效值(按详细程度从高到低)为 DEBUGINFOERRORWARN。您不能指定 DISABLED 日志记录级别。

roleArnForLogging

string

必需。用于日志记录的 IAM 角色的 ARN。

最小长度为 20。最大长度为 2048。

PublishingFindingToSns 的参数

名称 类型 描述

topicArn

string

必需。要将结果发布到的主题的 ARN。

最小长度为 20。最大长度为 2048。

ReplaceDefaultPolicyVersion 的参数

名称 类型 描述

templateName

string

必需。要应用的模板的名称。

BLANK_POLICY 是唯一受支持的值。

UpdateCACertificate 的参数

名称 类型 描述

action

string

必需。要应用于 CA 证书的操作。

DEACTIVATE 是唯一受支持的值。

UpdateDeviceCertificate 的参数

名称 类型 描述

action

string

必需。要应用于设备证书的操作。

DEACTIVATE 是唯一受支持的值。

cli 输出字段:

名称

类型

描述

actionArn

string

缓解操作的 ARN。

actionId

string

缓解操作的唯一标识符。

错误

InvalidRequestException

请求的内容无效。

ResourceNotFoundException

未找到具有指定名称的缓解操作。

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

ListMitigationActions

使用 ListMitigationActions 命令获取 AWS 账户中所有缓解操作的列表。

摘要

aws iot list-mitigation-actions \ [--action-type <value>] [--max-results <value>] \ [--next-token <value>]

输入参数

名称

类型

描述

action-type

string

指定一个值,以将结果限制为具有特定操作类型的缓解操作。

支持的值为 UPDATE_DEVICE_CERTIFICATEUPDATE_CA_CERTIFICATEADD_THINGS_TO_THING_GROUPREPLACE_DEFAULT_POLICY_VERSIONENABLE_IOT_LOGGINGPUBLISH_FINDING_TO_SNS

max-results

integer

一次性返回的最大结果数。

默认值为 25。有效范围为 1 到 250。

next-token

string

用于检索下一组结果的令牌。

输出 JSON:

{ "actionIdentifiers": [ { "actionArn": "string", "actionName": "string", "creationDate": number } ], "nextToken": "string" }

CLI 输出字段:

名称

类型

描述

actionIdentifiers

映射

有关与指定参数匹配的缓解操作集合的信息。

actionArn

string

缓解操作的 ARN。

actionName

string

新缓解操作的唯一标识符。

最大长度为 128。

模式:[a-zA-Z0-9_-]+

creationDate

timestamp

创建缓解操作的日期和时间。

nextToken

string

用于检索下一组结果的令牌。

错误

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

示例

此示例列出了为您在该区域的账户定义的所有缓解操作。

$ aws iot list-mitigation-actions

响应类似于以下内容:

{ "actionIdentifiers": [ { "actionName": "UpdateCACertName", "actionArn": "arn:aws:iot:us-east-1:123456789012:mitigationaction/UpdateCACertName", "creationDate": 1560173584.521 } ] }

DescribeMitigationAction

您可以使用 DescribeMitigationAction 命令查看您的 AWS 账户中缓解操作的详细信息。

摘要

aws iot describe-mitigation-action --action-name <value>

输入参数

名称

类型

描述

action-name

string

唯一标识缓解操作的友好名称。

最大长度为 128。

模式:[a-zA-Z0-9_-]+

输出 JSON:

{ "actionArn": "string", "actionId": "string", "actionName": "string", "actionParams": { "addThingsToThingGroupParams": { "overrideDynamicGroups": boolean, "thingGroupNames": [ "string" ] }, "enableIoTLoggingParams": { "logLevel": "string", "roleArnForLogging": "string" }, "publishFindingToSnsParams": { "topicArn": "string" }, "replaceDefaultPolicyVersionParams": { "templateName": "string" }, "updateCACertificateParams": { "action": "string" }, "updateDeviceCertificateParams": { "action": "string" } }, "actionType": "string", "creationDate": number, "lastModifiedDate": number, "roleArn": "string" }

每个缓解操作只有一种类型,因此只显示其中一组参数。

CLI 输出字段:

名称

类型

描述

actionArn

string

缓解操作的 ARN。

actionId

string

缓解操作的唯一标识符。

actionName

string

新缓解操作的唯一友好名称。

最大长度为 128。

模式:[a-zA-Z0-9_-]+

actionParams

映射

定义要应用的操作类型和该缓解操作的参数。

addThingsToThingGroupParams

映射

用于定义缓解操作的参数,该操作将与证书关联的设备移到一个或多个指定的事物组,通常用于隔离。

overrideDynamicGroups

boolean

指定此缓解操作是否可以移动触发缓解操作的事物,即使它们是一个或多个动态事物组的一部分。

thingGroupNames

字符串数组

要向其中添加触发缓解操作的事物的组列表。

您可以将一个事物添加到最多 10 个组,但您无法将事物添加到相同层次结构的多个组。

您必须提供至少一个组名称。

最小长度为 1。最大长度为 128。

模式:[a-zA-Z0-9:_-]+

enableIoTLoggingParams

映射

用于定义缓解操作的参数,该操作允许以指定的详细级别进行 AWS IoT 日志记录。

logLevel

string

指定要记录的信息类型。

有效值(按详细程度从高到低)为 DEBUGINFOERRORWARNDISABLED

roleArnForLogging

string

用于日志记录的 IAM 角色的 ARN。

最小长度为 20。最大长度为 2048。

publishFindingToSnsParams

映射

用于定义将结果发布到 Amazon SNS 的缓解操作的参数。您可以实施您自己的自定义操作以响应 Amazon SNS 消息。

topicArn

string

要将结果发布到的主题的 ARN。

最小长度为 20。最大长度为 2048。

replaceDefaultPolicyVersionParams

映射

用于定义缓解操作的参数,此操作用于添加空白策略以限制权限。

templateName

string

要应用的模板的名称。

BLANK_POLICY 是唯一受支持的值。

updateCACertificateParams

映射

用于定义缓解操作的参数,此操作将 CA 证书的状态更改为非活动。

action

string

要应用于 CA 证书的操作。

DEACTIVATE 是唯一受支持的值。

updateDeviceCertificateParams

映射

用于定义缓解操作的参数,此操作将设备证书的状态更改为非活动。

action

string

要应用于设备证书的操作。

DEACTIVATE 是唯一受支持的值。

actionType

string

正在应用的操作的类型。

creationDate

timestamp

创建缓解操作的日期和时间。

lastModifiedDate

timestamp

最近更改缓解操作的日期和时间。

roleArn

string

应用此缓解操作时要使用的角色的 ARN。

错误

ResourceNotFoundException

未找到具有指定名称的缓解操作。

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

示例

此示例获取名为 UpdateCACertName 的缓解操作的定义。

$ aws iot describe-mitigation-action --action-name UpdateCACertName

响应类似于以下内容:

{ "actionName": "UpdateCACertName", "actionType": "UPDATE_DEVICE_CERTIFICATE", "actionArn": "arn:aws:iot:us-east-1:123456789012:mitigationaction/UpdateCACertName", "actionId": "6a22b98e-0e27-4396-9b25-637d04959429", "roleArn": "arn:aws:iam::123456789012:role/MitigationActionsValidRole", "actionParams": { "updateDeviceCertificateParams": { "action": "DEACTIVATE" } }, "creationDate": 1560173584.521, "lastModifiedDate": 1560173584.521 }

DeleteMitigationAction

您使用 DeleteMitigationAction 命令删除您的 AWS 账户中的缓解操作。要使 DeleteMitigationAction 命令具有幂等性,如果您尝试删除不存在的缓解操作,则它则不会引发 ResourceNotFoundException。相反,当操作名称不存在时,DeleteMitigationAction 返回成功。

摘要

aws iot delete-mitigation-action --action-name <value>

输入参数

名称

类型

描述

action-name

string

唯一标识缓解操作的友好名称。

最大长度为 128。

模式:[a-zA-Z0-9_-]+

错误

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

StartAuditMitigationActionsTask

您使用 StartAuditMitigationActionsTask 命令将一组缓解操作应用于一个或多个审核的结果。

摘要

aws iot start-audit-mitigation-actions-task \ --task-id <value> --audit-task-id <value> --audit-checks-to-action-mapping <value> [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "auditCheckToActionsMapping": { "string" : [ "string" ] }, "clientRequestToken": "string", "target": { "auditTaskId": "string", "findingIds": [ "string" ] } }

输入参数

名称

类型

描述

taskId

string

审核缓解任务的唯一标识符。

最大长度为 128。

模式:[a-zA-Z0-9_-]+

auditCheckToActionsMapping

字符串到字符串数组映射

指定要应用于特定审核检查的操作列表。

数组必须至少包含 1 个成员,但不能超过 5 个成员。

最大长度为 128。

模式:[a-zA-Z0-9_-]+

clientRequestToken

string

每个审核缓解任务都必须具有唯一的客户端请求令牌。如果您尝试使用与现有任务相同的任务 ID 启动新任务,但使用不同的令牌,则会发生异常。如果省略此值,则会自动生成一个唯一的客户端请求令牌。

最小长度为 1。最大长度为 64。

模式:[a-zA-Z0-9_-]+$

target

映射

指定要对其应用缓解操作的审核结果。您可以将它们应用于某个审核任务的结果或一组结果。

auditTaskId

string

您要将一组操作应用于其结果的审核的唯一标识符。auditCheckToReasonCodeFilter 可以进一步筛选审核的结果。如果要将操作限制为特定的一组结果,请改用 findingIds

最大长度为 40。

模式:[a-zA-Z0-9\-]+

findingIds

字符串数组

如果任务将缓解操作应用于一个或多个列出的结果,则此值唯一地标识这些结果。

数组成员:最少 1 个项目。最多 25 个项目。

每个项目的最大长度为 128。

模式:[a-zA-Z0-9_-]+

输出 JSON:

{ "taskId": "string" }

CLI 输出字段:

名称

类型

描述

taskId

string

新创建的审核缓解操作任务的唯一标识符。

如果需要取消任务(CancelAuditMitigationActionsTask)或要使用 DesribeAuditMitigationAtionsTask 查看任务的详细信息,请使用此标识符。

错误

TaskAlreadyExistsException

如果您尝试使用与现有任务相同的 task-id 但使用不同的 clientRequestToken 启动任务,则会发生此异常。

InvalidRequestException

请求的内容无效。

LimitExceededException

如果您尝试启动 10 个以上的缓解操作任务,则会发生此异常。

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

示例

此示例启动一项任务,以将您定义的 UpdateCACertAction 应用于其 taskId 为 aef320b958891041e0c60c088afac64c 且审核检查为 CA_CERTIFICATE_EXPIRING_CHECK. 的审核中的审核结果。

$ aws iot start-audit-mitigation-actions-task --task-id "myActionsTaskId" --target "auditTaskId=aef320b958891041e0c60c088afac64c" --audit-check-to-actions-mapping "CA_CERTIFICATE_EXPIRING_CHECK=UpdateCACertAction" --client-request-token "adhadhahda"

响应看起来与以下内容类似。

{ "taskId": "myActionsTaskId" }

CancelAuditMitigationActionsTask

如果审核缓解任务尚未完成,您使用 CancelAuditMitigationActionsTask 命令停止此任务的执行。

摘要

aws iot cancel-audit-mitigation-actions-task --task-id <value>

输入参数

名称

类型

描述

task-id

string

您要取消的审核缓解任务的唯一标识符。

最大长度为 128。

模式:[a-zA-Z0-9_-]+

错误

ResourceNotFoundException

未找到具有指定任务 ID 的审核缓解操作任务。

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

ListAuditMitigationActionsExecutions

您使用 ListAuditMitigationActionsExecutions 命令以显示有关已启动的审核缓解任务的详细信息。

摘要

aws iot list-audit-mitigation-actions-executions \ [--action-status <value>] --finding-id <value> \ [--max-results <value>] \ [--next-token <value>] \ --task-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

输入参数

名称

类型

描述

action-status

string

指定此筛选条件可将结果限制为具有特定状态的那些执行。

支持的值为 IN_PROGRESSCOMPLETEDFAILEDCANCELEDSKIPPED PENDING

finding-id

string

指定此筛选条件可将结果限制为应用于特定审核结果的结果。

最大长度为 128。

模式:[a-zA-Z0-9_-]+

max-results

number

一次性返回的最大结果数。默认值为 25。

有效范围:最小值为 1,最大值为 250。

next-token

string

用于获取下一组结果的令牌。

task-id

string

您要显示其详细信息的审核缓解任务的唯一标识符。

最大长度为 128。

模式:[a-zA-Z0-9_-]+

输出 JSON:

{ "actionsExecutions": [ { "actionId": "string", "actionName": "string", "endTime": number, "errorCode": "string", "findingId": "string", "message": "string", "startTime": number, "status": "string", "taskId": "string" } ], "nextToken": "string" }

CLI 输出字段:

名称

类型

描述

actionsExecutions

映射

有关已为您的 AWS 账户启动的审核缓解任务执行的信息集合。

actionId

string

任务应用的缓解操作的唯一标识符。

actionName

string

任务应用的缓解操作的友好名称。

endTime

timestamp

任务完成或取消的日期和时间。

errorCode

string

如果出现错误,则为指示错误类型的代码。

findingId

string

对其应用任务和关联缓解操作的结果的唯一标识符。

message

string

如果出现了错误,则为一条说明错误的消息。

startTime

timestamp

启动任务的日期和时间。

status

string

正在执行的任务的当前状态。支持的值为 IN_PROGRESSCOMPLETEDFAILEDCANCELEDSKIPPED PENDING

taskId

string

应用缓解操作的任务的唯一标识符。

nextToken

string

用于获取下一组结果的令牌。

状态字段可以具有以下值:

状态 含义
IN_PROGRESS AWS IoT Device Defender 正在将缓解操作应用于结果。
COMPLETED 缓解操作成功应用于结果。
FAILED 缓解操作未能应用于结果。错误代码可提供更多信息。
CANCELED 操作已取消,因为用户取消了任务。
SKIPPED 已跳过操作执行,因为列表中的一个操作失败。
PENDING (待处理) 尚未启动操作执行。

可能返回以下错误代码:

INSUFFICIENT_PERMISSIONS
  • 为缓解操作提供的 roleArn 没有应用操作的权限。

INVALID_STATE_OF_RESOURCE
  • 结果中的资源未处于允许成功应用缓解操作的状态。如果事物已经在最大允许的组数中,则对于 ADD_THINGS_TO_THING_GROUP 操作类型会发生此错误。如果证书已被撤销,则对于 UPDATE_DEVICE_CERTIFICATE 和 UPDATE_CA_CERTIFICATE 缓解操作类型会发生错误。

错误

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

ListAuditMitigationActionsTasks

使用 ListAuditMitigationActionsTasks 命令来获取与指定的筛选条件匹配的审核缓解操作任务的列表。

摘要

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

输入参数

名称

类型

描述

audit-task-id

string

您要显示的审核缓解任务的唯一标识符。

最小长度为 1。最大长度为 40。

模式:[a-zA-Z0-9_-]+

end-time

timestamp

必需。指定此筛选条件以列出在此日期或之前结束的任务。该日期不得超过过去的 90 天。

finding-id

string

指定此筛选条件以列出应用于特定结果的任务。

最大长度为 128。

模式:[a-zA-Z0-9_-]+

max-results

number

一次性返回的最大结果数。默认值为 25。

有效范围:最小值为 1。最大值为 250。

next-token

string

用于获取下一组结果的令牌。

start-time

timestamp

必需。指定此筛选条件以将结果限制为在此日期和时间或之后启动的任务。该日期不得超过过去的 90 天。

task-status

string

指定此筛选条件以将结果限制为处于指定状态的任务。

支持的值为:IN_PROGRESSCOMPLETEDFAILEDCANCELED

输出 JSON:

{ "nextToken": "string", "tasks": [ { "startTime": number, "taskId": "string", "taskStatus": "string" } ] }

CLI 输出字段:

名称

类型

描述

nextToken

string

用于获取下一组结果的令牌。

tasks

映射

与筛选条件匹配的审核缓解操作任务的集合。

startTime

timestamp

用于定义缓解操作的参数,该操作将与证书关联的设备移到一个或多个指定的事物组,通常用于隔离。

taskId

string

任务的唯一标识符。

taskStatus

string

该表的当前状态。

错误

InvalidRequestException

请求的内容无效。如果您指定的日期超过过去的 90 天,则会发生此错误。

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

示例

此示例列出了在指定时间范围内运行的审核缓解任务。

$ aws iot list-audit-mitigation-actions-tasks --start-time 1560001663 --end-time 1560174463

响应看起来与以下内容类似。

{ "tasks": [ { "taskId": "actionsTaskId", "startTime": 1560174232.07, "taskStatus": "CANCELED" }, { "taskId": "4e8acaf8-b7f0-4484-9b0d-01b979e61d8d", "startTime": 1560060994.965, "taskStatus": "COMPLETED" }, { "taskId": "0e8f5a95-e43f-43fa-9aa4-57ff3efb946d", "startTime": 1560060860.243, "taskStatus": "COMPLETED" }, { "taskId": "92d60009-33a1-45a7-a3c6-b28e938ec68a", "startTime": 1560060707.653, "taskStatus": "COMPLETED" }, { "taskId": "bdea63c8-58bd-4798-9cb3-e949c7f1969a", "startTime": 1560060531.123, "taskStatus": "COMPLETED" }, { "taskId": "61e146ef-69f4-41bf-9d37-5d667f72ef3d", "startTime": 1560060388.035, "taskStatus": "COMPLETED" }, { "taskId": "2ef289dc-9bbd-422b-95ba-d96b7e626a60", "startTime": 1560060256.695, "taskStatus": "COMPLETED" }, { "taskId": "a6cdc16b-6be3-4800-bafa-2b86d3f5d639", "startTime": 1560060097.613, "taskStatus": "COMPLETED" }, { "taskId": "7ccf351b-e560-4eb2-8796-1dc1bcb25396", "startTime": 1560059925.477, "taskStatus": "COMPLETED" }, { "taskId": "8f69ee5d-3e35-4c91-88e8-3c5f84c96fde", "startTime": 1560059345.473, "taskStatus": "COMPLETED" } ] }

DescribeAuditMitigationActionsTask

您使用 DescribeAuditMitigationActionsTask 命令以显示有关已启动的审核缓解任务的详细信息。

摘要

aws iot describe-audit-mitigation-actions-task --taskId <value>

输入参数

名称

类型

描述

taskId

string

必需。您要显示其详细信息的审核缓解任务的唯一标识符。

最大长度为 128。

模式:[a-zA-Z0-9_-]+

输出 JSON:

{ "actionsDefinition": [ { "actionParams": { "addThingsToThingGroupParams": { "overrideDynamicGroups": boolean, "thingGroupNames": [ "string" ] }, "enableIoTLoggingParams": { "logLevel": "string", "roleArnForLogging": "string" }, "publishFindingToSnsParams": { "topicArn": "string" }, "replaceDefaultPolicyVersionParams": { "templateName": "string" }, "updateCACertificateParams": { "action": "string" }, "updateDeviceCertificateParams": { "action": "string" } }, "id": "string", "name": "string", "roleArn": "string" } ], "auditCheckToActionsMapping": { "string" : [ "string" ] }, "endTime": number, "startTime": number, "target": { "auditCheckToReasonCodeFilter": { "string" : [ "string" ] }, "auditTaskId": "string", "findingIds": [ "string" ] }, "taskStatistics": { "string" : { "canceledFindingsCount": number, "failedFindingsCount": number, "skippedFindingsCount": number, "succeededFindingsCount": number, "totalFindingsCount": number } }, "taskStatus": "string" }

CLI 输出字段:

名称

类型

描述

>actionsDefinition

映射

此审核缓解操作任务应用的一组操作(及其元数据)。

actionParams

映射

应用缓解操作时使用的参数。

addThingsToThingGroupParam

映射

用于定义缓解操作的参数,该操作将与证书关联的设备移到一个或多个指定的事物组,通常用于隔离。

overrideDynamicGroups

boolean

指定此缓解操作是否可以移动触发缓解操作的事物,即使它们是一个或多个动态事物组的一部分。

thingGroupNames

字符串数组

此缓解操作将此审核缓解操作任务的目标中的事物添加到的组的列表。

enableIoTLoggingParams

映射

用于定义缓解操作的参数,该操作允许以指定的详细级别进行 AWS IoT 日志记录。

logLevel

string

指定要记录的信息类型。

roleArnForLogging

string

用于日志记录的 IAM 角色的 ARN。

publishFindingToSnsParams

映射

用于定义将结果发布到 Amazon SNS 的缓解操作的参数。您可以实施您自己的自定义操作以响应 Amazon SNS 消息。

topicArn

string

要将结果发布到的主题的 ARN。

replaceDefaultPolicyVersionParams

映射

用于定义缓解操作的参数,此操作用于添加空白策略以限制权限。

templateName

string

要应用的模板的名称。

BLANK_POLICY 是唯一受支持的值。

updateCACertificateParams

映射

用于定义缓解操作的参数,此操作将 CA 证书的状态更改为非活动。

action

string

要应用于 CA 证书的操作。

DEACTIVATE 是唯一受支持的值。

updateDeviceCertificateParams

映射

用于定义缓解操作的参数,此操作将设备证书的状态更改为非活动。

action

string

要应用于设备证书的操作。

DEACTIVATE 是唯一受支持的值。

id

string

作为此审核缓解任务的一部分应用的缓解操作的唯一标识符。

name

string

作为此审核缓解任务的一部分应用的缓解操作的友好名称。

roleArn

string

应用此缓解任务时使用的角色的 ARN。

auditCheckToActionsMapping

映射

对于某个审核检查类型,指定此审核缓解任务应用哪些缓解操作。

endTime

timestamp

如果审核缓解操作任务已完成或已取消,则为停止执行的日期和时间。

startTime

timestamp

开始执行此审核缓解操作任务的日期和时间。

target

映射

有关作为此审核缓解操作任务的一部分将缓解操作应用到的目标的信息。

auditCheckToReasonCodeFilter

映射

指定一组审核检查和原因代码,它们用于标识此审核缓解操作任务应用到的审核结果。

auditTaskId

string

指定将此审核缓解操作任务应用于其结果的审核。

findingIds

字符串数组

指定将此审核缓解操作任务应用到的一组审核结果。

taskStatistics

映射

此审核缓解操作任务的执行统计信息集。

canceledFindingsCount

number

如果任务已取消,则指此审核缓解操作任务的目标中未应用缓解操作的结果数。

failedFindingsCount

number

此审核缓解操作任务的目标中对其应用缓解操作失败的结果数。

skippedFindingsCount

number

此审核缓解操作任务的目标中未应用缓解操作的结果数(因为这些结果被应用于此任务的筛选条件排除在外)。

succeededFindingsCount

number

此审核缓解操作任务的目标中已应用缓解操作而未出错或取消的结果数。

totalFindingsCount

number

此审核缓解操作任务的目标中的结果总数。

taskStatus

string

审核缓解操作任务的当前状态。如果针对结果应用一个或多个操作时失败,则状态为失败。

错误

ResourceNotFoundException

未找到具有指定的 taskId 的审核缓解任务。

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。