# @aws-sdk/client-opsworkscm 中文文档

规范地址：https://npmcn.com/package/%40aws-sdk/client-opsworkscm/

版本：3\.876\.0
npm 元数据更新时间：2025-08-27T21:06:13.041Z
中文译文更新时间：2026-11-07T12:29:17.689Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40aws-sdk/client-opsworkscm
原文对照：https://npmcn.com/package/%40aws-sdk/client-opsworkscm/?lang=original
项目主页：https://github.com/aws/aws-sdk-js-v3/tree/main/clients/client-opsworkscm
源码仓库：https://github.com/aws/aws-sdk-js-v3

弃用说明：The OpsWorksCM client was removed from the SDK\.

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：501 kB，149 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.0\.0
- 运行依赖：40 个
- 首次发布：2020-01-08T03:13:07.659Z
- 最新版本发布：2025-08-26T19:03:39.420Z
- 近 30 天下载量：88283（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：479（近 12 个月 0 个）

## 中文简介

JavaScript Opsworkscm 节点客户端的 AWS SDK, 浏览器和反应原生

## 安装

```sh
npm install @aws-sdk/client-opsworkscm
```

也可以使用：`pnpm add @aws-sdk/client-opsworkscm`、`yarn add @aws-sdk/client-opsworkscm`、`bun add @aws-sdk/client-opsworkscm`

## README

# @aws-sdk/ 客户端- opsworkscm

## 说明

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

操作工作 CM

