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

IOT 命令

本章包含以下部分:

AcceptCertificateTransfer

接受待处理证书传输。证书的默认状态为“INACTIVE”。

要检查待处理证书传输,请调用 ListCertificates 以枚举证书。

摘要

aws iot accept-certificate-transfer \ --certificate-id <value> \ [--set-as-active | --no-set-as-active] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "certificateId": "string", "setAsActive": "boolean" }

cli-input-json 字段

名称

类型

描述

certificateId

字符串

最大长度:64,最小长度:64

模式:(0x)?[a-fA-F0-9]+

证书的 ID。(证书 ARN 的最后一部分包含证书 ID。)

setAsActive

布尔值

指定证书是否活动。

输出

错误

ResourceNotFoundException

指定的资源不存在。

TransferAlreadyCompletedException

由于传输已完成,您无法还原证书传输。

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。

AddThingToBillingGroup

将事物添加到账单组。

摘要

aws iot add-thing-to-billing-group \ [--billing-group-name <value>] \ [--billing-group-arn <value>] \ [--thing-name <value>] \ [--thing-arn <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "billingGroupName": "string", "billingGroupArn": "string", "thingName": "string", "thingArn": "string" }

cli-input-json 字段

名称

类型

描述

billingGroupName

字符串

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

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

账单组的名称。

billingGroupArn

字符串

账单组的 ARN。

thingName

字符串

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

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

要添加到账单组的事物的名称。

thingArn

字符串

要添加到账单组的事物的 ARN。

输出

错误

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

ResourceNotFoundException

指定的资源不存在。

AddThingToThingGroup

将事物添加到事物组。

摘要

aws iot add-thing-to-thing-group \ [--thing-group-name <value>] \ [--thing-group-arn <value>] \ [--thing-name <value>] \ [--thing-arn <value>] \ [--override-dynamic-groups | --no-override-dynamic-groups] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "thingGroupName": "string", "thingGroupArn": "string", "thingName": "string", "thingArn": "string", "overrideDynamicGroups": "boolean" }

cli-input-json 字段

名称

类型

描述

thingGroupName

字符串

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

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

正在将事物添加到的组的名称。

thingGroupArn

字符串

将要添加事物的组 ARN。

thingName

字符串

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

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

要添加到组中的事物的名称。

thingArn

字符串

要添加到组中的事物的 ARN。

overrideDynamicGroups

布尔值

在达到 10 个组限制时,使用静态事物组覆盖动态事物组。如果一个事物属于 10 个事物组,并且其中一个或多个组是动态事物组,则将一个事物添加到静态组会导致从最后一个动态组删除该事物。

输出

错误

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

ResourceNotFoundException

指定的资源不存在。

AssociateTargetsWithJob

将组与持续任务关联。必须满足以下标准:

  • 创建任务时必须将 targetSelection 字段设置为“CONTINUOUS”。

  • 任务状态当前必须为“IN_PROGRESS”。

  • 与作业关联的目标总数不能超过 100。

摘要

aws iot associate-targets-with-job \ --targets <value> \ --job-id <value> \ [--comment <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "targets": [ "string" ], "jobId": "string", "comment": "string" }

cli-input-json 字段

名称

类型

描述

targets

list

成员:TargetArn

定义作业目标的事物组 ARN 的列表。

jobId

字符串

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

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

您在创建此作业时向其分配的唯一标识符。

comment

字符串

最大长度:2028

模式:[^\\p{C}]+

一个可选的备注字符串,用于描述为什么将任务与目标关联。

输出

{ "jobArn": "string", "jobId": "string", "description": "string" }

CLI 输出字段

名称

类型

描述

jobArn

字符串

标识作业的 ARN。

jobId

字符串

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

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

您在创建此作业时向其分配的唯一标识符。

description

字符串

最大长度:2028

模式:[^\\p{C}]+

作业的简短文本描述。

错误

InvalidRequestException

请求的内容无效。

ResourceNotFoundException

指定的资源不存在。

LimitExceededException

已超出限制。

ThrottlingException

速率超过限制。

ServiceUnavailableException

服务暂时不可用。

AttachPolicy

将策略附加到指定的目标。

摘要

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

cli-input-json 格式

{ "policyName": "string", "target": "string" }

cli-input-json 字段

名称

类型

描述

policyName

字符串

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

模式:[w+=,.@-]+

要附加的策略的名称。

target

字符串

策略附加到的身份

输出

错误

ResourceNotFoundException

指定的资源不存在。

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。

LimitExceededException

已超出限制。

AttachPrincipalPolicy

将指定的策略附加到指定的委托人 (证书或其他凭证)。

注意:此 API 已弃用。请改用 AttachPolicy。

摘要

aws iot attach-principal-policy \ --policy-name <value> \ --principal <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "policyName": "string", "principal": "string" }

cli-input-json 字段

名称

类型

描述

policyName

字符串

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

模式:[w+=,.@-]+

策略名称。

principal

字符串

委托人,可以是证书 ARN (从 CreateCertificate 操作返回) 或 Amazon Cognito ID。

输出

错误

ResourceNotFoundException

指定的资源不存在。

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。

LimitExceededException

已超出限制。

AttachSecurityProfile

将 Device Defender 安全配置文件与事物组或此账户关联。每个事物组或账户最多可关联五个安全配置文件。

摘要

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

字符串

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

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

附加的安全配置文件。

securityProfileTargetArn

字符串

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

输出

错误

InvalidRequestException

请求的内容无效。

ResourceNotFoundException

指定的资源不存在。

LimitExceededException

已超出限制。

VersionConflictException

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

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

AttachThingPrincipal

将指定的委托人附加到指定的事物。委托人可以是 X.509 证书、IAM 用户、组和角色、Amazon Cognito 身份或联合身份。

摘要

aws iot attach-thing-principal \ --thing-name <value> \ --principal <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "thingName": "string", "principal": "string" }

cli-input-json 字段

名称

类型

描述

thingName

字符串

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

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

事物的名称。

principal

字符串

委托人,例如证书或其他凭证。

输出

错误

ResourceNotFoundException

指定的资源不存在。

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。

CancelAuditTask

取消正在进行的审核。可以按计划或按需进行审核。如果审核未在进行,系统就会报告“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

字符串

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

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

要取消审核的 ID。您只能取消状态为“IN_PROGRESS”的审核。

输出

错误

ResourceNotFoundException

指定的资源不存在。

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

CancelCertificateTransfer

取消指定证书的待处理传输。

注意:只有传输源账户可以使用此操作来取消传输。(传输目标可以改为使用 RejectCertificateTransfer。) 在传输之后,AWS IoT 会将 INACTIVE 状态的证书返回到源账户。目标账户接受传输之后,无法取消传输。

取消证书传输之后,证书的状态从 PENDING_TRANSFER 更改为 INACTIVE。

摘要

aws iot cancel-certificate-transfer \ --certificate-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "certificateId": "string" }

cli-input-json 字段

名称

类型

描述

certificateId

字符串

最大长度:64,最小长度:64

模式:(0x)?[a-fA-F0-9]+

证书的 ID。(证书 ARN 的最后一部分包含证书 ID。)

输出

错误

ResourceNotFoundException

指定的资源不存在。

TransferAlreadyCompletedException

由于传输已完成,您无法还原证书传输。

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。

CancelJob

取消作业。

摘要

aws iot cancel-job \ --job-id <value> \ [--reason-code <value>] \ [--comment <value>] \ [--force | --no-force] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "jobId": "string", "reasonCode": "string", "comment": "string", "force": "boolean" }

cli-input-json 字段

名称

类型

描述

jobId

字符串

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

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

您在创建此任务时向其分配的唯一标识符。

reasonCode

字符串

最大长度:128

模式:[\\p{Upper}p Digit_]+

(可选)一个原因代码字符串,说明取消作业的原因。

comment

字符串

最大长度:2028

模式:[^\\p{C}]+

一个可选的备注字符串,用于描述为什么取消任务。

force

布尔值

(可选) 如果为 true,则取消状态为“IN_PROGRESS”和“QUEUED”的任务执行,否则仅取消状态为“QUEUED”的任务执行。默认为 false

取消状态为“IN_PROGRESS”的任务将导致执行该任务的设备无法更新任务执行状态。请谨慎使用,并且确保执行已取消的任务的每个设备能够恢复到有效状态。

输出

{ "jobArn": "string", "jobId": "string", "description": "string" }

CLI 输出字段

名称

类型

描述

jobArn

字符串

作业 ARN。

jobId

字符串

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

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

您在创建此作业时向其分配的唯一标识符。

description

字符串

最大长度:2028

模式:[^\\p{C}]+

作业的简短文本描述。

错误

InvalidRequestException

请求的内容无效。

ResourceNotFoundException

指定的资源不存在。

ThrottlingException

速率超过限制。

ServiceUnavailableException

服务暂时不可用。

CancelJobExecution

取消对给定事物执行的任务。

摘要

aws iot cancel-job-execution \ --job-id <value> \ --thing-name <value> \ [--force | --no-force] \ [--expected-version <value>] \ [--status-details <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "jobId": "string", "thingName": "string", "force": "boolean", "expectedVersion": "long", "statusDetails": { "string": "string" } }

cli-input-json 字段

名称

类型

描述

jobId

字符串

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

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

要取消的任务的 ID。

thingName

字符串

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

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

将取消其作业执行的事物的名称。

force

布尔值

(可选) 如果为 true,则取消状态为 IN_PROGRESS 或 QUEUED 的任务执行,否则仅取消状态为 QUEUED 的任务执行。如果您尝试取消状态为 IN_PROGRESS 的任务执行,并且未将 force 设置为 true,则会引发 InvalidStateTransitionException。默认为 false

取消状态为“IN_PROGRESS”的任务执行将导致设备无法更新任务执行状态。请谨慎使用,并且确保设备能够恢复到有效状态。

expectedVersion

long

(可选) 任务执行的预期当前版本。每次更新任务执行时,其版本将递增。如果存储在 Jobs 中的任务执行版本不匹配,则更新将被拒绝并出现 VersionMismatch 错误,并且将返回包含当前任务执行状态数据的 ErrorResponse。(这样就不再需要执行单独的 DescribeJobExecution 请求来获取任务执行状态数据。)

statusDetails

map

描述任务执行状态的名称/值对的集合。如果未指定,则 statusDetails 保持不变。您最多可以指定 10 个名称/值对。

输出

错误

InvalidRequestException

请求的内容无效。

InvalidStateTransitionException

更新尝试将任务执行更改为某个状态,但该状态由于任务执行的当前状态而无效 (例如,尝试将处于 SUCCESS 状态的请求更改为 IN_PROGRESS 状态)。在这种情况下,错误消息的正文还包含 executionState 字段。

ResourceNotFoundException

指定的资源不存在。

ThrottlingException

速率超过限制。

ServiceUnavailableException

服务暂时不可用。

VersionConflictException

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

ClearDefaultAuthorizer

清除默认授权方。

摘要

aws iot clear-default-authorizer \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ }

输出

错误

ResourceNotFoundException

指定的资源不存在。

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。

CreateAuthorizer

创建授权方。

摘要

aws iot create-authorizer \ --authorizer-name <value> \ --authorizer-function-arn <value> \ --token-key-name <value> \ --token-signing-public-keys <value> \ [--status <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "authorizerName": "string", "authorizerFunctionArn": "string", "tokenKeyName": "string", "tokenSigningPublicKeys": { "string": "string" }, "status": "string" }

cli-input-json 字段

名称

类型

描述

authorizerName

字符串

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

模式:[w=,@-]+

授权方名称。

authorizerFunctionArn

字符串

授权方 Lambda 函数的 ARN。

tokenKeyName

字符串

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

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

用于从 HTTP 标头提取令牌的令牌密钥的名称。

tokenSigningPublicKeys

map

用于验证由自定义身份验证服务返回的数字签名的公有密钥。

status

字符串

创建授权方请求的状态。

枚举:ACTIVE | INACTIVE

输出

{ "authorizerName": "string", "authorizerArn": "string" }

CLI 输出字段

名称

类型

描述

authorizerName

字符串

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

模式:[w=,@-]+

授权方的名称。

authorizerArn

字符串

授权方 ARN。

错误

ResourceAlreadyExistsException

该资源已存在。

InvalidRequestException

请求的内容无效。

LimitExceededException

已超出限制。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。

CreateBillingGroup

创建账单组。

摘要

aws iot create-billing-group \ --billing-group-name <value> \ [--billing-group-properties <value>] \ [--tags <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "billingGroupName": "string", "billingGroupProperties": { "billingGroupDescription": "string" }, "tags": [ { "Key": "string", "Value": "string" } ] }

cli-input-json 字段

名称

类型

描述

billingGroupName

字符串

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

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

您要为账单组指定的名称。

billingGroupProperties

BillingGroupProperties

账单组的属性。

billingGroupDescription

字符串

最大长度:2028

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

账单组的描述。

tags

列表

成员:Tag

java 类:java.util.List

可用于管理账单组的元数据。

Key

字符串

标签的键。

字符串

标签的值。

输出

{ "billingGroupName": "string", "billingGroupArn": "string", "billingGroupId": "string" }

CLI 输出字段

名称

类型

描述

billingGroupName

字符串

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

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

您已为账单组指定的名称。

billingGroupArn

字符串

账单组的 ARN。

billingGroupId

字符串

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

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

账单组的 ID。

错误

InvalidRequestException

请求的内容无效。

ResourceAlreadyExistsException

该资源已存在。

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

CreateCertificateFromCsr

使用指定的证书签名请求创建 X.509 证书。

