@aws-sdk/客户端-工作文档
说明
JavaScript WorkDocs 客户端的 AWS SDK 为Node.js, 浏览器和React Introduct 服务.
Amazon WorkDocs API是为下列使用案例设计的:
-
文件迁移:文件迁移应用程序为用户提供支持 想要将文件从默认文件系统或默认文件系统移出 服务。 用户可以将文件插入用户目录结构,以及 允许基本的元数据修改,例如修改 文档.
-
安全:支持有下列功能的用户的安全应用程序: 额外的安全需要,如防病毒或数据丢失。 API (英语) 操作与 CloudTrail 一起,允许这些应用在 amazon WorkDocs中出现变化。 然后,申请可以采取必要的 动作并替换目标文件。 如果目标文件违反策略,则 应用程序也可以选择电子邮件给用户.
-
e. 发现/分析:支持一般行政应用程序, 例如eDiscovery和分析。 这些应用程序可以选择模仿或 与 CloudTrail 一起记录在 Amazon WorkDocs 网站上的行动 复制用于eDiscovery,备份,或分析应用的数据.
所有Amazon WorkDocs API动作都是亚马逊认证并签名的. 它们不仅需要使用亚马逊网络服务SDK,而且还允许独家使用 IAM用户和作用,帮助促进访问、信任和许可政策。 以 创建角色并允许 IAM 用户访问 Amazon WorkDocs 网站 IAM用户在整个Amazon WorkDocs网站(或 (见IAM政策)。 包括但不限于修改文件的能力 权限并上传到任何用户。 这样可以让开发者执行三个 以及使用户能够有选择地允许访问 使用IAM模型.
Amazon WorkDocs API的定价因这些动作的API调用类型而不同:
-
READ (Get*) -
WRITE (Activate*, Add*, Create*, Deactivate*, Initiate*, Update*) -
LIST (Describe*) -
DELETE*, CANCEL
关于Amazon WorkDocs API定价的信息,参见 亚马逊工作 Docs 定价。 。 。 .
安装
要安装此软件包, 请使用您最喜欢的软件包管理器的 CLI :
npm install @aws-sdk/client-workdocsyarn add @aws-sdk/client-workdocspnpm add @aws-sdk/client-workdocs
开始
导入
AWS SDK由客户端和命令进行调制.
要发送请求,只需导入 WorkDocsClient 财务报告和审定财务报表
例如,您需要的命令 DescribeUsersCommand数字 :
// ES5 example
const { WorkDocsClient, DescribeUsersCommand } = require("@aws-sdk/client-workdocs");
// ES6+ example
import { WorkDocsClient, DescribeUsersCommand } from "@aws-sdk/client-workdocs";
使用量
发出请求:
- 以配置(如证书,区域)为客户端提供证据.
- 见 文件/中心 用于配置细节.
- 见 @aws- sdk/ 配置 附加选项.
- 以输入参数证明命令 .
- 打电话
send操作客户端,以输入方式提供命令对象.
const client = new WorkDocsClient({ region: "REGION" });
const params = { /** input parameters */ };
const command = new DescribeUsersCommand(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"后缀.
WorkDocs 扩展 WorkDocsClient 并额外支持所有操作,服务员, 和活人作为方法.
这种风格可能从JavaScript v2的AWS SDK中为您所熟悉.
如果你正在捆绑 AWS SDK, 我们建议只使用赤骨客户端(WorkDocsClient) (中文(简体) ).
更多详情见博客文章:
javaScript 的 AWS SDK 模块包。 。 。 .
import { WorkDocs } from "@aws-sdk/client-workdocs";
const client = new WorkDocs({ region: "REGION" });
// async/await.
try {
const data = await client.describeUsers(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.describeUsers(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks (not recommended).
client.describeUsers(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-workdocs 软件包正在更新.
为了帮助客户,你可以检查我们 生成客户端脚本。 。 。 .
许可证
此 SDK 分布于 Apache 许可证,2.0版本, (中文(简体) ), 更多信息见LICENSE.