@aws-sdk/client-cloudformation 3.1008.0 → 3.1010.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 +34 -34
package/README.md CHANGED
@@ -20,8 +20,9 @@ the resources for you.</p>
20
20
  about a specific Amazon Web Services product, you can find the product's technical documentation at <a href="https://docs.aws.amazon.com/">docs.aws.amazon.com</a>.</p>
21
21
 
22
22
  ## Installing
23
- To install this package, simply type add or install @aws-sdk/client-cloudformation
24
- using your favorite package manager:
23
+
24
+ To install this package, use the CLI of your favorite package manager:
25
+
25
26
  - `npm install @aws-sdk/client-cloudformation`
26
27
  - `yarn add @aws-sdk/client-cloudformation`
27
28
  - `pnpm add @aws-sdk/client-cloudformation`
@@ -46,15 +47,15 @@ import { CloudFormationClient, ListExportsCommand } from "@aws-sdk/client-cloudf
46
47
 
47
48
  ### Usage
48
49
 
49
- To send a request, you:
50
+ To send a request:
50
51
 
51
- - Initiate client with configuration (e.g. credentials, region).
52
- - Initiate command with input parameters.
53
- - Call `send` operation on client with command object as input.
54
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
52
+ - Instantiate a client with configuration (e.g. credentials, region).
53
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
54
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
55
+ - Instantiate a command with input parameters.
56
+ - Call the `send` operation on the client, providing the command object as input.
55
57
 
56
58
  ```js
57
- // a client can be shared by different commands.
58
59
  const client = new CloudFormationClient({ region: "REGION" });
59
60
 
60
61
  const params = { /** input parameters */ };
@@ -63,7 +64,7 @@ const command = new ListExportsCommand(params);
63
64
 
64
65
  #### Async/await
65
66
 
66
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
67
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
67
68
  operator to wait for the promise returned by send operation as follows:
68
69
 
69
70
  ```js
@@ -78,26 +79,9 @@ try {
78
79
  }
79
80
  ```
80
81
 
81
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
82
- as compared to using Promise chains or callbacks.
83
-
84
82
  #### Promises
85
83
 
86
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
87
- to execute send operation.
88
-
89
- ```js
90
- client.send(command).then(
91
- (data) => {
92
- // process data.
93
- },
94
- (error) => {
95
- // error handling.
96
- }
97
- );
98
- ```
99
-
100
- Promises can also be called using `.catch()` and `.finally()` as follows:
84
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
101
85
 
102
86
  ```js
103
87
  client
@@ -113,27 +97,21 @@ client
113
97
  });
114
98
  ```
115
99
 
116
- #### Callbacks
117
-
118
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
119
- but they are supported by the send operation.
100
+ #### Aggregated client
120
101
 
121
- ```js
122
- // callbacks.
123
- client.send(command, (err, data) => {
124
- // process err and data.
125
- });
126
- ```
102
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
127
103
 
128
- #### v2 compatible style
104
+ `CloudFormation` extends `CloudFormationClient` and additionally supports all operations, waiters, and paginators as methods.
105
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
129
106
 
130
- The client can also send requests using v2 compatible style.
131
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
132
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
107
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`CloudFormationClient`).
108
+ More details are in the blog post on
109
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
133
110
 
134
111
  ```ts
135
- import * as AWS from "@aws-sdk/client-cloudformation";
136
- const client = new AWS.CloudFormation({ region: "REGION" });
112
+ import { CloudFormation } from "@aws-sdk/client-cloudformation";
113
+
114
+ const client = new CloudFormation({ region: "REGION" });
137
115
 
138
116
  // async/await.
139
117
  try {
@@ -153,7 +131,7 @@ client
153
131
  // error handling.
154
132
  });
155
133
 
156
- // callbacks.
134
+ // callbacks (not recommended).
157
135
  client.listExports(params, (err, data) => {
158
136
  // process err and data.
159
137
  });
@@ -181,12 +159,14 @@ try {
181
159
  }