注意:CSR 必须包含一个公有密钥,该密钥可以是长度至少为 2048 位的 RSA 密钥,或者是来自 NIST P-256 或 NIST P-384 曲线的 ECC 密钥。

注意:重新使用同一证书签名请求 (CSR) 会生成不同的证书。

您可以通过创建一个目录,将多个 .csr 文件复制到该目录中,然后在命令行上指定该目录,以此来成批创建多个证书。以下命令显示如何通过提供一批 CSR 来创建一批证书。

假设一组 CSR 位于目录 my-csr-directory 中:

在 Linux 和 OS X 上,命令是:

$ ls my-csr-directory/ | xargs -I aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/

此命令列出 my-csr-directory 中的所有 CSR 并将各个 CSR 文件名以管道方式传输到 aws iot create-certificate-from-csr AWS CLI 命令,以便为对应的 CSR 创建证书。

命令的 aws iot create-certificate-from-csr 部分也可以并行运行,以加快证书创建过程:

$ ls my-csr-directory/ | xargs -P 10 -I aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/

在 Windows PowerShell 上,为 my-csr-directory 中的所有 CSR 创建证书的命令为:

> ls -Name my-csr-directory | % aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_

在 Windows 命令提示符中,为 my-csr-directory 中的所有 CSR 创建证书的命令为:

> forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path"

摘要

aws iot create-certificate-from-csr \ --certificate-signing-request <value> \ [--set-as-active | --no-set-as-active] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "certificateSigningRequest": "string", "setAsActive": "boolean" }

cli-input-json 字段

名称

类型

描述

certificateSigningRequest

字符串

最小长度:1

证书签名请求 (CSR)。

setAsActive

布尔值

指定证书是否活动。

输出

{ "certificateArn": "string", "certificateId": "string", "certificatePem": "string" }

CLI 输出字段

名称

类型

描述

certificateArn

字符串

证书的 Amazon 资源名称 (ARN)。您可以将 ARN 用作策略操作的委托人。

certificateId

字符串

最大长度:64,最小长度:64

模式:(0x)?[a-fA-F0-9]+

证书的 ID。证书管理操作仅接受 certificateId。

certificatePem

字符串

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

PEM 格式的证书数据。

错误

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。

CreateDynamicThingGroup

创建动态事物组。

摘要

aws iot create-dynamic-thing-group \ --thing-group-name <value> \ [--thing-group-properties <value>] \ [--index-name <value>] \ --query-string <value> \ [--query-version <value>] \ [--tags <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "thingGroupName": "string", "thingGroupProperties": { "thingGroupDescription": "string", "attributePayload": { "attributes": { "string": "string" }, "merge": "boolean" } }, "indexName": "string", "queryString": "string", "queryVersion": "string", "tags": [ { "Key": "string", "Value": "string" } ] }

cli-input-json 字段

名称

类型

描述

thingGroupName

字符串

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

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

要创建的动态事物组名称。

thingGroupProperties

ThingGroupProperties

动态事物组属性。

thingGroupDescription

字符串

最大长度:2028

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

事物组的描述。

attributePayload

AttributePayload

JSON 格式的事物组属性。

attributes

map

一个 JSON 字符串,其中最多包含三个 JSON 格式的键/值对。例如:

\"attributes\":{\"string1\":\"string2\"}

merge

布尔值

指定在 AttributePayload 中提供的属性列表是否与存储在注册表中的属性合并,而不是覆盖。

要删除属性,请使用空属性值调用 UpdateThing

注意

merge 属性仅在调用 UpdateThing 时有效。

indexName

字符串

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

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

动态事物组索引名称。

注意

目前支持一个索引:“AWS_Things”。

queryString

字符串

最小长度:1

动态事物组搜索查询字符串。

有关查询字符串语法的信息,请参阅查询语法

queryVersion

字符串

动态事物组查询版本。

注意

目前支持一个查询版本:“2017-09-30”。如果未指定,则查询版本默认为此值。

tags

列表

成员:Tag

java 类:java.util.List

可用于管理动态事物组的元数据。

Key

字符串

标签的键。

字符串

标签的值。

输出

{ "thingGroupName": "string", "thingGroupArn": "string", "thingGroupId": "string", "indexName": "string", "queryString": "string", "queryVersion": "string" }

CLI 输出字段

名称

类型

描述

thingGroupName

字符串

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

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

动态事物组名称。

thingGroupArn

字符串

动态事物组 ARN。

thingGroupId

字符串

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

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

动态事物组 ID。

indexName

字符串

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

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

动态事物组索引名称。

queryString

字符串

最小长度:1

动态事物组搜索查询字符串。

queryVersion

字符串

动态事物组查询版本。

错误

InvalidRequestException

请求的内容无效。

ResourceAlreadyExistsException

该资源已存在。

ResourceNotFoundException

指定的资源不存在。

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

InvalidQueryException

查询无效。

LimitExceededException

已超出限制。

CreateJob

创建作业。

摘要

aws iot create-job \ --job-id <value> \ --targets <value> \ [--document-source <value>] \ [--document <value>] \ [--description <value>] \ [--presigned-url-config <value>] \ [--target-selection <value>] \ [--job-executions-rollout-config <value>] \ [--abort-config <value>] \ [--timeout-config <value>] \ [--tags <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "jobId": "string", "targets": [ "string" ], "documentSource": "string", "document": "string", "description": "string", "presignedUrlConfig": { "roleArn": "string", "expiresInSec": "long" }, "targetSelection": "string", "jobExecutionsRolloutConfig": { "maximumPerMinute": "integer", "exponentialRate": { "baseRatePerMinute": "integer", "incrementFactor": "double", "rateIncreaseCriteria": { "numberOfNotifiedThings": "integer", "numberOfSucceededThings": "integer" } } }, "abortConfig": { "criteriaList": [ { "failureType": "string", "action": "string", "thresholdPercentage": "double", "minNumberOfExecutedThings": "integer" } ] }, "timeoutConfig": { "inProgressTimeoutInMinutes": "long" }, "tags": [ { "Key": "string", "Value": "string" } ] }

cli-input-json 字段

名称

类型

描述

jobId

字符串

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

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

作业的标识符,必须是您的 AWS 账户的唯一标识符。我们建议使用 UUID。此处可以使用字母数字字符、“-”和“_”。

targets

列表

成员:TargetArn

任务应发送到的事物和事物组的列表。

documentSource

字符串

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

指向任务文档的 S3 链接。

文档

字符串

最大长度:32768

任务文档。

注意

如果任务文档位于 S3 存储桶中,您在指定文档时必须使用占位符链接。

占位符链接采用以下形式:

$ aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key

其中 bucket 是您的存储桶名称,key 是您链接到的存储桶中的对象。

description

字符串

最大长度:2028

模式:[^\\p{C}]+

作业的简短文本描述。

presignedUrlConfig

PresignedUrlConfig

预签名 S3 URL 的配置信息。

roleArn

字符串

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

IAM 角色的 ARN,该角色授予权限以从存储任务数据/更新的 S3 存储桶下载文件。该角色还必须授予 IoT 下载文件的权限。

expiresInSec

long

范围 – 最大值:3600,最小值:60

预签名 URL 的有效时间长度 (以秒为单位)。有效值为 60 – 3600,默认值为 3600 秒。预签名 URL 在 Jobs 接收任务文档的 MQTT 请求时生成。

targetSelection

字符串

指定任务将继续运行 (CONTINUOUS),还是在指定作为目标的所有事物完成任务之后完成 (SNAPSHOT)。如果继续运行,则在检测到目标中出现更改时,任务也会在事物上运行。例如,当某个事物添加到目标组时会在该事物上运行任务,即使是组中原有的全部事物已经完成了任务。

枚举:CONTINUOUS | SNAPSHOT

jobExecutionsRolloutConfig

JobExecutionsRolloutConfig

允许您创建作业的分段推出。

maximumPerMinute

整数

范围 – 最小值:1

待处理任务每分钟通知事物的最大数量。此参数允许您创建分段部署。

exponentialRate

ExponentialRolloutRate

作业推出的增速。此参数允许您定义作业推出的指数速率。

baseRatePerMinute

整数

范围 – 最大值:1000,最小值:1

在作业推出开始时,每分钟接收待处理作业通知的事物的最小数量。此参数允许您定义推出的初始速率。

rateIncreaseCriteria

RateIncreaseCriteria

启动作业推出速率提高的条件。

AWS IoT 最多支持小数点后一位(例如,支持 1.5,但不支持 1.55)。

numberOfNotifiedThings

整数

范围 – 最小值:1

启动推出速率提高的被通知事物的数量阈值。

numberOfSucceededThings

整数

范围 – 最小值:1

启动推出速率提高的成功事物的数量阈值。

abortConfig

AbortConfig

允许您创建中止作业的条件。

criteriaList

列表

成员:AbortCriteria

java 类:java.util.List

定义中止作业的规则的中止条件列表。

failureType

字符串

定义启动作业中止的规则的作业执行失败的类型。

枚举:FAILED | REJECTED | TIMED_OUT | ALL

action

字符串

启动作业中止的中止操作的类型。

枚举:CANCEL

minNumberOfExecutedThings

整数

范围 – 最小值:1

评估中止规则之前已执行事物的最小数量。

timeoutConfig

TimeoutConfig

指定每个设备完成其作业执行所具有的时间。计时器在作业执行状态设置为 IN_PROGRESS 时启动。如果任务执行状态未在时间到期之前设置为其他最终状态,它会自动设置为 TIMED_OUT

inProgressTimeoutInMinutes

long

指定此设备完成该作业执行所具有的时间,以分钟为单位。超时间隔可以为 1 分钟到 7 天(1 到 10080 分钟)之间的任意长度。进行中计时器无法更新,将应用到该任务的全部任务执行。只要任务执行保持在 IN_PROGRESS 状态的时间长度超过了此间隔,任务执行将失败,并切换为最终 TIMED_OUT 状态。

tags

列表

成员:Tag

java 类:java.util.List

可用于管理作业的元数据。

Key

字符串

标签的键。

字符串

标签的值。

输出

{ "jobArn": "string", "jobId": "string", "description": "string" }

CLI 输出字段

名称

类型

描述

jobArn

字符串

作业 ARN。

jobId

字符串

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

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

您分配给此作业的唯一标识符。

description

字符串

最大长度:2028

模式:[^\\p{C}]+

作业描述。

错误

InvalidRequestException

请求的内容无效。

ResourceNotFoundException

指定的资源不存在。

ResourceAlreadyExistsException

该资源已存在。

LimitExceededException

已超出限制。

ThrottlingException

速率超过限制。

ServiceUnavailableException

服务暂时不可用。

CreateKeysAndCertificate

创建 2048 位 RSA 密钥对,并使用已发布公有密钥颁发 X.509 证书。

注意:这是 AWS IoT 唯一一次发布此证书的私有密钥,因此请务必将其保存在安全的位置。

摘要

aws iot create-keys-and-certificate \ [--set-as-active | --no-set-as-active] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "setAsActive": "boolean" }

cli-input-json 字段

名称

类型

描述

setAsActive

布尔值

指定证书是否活动。

输出

{ "certificateArn": "string", "certificateId": "string", "certificatePem": "string", "keyPair": { "PublicKey": "string", "PrivateKey": "string" } }

CLI 输出字段

名称

类型

描述

certificateArn

字符串

证书的 ARN。

certificateId

字符串

最大长度:64,最小长度:64

模式:(0x)?[a-fA-F0-9]+

证书的 ID。AWS IoT 发布证书的默认主题名称 (例如,“AWS IoT Certificate”)。

certificatePem

字符串

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

PEM 格式的证书数据。

keyPair

KeyPair

生成的密钥对。

PublicKey

字符串

最小长度:1

公有密钥。

PrivateKey

字符串

最小长度:1

私有密钥。

错误

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。

CreateOTAUpdate

在事物或事物组的目标组上创建 AWS IoT OTAUpdate。

摘要

aws iot create-ota-update \ --ota-update-id <value> \ [--description <value>] \ --targets <value> \ [--target-selection <value>] \ [--aws-job-executions-rollout-config <value>] \ --files <value> \ --role-arn <value> \ [--additional-parameters <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "otaUpdateId": "string", "description": "string", "targets": [ "string" ], "targetSelection": "string", "awsJobExecutionsRolloutConfig": { "maximumPerMinute": "integer" }, "files": [ { "fileName": "string", "fileVersion": "string", "fileLocation": { "stream": { "streamId": "string", "fileId": "integer" }, "s3Location": { "bucket": "string", "key": "string", "version": "string" } }, "codeSigning": { "awsSignerJobId": "string", "startSigningJobParameter": { "signingProfileParameter": { "certificateArn": "string", "platform": "string", "certificatePathOnDevice": "string" }, "signingProfileName": "string", "destination": { "s3Destination": { "bucket": "string", "prefix": "string" } } }, "customCodeSigning": { "signature": { "inlineDocument": "blob" }, "certificateChain": { "certificateName": "string", "inlineDocument": "string" }, "hashAlgorithm": "string", "signatureAlgorithm": "string" } }, "attributes": { "string": "string" } } ], "roleArn": "string", "additionalParameters": { "string": "string" } }

cli-input-json 字段

名称

类型

描述

otaUpdateId

字符串

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

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

要创建的 OTA 更新的 ID。

description

字符串

最大长度:2028

模式:[^\\p{C}]+

OTA 更新的描述。

targets

列表

成员:Target

接收 OTA 更新的目标设备。

targetSelection

字符串

指定更新将继续运行 (CONTINUOUS),还是在指定作为目标的所有事物完成更新之后完成 (SNAPSHOT)。如果继续运行,则在检测到目标中出现更改时,更新也会在事物上运行。例如,当某个事物添加到目标组时会在该事物上运行更新,即使是组中原有的全部事物已经完成了更新。有效值:CONTINUOUS | SNAPSHOT。

