@aws-sdk/client-support 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.
- package/README.md +26 -46
- package/package.json +33 -33
package/README.md
CHANGED
|
@@ -52,8 +52,9 @@ Process</a>.</p>
|
|
|
52
52
|
Amazon Web Services Support API</a> in the <i>Amazon Web Services Support User Guide</i>.</p>
|
|
53
53
|
|
|
54
54
|
## Installing
|
|
55
|
-
|
|
56
|
-
|
|
55
|
+
|
|
56
|
+
To install this package, use the CLI of your favorite package manager:
|
|
57
|
+
|
|
57
58
|
- `npm install @aws-sdk/client-support`
|
|
58
59
|
- `yarn add @aws-sdk/client-support`
|
|
59
60
|
- `pnpm add @aws-sdk/client-support`
|
|
@@ -78,15 +79,15 @@ import { SupportClient, DescribeCasesCommand } from "@aws-sdk/client-support";
|
|
|
78
79
|
|
|
79
80
|
### Usage
|
|
80
81
|
|
|
81
|
-
To send a request
|
|
82
|
+
To send a request:
|
|
82
83
|
|
|
83
|
-
-
|
|
84
|
-
-
|
|
85
|
-
-
|
|
86
|
-
-
|
|
84
|
+
- Instantiate a client with configuration (e.g. credentials, region).
|
|
85
|
+
- See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
|
|
86
|
+
- See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
|
|
87
|
+
- Instantiate a command with input parameters.
|
|
88
|
+
- Call the `send` operation on the client, providing the command object as input.
|
|
87
89
|
|
|
88
90
|
```js
|
|
89
|
-
// a client can be shared by different commands.
|
|
90
91
|
const client = new SupportClient({ region: "REGION" });
|
|
91
92
|
|
|
92
93
|
const params = { /** input parameters */ };
|
|
@@ -95,7 +96,7 @@ const command = new DescribeCasesCommand(params);
|
|
|
95
96
|
|
|
96
97
|
#### Async/await
|
|
97
98
|
|
|
98
|
-
We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
|
|
99
|
+
We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
|
|
99
100
|
operator to wait for the promise returned by send operation as follows:
|
|
100
101
|
|
|
101
102
|
```js
|
|
@@ -110,26 +111,9 @@ try {
|
|
|
110
111
|
}
|
|
111
112
|
```
|
|
112
113
|
|
|
113
|
-
Async-await is clean, concise, intuitive, easy to debug and has better error handling
|
|
114
|
-
as compared to using Promise chains or callbacks.
|
|
115
|
-
|
|
116
114
|
#### Promises
|
|
117
115
|
|
|
118
|
-
You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
|
|
119
|
-
to execute send operation.
|
|
120
|
-
|
|
121
|
-
```js
|
|
122
|
-
client.send(command).then(
|
|
123
|
-
(data) => {
|
|
124
|
-
// process data.
|
|
125
|
-
},
|
|
126
|
-
(error) => {
|
|
127
|
-
// error handling.
|
|
128
|
-
}
|
|
129
|
-
);
|
|
130
|
-
```
|
|
131
|
-
|
|
132
|
-
Promises can also be called using `.catch()` and `.finally()` as follows:
|
|
116
|
+
You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
|
|
133
117
|
|
|
134
118
|
```js
|
|
135
119
|
client
|
|
@@ -145,27 +129,21 @@ client
|
|
|
145
129
|
});
|
|
146
130
|
```
|
|
147
131
|
|
|
148
|
-
####
|
|
149
|
-
|
|
150
|
-
We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
|
|
151
|
-
but they are supported by the send operation.
|
|
132
|
+
#### Aggregated client
|
|
152
133
|
|
|
153
|
-
|
|
154
|
-
// callbacks.
|
|
155
|
-
client.send(command, (err, data) => {
|
|
156
|
-
// process err and data.
|
|
157
|
-
});
|
|
158
|
-
```
|
|
134
|
+
The aggregated client class is exported from the same package, but without the "Client" suffix.
|
|
159
135
|
|
|
160
|
-
|
|
136
|
+
`Support` extends `SupportClient` and additionally supports all operations, waiters, and paginators as methods.
|
|
137
|
+
This style may be familiar to you from the AWS SDK for JavaScript v2.
|
|
161
138
|
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
139
|
+
If you are bundling the AWS SDK, we recommend using only the bare-bones client (`SupportClient`).
|
|
140
|
+
More details are in the blog post on
|
|
141
|
+
[modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
|
|
165
142
|
|
|
166
143
|
```ts
|
|
167
|
-
import
|
|
168
|
-
|
|
144
|
+
import { Support } from "@aws-sdk/client-support";
|
|
145
|
+
|
|
146
|
+
const client = new Support({ region: "REGION" });
|
|
169
147
|
|
|
170
148
|
// async/await.
|
|
171
149
|
try {
|
|
@@ -185,7 +163,7 @@ client
|
|
|
185
163
|
// error handling.
|
|
186
164
|
});
|
|
187
165
|
|
|
188
|
-
// callbacks.
|
|
166
|
+
// callbacks (not recommended).
|
|
189
167
|
client.describeCases(params, (err, data) => {
|
|
190
168
|
// process err and data.
|
|
191
169
|
});
|
|
@@ -213,12 +191,14 @@ try {
|
|
|
213
191
|
}
|
|
214
192
|
```
|
|
215
193
|
|
|
194
|
+
See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
|
|
195
|
+
|
|
216
196
|
## Getting Help
|
|
217
197
|
|
|
218
198
|
Please use these community resources for getting help.
|
|
219
|
-
We use
|
|
199
|
+
We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
|
|
220
200
|
|
|
221
|
-
- Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
|
|
201
|
+
- Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
|
|
222
202
|
or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
|
|
223
203
|
- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
|
|
224
204
|
on AWS Developer Blog.
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-support",
|
|
3
3
|
"description": "AWS SDK for JavaScript Support Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
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-support",
|
|
@@ -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.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "^3.972.
|
|
26
|
-
"@aws-sdk/middleware-host-header": "^3.972.
|
|
27
|
-
"@aws-sdk/middleware-logger": "^3.972.
|
|
28
|
-
"@aws-sdk/middleware-recursion-detection": "^3.972.
|
|
29
|
-
"@aws-sdk/middleware-user-agent": "^3.972.
|
|
30
|
-
"@aws-sdk/region-config-resolver": "^3.972.
|
|
31
|
-
"@aws-sdk/types": "^3.973.
|
|
32
|
-
"@aws-sdk/util-endpoints": "^3.996.
|
|
33
|
-
"@aws-sdk/util-user-agent-browser": "^3.972.
|
|
34
|
-
"@aws-sdk/util-user-agent-node": "^3.973.
|
|
35
|
-
"@smithy/config-resolver": "^4.4.
|
|
36
|
-
"@smithy/core": "^3.23.
|
|
37
|
-
"@smithy/fetch-http-handler": "^5.3.
|
|
38
|
-
"@smithy/hash-node": "^4.2.
|
|
39
|
-
"@smithy/invalid-dependency": "^4.2.
|
|
40
|
-
"@smithy/middleware-content-length": "^4.2.
|
|
41
|
-
"@smithy/middleware-endpoint": "^4.4.
|
|
42
|
-
"@smithy/middleware-retry": "^4.4.
|
|
43
|
-
"@smithy/middleware-serde": "^4.2.
|
|
44
|
-
"@smithy/middleware-stack": "^4.2.
|
|
45
|
-
"@smithy/node-config-provider": "^4.3.
|
|
46
|
-
"@smithy/node-http-handler": "^4.4.
|
|
47
|
-
"@smithy/protocol-http": "^5.3.
|
|
48
|
-
"@smithy/smithy-client": "^4.12.
|
|
49
|
-
"@smithy/types": "^4.13.
|
|
50
|
-
"@smithy/url-parser": "^4.2.
|
|
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.
|
|
55
|
-
"@smithy/util-defaults-mode-node": "^4.2.
|
|
56
|
-
"@smithy/util-endpoints": "^3.3.
|
|
57
|
-
"@smithy/util-middleware": "^4.2.
|
|
58
|
-
"@smithy/util-retry": "^4.2.
|
|
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
|
},
|