182
160
  ```
183
161
 
162
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
163
+
184
164
  ## Getting Help
185
165
 
186
166
  Please use these community resources for getting help.
187
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
167
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
188
168
 
189
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
169
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
190
170
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
191
171
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
192
172
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-cloudformation",
3
3
  "description": "AWS SDK for JavaScript Cloudformation Client for Node.js, Browser and React Native",
4
- "version": "3.1008.0",
4
+ "version": "3.1010.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-cloudformation",
@@ -23,43 +23,43 @@
23
23
  "dependencies": {
24
24
  "@aws-crypto/sha256-browser": "5.2.0",
25
25
  "@aws-crypto/sha256-js": "5.2.0",
26
- "@aws-sdk/core": "^3.973.19",
27
- "@aws-sdk/credential-provider-node": "^3.972.20",
28
- "@aws-sdk/middleware-host-header": "^3.972.7",
29
- "@aws-sdk/middleware-logger": "^3.972.7",
30
- "@aws-sdk/middleware-recursion-detection": "^3.972.7",
31
- "@aws-sdk/middleware-user-agent": "^3.972.20",
32
- "@aws-sdk/region-config-resolver": "^3.972.7",
33
- "@aws-sdk/types": "^3.973.5",
34
- "@aws-sdk/util-endpoints": "^3.996.4",
35
- "@aws-sdk/util-user-agent-browser": "^3.972.7",
36
- "@aws-sdk/util-user-agent-node": "^3.973.6",
37
- "@smithy/config-resolver": "^4.4.10",
38
- "@smithy/core": "^3.23.9",
39
- "@smithy/fetch-http-handler": "^5.3.13",
40
- "@smithy/hash-node": "^4.2.11",
41
- "@smithy/invalid-dependency": "^4.2.11",
42
- "@smithy/middleware-content-length": "^4.2.11",
43
- "@smithy/middleware-endpoint": "^4.4.23",
44
- "@smithy/middleware-retry": "^4.4.40",
45
- "@smithy/middleware-serde": "^4.2.12",
46
- "@smithy/middleware-stack": "^4.2.11",
47
- "@smithy/node-config-provider": "^4.3.11",
48
- "@smithy/node-http-handler": "^4.4.14",
49
- "@smithy/protocol-http": "^5.3.11",
50
- "@smithy/smithy-client": "^4.12.3",
51
- "@smithy/types": "^4.13.0",
52
- "@smithy/url-parser": "^4.2.11",
26
+ "@aws-sdk/core": "^3.973.20",
27
+ "@aws-sdk/credential-provider-node": "^3.972.21",
28
+ "@aws-sdk/middleware-host-header": "^3.972.8",
29
+ "@aws-sdk/middleware-logger": "^3.972.8",
30
+ "@aws-sdk/middleware-recursion-detection": "^3.972.8",
31
+ "@aws-sdk/middleware-user-agent": "^3.972.21",
32
+ "@aws-sdk/region-config-resolver": "^3.972.8",
33
+ "@aws-sdk/types": "^3.973.6",
34
+ "@aws-sdk/util-endpoints": "^3.996.5",
35
+ "@aws-sdk/util-user-agent-browser": "^3.972.8",
36
+ "@aws-sdk/util-user-agent-node": "^3.973.7",
37
+ "@smithy/config-resolver": "^4.4.11",
38
+ "@smithy/core": "^3.23.11",
39
+ "@smithy/fetch-http-handler": "^5.3.15",
40
+ "@smithy/hash-node": "^4.2.12",
41
+ "@smithy/invalid-dependency": "^4.2.12",
42
+ "@smithy/middleware-content-length": "^4.2.12",
43
+ "@smithy/middleware-endpoint": "^4.4.25",
44
+ "@smithy/middleware-retry": "^4.4.42",
45
+ "@smithy/middleware-serde": "^4.2.14",
46
+ "@smithy/middleware-stack": "^4.2.12",
47
+ "@smithy/node-config-provider": "^4.3.12",
48
+ "@smithy/node-http-handler": "^4.4.16",
49
+ "@smithy/protocol-http": "^5.3.12",
50
+ "@smithy/smithy-client": "^4.12.5",
51
+ "@smithy/types": "^4.13.1",
52
+ "@smithy/url-parser": "^4.2.12",
53
53
  "@smithy/util-base64": "^4.3.2",
54
54
  "@smithy/util-body-length-browser": "^4.2.2",
55
55
  "@smithy/util-body-length-node": "^4.2.3",
56
- "@smithy/util-defaults-mode-browser": "^4.3.39",
57
- "@smithy/util-defaults-mode-node": "^4.2.42",
58
- "@smithy/util-endpoints": "^3.3.2",
59
- "@smithy/util-middleware": "^4.2.11",
60
- "@smithy/util-retry": "^4.2.11",
56
+ "@smithy/util-defaults-mode-browser": "^4.3.41",
57
+ "@smithy/util-defaults-mode-node": "^4.2.44",
58
+ "@smithy/util-endpoints": "^3.3.3",
59
+ "@smithy/util-middleware": "^4.2.12",
60
+ "@smithy/util-retry": "^4.2.12",
61
61
  "@smithy/util-utf8": "^4.2.2",
62
- "@smithy/util-waiter": "^4.2.12",
62
+ "@smithy/util-waiter": "^4.2.13",
63
63
  "tslib": "^2.6.2"
64
64
  },
65
65
  "devDependencies": {