枚举:CONTINUOUS | SNAPSHOT

awsJobExecutionsRolloutConfig

AwsJobExecutionsRolloutConfig

配置 OTA 更新的推广。

maximumPerMinute

整数

范围 – 最大值:1000,最小值:1

每分钟启动的最大 OTA 更新任务执行次数。

files

列表

成员:OTAUpdateFile

应由 OTA 更新流式处理的文件。

fileName

字符串

文件的名称。

fileVersion

字符串

文件版本。

fileLocation

FileLocation

更新后固件的位置。

stream

包含 OTA 的流。

streamId

字符串

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

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

流 ID。

fileId

整数

范围 – 最大值:255,最小值:0

与流关联的文件的 ID。

s3Location

S3 位置

更新后固件在 S3 中的位置。

bucket

字符串

最小长度:1

S3 存储桶。

key

字符串

最小长度:1

S3 键。

version

字符串

S3 存储桶版本。

codeSigning

CodeSigning

文件的代码签名方法。

awsSignerJobId

字符串

已创建用于对文件签名的 AWSSignerJob 的 ID。

startSigningJobParameter

StartSigningJobParameter

描述代码签名任务。

signingProfileParameter

SigningProfileParameter

描述代码签名配置文件。

certificateArn

字符串

证书 ARN。

platform

字符串

您设备的硬件平台。

certificatePathOnDevice

字符串

代码签名证书在设备上的位置。

signingProfileName

字符串

代码签名配置文件名称。

destination

目的地

编写代码签名文件的位置。

s3Destination

S3Destination

描述更新后固件在 S3 中的位置。

bucket

字符串

最小长度:1

包含更新后固件的 S3 存储桶。

prefix

字符串

S3 前缀。

customCodeSigning

CustomCodeSigning

用于对文件执行代码签名的自定义方法。

signature

CodeSigningSignature

文件的签名。

inlineDocument

blob

代码签署签名的 base64 编码二进制表示形式。

certificateChain

CodeSigningCertificateChain

证书链。

certificateName

字符串

证书的名称。

inlineDocument

字符串

代码签名证书链的 base64 编码二进制表示形式。

hashAlgorithm

字符串

用于对文件进行代码签名的哈希算法。

signatureAlgorithm

字符串

用于对文件进行代码签名的签名算法。

attributes

map

名称/属性对的列表。

roleArn

字符串

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

允许访问 AWS IoT Jobs 服务的 IAM 角色。

additionalParameters

map

其他 OTA 更新参数 (名称/值对) 的列表。

输出

{ "otaUpdateId": "string", "awsIotJobId": "string", "otaUpdateArn": "string", "awsIotJobArn": "string", "otaUpdateStatus": "string" }

CLI 输出字段

名称

类型

描述

otaUpdateId

字符串

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

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

OTA 更新 ID。

awsIotJobId

字符串

与 OTA 更新关联的 AWS IoT 任务 ID。

otaUpdateArn

字符串

OTA 更新 ARN。

awsIotJobArn

字符串

与 OTA 更新关联的 AWS IoT 任务 ARN。

otaUpdateStatus

字符串

OTA 更新状态。

枚举:CREATE_PENDING | CREATE_IN_PROGRESS | CREATE_COMPLETE | CREATE_FAILED

错误

InvalidRequestException

请求的内容无效。

LimitExceededException

已超出限制。

ResourceNotFoundException

指定的资源不存在。

ResourceAlreadyExistsException

该资源已存在。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

InternalFailureException

出现意外错误。

ServiceUnavailableException

服务暂时不可用。

CreatePolicy

创建 AWS IoT 策略。

创建的策略是策略的默认版本。此操作使用版本标识符 1 创建策略版本,并将策略的默认版本设置为 1

摘要

aws iot create-policy \ --policy-name <value> \ --policy-document <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "policyName": "string", "policyDocument": "string" }

cli-input-json 字段

名称

类型

描述

policyName

字符串

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

模式:[w+=,.@-]+

策略名称。

policyDocument

字符串

描述该策略的 JSON 文档。policyDocument 的最小长度为 1,最大长度为 2048,不包括空格。

输出

{ "policyName": "string", "policyArn": "string", "policyDocument": "string", "policyVersionId": "string" }

CLI 输出字段

名称

类型

描述

policyName

字符串

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

模式:[w+=,.@-]+

策略名称。

policyArn

字符串

策略 ARN。

policyDocument

字符串

描述该策略的 JSON 文档。

policyVersionId

字符串

模式:[0-9]+

策略版本 ID。

错误

ResourceAlreadyExistsException

该资源已存在。

MalformedPolicyException

策略文档无效。

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。

CreatePolicyVersion

创建指定 AWS IoT 策略的新版本。要更新策略,请创建新策略版本。一个托管策略最多可以有五个版本。如果策略有五个版本,则在创建新版本之前,必须使用 DeletePolicyVersion 删除一个现有版本。

(可选) 您可以将新版本设置为策略的默认版本。默认版本是有效版本 (即,该版本对策略所附加到的证书生效)。

摘要

aws iot create-policy-version \ --policy-name <value> \ --policy-document <value> \ [--set-as-default | --no-set-as-default] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "policyName": "string", "policyDocument": "string", "setAsDefault": "boolean" }

cli-input-json 字段

名称

类型

描述

policyName

字符串

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

模式:[w+=,.@-]+

策略名称。

policyDocument

字符串

描述该策略的 JSON 文档。最小长度为 1。最大长度为 2048,不包括空格。

setAsDefault

布尔值

指定是否将策略版本设置为默认版本。当此参数为 true 时,新策略版本将成为有效版本 (即,该版本对策略所附加到的证书生效)。

输出

{ "policyArn": "string", "policyDocument": "string", "policyVersionId": "string", "isDefaultVersion": "boolean" }

CLI 输出字段

名称

类型

描述

policyArn

字符串

策略 ARN。

policyDocument

字符串

描述该策略的 JSON 文档。

policyVersionId

字符串

模式:[0-9]+

策略版本 ID。

isDefaultVersion

布尔值

指定策略版本是否为默认版本。

错误

ResourceNotFoundException

指定的资源不存在。

MalformedPolicyException

策略文档无效。

VersionsLimitExceededException

策略版本数超过了限制。

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。

CreateRoleAlias

创建角色别名。

摘要

aws iot create-role-alias \ --role-alias <value> \ --role-arn <value> \ [--credential-duration-seconds <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "roleAlias": "string", "roleArn": "string", "credentialDurationSeconds": "integer" }

cli-input-json 字段

名称

类型

描述

roleAlias

字符串

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

模式:[w=,@-]+

指向角色 ARN 的角色别名。这样您就可以更改角色,而无需更新设备。

roleArn

字符串

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

角色 ARN。

credentialDurationSeconds

整数

范围 – 最大值:3600,最小值:900

凭证有效的时间长度 (以秒为单位)。

输出

{ "roleAlias": "string", "roleAliasArn": "string" }

CLI 输出字段

名称

类型

描述

roleAlias

字符串

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

模式:[w=,@-]+

角色别名。

roleAliasArn

字符串

角色别名 ARN。

错误

ResourceAlreadyExistsException

该资源已存在。

InvalidRequestException

请求的内容无效。

LimitExceededException

已超出限制。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。

CreateScheduledAudit

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

摘要

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”。每个审核的实际开始时间取决于系统。

枚举:DAILY | WEEKLY | BIWEEKLY | MONTHLY

dayOfMonth

字符串

模式:^([1-9]|[12][0-9]|3[01])$|^LAST$

运行计划审核当月的具体日期,可以是“1”到“31”的任意值或“LAST”。如果将“frequency”参数设置为“MONTHLY”,则此字段为必填字段。如果指定 29-31 日,但该月份没有那么多天,那么系统会在该月份的“LAST”天(最后一天)运行审核。

dayOfWeek

字符串

运行计划审核当周的具体日期,可以是以下任一值:“SUN”、“MON”、“TUE”、“WED”、“THU”、“FRI”或“SAT”。如果将“frequency”参数段设置为“WEEKLY”或“BIWEEKLY”,则此字段为必填字段。

枚举:SUN | MON | TUE | WED | THU | FRI | SAT

targetCheckNames

列表

成员:AuditCheckName

计划审核期间执行的检查。您的账户必须已启用检查功能。(使用 DescribeAccountAuditConfiguration 查看所有检查的列表,包括已启用的检查,或使用 UpdateAccountAuditConfiguration 选择已启用的检查。)

tags

list

成员:Tag

java 类:java.util.List

可用于管理计划审核的元数据。

Key

字符串

标签的键。

字符串

标签的值。

scheduledAuditName

字符串

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

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

您要为计划审核指定的名称。(最长128 个字符)

输出

{ "scheduledAuditArn": "string" }

CLI 输出字段

名称

类型

描述

scheduledAuditArn

字符串

计划审核的 ARN。

错误

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

LimitExceededException

已超出限制。

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

字符串

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

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

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

securityProfileDescription

字符串

最大长度:1000

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

安全配置文件的描述。

behaviors

列表

成员:Behavior

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

name

字符串

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

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

您已为行为指定的名称。

指标

字符串

行为评估的内容。

criteria

BehaviorCriteria

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

comparisonOperator

字符串

将评估的事物 (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

列表

成员:Cidr

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

ports

列表

成员:Port

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

durationSeconds

整数

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

consecutiveDatapointsToAlarm

整数

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

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

consecutiveDatapointsToClear

整数

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

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

statisticalThreshold

StatisticalThreshold

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

统计数据

字符串

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

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

alertTargets

map

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

alertTargetArn

字符串

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

roleArn

字符串

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

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

additionalMetricsToRetain

list

成员:BehaviorMetric

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

tags

list

成员:Tag

java 类:java.util.List

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

Key

字符串

标签的键。

字符串

标签的值。

输出

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

CLI 输出字段

名称

类型

描述

securityProfileName

字符串

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

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

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

securityProfileArn

字符串

安全配置文件的 ARN。

错误

InvalidRequestException

请求的内容无效。

ResourceAlreadyExistsException

该资源已存在。

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

CreateStream

创建一个流,以便通过 MQTT 以分块形式传送一个或多个大文件。流将来自 S3 之类的源的数据字节打包为 MQTT 消息,以块或数据块的形式传输。您可以将一个或多个文件与一个流关联。与流关联的文件的总大小不能超过 2 MB。创建流时版本为 0。如果创建流使用的 streamID 与曾经存在但在过去 90 天内删除的流相同,我们会将版本增加 1 来重新使用旧的流。

摘要

aws iot create-stream \ --stream-id <value> \ [--description <value>] \ --files <value> \ --role-arn <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "streamId": "string", "description": "string", "files": [ { "fileId": "integer", "s3Location": { "bucket": "string", "key": "string", "version": "string" } } ], "roleArn": "string" }

cli-input-json 字段

名称

类型

描述

streamId

字符串

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

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

流 ID。

description

字符串

最大长度:2028

模式:[^\\p{C}]+

流的描述。

files

列表

成员:StreamFile

要流式处理的文件。

fileId

整数

范围 – 最大值:255,最小值:0

文件 ID。

s3Location

S3 位置

S3 中文件的位置。

bucket

字符串

最小长度:1

S3 存储桶。

key

字符串

最小长度:1

S3 键。

version

字符串

S3 存储桶版本。

roleArn

字符串

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

一个 IAM 角色,IoT 服务委托人可以代入该角色以访问您的 S3 文件。

输出

{ "streamId": "string", "streamArn": "string", "description": "string", "streamVersion": "integer" }

CLI 输出字段

名称

类型

描述

streamId

字符串

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

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

流 ID。

streamArn

字符串

流 ARN。

description

字符串

最大长度:2028

模式:[^\\p{C}]+

流的描述。

streamVersion

整数

范围 – 最大值:65535,最小值:0

流的版本。

错误

InvalidRequestException

请求的内容无效。

LimitExceededException

已超出限制。

ResourceNotFoundException

指定的资源不存在。

ResourceAlreadyExistsException

该资源已存在。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。

CreateThing

在注册表中创建事物记录。

注意

这是一个控制层面操作。有关对控制层面操作进行授权的信息,请参阅授权

摘要

aws iot create-thing \ --thing-name <value> \ [--thing-type-name <value>] \ [--attribute-payload <value>] \ [--billing-group-name <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "thingName": "string", "thingTypeName": "string", "attributePayload": { "attributes": { "string": "string" }, "merge": "boolean" }, "billingGroupName": "string" }

cli-input-json 字段

名称

类型

描述

thingName

字符串

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

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

要创建的事物的名称。

thingTypeName

字符串

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

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

与新事物关联的事物类型的名称。

attributePayload

AttributePayload

属性负载,由 JSON 文档中最多三个名称/值对组成。例如:

\"attributes\":{\"string1\":\"string2\"}

attributes

map

一个 JSON 字符串,其中最多包含三个 JSON 格式的键/值对。例如:

\"attributes\":{\"string1\":\"string2\"}

merge

布尔值

指定在 AttributePayload 中提供的属性列表是否与存储在注册表中的属性合并,而不是覆盖。

要删除属性,请使用空属性值调用 UpdateThing

注意

merge 属性仅在调用 UpdateThing 时有效。

billingGroupName

字符串

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

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

事物将添加到的账单组的名称。

输出

{ "thingName": "string", "thingArn": "string", "thingId": "string" }

CLI 输出字段

名称

类型

描述

thingName

字符串

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

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

新事物的名称。

thingArn

字符串

新事物的 ARN。

thingId

