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

Detect 命令

AttachSecurityProfile

将 AWS IoT Device Defender 安全配置文件与以下目标类型之一相关联:

  • 所有设备

  • 所有已注册的设备(AWS IoT 注册表中的事物)

  • 所有未注册的设备

  • 事物组中的设备

每个目标类型最多可关联五个安全配置文件。

摘要:

aws iot attach-security-profile \ --security-profile-name <value> \ --security-profile-target-arn <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式:

{ "securityProfileName": "string", "securityProfileTargetArn": "string" }

cli-input-json 字段:

名称

类型

描述

securityProfileName

string

最大长度:128,最小长度:1

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

附加的安全配置文件。

securityProfileTargetArn

string

安全配置文件所附加到的目标(事物组)的 ARN。

要将安全配置文件附加到一组设备,必须指定包含这些设备的事物组的 ARN。事物组 ARN 采用以下格式:

arn:aws:iot:<region>:<accountid>:thinggroup/<thing-group-name>

要将安全配置文件附加到账户中所有已注册的事物(忽略未注册的事物),必须指定以下格式的 ARN:

arn:aws:iot:<region>:<accountid>:all/registered-things

要将安全配置文件附加到所有未注册的事物,必须指定以下格式的 ARN:

arn:aws:iot:<region>:<accountid>:all/unregistered-things

要将安全配置文件附加到所有设备,必须指定以下格式的 ARN:

arn:aws:iot:<region>:<accountid>:all/things

输出:

错误:

InvalidRequestException

请求的内容无效。

ResourceNotFoundException

指定的资源不存在。

LimitExceededException

已超出限制。

VersionConflictException

传递到命令的事物版本不同于使用 --version 参数指定的版本时,将引发异常。

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

CreateSecurityProfile

创建 Device Defender 安全配置文件。

摘要:

