@aws-sdk/client-auto-scaling-plans 3.1007.0 → 3.1009.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +26 -46
  2. package/package.json +33 -33
package/README.md CHANGED
@@ -42,8 +42,9 @@ previous</p>
42
42
  permissions for AWS Auto Scaling actions, see the <a href="https://docs.aws.amazon.com/autoscaling/plans/userguide/what-is-aws-auto-scaling.html">AWS Auto Scaling User Guide</a>. </p>
43
43
 
44
44
  ## Installing
45
- To install this package, simply type add or install @aws-sdk/client-auto-scaling-plans
46
- using your favorite package manager:
45
+
46
+ To install this package, use the CLI of your favorite package manager:
47
+
47
48
  - `npm install @aws-sdk/client-auto-scaling-plans`
48
49
  - `yarn add @aws-sdk/client-auto-scaling-plans`
49
50
  - `pnpm add @aws-sdk/client-auto-scaling-plans`
@@ -68,15 +69,15 @@ import { AutoScalingPlansClient, DescribeScalingPlansCommand } from "@aws-sdk/cl
68
69
 
69
70
  ### Usage
70
71
 
71
- To send a request, you:
72
+ To send a request:
72
73
 
73
- - Initiate client with configuration (e.g. credentials, region).
74
- - Initiate command with input parameters.
75
- - Call `send` operation on client with command object as input.
76
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
74
+ - Instantiate a client with configuration (e.g. credentials, region).
75
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
76
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
77
+ - Instantiate a command with input parameters.
78
+ - Call the `send` operation on the client, providing the command object as input.
77
79
 
78
80
  ```js
79
- // a client can be shared by different commands.
80
81
  const client = new AutoScalingPlansClient({ region: "REGION" });
81
82
 
82
83
  const params = { /** input parameters */ };
@@ -85,7 +86,7 @@ const command = new DescribeScalingPlansCommand(params);
85
86
 
86
87
  #### Async/await
87
88
 
88
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
89
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
89
90
  operator to wait for the promise returned by send operation as follows:
90
91
 
91
92
  ```js
@@ -100,26 +101,9 @@ try {
100
101
  }
101
102
  ```
102
103
 
103
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
104
- as compared to using Promise chains or callbacks.
105
-
106
104
  #### Promises
107
105
 
108
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
109
- to execute send operation.
110
-
111
- ```js
112
- client.send(command).then(
113
- (data) => {
114
- // process data.
115
- },
116
- (error) => {
117
- // error handling.
118
- }
119
- );
120
- ```
121
-
122
- Promises can also be called using `.catch()` and `.finally()` as follows:
106
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
123
107
 
124
108
  ```js
125
109
  client
@@ -135,27 +119,21 @@ client
135
119
  });
136
120
  ```
137
121
 
138
- #### Callbacks
139
-
140
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
141
- but they are supported by the send operation.
122
+ #### Aggregated client
142
123
 
143
- ```js
144
- // callbacks.
145
- client.send(command, (err, data) => {
146
- // process err and data.
147
- });
148
- ```
124
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
149
125
 
150
- #### v2 compatible style
126
+ `AutoScalingPlans` extends `AutoScalingPlansClient` and additionally supports all operations, waiters, and paginators as methods.
127
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
151
128
 
152
- The client can also send requests using v2 compatible style.
153
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
154
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
129
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`AutoScalingPlansClient`).
130
+ More details are in the blog post on
131
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
155
132
 
156
133
  ```ts
157
- import * as AWS from "@aws-sdk/client-auto-scaling-plans";
158
- const client = new AWS.AutoScalingPlans({ region: "REGION" });
134
+ import { AutoScalingPlans } from "@aws-sdk/client-auto-scaling-plans";
135
+
136
+ const client = new AutoScalingPlans({ region: "REGION" });
159
137
 
160
138
  // async/await.
161
139
  try {
@@ -175,7 +153,7 @@ client
175
153
  // error handling.
176
154
  });
177
155
 
178
- // callbacks.
156
+ // callbacks (not recommended).
179
157
  client.describeScalingPlans(params, (err, data) => {
180
158
  // process err and data.
181
159
  });
@@ -203,12 +181,14 @@ try {
203
181
  }