字符串

事物 ID。

错误

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。

ResourceAlreadyExistsException

该资源已存在。

ResourceNotFoundException

指定的资源不存在。

CreateThingGroup

创建事物组。

注意

这是一个控制层面操作。有关对控制层面操作进行授权的信息,请参阅授权

摘要

aws iot create-thing-group \ --thing-group-name <value> \ [--parent-group-name <value>] \ [--thing-group-properties <value>] \ [--tags <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "thingGroupName": "string", "parentGroupName": "string", "thingGroupProperties": { "thingGroupDescription": "string", "attributePayload": { "attributes": { "string": "string" }, "merge": "boolean" } }, "tags": [ { "Key": "string", "Value": "string" } ] }

cli-input-json 字段

名称

类型

描述

thingGroupName

字符串

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

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

要创建的事物组名称。

parentGroupName

字符串

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

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

父事物组的名称。

thingGroupProperties

ThingGroupProperties

事物组属性。

thingGroupDescription

字符串

最大长度:2028

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

事物组的描述。

attributePayload

AttributePayload

JSON 格式的事物组属性。

attributes

map

一个 JSON 字符串,其中最多包含三个 JSON 格式的键/值对。例如:

\"attributes\":{\"string1\":\"string2\"}

merge

布尔值

指定在 AttributePayload 中提供的属性列表是否与存储在注册表中的属性合并,而不是覆盖。

要删除属性,请使用空属性值调用 UpdateThing

注意

merge 属性仅在调用 UpdateThing 时有效。

tags

列表

成员:Tag

java 类:java.util.List

可用于管理事物组的元数据。

Key

字符串

标签的键。

字符串

标签的值。

输出

{ "thingGroupName": "string", "thingGroupArn": "string", "thingGroupId": "string" }

CLI 输出字段

名称

类型

描述

thingGroupName

字符串

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

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

事物组名称。

thingGroupArn

字符串

事物组 ARN。

thingGroupId

字符串

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

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

事物组 ID。

错误

InvalidRequestException

请求的内容无效。

ResourceAlreadyExistsException

该资源已存在。

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

CreateThingType

创建新事物类型。

摘要

aws iot create-thing-type \ --thing-type-name <value> \ [--thing-type-properties <value>] \ [--tags <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "thingTypeName": "string", "thingTypeProperties": { "thingTypeDescription": "string", "searchableAttributes": [ "string" ] }, "tags": [ { "Key": "string", "Value": "string" } ] }

cli-input-json 字段

名称

类型

描述

thingTypeName

字符串

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

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

事务类型的名称。

thingTypeProperties

ThingTypeProperties

要创建的事物类型的 ThingTypeProperties。它包含有关新事物类型的信息 (包括描述),以及可搜索事物属性名称的列表。

thingTypeDescription

字符串

最大长度:2028

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

事物类型的描述。

searchableAttributes

列表

成员:AttributeName

java 类:java.util.List

可搜索事物属性名称的列表。

tags

列表

成员:Tag

java 类:java.util.List

可用于管理事物类型的元数据。

Key

字符串

标签的键。

字符串

标签的值。

输出

{ "thingTypeName": "string", "thingTypeArn": "string", "thingTypeId": "string" }

CLI 输出字段

名称

类型

描述

thingTypeName

字符串

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

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

事务类型的名称。

thingTypeArn

字符串

事物类型的 Amazon 资源名称 (ARN)。

thingTypeId

字符串

事物类型 ID。

错误

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。

ResourceAlreadyExistsException

该资源已存在。

CreateTopicRule

创建规则。创建规则是管理员级别操作。有权创建规则的所有用户都将能够访问规则所处理的数据。

摘要

aws iot create-topic-rule \ --rule-name <value> \ --topic-rule-payload <value> \ [--tags <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "ruleName": "string", "topicRulePayload": { "sql": "string", "description": "string", "actions": [ { "dynamoDB": { "tableName": "string", "roleArn": "string", "operation": "string", "hashKeyField": "string", "hashKeyValue": "string", "hashKeyType": "string", "rangeKeyField": "string", "rangeKeyValue": "string", "rangeKeyType": "string", "payloadField": "string" }, "dynamoDBv2": { "roleArn": "string", "putItem": { "tableName": "string" } }, "lambda": { "functionArn": "string" }, "sns": { "targetArn": "string", "roleArn": "string", "messageFormat": "string" }, "sqs": { "roleArn": "string", "queueUrl": "string", "useBase64": "boolean" }, "kinesis": { "roleArn": "string", "streamName": "string", "partitionKey": "string" }, "republish": { "roleArn": "string", "topic": "string" }, "s3": { "roleArn": "string", "bucketName": "string", "key": "string", "cannedAcl": "string" }, "firehose": { "roleArn": "string", "deliveryStreamName": "string", "separator": "string" }, "cloudwatchMetric": { "roleArn": "string", "metricNamespace": "string", "metricName": "string", "metricValue": "string", "metricUnit": "string", "metricTimestamp": "string" }, "cloudwatchAlarm": { "roleArn": "string", "alarmName": "string", "stateReason": "string", "stateValue": "string" }, "elasticsearch": { "roleArn": "string", "endpoint": "string", "index": "string", "type": "string", "id": "string" }, "salesforce": { "token": "string", "url": "string" }, "iotAnalytics": { "channelArn": "string", "channelName": "string", "roleArn": "string" }, "iotEvents": { "inputName": "string", "messageId": "string", "roleArn": "string" }, "stepFunctions": { "executionNamePrefix": "string", "stateMachineName": "string", "roleArn": "string" } } ], "ruleDisabled": "boolean", "awsIotSqlVersion": "string", "errorAction": { "dynamoDB": { "tableName": "string", "roleArn": "string", "operation": "string", "hashKeyField": "string", "hashKeyValue": "string", "hashKeyType": "string", "rangeKeyField": "string", "rangeKeyValue": "string", "rangeKeyType": "string", "payloadField": "string" }, "dynamoDBv2": { "roleArn": "string", "putItem": { "tableName": "string" } }, "lambda": { "functionArn": "string" }, "sns": { "targetArn": "string", "roleArn": "string", "messageFormat": "string" }, "sqs": { "roleArn": "string", "queueUrl": "string", "useBase64": "boolean" }, "kinesis": { "roleArn": "string", "streamName": "string", "partitionKey": "string" }, "republish": { "roleArn": "string", "topic": "string" }, "s3": { "roleArn": "string", "bucketName": "string", "key": "string", "cannedAcl": "string" }, "firehose": { "roleArn": "string", "deliveryStreamName": "string", "separator": "string" }, "cloudwatchMetric": { "roleArn": "string", "metricNamespace": "string", "metricName": "string", "metricValue": "string", "metricUnit": "string", "metricTimestamp": "string" }, "cloudwatchAlarm": { "roleArn": "string", "alarmName": "string", "stateReason": "string", "stateValue": "string" }, "elasticsearch": { "roleArn": "string", "endpoint": "string", "index": "string", "type": "string", "id": "string" }, "salesforce": { "token": "string", "url": "string" }, "iotAnalytics": { "channelArn": "string", "channelName": "string", "roleArn": "string" }, "iotEvents": { "inputName": "string", "messageId": "string", "roleArn": "string" }, "stepFunctions": { "executionNamePrefix": "string", "stateMachineName": "string", "roleArn": "string" } } }, "tags": "string" }

cli-input-json 字段

名称

类型

描述

ruleName

字符串

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

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

规则的名称。

topicRulePayload

TopicRulePayload

规则负载。

sql

字符串

用于查询主题的 SQL 语句。有关更多信息,请参阅 AWS IoT 开发人员指南 中的 AWS IoT SQL 参考

description

字符串

规则的描述。

actions

列表

成员:Action

与该规则关联的操作。

dynamoDB

DynamoDBAction

写入到 DynamoDB 表。

tableName

字符串

DynamoDB 表的名称。

roleArn

字符串

授予对 DynamoDB 表的访问权限的 IAM 角色的 ARN。

operation

字符串

要执行的操作类型。该信息遵循替换模板,因此可以是 $ operation,但替换必须产生以下操作之一:INSERTUPDATEDELETE

hashKeyField

字符串

哈希键名称。

hashKeyValue

字符串

哈希键值。

hashKeyType

字符串

哈希键类型。有效值为“STRING”或“NUMBER”

枚举:STRING | NUMBER

rangeKeyField

字符串

范围键名称。

rangeKeyValue

字符串

范围键值。

rangeKeyType

字符串

范围键类型。有效值为“STRING”或“NUMBER”

枚举:STRING | NUMBER

payloadField

字符串

操作负载。此名称可以自定义。

dynamoDBv2

DynamoDBv2Action

写入到 DynamoDB 表。这是 DynamoDB 操作的新版本。它允许您将 MQTT 消息负载中的各个属性分别写入不同的 DynamoDB 列。

roleArn

字符串

授予对 DynamoDB 表的访问权限的 IAM 角色的 ARN。

putItem

PutItemInput

指定消息数据将写入的 DynamoDB 表。例如:

{ "dynamoDBv2": { "roleArn": "aws:iam:12341251:my-role" "putItem": { "tableName": "my-table" } } }

消息负载中的每个属性将写入到 DynamoDB 数据库中的单独一列。

tableName

字符串

消息数据将写入的表

lambda

LambdaAction

调用 Lambda 函数。

functionArn

字符串

Lambda 函数的 ARN。

sns

SnsAction

发布到 Amazon SNS 主题。

targetArn

字符串

SNS 主题的 ARN。

roleArn

字符串

授予访问权限的 IAM 角色的 ARN。

messageFormat

字符串

(可选) 要发布的消息的消息格式。接受的值为“JSON”和“RAW”。该属性的默认值为“RAW”。SNS 使用此设置来确定是否应解析负载,以及是否应提取负载的特定于平台的相关位。要了解有关 SNS 消息格式的更多信息,请访问 https://docs.amazonaws.cn/sns/latest/dg/json-formats.html 以查看其官方文档。

枚举:RAW | JSON

sqs

SqsAction

发布到 Amazon SQS 队列。

roleArn

字符串

授予访问权限的 IAM 角色的 ARN。

queueUrl

字符串

Amazon SQS 队列的 URL。

useBase64

布尔值

指定是否使用 Base64 编码。

kinesis

KinesisAction

将数据写入 Amazon Kinesis 流。

roleArn

字符串

授予对 Amazon Kinesis 流的访问权限的 IAM 角色的 ARN。

streamName

字符串

Amazon Kinesis 流的名称。

partitionKey

字符串

分区键。

重新发布

RepublishAction

发布到其他 MQTT 主题。

roleArn

字符串

授予访问权限的 IAM 角色的 ARN。

topic

字符串

MQTT; 主题的名称。

S3

S3 操作

写入 Amazon S3 存储桶。

roleArn

字符串

授予访问权限的 IAM 角色的 ARN。

bucketName

字符串

Amazon S3 存储桶。

key

字符串

对象键。

cannedAcl

字符串

Amazon S3 标准 ACL,用于控制对由对象键标识的对象的访问权限。有关更多信息,请参阅 S3 标准 ACL

枚举:private | public-read | public-read-write | aws-exec-read | authenticated-read | bucket-owner-read | bucket-owner-full-control | log-delivery-write

firehose

FirehoseAction

将数据写入 Amazon Kinesis Firehose 流。

roleArn

字符串

授予对 Amazon Kinesis Firehose 流的访问权限的 IAM 角色。

deliveryStreamName

字符串

传输流名称。

separator

字符串

pattern: ([ ])|( )|(,)

将用于分隔写入到 Firehose 流的记录的字符分隔符。有效值为:'\n'(换行符)、'\t'(制表符)、'\r\n'(Windows 换行符)、','(逗号)。

cloudwatchMetric

CloudwatchMetricAction

捕获 CloudWatch 指标。

roleArn

字符串

允许访问 CloudWatch 指标的 IAM 角色。

metricNamespace

字符串

CloudWatch 指标命名空间名称。

metricName

字符串

CloudWatch 指标名称。

metricValue

字符串

CloudWatch 指标值。

metricUnit

字符串

CloudWatch 支持的指标单位

metricTimestamp

字符串

可选 Unix 时间戳

cloudwatchAlarm

CloudwatchAlarmAction

更改 CloudWatch 警报的状态。

roleArn

字符串

允许访问 CloudWatch 警报的 IAM 角色。

alarmName

字符串

CloudWatch 警报名称。

stateReason

字符串

警报更改的原因。

stateValue

字符串

警报状态的值。可接受的值为:OK、ALARM、INSUFFICIENT_DATA。

elasticsearch

ElasticsearchAction

将数据写入 Amazon Elasticsearch Service 域。

roleArn

字符串

具有 Elasticsearch 访问权限的 IAM 角色 ARN。

endpoint

字符串

模式:https?://.*

Elasticsearch 域的终端节点。

index

字符串

您要在其中存储数据的 Elasticsearch 索引。

type

字符串

您存储的文档类型。

id

字符串

您将要存储的文档的唯一标识符。

salesforce

SalesforceAction

向 Salesforce IoT Cloud 输入流发送消息。

token

字符串

最小长度:40

用于验证对 Salesforce IoT Cloud 输入流的访问权限的令牌。在创建输入流之后,可从 Salesforce IoT Cloud 平台获取该令牌。

url

字符串

最大长度:2000

模式:https://ingestion-[a-zA-Z0-9]{1,12}.[a-zA-Z0-9]+.((sfdc-matrix.net)|(sfdcnow.com))/streams/w 1,20/w 1,20/event

由 Salesforce IoT Cloud 输入流公开的 URL。在创建输入流之后,可从 Salesforce IoT Cloud 平台获取该 URL。

