@aws-sdk/客户端-iot-jobs-data-平面

说明

JavaScript IoTJobsDataPlane 节点客户端的 AWS SDK,浏览器和React Industrial.

IOT Jobs 是允许您定义一组工作的服务——远程操作 在连接到亚马逊网络服务IoT Core的一个或多个设备上发送和执行。 譬如说, 您可以定义指示一组设备下载和安装应用程序的工作或 固件更新、 重新启动、 旋转证书或进行远程故障排除 操作.

通过运行此程序查找 IOT 任务数据平面中动作的终点地址 CLI 命令 :

aws iot describe-endpoint --endpoint-type iot:Jobs

使用的服务名称 亚马逊网络服务 签字版本4 要签名的请求是: 工作数据。 。 。 .

为了创造工作,您会制作一份工作文件,描述远程 操作时,请指定一个清单,列出执行 操作。 目标可以是个人事物,事物组或者两者兼而有之.

IoT Jobs发出信息,告知目标有工作。 目标 通过下载工作文件、操作来启动任务执行 并报告进展。 工作服务提供命令 跟踪某项具体目标和所有具体目标的进展情况 任务

安装

要安装此软件包, 请使用您最喜欢的软件包管理器的 CLI :

• npm install @aws-sdk/client-iot-jobs-data-plane
• yarn add @aws-sdk/client-iot-jobs-data-plane
• pnpm add @aws-sdk/client-iot-jobs-data-plane

开始

导入

AWS SDK由客户端和命令进行调制. 要发送请求,只需导入 IoTJobsDataPlaneClient 财务报告和审定财务报表 例如,您需要的命令 GetPendingJobExecutionsCommand数字 :

// ES5 example
const { IoTJobsDataPlaneClient, GetPendingJobExecutionsCommand } = require("@aws-sdk/client-iot-jobs-data-plane");

// ES6+ example
import { IoTJobsDataPlaneClient, GetPendingJobExecutionsCommand } from "@aws-sdk/client-iot-jobs-data-plane";

使用量

发出请求:

• 以配置(如证书,区域)为客户端提供证据.
  • 见 文件/中心 用于配置细节.
  • 见 @aws- sdk/ 配置 附加选项.
• 以输入参数证明命令 .
• 打电话 send 操作客户端,以输入方式提供命令对象.

const client = new IoTJobsDataPlaneClient({ region: "REGION" });

const params = { /** input parameters */ };
const command = new GetPendingJobExecutionsCommand(params);

自动/等待

我们建议使用 等待时 运算符等待通过发送操作返回的承诺如下:

// async/await.
try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  // error handling.
} finally {
  // finally.
}

承诺

您还可以使用 承诺连锁。 。 。 .

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });

合并客户端

归集客户端类别从同套件中导出,但没有"Client"后缀.

IoTJobsDataPlane 扩展 IoTJobsDataPlaneClient 并额外支持所有操作,服务员, 和活人作为方法. 这种风格可能从JavaScript v2的AWS SDK中为您所熟悉.

如果你正在捆绑 AWS SDK, 我们建议只使用赤骨客户端(IoTJobsDataPlaneClient) (中文(简体) ). 更多详情见博客文章: javaScript 的 AWS SDK 模块包。 。 。 .

import { IoTJobsDataPlane } from "@aws-sdk/client-iot-jobs-data-plane";

const client = new IoTJobsDataPlane({ region: "REGION" });

// async/await.
try {
  const data = await client.getPendingJobExecutions(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .getPendingJobExecutions(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks (not recommended).
client.getPendingJobExecutions(params, (err, data) => {
  // process err and data.
});

解决问题

当服务返回例外时,错误将包括例外信息, 以及响应元数据(如请求编号).

try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  const { requestId, cfId, extendedRequestId } = error.$metadata;
  console.log({ requestId, cfId, extendedRequestId });
  /**
   * The keys within exceptions are also parsed.
   * You can access them by specifying exception names:
   * if (error.name === 'SomeServiceException') {
   *     const value = error.specialKeyInException;
   * }
   */
}

另见 文档/错误。 。 。 .

获取帮助

请利用这些社区资源获得帮助. 我们使用 GitHub 问题来跟踪错误和特性请求,但处理它们的带宽有限.

• 访问 开发者指南 或者说 API 参考。 。 。 .
• 看看贴有标签的博客文章 aws-sdk-js aWS 开发者博客.
• 问个问题 叠叠流 并贴上标签 aws-sdk-js。 。 。 .
• 加入 AWS JavaScript 社区 发光。 。 。 .
• 如果你发现你发现了一个虫子,请 打开一个问题。 。 。 .

为了测试您在Node.js中通用的JavaScript代码,浏览器和反应本地环境, 拜访我们 代码样本 repo。 。 。 .

捐款

此客户端代码是自动生成的. 任何修改在下次修改时都会被覆盖 @aws-sdk/client-iot-jobs-data-plane 软件包正在更新. 为了帮助客户,你可以检查我们 生成客户端脚本。 。 。 .

许可证

此 SDK 分布于 Apache 许可证,2.0版本, (中文(简体) ), 更多信息见LICENSE.

客户端命令( 操作列表)