aws iot create-security-profile \ --security-profile-name <value> \ [--security-profile-description <value>] \ [--behaviors <value>] \ [--alert-targets <value>] \ [--additional-metrics-to-retain <value>] \ [--tags <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式:

{ "securityProfileName": "string", "securityProfileDescription": "string", "behaviors": [ { "name": "string", "metric": "string", "criteria": { "comparisonOperator": "string", "value": { "count": "long", "cidrs": [ "string" ], "ports": [ "integer" ] }, "durationSeconds": "integer", "consecutiveDatapointsToAlarm": "integer", "consecutiveDatapointsToClear": "integer", "statisticalThreshold": { "statistic": "string" } } } ], "alertTargets": { "string": { "alertTargetArn": "string", "roleArn": "string" } }, "additionalMetricsToRetain": [ "string" ], "tags": [ { "Key": "string", "Value": "string" } ] }

cli-input-json 字段:

名称

类型

描述

securityProfileName

string

最大长度:128,最小长度:1

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

为安全配置文件指定的名称。

securityProfileDescription

string

最大长度:1000

模式:[\\p {Graph}]*

安全配置文件的描述。

behaviors

List

成员:Behavior

指定行为,设备(事物)在违反此行为时会引发提醒。

name

string

最大长度:128,最小长度:1

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

为行为指定的名称。

metric

string

行为评估的内容。

criteria

BehaviorCriteria

确定设备与 metric 相关的行为是否正常的标准。

comparisonOperator

string

将评估的事物 (metric) 与标准(包含 valuestatisticalThreshold)关联在一起的运算符。

枚举:less-than | less-than-equals | greater-than | greater-than-equals | in-cidr-set | not-in-cidr-set | in-port-set | not-in-port-set

value

MetricValue

metric 进行比较的值。

count

Long

范围 - 最小值:0

如果 comparisonOperator 调用的是数字值,请使用此参数指定要与 metric 比较的数字值。

cidrs

List

成员:Cidr

如果 comparisonOperator 调用的是一组 CIDR,请使用此参数指定要与 metric 比较的一组 CIDR。

ports

List

成员:Port

如果 comparisonOperator 调用的是一组端口,请使用此参数指定要与 metric 比较的一组端口。

durationSeconds

integer

使用此参数为具有时间维度的条件(例如,NUM_MESSAGES_SENT)指定评估行为的持续时间。对于 statisticalThreshhold 指标比较,所有设备的测量值在用于计算百分位数之前会在该持续时间内累积,之后,单个设备的测量值也会在给定百分位数排名之前在该持续时间内累积。

consecutiveDatapointsToAlarm

integer

范围 - 最大值:10,最小值:1

如果设备在指定数量的连续数据点违反了行为,则会发出警报。如果未指定,默认值为 1。

consecutiveDatapointsToClear

integer

范围 - 最大值:10,最小值:1

如果发出警报后,违规设备不再违反指定数量的连续数据点的行为,则警报将被解除。如果未指定,默认值为 1。

statisticalThreshold

StatisticalThreshold

统计排名(百分位数),指示一个阈值,通过该阈值可以确定是符合行为还是违反了行为。

statistic

string

模式:(p0|p0.1|p0.01|p1|p10|p50|p90|p99|p99.9|p99.99|p100)

百分位数,解析为一个阈值,通过该阈值可以确定行是否合规。在指定的时间段内 (durationSeconds) 从账户中所有报告设备收集指标,并计算统计排名。然后,在同一时间段内收集设备的测量值。如果设备的累积测量值高于或低于 (comparisonOperator) 与指定百分位数关联的值,则认为设备符合行为。否则,认为发生了违规情况。

alertTargets

Map

指定提醒所发送到的目标位置。(提醒始终发送到控制台。) 当设备(事物)违反行为时会生成提醒。

alertTargetArn

string

提醒要发送到的通知目标的 ARN。

roleArn

string

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

可授权向通知目标发送提醒的角色的 ARN。

additionalMetricsToRetain

List

成员:BehaviorMetric

保留(存储)其数据的指标的列表。默认情况下,将为配置文件的 behaviors 中使用的任何指标保留数据,也将为此处指定的任何指标保留数据。

tags

List

成员:Tag

java 类:java.util.List

可用于管理安全配置文件的元数据。

Key

string

标签的键。

Value

string

标签的值。

输出:

{ "securityProfileName": "string", "securityProfileArn": "string" }

CLI 输出字段:

名称

类型

描述

securityProfileName

string

最大长度:128,最小长度:1

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

为安全配置文件指定的名称。

securityProfileArn

string

安全配置文件的 ARN。

错误:

InvalidRequestException

请求的内容无效。

ResourceAlreadyExistsException

该资源已存在。

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

DeleteSecurityProfile

删除 Device Defender 安全配置文件。

摘要:

aws iot delete-security-profile \ --security-profile-name <value> \ [--expected-version <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式:

{ "securityProfileName": "string", "expectedVersion": "long" }

cli-input-json 字段:

名称

类型

描述

securityProfileName

string

最大长度:128,最小长度:1

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

要删除的安全配置文件的名称。

expectedVersion

Long

安全配置文件的预期版本。安全配置文件每次更新时都会生成新的版本。如果您指定的值不同于实际版本,则会引发 VersionConflictException

输出:

错误:

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

VersionConflictException

传递到命令的事物版本不同于使用 --version 参数指定的版本时,将引发异常。

DescribeSecurityProfile

获取有关 Device Defender 安全配置文件的信息。

摘要:

aws iot describe-security-profile \ --security-profile-name <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式:

{ "securityProfileName": "string" }

cli-input-json 字段:

名称

类型

描述

securityProfileName

string

最大长度:128,最小长度:1

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

要获取其信息的安全配置文件的名称。

输出:

{ "securityProfileName": "string", "securityProfileArn": "string", "securityProfileDescription": "string", "behaviors": [ { "name": "string", "metric": "string", "criteria": { "comparisonOperator": "string", "value": { "count": "long", "cidrs": [ "string" ], "ports": [ "integer" ] }, "durationSeconds": "integer", "consecutiveDatapointsToAlarm": "integer", "consecutiveDatapointsToClear": "integer", "statisticalThreshold": { "statistic": "string" } } } ], "alertTargets": { "string": { "alertTargetArn": "string", "roleArn": "string" } }, "additionalMetricsToRetain": [ "string" ], "version": "long", "creationDate": "timestamp", "lastModifiedDate": "timestamp" }

CLI 输出字段:

名称

类型

描述

securityProfileName

string

最大长度:128,最小长度:1

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

安全配置文件的名称。

securityProfileArn

string

安全配置文件的 ARN。

securityProfileDescription

string

最大长度:1000

模式:[\\p {Graph}]*

安全配置文件的描述(安全配置文件在创建或更新时与之关联)。

behaviors

List

成员:Behavior

指定行为,设备(事物)在违反此行为时会引发提醒。

name

string

最大长度:128,最小长度:1

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

为行为指定的名称。

metric

string

行为评估的内容。

criteria

BehaviorCriteria

确定设备与 metric 相关的行为是否正常的标准。

comparisonOperator

string

将评估的事物 (metric) 与标准(包含 valuestatisticalThreshold)关联在一起的运算符。

枚举:less-than | less-than-equals | greater-than | greater-than-equals | in-cidr-set | not-in-cidr-set | in-port-set | not-in-port-set

value

MetricValue

metric 进行比较的值。

count

Long

范围 - 最小值:0

如果 comparisonOperator 调用的是数字值,请使用此参数指定要与 metric 比较的数字值。

cidrs

List

成员:Cidr

如果 comparisonOperator 调用的是一组 CIDR,请使用此参数指定要与 metric 比较的一组 CIDR。

ports

List

成员:Port

如果 comparisonOperator 调用的是一组端口,请使用此参数指定要与 metric 比较的一组端口。

durationSeconds

integer

使用此参数为具有时间维度的条件(例如,NUM_MESSAGES_SENT)指定评估行为的持续时间。对于 statisticalThreshhold 指标比较,所有设备的测量值在用于计算百分位数之前会在该持续时间内累积,之后,单个设备的测量值也会在给定百分位数排名之前在该持续时间内累积。

consecutiveDatapointsToAlarm

integer

范围 - 最大值:10,最小值:1

如果设备在指定数量的连续数据点违反了行为,则会发出警报。如果未指定,默认值为 1。

consecutiveDatapointsToClear

integer

范围 - 最大值:10,最小值:1

如果发出警报后,违规设备不再违反指定数量的连续数据点的行为,则警报将被解除。如果未指定,默认值为 1。

statisticalThreshold

StatisticalThreshold

统计排名(百分位数),指示一个阈值,通过该阈值可以确定是符合行为还是违反了行为。

statistic

string

模式:(p0|p0.1|p0.01|p1|p10|p50|p90|p99|p99.9|p99.99|p100)

百分位数,解析为一个阈值,通过该阈值可以确定行是否合规。在指定的时间段内 (durationSeconds) 从账户中所有报告设备收集指标,并计算统计排名。然后,在同一时间段内收集设备的测量值。如果设备的累积测量值高于或低于 (comparisonOperator) 与指定百分位数关联的值,则认为设备符合行为。否则,认为发生了违规情况。

alertTargets

Map

提醒发送到的位置。(提醒始终发送到控制台。)

alertTargetArn

string

提醒要发送到的通知目标的 ARN。

roleArn

string

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

可授权向通知目标发送提醒的角色的 ARN。

additionalMetricsToRetain

List

成员:BehaviorMetric

保留(存储)其数据的指标的列表。默认情况下,将为配置文件的 behaviors 中使用的任何指标保留数据,也将为此处指定的任何指标保留数据。

version

Long

安全配置文件的版本。安全配置文件每次更新时都会生成新的版本。

creationDate

timestamp

安全配置文件创建的时间。

lastModifiedDate

timestamp

安全配置文件的上次修改时间。

错误:

InvalidRequestException

请求的内容无效。

ResourceNotFoundException

指定的资源不存在。

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

DetachSecurityProfile

将 Device Defender 安全配置文件与事物组或此账户取消关联。

摘要:

aws iot detach-security-profile \ --security-profile-name <value> \ --security-profile-target-arn <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式:

{ "securityProfileName": "string", "securityProfileTargetArn": "string" }

cli-input-json 字段:

名称

类型

描述

securityProfileName

string

最大长度:128,最小长度:1

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

已分离的安全配置文件。

securityProfileTargetArn

string

安全配置文件已与之分离的事物组的 ARN。

输出:

错误:

InvalidRequestException

请求的内容无效。

ResourceNotFoundException

指定的资源不存在。

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

ListActiveViolations

列出指定 Device Defender 安全配置文件的活跃违规项。

摘要:

aws iot list-active-violations \ [--thing-name <value>] \ [--security-profile-name <value>] \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式:

{ "thingName": "string", "securityProfileName": "string", "nextToken": "string", "maxResults": "integer" }

cli-input-json 字段:

名称

类型

描述

thingName

string

最大长度:128,最小长度:1

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

列出其活跃违规项的事物的名称。

securityProfileName

string

最大长度:128,最小长度:1

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

列出其违规项的 Device Defender 安全配置文件的名称。

nextToken

string

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

maxResults

integer

范围 - 最大值:250,最小值:1

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

输出:

{ "activeViolations": [ { "violationId": "string", "thingName": "string", "securityProfileName": "string", "behavior": { "name": "string", "metric": "string", "criteria": { "comparisonOperator": "string", "value": { "count": "long", "cidrs": [ "string" ], "ports": [ "integer" ] }, "durationSeconds": "integer", "consecutiveDatapointsToAlarm": "integer", "consecutiveDatapointsToClear": "integer", "statisticalThreshold": { "statistic": "string" } } }, "lastViolationValue": { "count": "long", "cidrs": [ "string" ], "ports": [ "integer" ] }, "lastViolationTime": "timestamp", "violationStartTime": "timestamp" } ], "nextToken": "string" }

CLI 输出字段:

名称

类型

描述

activeViolations

List

成员:ActiveViolation

活跃违规项列表。

violationId

string

最大长度:128,最小长度:1

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

活跃违规项的 ID。

thingName

string

最大长度:128,最小长度:1

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

造成活跃违规的事物的名称。

securityProfileName

string

最大长度:128,最小长度:1

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

其行为属于违规的安全配置文件。

behavior

Behavior

违反的行为。

name

string

最大长度:128,最小长度:1

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

为行为指定的名称。

metric

string

行为评估的内容。

criteria

BehaviorCriteria

确定设备与 metric 相关的行为是否正常的标准。

comparisonOperator

string

将评估的事物 (metric) 与标准(包含 valuestatisticalThreshold)关联在一起的运算符。

枚举:less-than | less-than-equals | greater-than | greater-than-equals | in-cidr-set | not-in-cidr-set | in-port-set | not-in-port-set

value

MetricValue

metric 进行比较的值。

count

Long

范围 - 最小值:0

如果 comparisonOperator 调用的是数字值,请使用此参数指定要与 metric 比较的数字值。

cidrs

List

成员:Cidr

如果 comparisonOperator 调用的是一组 CIDR,请使用此参数指定要与 metric 比较的一组 CIDR。

ports

List

成员:Port

如果 comparisonOperator 调用的是一组端口,请使用此参数指定要与 metric 比较的一组端口。

durationSeconds

integer

使用此参数为具有时间维度的条件(例如,NUM_MESSAGES_SENT)指定评估行为的持续时间。对于 statisticalThreshhold 指标比较,所有设备的测量值在用于计算百分位数之前会在该持续时间内累积,之后,单个设备的测量值也会在给定百分位数排名之前在该持续时间内累积。

consecutiveDatapointsToAlarm

integer

范围 - 最大值:10,最小值:1

如果设备在指定数量的连续数据点违反了行为,则会发出警报。如果未指定,默认值为 1。

consecutiveDatapointsToClear

integer

范围 - 最大值:10,最小值:1

如果发出警报后,违规设备不再违反指定数量的连续数据点的行为,则警报将被解除。如果未指定,默认值为 1。

statisticalThreshold

StatisticalThreshold

统计排名(百分位数),指示一个阈值,通过该阈值可以确定是符合行为还是违反了行为。

statistic

string

模式:(p0|p0.1|p0.01|p1|p10|p50|p90|p99|p99.9|p99.99|p100)

百分位数,解析为一个阈值,通过该阈值可以确定行为是否合规。在指定的时间段内 (durationSeconds) 从账户中所有报告设备收集指标,并计算统计排名。然后,在同一时间段内收集设备的测量值。如果设备的累积测量值高于或低于 (comparisonOperator) 与指定百分位数关联的值,则认为设备符合行为。否则,认为发生了违规情况。

lastViolationValue

MetricValue

造成最新违规事件的指标的值(测量值)。

count

Long

范围 - 最小值:0

如果 comparisonOperator 调用的是数字值,请使用此参数指定要与 metric 比较的数字值。

cidrs

List

成员:Cidr

如果 comparisonOperator 调用的是一组 CIDR,请使用此参数指定要与 metric 比较的一组 CIDR。

ports

List

成员:Port

如果 comparisonOperator 调用的是一组端口,请使用此参数指定要与 metric 比较的一组端口。

lastViolationTime

timestamp

最新违规事件发生的时间。

violationStartTime

timestamp

违规事件开始的时间。

nextToken

string

用于检索下一组结果的令牌,没有更多结果时为 null

错误:

InvalidRequestException

请求的内容无效。

ResourceNotFoundException

指定的资源不存在。

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

ListSecurityProfiles

列出创建的 Device Defender 安全配置文件。您可以使用筛选条件仅列出与事物组关联的安全配置文件,也可以仅列出与账户关联的安全配置文件。

摘要:

aws iot list-security-profiles \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式:

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

cli-input-json 字段:

名称

类型

描述

nextToken

string

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

maxResults

integer

范围 - 最大值:250,最小值:1

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

输出:

{ "securityProfileIdentifiers": [ { "name": "string", "arn": "string" } ], "nextToken": "string" }

CLI 输出字段:

名称

类型

描述

securityProfileIdentifiers

List

成员:SecurityProfileIdentifier

java 类:java.util.List

安全配置文件标识符(名称和 ARN)的列表。

name

string

最大长度:128,最小长度:1

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

为安全配置文件指定的名称。

arn

string

安全配置文件的 ARN。

nextToken

string

用于检索下一组结果的令牌,没有更多结果时为 null

错误:

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

ListSecurityProfilesForTarget

列出附加到目标(事物组)的 Device Defender 安全配置文件。

摘要:

aws iot list-security-profiles-for-target \ [--next-token <value>] \ [--max-results <value>] \ [--recursive | --no-recursive] \ --security-profile-target-arn <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式:

{ "nextToken": "string", "maxResults": "integer", "recursive": "boolean", "securityProfileTargetArn": "string" }

cli-input-json 字段:

名称

类型

描述

nextToken

string

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

maxResults

integer

范围 - 最大值:250,最小值:1

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

recursive

boolean

如果为 True,则还会返回子组。

securityProfileTargetArn

string

要获取其已附加安全配置文件的目标(事物组)的 ARN。

输出:

{ "securityProfileTargetMappings": [ { "securityProfileIdentifier": { "name": "string", "arn": "string" }, "target": { "arn": "string" } } ], "nextToken": "string" }

CLI 输出字段:

名称

类型

描述

securityProfileTargetMappings

List

成员:SecurityProfileTargetMapping

java 类:java.util.List

安全配置文件及其关联目标的列表。

securityProfileIdentifier

SecurityProfileIdentifier

用于标识安全配置文件的信息。

name

string

最大长度:128,最小长度:1

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

为安全配置文件指定的名称。

arn

string

安全配置文件的 ARN。

target

SecurityProfileTarget

与安全配置文件关联的目标(事物组)的相关信息。

arn

string

安全配置文件的 ARN。

nextToken

string

用于检索下一组结果的令牌,没有更多结果时为 null

错误:

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

ResourceNotFoundException

指定的资源不存在。

ListTargetsForSecurityProfile

列出与指定 Device Defender 安全配置文件关联的目标(事物组)。

摘要:

aws iot list-targets-for-security-profile \ --security-profile-name <value> \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式:

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

cli-input-json 字段:

名称

类型

描述

securityProfileName

string

最大长度:128,最小长度:1

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

安全配置文件。

nextToken

string

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

maxResults

integer

范围 - 最大值:250,最小值:1

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

输出:

{ "securityProfileTargets": [ { "arn": "string" } ], "nextToken": "string" }

CLI 输出字段:

名称

类型

描述

securityProfileTargets

list

成员:SecurityProfileTarget

java 类:java.util.List

安全配置文件所附加到的事物组。

arn

string

安全配置文件的 ARN。

nextToken

string

用于检索下一组结果的令牌,没有更多结果时为 null

错误:

InvalidRequestException

请求的内容无效。

ResourceNotFoundException

指定的资源不存在。

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

ListViolationEvents

列出在指定时间段内发现的 Device Defender 安全配置文件违规事件。可以使用筛选条件将结果限定为针对特定安全配置文件、行为或事物(设备)发出的提醒。

摘要:

aws iot list-violation-events \ --start-time <value> \ --end-time <value> \ [--thing-name <value>] \ [--security-profile-name <value>] \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式:

{ "startTime": "timestamp", "endTime": "timestamp", "thingName": "string", "securityProfileName": "string", "nextToken": "string", "maxResults": "integer" }

cli-input-json 字段:

名称

类型

描述

startTime

timestamp

列出提醒的开始时间。

endTime

timestamp

列出提醒的结束时间。

thingName

string

最大长度:128,最小长度:1

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

筛选条件,用于将结果限定为由特定事物引发的提醒。

securityProfileName

string

最大长度:128,最小长度:1

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

筛选条件,用于将结果限定为由特定安全配置文件引发的提醒。

nextToken

string

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

maxResults

integer

范围 - 最大值:250,最小值:1

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

输出:

{ "violationEvents": [ { "violationId": "string", "thingName": "string", "securityProfileName": "string", "behavior": { "name": "string", "metric": "string", "criteria": { "comparisonOperator": "string", "value": { "count": "long", "cidrs": [ "string" ], "ports": [ "integer" ] }, "durationSeconds": "integer", "consecutiveDatapointsToAlarm": "integer", "consecutiveDatapointsToClear": "integer", "statisticalThreshold": { "statistic": "string" } } }, "metricValue": { "count": "long", "cidrs": [ "string" ], "ports": [ "integer" ] }, "violationEventType": "string", "violationEventTime": "timestamp" } ], "nextToken": "string" }

CLI 输出字段:

名称

类型

描述

violationEvents

list

成员:ViolationEvent

在指定时间范围内针对此账户发出的安全配置文件违规提醒,可能按安全配置文件、违反的行为或事物(设备)违规进行筛选。

violationId

string

最大长度:128,最小长度:1

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

违规事件的 ID。

thingName

string

最大长度:128,最小长度:1

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

造成违规事件的事物的名称。

securityProfileName

string

最大长度:128,最小长度:1

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

存在违规行为的安全配置文件的名称。

behavior

Behavior

违反的行为。

name

string

最大长度:128,最小长度:1

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

为行为指定的名称。

metric

string

行为评估的内容。

criteria

BehaviorCriteria

确定设备与 metric 相关的行为是否正常的标准。

comparisonOperator

string

将评估的事物 (metric) 与标准(包含 valuestatisticalThreshold)关联在一起的运算符。

枚举:less-than | less-than-equals | greater-than | greater-than-equals | in-cidr-set | not-in-cidr-set | in-port-set | not-in-port-set

value

MetricValue

metric 进行比较的值。

count

Long

范围 - 最小值:0

如果 comparisonOperator 调用的是数字值,请使用此参数指定要与 metric 比较的数字值。

cidrs

list

成员:Cidr

如果 comparisonOperator 调用的是一组 CIDR,请使用此参数指定要与 metric 比较的一组 CIDR。

ports

list

成员:Port

如果 comparisonOperator 调用的是一组端口,请使用此参数指定要与 metric 比较的一组端口。

durationSeconds

integer

使用此参数为具有时间维度的条件(例如,NUM_MESSAGES_SENT)指定评估行为的持续时间。对于 statisticalThreshhold 指标比较,所有设备的测量值在用于计算百分位数之前会在该持续时间内累积,之后,单个设备的测量值也会在给定百分位数排名之前在该持续时间内累积。

consecutiveDatapointsToAlarm

integer

范围 - 最大值:10,最小值:1

如果设备在指定数量的连续数据点违反了行为,则会发出警报。如果未指定,默认值为 1。

consecutiveDatapointsToClear

integer

范围 - 最大值:10,最小值:1

如果发出警报后,违规设备不再违反指定数量的连续数据点的行为,则警报将被解除。如果未指定,默认值为 1。

statisticalThreshold

StatisticalThreshold

统计排名(百分位数),指示一个阈值,通过该阈值可以确定是符合行为还是违反了行为。

statistic

string

模式:(p0|p0.1|p0.01|p1|p10|p50|p90|p99|p99.9|p99.99|p100)

百分位数,解析为一个阈值,通过该阈值可以确定行是否合规。在指定的时间段内 (durationSeconds) 从账户中所有报告设备收集指标,并计算统计排名。然后,在同一时间段内收集设备的测量值。如果设备的累积测量值高于或低于 (comparisonOperator) 与指定百分位数关联的值,则认为设备符合行为。否则,认为发生了违规情况。

metricValue

MetricValue

指标(测量)的值。

count

Long

范围 - 最小值:0

如果 comparisonOperator 调用的是数字值,请使用此参数指定要与 metric 比较的数字值。

cidrs

list

成员:Cidr

如果 comparisonOperator 调用的是一组 CIDR,请使用此参数指定要与 metric 比较的一组 CIDR。

ports

list

成员:Port

如果 comparisonOperator 调用的是一组端口,请使用此参数指定要与 metric 比较的一组端口。

violationEventType

string

违规事件的类型。

枚举:in-alarm | alarm-cleared | alarm-invalidated

violationEventTime

timestamp

违规事件发生的时间。

nextToken

string

用于检索下一组结果的令牌,没有更多结果时为 null

错误:

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

UpdateSecurityProfile

更新 Device Defender 安全配置文件。

摘要:

aws iot update-security-profile \ --security-profile-name <value> \ [--security-profile-description <value>] \ [--behaviors <value>] \ [--alert-targets <value>] \ [--additional-metrics-to-retain <value>] \ [--delete-behaviors | --no-delete-behaviors] \ [--delete-alert-targets | --no-delete-alert-targets] \ [--delete-additional-metrics-to-retain | --no-delete-additional-metrics-to-retain] \ [--expected-version <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式:

{ "securityProfileName": "string", "securityProfileDescription": "string", "behaviors": [ { "name": "string", "metric": "string", "criteria": { "comparisonOperator": "string", "value": { "count": "long", "cidrs": [ "string" ], "ports": [ "integer" ] }, "durationSeconds": "integer", "consecutiveDatapointsToAlarm": "integer", "consecutiveDatapointsToClear": "integer", "statisticalThreshold": { "statistic": "string" } } } ], "alertTargets": { "string": { "alertTargetArn": "string", "roleArn": "string" } }, "additionalMetricsToRetain": [ "string" ], "deleteBehaviors": "boolean", "deleteAlertTargets": "boolean", "deleteAdditionalMetricsToRetain": "boolean", "expectedVersion": "long" }

cli-input-json 字段:

名称

类型

描述

securityProfileName

string

最大长度:128,最小长度:1

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

要更新的安全配置文件的名称。

securityProfileDescription

string

最大长度:1000

模式:[\\p {Graph}]*

安全配置文件的描述。

behaviors

list

成员:Behavior

指定行为,设备(事物)在违反此行为时会引发提醒。

name

string

最大长度:128,最小长度:1

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

为行为指定的名称。

metric

string

行为评估的内容。

criteria

BehaviorCriteria

确定设备与 metric 相关的行为是否正常的标准。

comparisonOperator

string

将评估的事物 (metric) 与标准(包含 valuestatisticalThreshold)关联在一起的运算符。

枚举:less-than | less-than-equals | greater-than | greater-than-equals | in-cidr-set | not-in-cidr-set | in-port-set | not-in-port-set

value

MetricValue

metric 进行比较的值。

count

Long

范围 - 最小值:0

如果 comparisonOperator 调用的是数字值,请使用此参数指定要与 metric 比较的数字值。

cidrs

list

成员:Cidr

如果 comparisonOperator 调用的是一组 CIDR,请使用此参数指定要与 metric 比较的一组 CIDR。

ports

list

成员:Port

如果 comparisonOperator 调用的是一组端口,请使用此参数指定要与 metric 比较的一组端口。

durationSeconds

integer

使用此参数为具有时间维度的条件(例如,NUM_MESSAGES_SENT)指定评估行为的持续时间。对于 statisticalThreshhold 指标比较,所有设备的测量值在用于计算百分位数之前会在该持续时间内累积,之后,单个设备的测量值也会在给定百分位数排名之前在该持续时间内累积。

consecutiveDatapointsToAlarm

integer

范围 - 最大值:10,最小值:1

如果设备在指定数量的连续数据点违反了行为,则会发出警报。如果未指定,默认值为 1。

consecutiveDatapointsToClear

integer

范围 - 最大值:10,最小值:1

如果发出警报后,违规设备不再违反指定数量的连续数据点的行为,则警报将被解除。如果未指定,默认值为 1。

statisticalThreshold

StatisticalThreshold

统计排名(百分位数),指示一个阈值,通过该阈值可以确定是符合行为还是违反了行为。

statistic

string

模式:(p0|p0.1|p0.01|p1|p10|p50|p90|p99|p99.9|p99.99|p100)

百分位数,解析为一个阈值,通过该阈值可以确定行是否合规。在指定的时间段内 (durationSeconds) 从账户中所有报告设备收集指标,并计算统计排名。然后,在同一时间段内收集设备的测量值。如果设备的累积测量值高于或低于 (comparisonOperator) 与指定百分位数关联的值,则认为设备符合行为。否则,认为发生了违规情况。

alertTargets

Map

提醒发送到的位置。(提醒始终发送到控制台。)

alertTargetArn

string

提醒要发送到的通知目标的 ARN。

roleArn

string

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

可授权向通知目标发送提醒的角色的 ARN。

additionalMetricsToRetain

list

成员:BehaviorMetric

保留(存储)其数据的指标的列表。默认情况下,将为配置文件的 behaviors 中使用的任何指标保留数据,也将为此处指定的任何指标保留数据。

deleteBehaviors

boolean

如果为 True,则删除为该安全配置文件定义的所有 behaviors。如果在当前调用中定义任何 behaviors,则会发生异常。

deleteAlertTargets

boolean

如果为 True,则删除为该安全配置文件定义的所有 alertTargets。如果在当前调用中定义任何 alertTargets,则会发生异常。

deleteAdditionalMetricsToRetain

boolean

如果为 True,则删除为该安全配置文件定义的所有 additionalMetricsToRetain。如果在当前调用中定义任何 additionalMetricsToRetain,则会发生异常。

expectedVersion

Long

安全配置文件的预期版本。安全配置文件每次更新时都会生成新的版本。如果您指定的值不同于实际版本,则会引发 VersionConflictException

输出:

{ "securityProfileName": "string", "securityProfileArn": "string", "securityProfileDescription": "string", "behaviors": [ { "name": "string", "metric": "string", "criteria": { "comparisonOperator": "string", "value": { "count": "long", "cidrs": [ "string" ], "ports": [ "integer" ] }, "durationSeconds": "integer", "consecutiveDatapointsToAlarm": "integer", "consecutiveDatapointsToClear": "integer", "statisticalThreshold": { "statistic": "string" } } } ], "alertTargets": { "string": { "alertTargetArn": "string", "roleArn": "string" } }, "additionalMetricsToRetain": [ "string" ], "version": "long", "creationDate": "timestamp", "lastModifiedDate": "timestamp" }

CLI 输出字段:

名称

类型

描述

securityProfileName

string

最大长度:128,最小长度:1

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

已更新的安全配置文件的名称。

securityProfileArn

string

已更新的安全配置文件的 ARN。

securityProfileDescription

string

最大长度:1000

模式:[\\p {Graph}]*

安全配置文件的描述。

behaviors

list

成员:Behavior

指定行为,设备(事物)在违反此行为时会引发提醒。

name

string

最大长度:128,最小长度:1

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

为行为指定的名称。

metric

string

行为评估的内容。

criteria

BehaviorCriteria

确定设备与 metric 相关的行为是否正常的标准。

comparisonOperator

string

将评估的事物 (metric) 与标准(包含 valuestatisticalThreshold)关联在一起的运算符。

枚举:less-than | less-than-equals | greater-than | greater-than-equals | in-cidr-set | not-in-cidr-set | in-port-set | not-in-port-set

value

MetricValue

metric 进行比较的值。

count

Long

范围 - 最小值:0

如果 comparisonOperator 调用的是数字值,请使用此参数指定要与 metric 比较的数字值。

cidrs

list

成员:Cidr

如果 comparisonOperator 调用的是一组 CIDR,请使用此参数指定要与 metric 比较的一组 CIDR。

ports

list

成员:Port

如果 comparisonOperator 调用的是一组端口,请使用此参数指定要与 metric 比较的一组端口。

durationSeconds

integer

使用此参数为具有时间维度的条件(例如,NUM_MESSAGES_SENT)指定评估行为的持续时间。对于 statisticalThreshhold 指标比较,所有设备的测量值在用于计算百分位数之前会在该持续时间内累积,之后,单个设备的测量值也会在给定百分位数排名之前在该持续时间内累积。

consecutiveDatapointsToAlarm

integer

范围 - 最大值:10,最小值:1

如果设备在指定数量的连续数据点违反了行为,则会发出警报。如果未指定,默认值为 1。

consecutiveDatapointsToClear

integer

范围 - 最大值:10,最小值:1

如果发出警报后,违规设备不再违反指定数量的连续数据点的行为,则警报将被解除。如果未指定,默认值为 1。

statisticalThreshold

StatisticalThreshold

统计排名(百分位数),指示一个阈值,通过该阈值可以确定是符合行为还是违反了行为。

statistic

string

模式:(p0|p0.1|p0.01|p1|p10|p50|p90|p99|p99.9|p99.99|p100)

百分位数,解析为一个阈值,通过该阈值可以确定行是否合规。在指定的时间段内 (durationSeconds) 从账户中所有报告设备收集指标,并计算统计排名。然后,在同一时间段内收集设备的测量值。如果设备的累积测量值高于或低于 (comparisonOperator) 与指定百分位数关联的值,则认为设备符合行为。否则,认为发生了违规情况。

alertTargets

Map

提醒发送到的位置。(提醒始终发送到控制台。)

alertTargetArn

string

提醒要发送到的通知目标的 ARN。

roleArn

string

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

可授权向通知目标发送提醒的角色的 ARN。

additionalMetricsToRetain

list

成员:BehaviorMetric

保留(存储)其数据的指标的列表。默认情况下,将为安全配置文件的 behaviors 中使用的任何指标保留数据,也将为此处指定的任何指标保留数据。

version

Long

安全配置文件的更新版本。

creationDate

timestamp

安全配置文件创建的时间。

lastModifiedDate

timestamp

安全配置文件的上次修改时间。

错误:

InvalidRequestException

请求的内容无效。

ResourceNotFoundException

指定的资源不存在。

VersionConflictException

传递到命令的事物版本不同于使用 --version 参数指定的版本时,将引发异常。

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

ValidateSecurityProfileBehaviors

验证 Device Defender 安全配置文件行为规范。

摘要:

aws iot validate-security-profile-behaviors \ --behaviors <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式:

{ "behaviors": [ { "name": "string", "metric": "string", "criteria": { "comparisonOperator": "string", "value": { "count": "long", "cidrs": [ "string" ], "ports": [ "integer" ] }, "durationSeconds": "integer", "consecutiveDatapointsToAlarm": "integer", "consecutiveDatapointsToClear": "integer", "statisticalThreshold": { "statistic": "string" } } } ] }

cli-input-json 字段:

名称

类型

描述

behaviors

list

成员:Behavior

指定行为,设备(事物)在违反此行为时会引发提醒。

name

string

最大长度:128,最小长度:1

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

为行为指定的名称。

metric

string

行为评估的内容。

criteria

BehaviorCriteria

确定设备与 metric 相关的行为是否正常的标准。

comparisonOperator

string

将评估的事物 (metric) 与标准(包含 valuestatisticalThreshold)关联在一起的运算符。

枚举:less-than | less-than-equals | greater-than | greater-than-equals | in-cidr-set | not-in-cidr-set | in-port-set | not-in-port-set

value

MetricValue

metric 进行比较的值。

count

Long

范围 - 最小值:0

如果 comparisonOperator 调用的是数字值,请使用此参数指定要与 metric 比较的数字值。

cidrs

list

成员:Cidr

如果 comparisonOperator 调用的是一组 CIDR,请使用此参数指定要与 metric 比较的一组 CIDR。

ports

list

成员:Port

如果 comparisonOperator 调用的是一组端口,请使用此参数指定要与 metric 比较的一组端口。

durationSeconds

integer

使用此参数为具有时间维度的条件(例如,NUM_MESSAGES_SENT)指定评估行为的持续时间。对于 statisticalThreshhold 指标比较,所有设备的测量值在用于计算百分位数之前会在该持续时间内累积,之后,单个设备的测量值也会在给定百分位数排名之前在该持续时间内累积。

consecutiveDatapointsToAlarm

integer

范围 - 最大值:10,最小值:1

如果设备在指定数量的连续数据点违反了行为,则会发出警报。如果未指定,默认值为 1。

consecutiveDatapointsToClear

integer

范围 - 最大值:10,最小值:1

如果发出警报后,违规设备不再违反指定数量的连续数据点的行为,则警报将被解除。如果未指定,默认值为 1。

statisticalThreshold

StatisticalThreshold

统计排名(百分位数),指示一个阈值,通过该阈值可以确定是符合行为还是违反了行为。

statistic

string

模式:(p0|p0.1|p0.01|p1|p10|p50|p90|p99|p99.9|p99.99|p100)

百分位数,解析为一个阈值,通过该阈值可以确定行是否合规。在指定的时间段内 (durationSeconds) 从账户中所有报告设备收集指标,并计算统计排名。然后,在同一时间段内收集设备的测量值。如果设备的累积测量值高于或低于 (comparisonOperator) 与指定百分位数关联的值,则认为设备符合行为。否则,认为发生了违规情况。

输出:

{ "valid": "boolean", "validationErrors": [ { "errorMessage": "string" } ] }

CLI 输出字段:

名称

类型

描述

valid

boolean

如果行为有效,则为 True。

validationErrors

list

成员:ValidationError

在行为中发现的所有错误的列表。

errorMessage

string

最大长度:2048

在行为中发现的某错误的描述。

错误:

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。