iotAnalytics

IotAnalyticsAction

向 AWS IoT Analytics 通道发送消息数据。

channelArn

字符串

(已弃用) 消息数据将发送到的 IoT Analytics 通道的 ARN。

channelName

字符串

消息数据将发送到的 IoT Analytics 通道的名称。

roleArn

字符串

一个角色的 ARN,该角色具有授予通过 IoT Analytics (iotanalytics:BatchPutMessage) 发送消息数据的 IoT Analytics 权限的策略。

iotEvents

IotEventsAction

将输入发送到 AWS IoT Events 探测器。

inputName

字符串

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

AWS IoT Events 输入的名称。

messageId

字符串

最大长度:128

[可选] 使用此可确保 AWS IoT Events 探测器将只处理一个具有给定 messageId 的输入(消息)。

roleArn

字符串

向 AWS IoT 授予将输入发送到 AWS IoT Events 探测器的权限的角色的 ARN。("Action":"iotevents:BatchPutMessage")。

stepFunctions

StepFunctionsAction

开始执行 Step Functions 状态机。

executionNamePrefix

字符串

(可选)将为状态机执行操作指定名称,由此前缀后加 UUID 组成。如果未提供名称,Step Functions 会自动为每次状态机执行操作创建一个唯一的名称。

stateMachineName

字符串

将开始执行的 Step Functions 状态机名称。

roleArn

字符串

授予 IoT 权限以开始执行状态机(“Action”:“states:StartExecution”)的角色的 ARN。

ruleDisabled

布尔值

指定是否禁用规则。

awsIotSqlVersion

字符串

评估规则时使用的 SQL 规则引擎的版本。

errorAction

操作

发生错误时要执行的操作。

dynamoDB

DynamoDBAction

写入到 DynamoDB 表。

tableName

字符串

DynamoDB 表的名称。

roleArn

字符串

授予对 DynamoDB 表的访问权限的 IAM 角色的 ARN。

operation

字符串

要执行的操作类型。该信息遵循替换模板,因此可以是 $ operation,但替换必须产生以下操作之一:INSERTUPDATEDELETE

hashKeyField

字符串

哈希键名称。

hashKeyValue

字符串

哈希键值。

hashKeyType

字符串

哈希键类型。有效值为“STRING”或“NUMBER”

枚举:STRING | NUMBER

rangeKeyField

字符串

范围键名称。

rangeKeyValue

字符串

范围键值。

rangeKeyType

字符串

范围键类型。有效值为“STRING”或“NUMBER”

枚举:STRING | NUMBER

payloadField

字符串

操作负载。此名称可以自定义。

dynamoDBv2

DynamoDBv2Action

写入到 DynamoDB 表。这是 DynamoDB 操作的新版本。它允许您将 MQTT 消息负载中的各个属性分别写入不同的 DynamoDB 列。

roleArn

字符串

授予对 DynamoDB 表的访问权限的 IAM 角色的 ARN。

putItem

PutItemInput

指定消息数据将写入的 DynamoDB 表。例如:

{ "dynamoDBv2": { "roleArn": "aws:iam:12341251:my-role" "putItem": { "tableName": "my-table" } } }

消息负载中的每个属性将写入到 DynamoDB 数据库中的单独一列。

tableName

字符串

消息数据将写入的表

lambda

LambdaAction

调用 Lambda 函数。

functionArn

字符串

Lambda 函数的 ARN。

sns

SnsAction

发布到 Amazon SNS 主题。

targetArn

字符串

SNS 主题的 ARN。

roleArn

字符串

授予访问权限的 IAM 角色的 ARN。

messageFormat

字符串

(可选) 要发布的消息的消息格式。接受的值为“JSON”和“RAW”。该属性的默认值为“RAW”。SNS 使用此设置来确定是否应解析负载,以及是否应提取负载的特定于平台的相关位。要了解有关 SNS 消息格式的更多信息,请访问 https://docs.amazonaws.cn/sns/latest/dg/json-formats.html 以查看其官方文档。

枚举:RAW | JSON

sqs

SqsAction

发布到 Amazon SQS 队列。

roleArn

字符串

授予访问权限的 IAM 角色的 ARN。

queueUrl

字符串

Amazon SQS 队列的 URL。

useBase64

布尔值

指定是否使用 Base64 编码。

kinesis

KinesisAction

将数据写入 Amazon Kinesis 流。

roleArn

字符串

授予对 Amazon Kinesis 流的访问权限的 IAM 角色的 ARN。

streamName

字符串

Amazon Kinesis 流的名称。

partitionKey

字符串

分区键。

重新发布

RepublishAction

发布到其他 MQTT 主题。

roleArn

字符串

授予访问权限的 IAM 角色的 ARN。

topic

字符串

MQTT; 主题的名称。

S3

S3 操作

写入 Amazon S3 存储桶。

roleArn

字符串

授予访问权限的 IAM 角色的 ARN。

bucketName

字符串

Amazon S3 存储桶。

key

字符串

对象键。

cannedAcl

字符串

Amazon S3 标准 ACL,用于控制对由对象键标识的对象的访问权限。有关更多信息,请参阅 S3 标准 ACL

枚举:private | public-read | public-read-write | aws-exec-read | authenticated-read | bucket-owner-read | bucket-owner-full-control | log-delivery-write

firehose

FirehoseAction

将数据写入 Amazon Kinesis Firehose 流。

roleArn

字符串

授予对 Amazon Kinesis Firehose 流的访问权限的 IAM 角色。

deliveryStreamName

字符串

传输流名称。

separator

字符串

pattern: ([ ])|( )|(,)

将用于分隔写入到 Firehose 流的记录的字符分隔符。有效值为:'\n'(换行符)、'\t'(制表符)、'\r\n'(Windows 换行符)、','(逗号)。

cloudwatchMetric

CloudwatchMetricAction

捕获 CloudWatch 指标。

roleArn

字符串

允许访问 CloudWatch 指标的 IAM 角色。

metricNamespace

字符串

CloudWatch 指标命名空间名称。

metricName

字符串

CloudWatch 指标名称。

metricValue

字符串

CloudWatch 指标值。

metricUnit

字符串

CloudWatch 支持的指标单位

metricTimestamp

字符串

可选 Unix 时间戳

cloudwatchAlarm

CloudwatchAlarmAction

更改 CloudWatch 警报的状态。

roleArn

字符串

允许访问 CloudWatch 警报的 IAM 角色。

alarmName

字符串

CloudWatch 警报名称。

stateReason

字符串

警报更改的原因。

stateValue

字符串

警报状态的值。可接受的值为:OK、ALARM、INSUFFICIENT_DATA。

elasticsearch

ElasticsearchAction

将数据写入 Amazon Elasticsearch Service 域。

roleArn

字符串

具有 Elasticsearch 访问权限的 IAM 角色 ARN。

endpoint

字符串

模式:https?://.*

Elasticsearch 域的终端节点。

index

字符串

您要在其中存储数据的 Elasticsearch 索引。

type

字符串

您存储的文档类型。

id

字符串

您将要存储的文档的唯一标识符。

salesforce

SalesforceAction

向 Salesforce IoT Cloud 输入流发送消息。

token

字符串

最小长度:40

用于验证对 Salesforce IoT Cloud 输入流的访问权限的令牌。在创建输入流之后,可从 Salesforce IoT Cloud 平台获取该令牌。

url

字符串

最大长度:2000

模式:https://ingestion-[a-zA-Z0-9]{1,12}.[a-zA-Z0-9]+.((sfdc-matrix.net)|(sfdcnow.com))/streams/w 1,20/w 1,20/event

由 Salesforce IoT Cloud 输入流公开的 URL。在创建输入流之后,可从 Salesforce IoT Cloud 平台获取该 URL。

iotAnalytics

IotAnalyticsAction

向 AWS IoT Analytics 通道发送消息数据。

channelArn

字符串

(已弃用) 消息数据将发送到的 IoT Analytics 通道的 ARN。

channelName

字符串

消息数据将发送到的 IoT Analytics 通道的名称。

roleArn

字符串

一个角色的 ARN,该角色具有授予通过 IoT Analytics (iotanalytics:BatchPutMessage) 发送消息数据的 IoT Analytics 权限的策略。

iotEvents

IotEventsAction

将输入发送到 AWS IoT Events 探测器。

inputName

字符串

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

AWS IoT Events 输入的名称。

messageId

字符串

最大长度:128

[可选] 使用此可确保 AWS IoT Events 探测器将只处理一个具有给定 messageId 的输入(消息)。

roleArn

字符串

向 AWS IoT 授予将输入发送到 AWS IoT Events 探测器的权限的角色的 ARN。("Action":"iotevents:BatchPutMessage")。

stepFunctions

StepFunctionsAction

开始执行 Step Functions 状态机。

executionNamePrefix

字符串

(可选)将为状态机执行操作指定名称,由此前缀后加 UUID 组成。如果未提供名称,Step Functions 会自动为每次状态机执行操作创建一个唯一的名称。

stateMachineName

字符串

将开始执行的 Step Functions 状态机名称。

roleArn

字符串

授予 IoT 权限以开始执行状态机(“Action”:“states:StartExecution”)的角色的 ARN。

tags

字符串

可用于管理主题规则的元数据。

注意

对于 URI 请求参数,使用格式:...key1=value1&key2=value2...

对于 CLI 命令行参数,使用格式:--tags "key1=value1&key2=value2..."

对于 cli-input-json 文件,使用格式:"tags": "key1=value1&key2=value2..."

输出

错误

SqlParseException

无法正确解析 Rule-SQL 表达式。

InternalException

出现意外错误。

InvalidRequestException

请求的内容无效。

ResourceAlreadyExistsException

该资源已存在。

ServiceUnavailableException

服务暂时不可用。

ConflictingResourceUpdateException

资源更新冲突异常。在两个待处理更新导致冲突时,会引发此异常。

DeleteAccountAuditConfiguration

还原此账户的默认 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,则所有计划审核都将被删除。

输出

错误

InvalidRequestException

请求的内容无效。

ResourceNotFoundException

指定的资源不存在。

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

DeleteAuthorizer

删除授权方。

摘要

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

cli-input-json 格式

{ "authorizerName": "string" }

cli-input-json 字段

名称

类型

描述

authorizerName

字符串

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

模式:[w=,@-]+

要删除的授权方的名称。

输出

错误

DeleteConflictException

由于资源已附加到一个或多个资源,您无法删除资源。

ResourceNotFoundException

指定的资源不存在。

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。

DeleteBillingGroup

删除账单组。

摘要

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

cli-input-json 格式

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

cli-input-json 字段

名称

类型

描述

billingGroupName

字符串

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

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

账单组的名称。

expectedVersion

long

账单组的预期版本。如果账单组的版本与请求中指定的预期版本不匹配,则使用 VersionConflictException 拒绝 DeleteBillingGroup 请求。

输出

错误

InvalidRequestException

请求的内容无效。

VersionConflictException

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

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

DeleteCACertificate

删除已注册的 CA 证书。

摘要

aws iot delete-ca-certificate \ --certificate-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "certificateId": "string" }

cli-input-json 字段

名称

类型

描述

certificateId

字符串

最大长度:64,最小长度:64

模式:(0x)?[a-fA-F0-9]+

要删除的证书的 ID。(证书 ARN 的最后一部分包含证书 ID。)

输出

错误

InvalidRequestException

请求的内容无效。

CertificateStateException

不允许执行该证书操作。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。

ResourceNotFoundException

指定的资源不存在。

DeleteCertificate

删除指定的证书。

如果证书上已经附加了策略或者其状态设置为 ACTIVE,则无法删除该证书。要删除证书,请先使用 DetachPrincipalPolicy API 分离所有策略。接下来,使用 UpdateCertificate API 将证书设置为 INACTIVE 状态。

摘要

aws iot delete-certificate \ --certificate-id <value> \ [--force-delete | --no-force-delete] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "certificateId": "string", "forceDelete": "boolean" }

cli-input-json 字段

名称

类型

描述

certificateId

字符串

最大长度:64,最小长度:64

模式:(0x)?[a-fA-F0-9]+

证书的 ID。(证书 ARN 的最后一部分包含证书 ID。)

forceDelete

布尔值

强制删除证书请求。

输出

错误

CertificateStateException

不允许执行该证书操作。

DeleteConflictException

由于资源已附加到一个或多个资源,您无法删除资源。

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。

ResourceNotFoundException

指定的资源不存在。

DeleteDynamicThingGroup

删除动态事物组。

摘要

aws iot delete-dynamic-thing-group \ --thing-group-name <value> \ [--expected-version <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

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

cli-input-json 字段

名称

类型

描述

thingGroupName

字符串

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

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

要删除的动态事物组的名称。

expectedVersion

long

要删除的动态事物组的预期版本。

输出

错误

InvalidRequestException

请求的内容无效。

VersionConflictException

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

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

DeleteJob

删除任务及其相关的任务执行。

删除任务可能需要一些时间,具体取决于为该任务创建的任务执行的数量以及其他各种因素。正在删除任务时,任务的状态将显示为“DELETION_IN_PROGRESS”。尝试删除或取消其状态已为“DELETION_IN_PROGRESS”的任务将导致错误。

只能有 10 个任务的状态可以同时为“DELETION_IN_PROGRESS”,否则会出现 LimitExceededException。

摘要

aws iot delete-job \ --job-id <value> \ [--force | --no-force] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "jobId": "string", "force": "boolean" }

cli-input-json 字段

名称

类型

描述

jobId

字符串

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

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

要删除的任务的 ID。

在任务删除完成后,您可以在创建新任务时重新使用此 jobId。但是,不建议这样做,您必须确保设备没有使用此 jobId 来引用已删除的任务。

