The OpsWorks services have reached end of life and have been disabled for both new and existing customers.\nWe strongly recommend customers migrate their workloads to other solutions as soon as possible. If you have questions about migration, reach out to the Amazon Web ServicesSupport Team on Amazon Web Services re:Post or through Amazon Web Services Premium Support.
\nOpsWorks CM is a service that runs and manages\nconfiguration management servers. You can use OpsWorks CM to create and manage OpsWorks for Chef Automate and\nOpsWorks for Puppet Enterprise servers, and add or remove\nnodes for the servers to manage.
\n\nGlossary of terms\n
\n\nServer: A configuration management server that can be\nhighly-available. The configuration management server runs on\nan Amazon Elastic Compute Cloud (EC2) instance, and may use various other Amazon Web Services services, such as Amazon Relational Database Service\n(RDS) and Elastic Load Balancing. A server is a generic abstraction over the configuration\nmanager that you want to use, much like Amazon RDS. In OpsWorks CM, you do not start\nor stop servers. After you create servers, they continue to run until they are deleted.
\n\nEngine: The engine is the specific configuration manager\nthat you want to use. Valid values in this release include ChefAutomate and Puppet.
\nBackup: This\nis an application-level backup of the data that the configuration manager\nstores. OpsWorks CM\ncreates an S3 bucket for backups when you launch the first\nserver. A backup maintains a snapshot of a server's configuration-related\nattributes at the time the backup starts.
\n\nEvents:\nEvents are always related to a server. Events are written\nduring server creation, when health checks run, when backups\nare created, when system maintenance is performed, etc. When you delete a server, the server's events are\nalso deleted.
\n\nAccount attributes:\nEvery account has attributes that are assigned in the OpsWorks CM\ndatabase. These attributes store information about configuration limits (servers,\nbackups, etc.) and your customer account.\n
\n\nEndpoints\n
\nOpsWorks CM supports the following endpoints, all HTTPS. You must connect to one of the following endpoints.\nYour servers\ncan only be accessed or managed within the endpoint in which they are created.
\nopsworks-cm.us-east-1.amazonaws.com
\nopsworks-cm.us-east-2.amazonaws.com
\nopsworks-cm.us-west-1.amazonaws.com
\nopsworks-cm.us-west-2.amazonaws.com
\nopsworks-cm.ap-northeast-1.amazonaws.com
\nopsworks-cm.ap-southeast-1.amazonaws.com
\nopsworks-cm.ap-southeast-2.amazonaws.com
\nopsworks-cm.eu-central-1.amazonaws.com
\nopsworks-cm.eu-west-1.amazonaws.com
\nFor more information, see OpsWorks endpoints and quotas in the Amazon Web Services General Reference.
\n\nThrottling limits\n
\nAll API operations allow for five requests per second with a burst of 10 requests per second.
\n\n## Installing\n\nTo install this package, simply type add or install @aws-sdk/client-opsworkscm\nusing your favorite package manager:\n\n- `npm install @aws-sdk/client-opsworkscm`\n- `yarn add @aws-sdk/client-opsworkscm`\n- `pnpm add @aws-sdk/client-opsworkscm`\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands.\nTo send a request, you only need to import the `OpsWorksCMClient` and\nthe commands you need, for example `ListTagsForResourceCommand`:\n\n```js\n// ES5 example\nconst { OpsWorksCMClient, ListTagsForResourceCommand } = require(\"@aws-sdk/client-opsworkscm\");\n```\n\n```ts\n// ES6+ example\nimport { OpsWorksCMClient, ListTagsForResourceCommand } from \"@aws-sdk/client-opsworkscm\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region).\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```js\n// a client can be shared by different commands.\nconst client = new OpsWorksCMClient({ region: \"REGION\" });\n\nconst params = {\n /** input parameters */\n};\nconst command = new ListTagsForResourceCommand(params);\n```\n\n#### Async/await\n\nWe recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)\noperator to wait for the promise returned by send operation as follows:\n\n```js\n// async/await.\ntry {\n const data = await client.send(command);\n // process data.\n} catch (error) {\n // error handling.\n} finally {\n // finally.\n}\n```\n\nAsync-await is clean, concise, intuitive, easy to debug and has better error handling\nas compared to using Promise chains or callbacks.\n\n#### Promises\n\nYou can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)\nto execute send operation.\n\n```js\nclient.send(command).then(\n (data) => {\n // process data.\n },\n (error) => {\n // error handling.\n }\n);\n```\n\nPromises can also be called using `.catch()` and `.finally()` as follows:\n\n```js\nclient\n .send(command)\n .then((data) => {\n // process data.\n })\n .catch((error) => {\n // error handling.\n })\n .finally(() => {\n // finally.\n });\n```\n\n#### Callbacks\n\nWe do not recommend using callbacks because of [callback hell](http://callbackhell.com/),\nbut they are supported by the send operation.\n\n```js\n// callbacks.\nclient.send(command, (err, data) => {\n // process err and data.\n});\n```\n\n#### v2 compatible style\n\nThe client can also send requests using v2 compatible style.\nHowever, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post\non [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)\n\n```ts\nimport * as AWS from \"@aws-sdk/client-opsworkscm\";\nconst client = new AWS.OpsWorksCM({ region: \"REGION\" });\n\n// async/await.\ntry {\n const data = await client.listTagsForResource(params);\n // process data.\n} catch (error) {\n // error handling.\n}\n\n// Promises.\nclient\n .listTagsForResource(params)\n .then((data) => {\n // process data.\n })\n .catch((error) => {\n // error handling.\n });\n\n// callbacks.\nclient.listTagsForResource(params, (err, data) => {\n // process err and data.\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information,\nas well as response metadata (e.g. request id).\n\n```js\ntry {\n const data = await client.send(command);\n // process data.\n} catch (error) {\n const { requestId, cfId, extendedRequestId } = error.$metadata;\n console.log({ requestId, cfId, extendedRequestId });\n /**\n * The keys within exceptions are also parsed.\n * You can access them by specifying exception names:\n * if (error.name === 'SomeServiceException') {\n * const value = error.specialKeyInException;\n * }\n */\n}\n```\n\n## Getting Help\n\nPlease use these community resources for getting help.\nWe use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.\n\n- Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)\n or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).\n- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)\n on AWS Developer Blog.\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`.\n- Join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3).\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues/new/choose).\n\nTo test your universal JavaScript code in Node.js, browser and react-native environments,\nvisit our [code samples repo](https://github.com/aws-samples/aws-sdk-js-tests).\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/client-opsworkscm` package is updated.\nTo contribute to client you can check our [generate clients scripts](https://github.com/aws/aws-sdk-js-v3/tree/main/scripts/generate-clients).\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n## Client Commands (Operations List)\n\n