@aws- sdk/ 客户端- pinpoint- 电子邮件
说明
JavaScript PinpointEmail客户端的 AWS SDK 为Node.js, 浏览器和React Introduct 服务.
亚马逊平分电子邮件服务
欢迎光临 Amazon Pinpoint 电子邮件 API 参考。本指南提供 关于Amazon Pinpoint Email API(1.0版)的信息,包括支持的信息 操作、数据类型、参数和计划.
亚马逊平分 您的 AWS 服务 可以通过多个消息渠道与客户接触。 你用得着 Amazon Pinpoint 发送电子邮件,短信,语音信息,并按下通知. 这个 Amazon Pinpoint Email API 提供程序访问选项,这些选项是该平台独有的 电子邮件通道并补充由Amazon Pinpoint API提供的选项.
如果你是亚马逊宾点的新人, 你可能会发现它有帮助 同时审查 亚马逊 Pinpoint 开发者指南编辑 亚马逊平分开发者 指南 提供演示 如何在程序上使用 Amazon Pinpoint 功能以及如何将 Amazon Pinpoint 功能整合到 移动应用程序和其他类型的应用程序. 该指南还提供关于下列方面的信息: 关键议题,如亚马逊平点与其他AWS服务的整合以及适用的限制 使用服务.
Amazon Pinpoint 电子邮件 API 可在多个 AWS 区域获得,它提供了一个终点 每一个地区。 API所在的所有区域和终点列表 现有,见 AWS 服务端点 内 页:1 亚马逊网络服务总参考。欲进一步了解AWS区域,请参见 管理AWS 区域 输入 亚马逊网络服务总参考。 。 。 .
在每个地区,AWS维持多个可用区. 这些可用区域 彼此隔绝,但由私人、低纬度, 高通量,以及高度冗余的网络连接. 这些可用区域 使我们能够提供非常高的可用性和冗余,同时 尽可能减少延迟。 了解更多关于可提供区的数量 各区可提供的数据,见 AWS 全球基础设施。 。 。 .
安装
要安装此软件包, 请使用您最喜欢的软件包管理器的 CLI :
npm install @aws-sdk/client-pinpoint-emailyarn add @aws-sdk/client-pinpoint-emailpnpm add @aws-sdk/client-pinpoint-email
开始
导入
AWS SDK由客户端和命令进行调制.
要发送请求,只需导入 PinpointEmailClient 财务报告和审定财务报表
例如,您需要的命令 ListConfigurationSetsCommand数字 :
// ES5 example
const { PinpointEmailClient, ListConfigurationSetsCommand } = require("@aws-sdk/client-pinpoint-email");
// ES6+ example
import { PinpointEmailClient, ListConfigurationSetsCommand } from "@aws-sdk/client-pinpoint-email";
使用量
发出请求:
- 以配置(如证书,区域)为客户端提供证据.
- 见 文件/中心 用于配置细节.
- 见 @aws- sdk/ 配置 附加选项.
- 以输入参数证明命令 .
- 打电话
send操作客户端,以输入方式提供命令对象.
const client = new PinpointEmailClient({ region: "REGION" });
const params = { /** input parameters */ };
const command = new ListConfigurationSetsCommand(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"后缀.
PinpointEmail 扩展 PinpointEmailClient 并额外支持所有操作,服务员, 和活人作为方法.
这种风格可能从JavaScript v2的AWS SDK中为您所熟悉.
如果你正在捆绑 AWS SDK, 我们建议只使用赤骨客户端(PinpointEmailClient) (中文(简体) ).
更多详情见博客文章:
javaScript 的 AWS SDK 模块包。 。 。 .
import { PinpointEmail } from "@aws-sdk/client-pinpoint-email";
const client = new PinpointEmail({ region: "REGION" });
// async/await.
try {
const data = await client.listConfigurationSets(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listConfigurationSets(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks (not recommended).
client.listConfigurationSets(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-jsaWS 开发者博客. - 问个问题 叠叠流 并贴上标签
aws-sdk-js。 。 。 . - 加入 AWS JavaScript 社区 发光。 。 。 .
- 如果你发现你发现了一个虫子,请 打开一个问题。 。 。 .
为了测试您在Node.js中通用的JavaScript代码,浏览器和反应本地环境, 拜访我们 代码样本 repo。 。 。 .
捐款
此客户端代码是自动生成的. 任何修改在下次修改时都会被覆盖 @aws-sdk/client-pinpoint-email 软件包正在更新.
为了帮助客户,你可以检查我们 生成客户端脚本。 。 。 .
许可证
此 SDK 分布于 Apache 许可证,2.0版本, (中文(简体) ), 更多信息见LICENSE.