force

布尔值

(可选) 当为 true 时,您可以删除状态为“IN_PROGRESS”的任务。否则,您只能删除处于最终状态 (“COMPLETED”或“CANCELED”) 的任务,否则会出现异常。默认为 false。

注意

删除状态为“IN_PROGRESS”的任务将导致执行该任务的设备无法访问任务信息或更新任务执行状态。请谨慎使用,并且确保执行已删除的任务的每个设备能够恢复到有效状态。

输出

错误

InvalidRequestException

请求的内容无效。

InvalidStateTransitionException

更新尝试将任务执行更改为某个状态,但该状态由于任务执行的当前状态而无效 (例如,尝试将处于 SUCCESS 状态的请求更改为 IN_PROGRESS 状态)。在这种情况下,错误消息的正文还包含 executionState 字段。

ResourceNotFoundException

指定的资源不存在。

LimitExceededException

已超出限制。

ThrottlingException

速率超过限制。

ServiceUnavailableException

服务暂时不可用。

DeleteJobExecution

删除作业执行。

摘要

aws iot delete-job-execution \ --job-id <value> \ --thing-name <value> \ --execution-number <value> \ [--force | --no-force] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "jobId": "string", "thingName": "string", "executionNumber": "long", "force": "boolean" }

cli-input-json 字段

名称

类型

描述

jobId

字符串

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

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

将删除其在特定设备上的执行的任务的 ID。

thingName

字符串

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

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

将删除其任务执行的事物的名称。

executionNumber

long

要删除的任务执行的 ID。executionNumber 是指特定任务在特定设备上的执行。

请注意,在删除任务执行后,executionNumber 可能由 IoT 重新使用,因此请确保您在此处获取并使用正确的值。

force

布尔值

(可选) 当为 true 时,您可以删除状态为“IN_PROGRESS”的任务执行。否则,您只能删除处于最终状态 (“SUCCEEDED”、“FAILED”、“REJECTED”、“REMOVED”或“CANCELED”) 的任务执行,否则会出现异常。默认为 false。

注意

删除状态为“IN_PROGRESS”的任务执行将导致设备无法访问任务信息或更新任务执行状态。请谨慎使用,并且确保设备能够恢复到有效状态。

输出

错误

InvalidRequestException

请求的内容无效。

InvalidStateTransitionException

更新尝试将任务执行更改为某个状态,但该状态由于任务执行的当前状态而无效 (例如,尝试将处于 SUCCESS 状态的请求更改为 IN_PROGRESS 状态)。在这种情况下,错误消息的正文还包含 executionState 字段。

ResourceNotFoundException

指定的资源不存在。

ThrottlingException

速率超过限制。

ServiceUnavailableException

服务暂时不可用。

DeleteOTAUpdate

删除 OTA 更新。

摘要

aws iot delete-ota-update \ --ota-update-id <value> \ [--delete-stream | --no-delete-stream] \ [--force-delete-aws-job | --no-force-delete-aws-job] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "otaUpdateId": "string", "deleteStream": "boolean", "forceDeleteAWSJob": "boolean" }

cli-input-json 字段

名称

类型

描述

otaUpdateId

字符串

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

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

要删除的 OTA 更新 ID。

deleteStream

布尔值

指定在删除 OTA 更新时是否应删除与 OTA 更新关联的流。

forceDeleteAWSJob

布尔值

指定在删除 OTA 更新时是否应删除与 OTA 更新关联的 AWS 任务。

输出

错误

InvalidRequestException

请求的内容无效。

ResourceNotFoundException

指定的资源不存在。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

InternalFailureException

出现意外错误。

ServiceUnavailableException

服务暂时不可用。

VersionConflictException

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

DeletePolicy

删除指定的策略。

如果策略具有非默认版本或者已经附加到了任何证书,则无法删除该策略。

要删除策略,请使用 DeletePolicyVersion API 删除策略的所有非默认版本;使用 DetachPrincipalPolicy API 将策略从所有证书上分离;然后使用 DeletePolicy API 删除策略。

使用 DeletePolicy 删除策略后,将随之删除其默认版本。

摘要

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

cli-input-json 格式

{ "policyName": "string" }

cli-input-json 字段

名称

类型

描述

policyName

字符串

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

模式:[w+=,.@-]+

要删除的策略的名称。

输出

错误

DeleteConflictException

由于资源已附加到一个或多个资源,您无法删除资源。

ResourceNotFoundException

指定的资源不存在。

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。

DeletePolicyVersion

删除指定策略的指定版本。您无法使用此 API 删除策略的默认版本。要删除策略的默认版本,请使用 DeletePolicy。要查明策略的哪个版本标记为默认版本,请使用 ListPolicyVersions。

摘要

aws iot delete-policy-version \ --policy-name <value> \ --policy-version-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "policyName": "string", "policyVersionId": "string" }

cli-input-json 字段

名称

类型

描述

policyName

字符串

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

模式:[w+=,.@-]+

策略的名称。

policyVersionId

字符串

模式:[0-9]+

策略版本 ID。

输出

错误

DeleteConflictException

由于资源已附加到一个或多个资源,您无法删除资源。

ResourceNotFoundException

指定的资源不存在。

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。

DeleteRegistrationCode

删除 CA 证书注册代码。

摘要

aws iot delete-registration-code \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ }

输出

错误

ThrottlingException

速率超过限制。

ResourceNotFoundException

指定的资源不存在。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。

DeleteRoleAlias

删除角色别名。

摘要

aws iot delete-role-alias \ --role-alias <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "roleAlias": "string" }

cli-input-json 字段

名称

类型

描述

roleAlias

字符串

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

模式:[w=,@-]+

要删除的角色别名。

输出

错误

DeleteConflictException

由于资源已附加到一个或多个资源,您无法删除资源。

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。

ResourceNotFoundException

指定的资源不存在。

DeleteScheduledAudit

删除计划审核。

摘要

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

字符串

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

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

要删除的计划审核的名称。

输出

错误

InvalidRequestException

请求的内容无效。

ResourceNotFoundException

指定的资源不存在。

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

字符串

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

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

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

expectedVersion

long

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

输出

错误

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

VersionConflictException

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

DeleteStream

删除流。

摘要

aws iot delete-stream \ --stream-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "streamId": "string" }

cli-input-json 字段

名称

类型

描述

streamId

字符串

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

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

流 ID。

输出

错误

ResourceNotFoundException

指定的资源不存在。

DeleteConflictException

由于资源已附加到一个或多个资源,您无法删除资源。

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。

DeleteThing

删除指定的事物。如果删除成功或者您指定的事物不存在,则成功返回且没有错误。

摘要

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

cli-input-json 格式

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

cli-input-json 字段

名称

类型

描述

thingName

字符串

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

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

要删除的事物的名称。

expectedVersion

long

注册表中预期的事物记录的版本。如果注册表中记录的版本与请求中指定的预期版本不匹配,则使用 DeleteThing 拒绝 VersionConflictException 请求。

输出

错误

ResourceNotFoundException

指定的资源不存在。

VersionConflictException

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

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。

DeleteThingGroup

删除事物组。

摘要

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

cli-input-json 格式

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

cli-input-json 字段

名称

类型

描述

thingGroupName

字符串

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

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

要删除的事物组的名称。

expectedVersion

long

要删除的事物组的预期版本。

输出

错误

InvalidRequestException

请求的内容无效。

VersionConflictException

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

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

DeleteThingShadow

删除指定事物的影子。

有关更多信息,请参阅 AWS IoT 开发人员指南中的 DeleteThingShadow

摘要

aws iot-data delete-thing-shadow \ --thing-name <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "thingName": "string" }

cli-input-json 字段

名称

类型

描述

thingName

字符串

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

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

事物的名称。

输出

{ "payload": "blob" }

CLI 输出字段

名称

类型

描述

payload

blob

状态信息,采用 JSON 格式。

错误

ResourceNotFoundException

指定的资源不存在。

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。

MethodNotAllowedException

不支持指定的 HTTP 动词和 URI 组合。

UnsupportedDocumentEncodingException

不支持的编码。

DeleteThingType

删除指定的事物类型。如果有事物与事物类型关联,则无法删除该事物类型。要删除事物类型,请先通过调用 DeprecateThingType 将其标记为已弃用,然后调用 UpdateThing 移除任意关联的事物以更改任意关联事物上的事物类型,最后使用 DeleteThingType 删除事物类型。

摘要

aws iot delete-thing-type \ --thing-type-name <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "thingTypeName": "string" }

cli-input-json 字段

名称

类型

描述

thingTypeName

字符串

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

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

事务类型的名称。

输出

错误

ResourceNotFoundException

指定的资源不存在。

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。

DeleteTopicRule

删除规则。

摘要

aws iot delete-topic-rule \ [--rule-name <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "ruleName": "string" }

cli-input-json 字段

名称

类型

描述

ruleName

字符串

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

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

规则的名称。

输出

错误

InternalException

出现意外错误。

InvalidRequestException

请求的内容无效。

ServiceUnavailableException

服务暂时不可用。

UnauthorizedException

您没有权限执行此操作。

ConflictingResourceUpdateException

资源更新冲突异常。在两个待处理更新导致冲突时,会引发此异常。

DeleteV2LoggingLevel

删除日志记录级别。

摘要

aws iot delete-v2-logging-level \ --target-type <value> \ --target-name <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "targetType": "string", "targetName": "string" }

cli-input-json 字段

名称

类型

描述

targetType

字符串

您要配置日志记录的资源的类型。必须是 THING_Group

枚举:DEFAULT | THING_GROUP

targetName

字符串

您要配置日志记录的资源的名称。

输出

错误

InternalException

出现意外错误。

InvalidRequestException

请求的内容无效。

ServiceUnavailableException

服务暂时不可用。

DeprecateThingType

弃用事物类型。您不能将新事物与已弃用事物类型关联。

摘要

aws iot deprecate-thing-type \ --thing-type-name <value> \ [--undo-deprecate | --no-undo-deprecate] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "thingTypeName": "string", "undoDeprecate": "boolean" }

cli-input-json 字段

名称

类型

描述

thingTypeName

字符串

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

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

要弃用的事物类型的名称。

undoDeprecate

布尔值

是否取消弃用已弃用的事物类型。如果为 true,则不再弃用该事物类型,您可以将其与事物关联。

输出

错误

ResourceNotFoundException

指定的资源不存在。

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。

DescribeAccountAuditConfiguration

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

摘要