204
182
  ```
205
183
 
184
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
185
+
206
186
  ## Getting Help
207
187
 
208
188
  Please use these community resources for getting help.
209
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
189
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
210
190
 
211
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
191
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
212
192
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
213
193
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
214
194
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-auto-scaling-plans",
3
3
  "description": "AWS SDK for JavaScript Auto Scaling Plans Client for Node.js, Browser and React Native",
4
- "version": "3.1007.0",
4
+ "version": "3.1009.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:types' 'yarn:build:es' && yarn build:cjs",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-auto-scaling-plans",
@@ -21,41 +21,41 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "5.2.0",
23
23
  "@aws-crypto/sha256-js": "5.2.0",
24
- "@aws-sdk/core": "^3.973.19",
25
- "@aws-sdk/credential-provider-node": "^3.972.19",
26
- "@aws-sdk/middleware-host-header": "^3.972.7",
27
- "@aws-sdk/middleware-logger": "^3.972.7",
28
- "@aws-sdk/middleware-recursion-detection": "^3.972.7",
29
- "@aws-sdk/middleware-user-agent": "^3.972.20",
30
- "@aws-sdk/region-config-resolver": "^3.972.7",
31
- "@aws-sdk/types": "^3.973.5",
32
- "@aws-sdk/util-endpoints": "^3.996.4",
33
- "@aws-sdk/util-user-agent-browser": "^3.972.7",
34
- "@aws-sdk/util-user-agent-node": "^3.973.5",
35
- "@smithy/config-resolver": "^4.4.10",
36
- "@smithy/core": "^3.23.9",
37
- "@smithy/fetch-http-handler": "^5.3.13",
38
- "@smithy/hash-node": "^4.2.11",
39
- "@smithy/invalid-dependency": "^4.2.11",
40
- "@smithy/middleware-content-length": "^4.2.11",
41
- "@smithy/middleware-endpoint": "^4.4.23",
42
- "@smithy/middleware-retry": "^4.4.40",
43
- "@smithy/middleware-serde": "^4.2.12",
44
- "@smithy/middleware-stack": "^4.2.11",
45
- "@smithy/node-config-provider": "^4.3.11",
46
- "@smithy/node-http-handler": "^4.4.14",
47
- "@smithy/protocol-http": "^5.3.11",
48
- "@smithy/smithy-client": "^4.12.3",
49
- "@smithy/types": "^4.13.0",
50
- "@smithy/url-parser": "^4.2.11",
24
+ "@aws-sdk/core": "^3.973.20",
25
+ "@aws-sdk/credential-provider-node": "^3.972.21",
26
+ "@aws-sdk/middleware-host-header": "^3.972.8",
27
+ "@aws-sdk/middleware-logger": "^3.972.8",
28
+ "@aws-sdk/middleware-recursion-detection": "^3.972.8",
29
+ "@aws-sdk/middleware-user-agent": "^3.972.21",
30
+ "@aws-sdk/region-config-resolver": "^3.972.8",
31
+ "@aws-sdk/types": "^3.973.6",
32
+ "@aws-sdk/util-endpoints": "^3.996.5",
33
+ "@aws-sdk/util-user-agent-browser": "^3.972.8",
34
+ "@aws-sdk/util-user-agent-node": "^3.973.7",
35
+ "@smithy/config-resolver": "^4.4.11",
36
+ "@smithy/core": "^3.23.11",
37
+ "@smithy/fetch-http-handler": "^5.3.15",
38
+ "@smithy/hash-node": "^4.2.12",
39
+ "@smithy/invalid-dependency": "^4.2.12",
40
+ "@smithy/middleware-content-length": "^4.2.12",
41
+ "@smithy/middleware-endpoint": "^4.4.25",
42
+ "@smithy/middleware-retry": "^4.4.42",
43
+ "@smithy/middleware-serde": "^4.2.14",
44
+ "@smithy/middleware-stack": "^4.2.12",
45
+ "@smithy/node-config-provider": "^4.3.12",
46
+ "@smithy/node-http-handler": "^4.4.16",
47
+ "@smithy/protocol-http": "^5.3.12",
48
+ "@smithy/smithy-client": "^4.12.5",
49
+ "@smithy/types": "^4.13.1",
50
+ "@smithy/url-parser": "^4.2.12",
51
51
  "@smithy/util-base64": "^4.3.2",
52
52
  "@smithy/util-body-length-browser": "^4.2.2",
53
53
  "@smithy/util-body-length-node": "^4.2.3",
54
- "@smithy/util-defaults-mode-browser": "^4.3.39",
55
- "@smithy/util-defaults-mode-node": "^4.2.42",
56
- "@smithy/util-endpoints": "^3.3.2",
57
- "@smithy/util-middleware": "^4.2.11",
58
- "@smithy/util-retry": "^4.2.11",
54
+ "@smithy/util-defaults-mode-browser": "^4.3.41",
55
+ "@smithy/util-defaults-mode-node": "^4.2.44",
56
+ "@smithy/util-endpoints": "^3.3.3",
57
+ "@smithy/util-middleware": "^4.2.12",
58
+ "@smithy/util-retry": "^4.2.12",
59
59
  "@smithy/util-utf8": "^4.2.2",
60
60
  "tslib": "^2.6.2"
61
61
  },