OpsWorks服务已到生命的尽头,并为新客户和现有客户停用. 我们强烈建议客户尽快将其工作量转移到其他解决办法。 如果您对移民有疑问,请联系亚马逊网络服务支持小组 [亚马逊网络服务 re: Post](https://repost.aws/) 或通过 [亚马逊网络服务 Premium 支持](https://aws.amazon.com/support)。 。 。 .

OpsWorks CM 是一个运行和管理的服务 配置管理服务器. 您可以使用 OpsWorks CM 创建和管理 OpsWorks,用于主厨自动和 用于傀儡企业服务器的 OpsWorks, 并添加或删除 服务器管理的节点 .

**术语表**

-   **服务器**: 一个可以使用的配置管理服务器 高度可用的。 配置管理服务器运行于 a 亚马逊弹性计算云(EC2)实例,并可能使用亚马逊其他各种网络服务,如亚马逊关系数据库服务 (RDS)和弹性负载平衡。 服务器是配置的通用抽象 您想要使用的管理器, 很像 Amazon RDS 。 在 OpsWorks CM 中,您不启动 或停止服务器。 在您创建服务器后,它们会继续运行,直到被删除.
    
-   **发动机**: 引擎是特定的配置管理器 您想要使用的。 此发行中的有效值包括 `ChefAutomate` 财务报告和审定财务报表 `Puppet`。 。 。 .
    
-   **备份**: 这个 是配置管理器的数据的应用程序级备份 商店。 操作工作 CM 在启动第一个时创建 S3 备份桶 服务器。 备份维护服务器配置相关的快照 属性.
    
-   **活动**数字 : 事件总是与服务器有关. 事件被写入 服务器创建、健康检查运行、备份时 当系统进行维护时,将创建。 删除服务器时,服务器的事件是 还被删除.
    
-   **账户属性**数字 : 每个账户都有OpsWorks CM中指定的属性 数据库。 这些属性存储关于配置限制的信息(服务器, 备份等)和客户账户.
    

**终点**

OpsWorks CM支持以下终点,全部为HTTPS. 您必须连接到以下终点之一 . 您的服务器 只能在其创建的端点内访问或管理.

-   (原始内容存档于2017-10-21). opsworks-cm.us-east-1.amazonaws.com
    
-   opsworks-cm.us-east-2.amazonaws.com (英语)
    
-   opsworks-cm.us-west-1.amazonaws.com (原始内容存档于2012-10-12)
    
-   opsworks-cm.us-west-2.amazonaws.com 互联网档案馆的存檔,存档日期2013-12-2
    
-   (原始内容存档于2018-10-12). opsworks-cm.ap-northest-1.amazonaws.com
    
-   (原始内容存档于2018-10-12). opsworks-cm.ap-sunish-sunish--1.amazonaws.com
    
-   (原始内容存档于2017-10-21). opsworks-cm.ap-sunestival-2.amazonaws.com
    
-   (原始内容存档于2013-10-12). opsworks-cm.eu-central-1.amazonaws.com
    
-   (原始内容存档于2018-10-12). opsworks-cm.eu-west-1.amazonaws.com
    

更多信息见 [工作终点和配额](https://docs.aws.amazon.com/general/latest/gr/opsworks-service.html) 在亚马逊网络服务总参考资料.

**调压限制**

所有API操作允许每秒5个请求,每秒10个请求突起.

## 安装

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

-   `npm install @aws-sdk/client-opsworkscm`
-   `yarn add @aws-sdk/client-opsworkscm`
-   `pnpm add @aws-sdk/client-opsworkscm`

## 开始

### 导入

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

```js
// ES5 example
const { OpsWorksCMClient, ListTagsForResourceCommand } = require("@aws-sdk/client-opsworkscm");
```

```ts
// ES6+ example
import { OpsWorksCMClient, ListTagsForResourceCommand } from "@aws-sdk/client-opsworkscm";
```

### 使用量

为了发出一个请求,你:

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

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

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

#### 自动/等待

我们建议使用 [等待时](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await) 运算符等待通过发送操作返回的承诺如下:

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

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

#### 承诺

您还可以使用 [承诺连锁](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining) 以执行发送操作.

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

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

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

#### 回电

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

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

#### v2 兼容样式

客户端也可以使用v2相容的样式发送请求. 然而,这导致了更大的捆绑尺寸,并可能在下个主要版本中下降. 更多细节在博客文章中 打开 [javaScript 的 AWS SDK 模块包](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)

```ts
import * as AWS from "@aws-sdk/client-opsworkscm";
const client = new AWS.OpsWorksCM({ region: "REGION" });

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

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

// callbacks.
client.listTagsForResource(params, (err, data) => {
  // process err and data.
});
```

### 解决问题

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

```js
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 问题来跟踪错误和特性请求,但处理它们的带宽有限.

-   访问 [开发者指南](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html) 或者说 [API 参考](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html)。 。 。 .
-   看看贴有标签的博客文章 [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/) aWS 开发者博客.
-   问个问题 [叠叠流](https://stackoverflow.com/questions/tagged/aws-sdk-js) 并贴上标签 `aws-sdk-js`。 。 。 .
-   加入 AWS JavaScript 社区 [发光](https://gitter.im/aws/aws-sdk-js-v3)。 。 。 .
-   如果你发现你发现了一个虫子,请 [打开一个问题](https://github.com/aws/aws-sdk-js-v3/issues/new/choose)。 。 。 .

为了测试您在Node.js中通用的JavaScript代码,浏览器和反应本地环境, 拜访我们 [代码样本 repo](https://github.com/aws-samples/aws-sdk-js-tests)。 。 。 .

## 捐款

此客户端代码是自动生成的. 任何修改在下次修改时都会被覆盖 `@aws-sdk/client-opsworkscm` 软件包正在更新. 为了帮助客户,你可以检查我们 [生成客户端脚本](https://github.com/aws/aws-sdk-js-v3/tree/main/scripts/generate-clients)。 。 。 .

## 许可证

此 SDK 分布于 [Apache 许可证,2.0版本](http://www.apache.org/licenses/LICENSE-2.0), (中文(简体) ), 更多信息见LICENSE.

## 客户端命令( 操作列表)

联合节点

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/opsworkscm/command/AssociateNodeCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/AssociateNodeCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/AssociateNodeCommandOutput/)

创建备份

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/opsworkscm/command/CreateBackupCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/CreateBackupCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/CreateBackupCommandOutput/)

创建服务器

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/opsworkscm/command/CreateServerCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/CreateServerCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/CreateServerCommandOutput/)

删除备份

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/opsworkscm/command/DeleteBackupCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/DeleteBackupCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/DeleteBackupCommandOutput/)

删除服务器

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/opsworkscm/command/DeleteServerCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/DeleteServerCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/DeleteServerCommandOutput/)

描述账户属性

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/opsworkscm/command/DescribeAccountAttributesCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/DescribeAccountAttributesCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/DescribeAccountAttributesCommandOutput/)

描述备份

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/opsworkscm/command/DescribeBackupsCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/DescribeBackupsCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/DescribeBackupsCommandOutput/)

描述事件

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/opsworkscm/command/DescribeEventsCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/DescribeEventsCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/DescribeEventsCommandOutput/)

描述节点协会状况

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/opsworkscm/command/DescribeNodeAssociationStatusCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/DescribeNodeAssociationStatusCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/DescribeNodeAssociationStatusCommandOutput/)

描述服务员

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/opsworkscm/command/DescribeServersCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/DescribeServersCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/DescribeServersCommandOutput/)

断开连接节点

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/opsworkscm/command/DisassociateNodeCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/DisassociateNodeCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/DisassociateNodeCommandOutput/)

导出服务器引擎属性

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/opsworkscm/command/ExportServerEngineAttributeCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/ExportServerEngineAttributeCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/ExportServerEngineAttributeCommandOutput/)

列表标签格式资源

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/opsworkscm/command/ListTagsForResourceCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/ListTagsForResourceCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/ListTagsForResourceCommandOutput/)

还原服务器

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/opsworkscm/command/RestoreServerCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/RestoreServerCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/RestoreServerCommandOutput/)

开始维护

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/opsworkscm/command/StartMaintenanceCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/StartMaintenanceCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/StartMaintenanceCommandOutput/)

标签资源

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/opsworkscm/command/TagResourceCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/TagResourceCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/TagResourceCommandOutput/)

调和资源

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/opsworkscm/command/UntagResourceCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/UntagResourceCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/UntagResourceCommandOutput/)

更新服务器

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/opsworkscm/command/UpdateServerCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/UpdateServerCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/UpdateServerCommandOutput/)

更新服务器引擎属性

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/opsworkscm/command/UpdateServerEngineAttributesCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/UpdateServerEngineAttributesCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-opsworkscm/Interface/UpdateServerEngineAttributesCommandOutput/)

## 常见问题

### @aws-sdk/client-opsworkscm 是什么？

JavaScript Opsworkscm 节点客户端的 AWS SDK, 浏览器和反应原生注意：该包已被作者标记为弃用——The OpsWorksCM client was removed from the SDK\.

### 如何安装 @aws-sdk/client-opsworkscm？

在项目目录运行 npm install @aws-sdk/client-opsworkscm，或使用 pnpm add / yarn add / bun add。

### @aws-sdk/client-opsworkscm 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @aws-sdk/client-opsworkscm 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @aws-sdk/client-opsworkscm 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @aws-sdk/client-opsworkscm 可以商用吗？

@aws-sdk/client-opsworkscm 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @aws-sdk/client-opsworkscm 的下载量有多少？

根据 npm 官方下载统计，@aws-sdk/client-opsworkscm 在 2026/10/08 – 2026/11/06 这 30 天内被下载 88,283 次，日均约 2,943 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @aws-sdk/client-opsworkscm 还在维护吗？

最新版本 3\.876\.0 发布于 2025/08/27（1\.2 年前）；至今共发布 479 个版本，其中过去 12 个月发布了 0 个；首次发布于 2020/01/08。作者已将其标记为弃用，新项目建议寻找替代方案。