aws iot describe-account-audit-configuration \ [--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 输出字段

名称

类型

描述

roleArn

字符串

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

相关角色的 ARN,该角色可授予 AWS IoT 在执行审核时根据需要访问您的设备、策略、证书及其他项目相关信息的权限。

第一次调用 UpdateAccountAuditConfiguration 时,必须提供此参数。

auditNotificationTargetConfigurations

map

有关此账户的审核通知要发送到的目标的相关信息。

targetArn

字符串

审核通知要发送到的目标(SNS 主题)的 ARN。

roleArn

字符串

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

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

已启用

布尔值

如果已启用向目标发送通知,则为 True。

auditCheckConfigurations

map

针对此账户启用和禁用的审核检查。

已启用

布尔值

如果已为此账户启用审核检查,则为 True。

错误

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

DescribeAuditTask

获取有关 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

字符串

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

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

您要获取审核信息的审核 ID。

输出

{ "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”。

枚举:IN_PROGRESS | COMPLETED | FAILED | CANCELED

taskType

字符串

审核类型,可以为:“ON_DEMAND_AUDIT_TASK”或“SCHEDULED_AUDIT_TASK”。

枚举:ON_DEMAND_AUDIT_TASK | SCHEDULED_AUDIT_TASK

taskStartTime

timestamp

审核的开始时间。

taskStatistics

TaskStatistics

有关审核的统计信息。

totalChecks

整数

此审核中检查的数量。

inProgressChecks

整数

正在进行的检查的数量。

waitingForDataCollectionChecks

整数

等待数据收集的检查的数量。

compliantChecks

整数

已发现合规资源的检查的数量。

nonCompliantChecks

整数

已发现不合规资源的检查的数量。

failedChecks

整数

检查的数量

canceledChecks

整数

因审核取消而未运行的检查的数量。

scheduledAuditName

字符串

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

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

计划审核的名称(仅当审核是计划审核时)。

auditDetails

map

有关在此审核过程中执行的每项检查的详细信息。

checkRunStatus

字符串

此检查的完成状态,以下项之一:“IN_PROGRESS”、“WAITING_FOR_DATA_COLLECTION”、“CANCELED”、“COMPLETED_COMPLIANT”、“COMPLETED_NON_COMPLIANT”或“FAILED”。

枚举:IN_PROGRESS | WAITING_FOR_DATA_COLLECTION | CANCELED | COMPLETED_COMPLIANT | COMPLETED_NON_COMPLIANT | FAILED

checkCompliant

布尔值

如果检查完成并找到所有合规资源,则为 True。

totalResourcesCount

long

已执行检查的资源的数量。

nonCompliantResourcesCount

long

检查已发现不合规的资源数量。

errorCode

字符串

在此审核过程中执行此检查时遇到的所有错误代码。“INSUFFICIENT_PERMISSIONS”或“AUDIT_CHECK_DISABLED”。

message

字符串

最大长度:2048

与在此审核过程中执行此检查时遇到的所有错误相关的消息。

错误

InvalidRequestException

请求的内容无效。

ResourceNotFoundException

指定的资源不存在。

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

DescribeAuthorizer

描述授权方。

摘要

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

cli-input-json 格式

{ "authorizerName": "string" }

cli-input-json 字段

名称

类型

描述

authorizerName

字符串

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

模式:[w=,@-]+

要描述的授权方的名称。

输出

{ "authorizerDescription": { "authorizerName": "string", "authorizerArn": "string", "authorizerFunctionArn": "string", "tokenKeyName": "string", "tokenSigningPublicKeys": { "string": "string" }, "status": "string", "creationDate": "timestamp", "lastModifiedDate": "timestamp" } }

CLI 输出字段

名称

类型

描述

authorizerDescription

AuthorizerDescription

授权方的描述。

authorizerName

字符串

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

模式:[w=,@-]+

授权方名称。

authorizerArn

字符串

授权方 ARN。

authorizerFunctionArn

字符串

授权方的 Lambda 函数 ARN。

tokenKeyName

字符串

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

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

用于从 HTTP 标头提取令牌的键。

tokenSigningPublicKeys

map

用于验证由自定义身份验证服务返回的令牌签名的公有密钥。

status

字符串

授权方的状态。

枚举:ACTIVE | INACTIVE

creationDate

timestamp

创建授权方的时间的 UNIX 时间戳。

lastModifiedDate

timestamp

上次更新授权方的时间的 UNIX 时间戳。

错误

ResourceNotFoundException

指定的资源不存在。

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。

DescribeBillingGroup

返回有关账单组的信息。

摘要

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

cli-input-json 格式

{ "billingGroupName": "string" }

cli-input-json 字段

名称

类型

描述

billingGroupName

字符串

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

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

账单组的名称。

输出

{ "billingGroupName": "string", "billingGroupId": "string", "billingGroupArn": "string", "version": "long", "billingGroupProperties": { "billingGroupDescription": "string" }, "billingGroupMetadata": { "creationDate": "timestamp" } }

CLI 输出字段

名称

类型

描述

billingGroupName

字符串

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

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

账单组的名称。

billingGroupId

字符串

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

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

账单组的 ID。

billingGroupArn

字符串

账单组的 ARN。

version

long

账单组的版本。

billingGroupProperties

BillingGroupProperties

账单组的属性。

billingGroupDescription

字符串

最大长度:2028

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

账单组的描述。

billingGroupMetadata

BillingGroupMetadata

有关账单组的其他信息。

creationDate

timestamp

创建账单组的日期。

错误

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

ResourceNotFoundException

指定的资源不存在。

DescribeCACertificate

描述已注册的 CA 证书。

摘要

aws iot describe-ca-certificate \ --certificate-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "certificateId": "string" }

cli-input-json 字段

名称

类型

描述

certificateId

字符串

最大长度:64,最小长度:64

模式:(0x)?[a-fA-F0-9]+

CA 证书标识符。

输出

{ "certificateDescription": { "certificateArn": "string", "certificateId": "string", "status": "string", "certificatePem": "string", "ownedBy": "string", "creationDate": "timestamp", "autoRegistrationStatus": "string", "lastModifiedDate": "timestamp", "customerVersion": "integer", "generationId": "string", "validity": { "notBefore": "timestamp", "notAfter": "timestamp" } }, "registrationConfig": { "templateBody": "string", "roleArn": "string" } }

CLI 输出字段

名称

类型

描述

certificateDescription

CACertificateDescription

CA 证书描述。

certificateArn

字符串

CA 证书 ARN。

certificateId

字符串

最大长度:64,最小长度:64

模式:(0x)?[a-fA-F0-9]+

CA 证书 ID。

status

字符串

CA 证书的状态。

枚举:ACTIVE | INACTIVE

certificatePem

字符串

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

PEM 格式的 CA 证书数据。

ownedBy

字符串

最大长度:12,最小长度:12

模式:[0-9]+

CA 证书的所有者。

creationDate

timestamp

CA 证书的创建日期。

autoRegistrationStatus

字符串

是否为设备证书的自动注册配置 CA 证书。有效值为“ENABLE”和“DISABLE”

枚举:ENABLE | DISABLE

lastModifiedDate

timestamp

上次修改 CA 证书的日期。

customerVersion

整数

范围 – 最小值:1

CA 证书的客户版本。

generationId

字符串

CA 证书的生成 ID。

有效性

CertificateValidity

CA 证书生效的时间。

notBefore

timestamp

证书在此日期之前无效。

notAfter

timestamp

证书在此日期之后无效。

registrationConfig

RegistrationConfig

有关注册配置的信息。

templateBody

字符串

模板正文。

roleArn

字符串

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

角色的 ARN。

错误

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。

ResourceNotFoundException

指定的资源不存在。

DescribeCertificate

获取有关指定证书的信息。

摘要

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

cli-input-json 格式

{ "certificateId": "string" }

cli-input-json 字段

名称

类型

描述

certificateId

字符串

最大长度:64,最小长度:64

模式:(0x)?[a-fA-F0-9]+

证书的 ID。(证书 ARN 的最后一部分包含证书 ID。)

输出

{ "certificateDescription": { "certificateArn": "string", "certificateId": "string", "caCertificateId": "string", "status": "string", "certificatePem": "string", "ownedBy": "string", "previousOwnedBy": "string", "creationDate": "timestamp", "lastModifiedDate": "timestamp", "customerVersion": "integer", "transferData": { "transferMessage": "string", "rejectReason": "string", "transferDate": "timestamp", "acceptDate": "timestamp", "rejectDate": "timestamp" }, "generationId": "string", "validity": { "notBefore": "timestamp", "notAfter": "timestamp" } } }

CLI 输出字段

名称

类型

描述

certificateDescription

CertificateDescription

证书的描述。

certificateArn

字符串

证书的 ARN。

certificateId

字符串

最大长度:64,最小长度:64

模式:(0x)?[a-fA-F0-9]+

证书的 ID。

caCertificateId

字符串

最大长度:64,最小长度:64

模式:(0x)?[a-fA-F0-9]+

签名此证书所用 CA 证书的证书 ID。

status

字符串

证书的状态。

枚举:ACTIVE | INACTIVE | REVOKED | PENDING_TRANSFER | REGISTER_INACTIVE | PENDING_ACTIVATION

certificatePem

字符串

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

PEM 格式的证书数据。

ownedBy

字符串

最大长度:12,最小长度:12

模式:[0-9]+

拥有证书的 AWS 账户的 ID。

previousOwnedBy

字符串

最大长度:12,最小长度:12

模式:[0-9]+

证书以前拥有者的 AWS 账户 ID。

creationDate

timestamp

证书的创建日期和时间。

lastModifiedDate

timestamp

上次修改证书的日期和时间。

customerVersion

整数

范围 – 最小值:1

证书的客户版本。

transferData

TransferData

传输数据。

transferMessage

字符串

最大长度:128

传输消息。

rejectReason

字符串

最大长度:128

拒绝传输的原因。

transferDate

timestamp

传输发生的日期。

acceptDate

timestamp

接受传输的日期。

rejectDate

timestamp

拒绝传输的日期。

generationId

字符串

证书的生成 ID。

有效性

CertificateValidity

证书生效的时间。

notBefore

timestamp

证书在此日期之前无效。

notAfter

timestamp

证书在此日期之后无效。

错误

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。

ResourceNotFoundException

指定的资源不存在。

DescribeDefaultAuthorizer

描述默认授权方。

摘要

aws iot describe-default-authorizer \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ }

输出

{ "authorizerDescription": { "authorizerName": "string", "authorizerArn": "string", "authorizerFunctionArn": "string", "tokenKeyName": "string", "tokenSigningPublicKeys": { "string": "string" }, "status": "string", "creationDate": "timestamp", "lastModifiedDate": "timestamp" } }

CLI 输出字段

名称

类型

描述

authorizerDescription

AuthorizerDescription

默认授权方的描述。

authorizerName

字符串

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

模式:[w=,@-]+

授权方名称。

authorizerArn

字符串

授权方 ARN。

authorizerFunctionArn

字符串

授权方的 Lambda 函数 ARN。

tokenKeyName

字符串

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

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

用于从 HTTP 标头提取令牌的键。

tokenSigningPublicKeys

map

用于验证由自定义身份验证服务返回的令牌签名的公有密钥。

status

字符串

授权方的状态。

枚举:ACTIVE | INACTIVE

creationDate

timestamp

创建授权方的时间的 UNIX 时间戳。

lastModifiedDate

timestamp

上次更新授权方的时间的 UNIX 时间戳。

错误

ResourceNotFoundException

指定的资源不存在。

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。

DescribeEndpoint

返回特定于发出调用的 AWS 账户的唯一终端节点。

摘要

aws iot describe-endpoint \ [--endpoint-type <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "endpointType": "string" }

cli-input-json 字段

名称

类型

描述

endpointType

字符串

终端节点类型。有效终端节点类型包括:

  • iot:Data – 返回一个 VeriSign 签名的数据终端节点。

  • iot:Data-ATS – 返回一个 ATS 签名的数据终端节点。

  • iot:CredentialProvider – 返回一个 AWS IoT 凭证提供程序 API 终端节点。

  • iot:Jobs – 返回一个 AWS IoT Device Management 任务 API 终端节点。

输出

{ "endpointAddress": "string" }

CLI 输出字段

名称

类型

描述

endpointAddress

字符串

终端节点。终端节点的格式如下:identifier.iot.region.amazonaws.com。

错误

InternalFailureException

出现意外错误。

InvalidRequestException

请求的内容无效。

UnauthorizedException

您没有权限执行此操作。

ThrottlingException

速率超过限制。

DescribeEventConfigurations

描述事件配置。

摘要

aws iot describe-event-configurations \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ }

输出

{ "eventConfigurations": { "string": { "Enabled": "boolean" } }, "creationDate": "timestamp", "lastModifiedDate": "timestamp" }

CLI 输出字段

名称

类型

描述

eventConfigurations

map

事件配置。

启用

布尔值

为 True 时启用配置。

creationDate

timestamp

事件配置的创建日期。

lastModifiedDate

timestamp

上次修改事件配置的日期。

错误

InternalFailureException

出现意外错误。

ThrottlingException

速率超过限制。

DescribeIndex

描述搜索索引。

摘要

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

cli-input-json 格式

{ "indexName": "string" }

cli-input-json 字段

名称

类型

描述

indexName

字符串

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

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

索引名称。

输出

{ "indexName": "string", "indexStatus": "string", "schema": "string" }

CLI 输出字段

名称

类型

描述

indexName

字符串

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

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

索引名称。

indexStatus

字符串

索引状态。

枚举:ACTIVE | BUILDING | REBUILDING

schema

字符串

包含一个特定于所执行索引类型的值。有效值为:

  • REGISTRY - 您的事物索引将只包含注册表数据。

  • REGISTRY_AND_SHADOW – 您的事物索引将包含注册表数据和影子数据。

  • REGISTRY_AND_CONNECTIVITY_STATUS – 您的事物索引将包含注册表数据和事物连接状态数据。

  • REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS – 您的事物索引将包含注册表数据、影子数据和事物连接状态数据。

错误

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。

ResourceNotFoundException

指定的资源不存在。

DescribeJob

描述任务。

摘要

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

cli-input-json 格式

{ "jobId": "string" }

cli-input-json 字段

名称

类型

描述

jobId

字符串

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

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

您在创建此作业时向其分配的唯一标识符。

输出

{ "documentSource": "string", "job": { "jobArn": "string", "jobId": "string", "targetSelection": "string", "status": "string", "forceCanceled": "boolean", "reasonCode": "string", "comment": "string", "targets": [ "string" ], "description": "string", "presignedUrlConfig": { "roleArn": "string", "expiresInSec": "long" }, "jobExecutionsRolloutConfig": { "maximumPerMinute": "integer", "exponentialRate": { "baseRatePerMinute": "integer", "incrementFactor": "double", "rateIncreaseCriteria": { "numberOfNotifiedThings": "integer", "numberOfSucceededThings": "integer" } } }, "abortConfig": { "criteriaList": [ { "failureType": "string", "action": "string", "thresholdPercentage": "double", "minNumberOfExecutedThings": "integer" } ] }, "createdAt": "timestamp", "lastUpdatedAt": "timestamp", "completedAt": "timestamp", "jobProcessDetails": { "processingTargets": [ "string" ], "numberOfCanceledThings": "integer", "numberOfSucceededThings": "integer", "numberOfFailedThings": "integer", "numberOfRejectedThings": "integer", "numberOfQueuedThings": "integer", "numberOfInProgressThings": "integer", "numberOfRemovedThings": "integer", "numberOfTimedOutThings": "integer" }, "timeoutConfig": { "inProgressTimeoutInMinutes": "long" } } }

CLI 输出字段

名称

类型

描述

documentSource

字符串

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

指向任务文档的 S3 链接。

任务

作业

该作业的相关信息。

jobArn

字符串

标识作业的 ARN,格式为“arn:aws:iot:region:account:job/jobId”。

jobId

字符串

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

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

您在创建此作业时向其分配的唯一标识符。

targetSelection

字符串

指定任务将继续运行 (CONTINUOUS),还是在指定作为目标的所有事物完成任务之后完成 (SNAPSHOT)。如果继续运行,则在检测到目标中出现更改时,任务也会在事物上运行。例如,当代表设备的某个事物添加到目标组时,会在该设备上运行任务,即使是组中原有的全部事物已经完成了任务。

枚举:CONTINUOUS | SNAPSHOT

status

字符串

任务的状态,为 IN_PROGRESSCANCELEDDELETION_IN_PROGRESSCOMPLETED 之一。

枚举:IN_PROGRESS | CANCELED | COMPLETED | DELETION_IN_PROGRESS

forceCanceled

布尔值

如果在取消任务时将可选的 true 参数设置为 force,则将为 true

reasonCode

字符串

最大长度:128

