@aws-sdk/客户端-iot-1点击-devices- service

说明

JavaScript IoT1ClickDevices Service客户端的 AWS SDK 为Node.js, 浏览器和React Introduct 服务客户端.

描述服务的所有AWS IOT 1-Click设备相关的API操作. 还为所支持的网络服务提供抽样请求、答复和错误 协议.

安装

要安装此软件包, 只需输入或安装 @aws- sdk/ client- iot-1 click- devices- service 使用您最喜欢的软件包管理器 :

• npm install @aws-sdk/client-iot-1click-devices-service
• yarn add @aws-sdk/client-iot-1click-devices-service
• pnpm add @aws-sdk/client-iot-1click-devices-service

开始

导入

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

// ES5 example
const { IoT1ClickDevicesServiceClient, ListDevicesCommand } = require("@aws-sdk/client-iot-1click-devices-service");

// ES6+ example
import { IoT1ClickDevicesServiceClient, ListDevicesCommand } from "@aws-sdk/client-iot-1click-devices-service";

使用量

为了发出一个请求,你:

• 以配置启动客户端(如证书,区域).
• 用输入参数启动命令 .
• 打电话 send 在客户端上操作,以命令对象作为输入.
• 如果您使用自定义 http 处理器, 您可以拨打 destroy() 关闭打开的连接.

// a client can be shared by different commands.
const client = new IoT1ClickDevicesServiceClient({ region: "REGION" });

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

自动/等待

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

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

Async-await 是干净的,简洁的,直观的,容易调试的,并且有更好的错误处理 与使用 " 承诺 " 链条或回调相比.

承诺

您还可以使用 承诺连锁 以执行发送操作.

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

承诺也可以称为使用 .catch() 财务报告和审定财务报表 .finally() 内容如下:

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

回电

我们不建议使用回调,因为 召回地狱, (中文(简体) ), 但他们得到发送操作的支持.

// callbacks.
client.send(command, (err, data) => {
  // process err and data.
});

v2 兼容样式

客户端也可以使用v2相容的样式发送请求. 然而,这导致了更大的捆绑尺寸,并可能在下个主要版本中下降. 更多细节在博客文章中 打开 javaScript 的 AWS SDK 模块包

import * as AWS from "@aws-sdk/client-iot-1click-devices-service";
const client = new AWS.IoT1ClickDevicesService({ region: "REGION" });

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

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

// callbacks.
client.listDevices(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-1click-devices-service 软件包正在更新. 为了帮助客户,你可以检查我们 生成客户端脚本。 。 。 .

许可证

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

客户端命令( 操作列表)