模式:[\\p{Upper}p Digit_]+

如果作业已更新,提供更新的原因代码。

comment

字符串

最大长度:2028

模式:[^\\p{C}]+

如果作业已更新,介绍更新原因。

targets

列表

成员:TargetArn

任务应发送到的 IoT 事物和事物组的列表。

description

字符串

最大长度:2028

模式:[^\\p{C}]+

作业的简短文本描述。

presignedUrlConfig

PresignedUrlConfig

预签名 S3 URL 的配置。

roleArn

字符串

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

IAM 角色的 ARN,该角色授予权限以从存储任务数据/更新的 S3 存储桶下载文件。该角色还必须授予 IoT 下载文件的权限。

expiresInSec

long

范围 – 最大值:3600,最小值:60

预签名 URL 的有效时间长度 (以秒为单位)。有效值为 60 – 3600,默认值为 3600 秒。预签名 URL 在 Jobs 接收任务文档的 MQTT 请求时生成。

jobExecutionsRolloutConfig

JobExecutionsRolloutConfig

允许您创建任务的分段部署。

maximumPerMinute

整数

范围 – 最小值:1

待处理任务每分钟通知事物的最大数量。此参数允许您创建分段部署。

exponentialRate

ExponentialRolloutRate

作业推出的增速。此参数允许您定义作业推出的指数速率。

baseRatePerMinute

整数

范围 – 最大值:1000,最小值:1

在作业推出开始时,每分钟接收待处理作业通知的事物的最小数量。此参数允许您定义推出的初始速率。

rateIncreaseCriteria

RateIncreaseCriteria

启动作业推出速率提高的条件。

AWS IoT 最多支持小数点后一位(例如,支持 1.5,但不支持 1.55)。

numberOfNotifiedThings

整数

范围 – 最小值:1

启动推出速率提高的被通知事物的数量阈值。

numberOfSucceededThings

整数

范围 – 最小值:1

启动推出速率提高的成功事物的数量阈值。

abortConfig

AbortConfig

中止作业的条件配置。

criteriaList

列表

成员:AbortCriteria

java 类:java.util.List

定义中止作业的规则的中止条件列表。

failureType

字符串

定义启动作业中止的规则的作业执行失败的类型。

枚举:FAILED | REJECTED | TIMED_OUT | ALL

action

字符串

启动作业中止的中止操作的类型。

枚举:CANCEL

minNumberOfExecutedThings

整数

范围 – 最小值:1

评估中止规则之前已执行事物的最小数量。

createdAt

timestamp

创建作业的时间,用从纪元开始的秒数表示。

lastUpdatedAt

timestamp

上次更新作业的时间,用从纪元开始的秒数表示。

completedAt

timestamp

完成作业的时间,用从纪元开始的秒数表示。

jobProcessDetails

JobProcessDetails

作业流程的详细信息。

processingTargets

列表

成员:ProcessingTargetName

java 类:java.util.List

任务执行推出到的目标设备。在任务执行已完成推出到所有目标设备后,此值将为空。

numberOfCanceledThings

整数

取消了任务的事物数。

numberOfSucceededThings

整数

成功完成任务的事物数。

numberOfFailedThings

整数

任务执行失败的事物数。

numberOfRejectedThings

整数

拒绝了任务的事物数。

numberOfQueuedThings

整数

等待任务执行的事物数。

numberOfInProgressThings

整数

当前正在执行任务的事物数。

numberOfRemovedThings

整数

因其已从作为任务目标的组中被删除或移除而不再计划执行的事物的数量。

numberOfTimedOutThings

整数

任务执行状态为 TIMED_OUT 的事物数。

timeoutConfig

TimeoutConfig

指定每个设备完成其作业执行所具有的时间。计时器在作业执行状态设置为 IN_PROGRESS 时启动。如果任务执行状态未在时间到期之前设置为其他最终状态,它会自动设置为 TIMED_OUT

inProgressTimeoutInMinutes

long

指定此设备完成该作业执行所具有的时间,以分钟为单位。超时间隔可以为 1 分钟到 7 天(1 到 10080 分钟)之间的任意长度。进行中计时器无法更新,将应用到该任务的全部任务执行。只要任务执行保持在 IN_PROGRESS 状态的时间长度超过了此间隔,任务执行将失败,并切换为最终 TIMED_OUT 状态。

错误

InvalidRequestException

请求的内容无效。

ResourceNotFoundException

指定的资源不存在。

ThrottlingException

速率超过限制。

ServiceUnavailableException

服务暂时不可用。

DescribeJobExecution

描述任务执行。

摘要

aws iot describe-job-execution \ --job-id <value> \ --thing-name <value> \ [--execution-number <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "jobId": "string", "thingName": "string", "executionNumber": "long" }

cli-input-json 字段

名称

类型

描述

jobId

字符串

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

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

您在创建此作业时向其分配的唯一标识符。

thingName

字符串

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

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

正在运行作业执行的事物的名称。

executionNumber

long

一个由从“0”到“9”的数字组成的字符串,用于指定特定设备上的特定任务执行。

输出

{ "execution": { "jobId": "string", "status": "string", "forceCanceled": "boolean", "statusDetails": { "detailsMap": { "string": "string" } }, "thingArn": "string", "queuedAt": "timestamp", "startedAt": "timestamp", "lastUpdatedAt": "timestamp", "executionNumber": "long", "versionNumber": "long", "approximateSecondsBeforeTimedOut": "long" } }

CLI 输出字段

名称

类型

描述

execution

JobExecution

作业执行的相关信息。

jobId

字符串

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

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

您在创建作业时向其分配的唯一标识符。

status

字符串

任务执行的状态(IN_PROGRESS、QUEUED、FAILED、SUCCEEDED、TIMED_OUT、CANCELED 或 REJECTED)。

枚举:QUEUED | IN_PROGRESS | SUCCEEDED | FAILED | TIMED_OUT | REJECTED | REMOVED | CANCELED

forceCanceled

布尔值

如果在取消任务执行时将可选的 true 参数设置为 force,则将为 true

statusDetails

JobExecutionStatusDetails

描述任务执行状态的名称/值对的集合。

detailsMap

map

任务执行状态。

thingArn

字符串

正在运行作业执行的事物的 ARN。

queuedAt

timestamp

作业执行入队的时间,用从纪元开始的秒数表示。

startedAt

timestamp

作业执行开始的时间,用从纪元开始的秒数表示。

lastUpdatedAt

timestamp

上次更新作业执行的时间,用从纪元开始的秒数表示。

executionNumber

long

一个由从“0”到“9”的数字组成的字符串,用于标识此特定设备上的该特定任务执行。它可在返回或更新任务执行信息的命令中使用。

versionNumber

long

作业执行的版本。每次设备更新任务执行版本时,版本将递增。

approximateSecondsBeforeTimedOut

long

任务执行状态更改为 TIMED_OUT 之前估计剩余的秒数。超时间隔可以为 1 分钟到 7 天(1 到 10080 分钟)之间的任意长度。实际作业执行超时可能晚于估计的持续时间最多 60 秒。如果任务执行进入了最终状态,则不包括此值。

错误

InvalidRequestException

请求的内容无效。

ResourceNotFoundException

指定的资源不存在。

ThrottlingException

速率超过限制。

ServiceUnavailableException

服务暂时不可用。

DescribeJobExecution

获取作业执行的详细信息。

摘要

aws iot-jobs-data describe-job-execution \ --job-id <value> \ --thing-name <value> \ [--include-job-document | --no-include-job-document] \ [--execution-number <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "jobId": "string", "thingName": "string", "includeJobDocument": "boolean", "executionNumber": "long" }

cli-input-json 字段

名称

类型

描述

jobId

字符串

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

创建此作业时向其分配的唯一标识符。

thingName

字符串

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

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

与正在运行作业执行的设备关联的事物名称。

includeJobDocument

布尔值

可选。设置为 true 时,响应将包含作业文档。默认为 false。

executionNumber

long

可选。标识特定设备上的特定任务执行的数字。如果未指定,则返回最新的作业执行。

输出

{ "execution": { "jobId": "string", "thingName": "string", "status": "string", "statusDetails": { "string": "string" }, "queuedAt": "long", "startedAt": "long", "lastUpdatedAt": "long", "approximateSecondsBeforeTimedOut": "long", "versionNumber": "long", "executionNumber": "long", "jobDocument": "string" } }

CLI 输出字段

名称

类型

描述

execution

JobExecution

包含有关作业执行的数据。

jobId

字符串

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

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

您在创建此作业时向其分配的唯一标识符。

thingName

字符串

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

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

正在执行作业的事物的名称。

status

字符串

任务执行的状态。可以为以下值之一:“QUEUED”、“IN_PROGRESS”、“FAILED”、“SUCCESS”、“CANCELED”、“TIMED_OUT”、“REJECTED”或“REMOVED”。

枚举:QUEUED | IN_PROGRESS | SUCCEEDED | FAILED | TIMED_OUT | REJECTED | REMOVED | CANCELED

statusDetails

map

描述任务执行状态的名称/值对的集合。

queuedAt

long

作业执行入队的时间,用从纪元开始的秒数表示。

startedAt

long

作业执行开始的时间,用从纪元开始的秒数表示。

lastUpdatedAt

long

上次更新作业执行的时间,用从纪元开始的秒数表示。

approximateSecondsBeforeTimedOut

long

任务执行状态更改为 TIMED_OUT 之前估计剩余的秒数。实际任务执行超时可能晚于估计的持续时间最多 60 秒。

versionNumber

long

作业执行的版本。每次设备更新作业执行版本时,版本将递增。

executionNumber

long

标识特定设备上的特定任务执行的数字。它可随后在返回或更新作业执行信息的命令中使用。

jobDocument

字符串

最大长度:32768

作业文档的内容。

错误

InvalidRequestException

请求的内容无效。

ResourceNotFoundException

指定的资源不存在。

ThrottlingException

速率超过限制。

ServiceUnavailableException

服务暂时不可用。

CertificateValidationException

证书无效。

TerminalStateException

任务处于最终状态。

DescribeRoleAlias

描述角色别名。

摘要

aws iot describe-role-alias \ --role-alias <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json 格式

{ "roleAlias": "string" }

cli-input-json 字段

名称

类型

描述

roleAlias

字符串

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

模式:[w=,@-]+

要描述的角色别名。

输出

{ "roleAliasDescription": { "roleAlias": "string", "roleAliasArn": "string", "roleArn": "string", "owner": "string", "credentialDurationSeconds": "integer", "creationDate": "timestamp", "lastModifiedDate": "timestamp" } }

CLI 输出字段

名称

类型

描述

roleAliasDescription

RoleAliasDescription

角色别名描述。

roleAlias

字符串

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

模式:[w=,@-]+

角色别名。

roleAliasArn

字符串

角色别名的 ARN。

roleArn

字符串

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

角色 ARN。

owner

字符串

最大长度:12,最小长度:12

模式:[0-9]+

角色别名所有者。

credentialDurationSeconds

整数

范围 – 最大值:3600,最小值:900

凭证有效的秒数。

creationDate

timestamp

创建角色别名的时间的 UNIX 时间戳。

lastModifiedDate

timestamp

上次修改角色别名的时间的 UNIX 时间戳。

错误

InvalidRequestException

请求的内容无效。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。

ResourceNotFoundException

指定的资源不存在。

DescribeScheduledAudit

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

摘要

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

字符串

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

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

您要获取其信息的计划审核的名称。

输出

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

CLI 输出字段

名称

类型

描述

frequency

字符串

计划审核的运行频率,“DAILY”、“WEEKLY”、“BIWEEKLY”或“MONTHLY”。每个审核的实际开始时间取决于系统。

枚举:DAILY | WEEKLY | BIWEEKLY | MONTHLY

dayOfMonth

字符串

模式:^([1-9]|[12][0-9]|3[01])$|^LAST$

运行计划审核当月的具体日期,可以是“1”到“31”的任意值或“LAST”。如果指定 29-31 日,但该月份没有那么多天,那么系统会在该月份的“LAST”天(最后一天)运行审核。

dayOfWeek

字符串

运行计划审核当周的具体日期,以下值之一:“SUN”、“MON”、“TUE”、“WED”、“THU”、“FRI”或“SAT”。

枚举:SUN | MON | TUE | WED | THU | FRI | SAT

targetCheckNames

列表

成员:AuditCheckName

计划审核期间执行的检查。(请注意,您的账户必须已启用检查功能。(使用 DescribeAccountAuditConfiguration 查看所有检查的列表,包括已启用的检查,或使用 UpdateAccountAuditConfiguration 选择已启用的检查。)

scheduledAuditName

字符串

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

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

计划审核的名称。

scheduledAuditArn

字符串

计划审核的 ARN。

错误

InvalidRequestException

请求的内容无效。

ResourceNotFoundException

指定的资源不存在。

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

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

字符串

最大长度: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

字符串

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

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

安全配置文件的名称。

securityProfileArn

字符串

安全配置文件的 ARN。

securityProfileDescription

字符串

最大长度:1000

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

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

behaviors

列表

成员:Behavior

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

name

字符串

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

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

您已为行为指定的名称。

指标

字符串

行为评估的内容。

criteria

BehaviorCriteria

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

comparisonOperator

字符串

将评估的事物 (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

列表

成员:Cidr

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

ports

列表

成员:Port

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

durationSeconds

整数

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

consecutiveDatapointsToAlarm

整数

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

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

consecutiveDatapointsToClear

整数

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

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

statisticalThreshold

StatisticalThreshold

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

统计数据

字符串

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

一个百分位数,它解析为用于确定符合行为的阈值。在指定的时间段内 (durationSeconds) 从账户中的所