@aws-sdk/client-pi 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 +33 -33
package/README.md CHANGED
@@ -33,8 +33,9 @@ dimensions, measured at that time point. Examples include SQL, Wait event, User,
33
33
  </ul>
34
34
 
35
35
  ## Installing
36
- To install this package, simply type add or install @aws-sdk/client-pi
37
- using your favorite package manager:
36
+
37
+ To install this package, use the CLI of your favorite package manager:
38
+
38
39
  - `npm install @aws-sdk/client-pi`
39
40
  - `yarn add @aws-sdk/client-pi`
40
41
  - `pnpm add @aws-sdk/client-pi`
@@ -59,15 +60,15 @@ import { PIClient, ListTagsForResourceCommand } from "@aws-sdk/client-pi";
59
60
 
60
61
  ### Usage
61
62
 
62
- To send a request, you:
63
+ To send a request:
63
64
 
64
- - Initiate client with configuration (e.g. credentials, region).
65
- - Initiate command with input parameters.
66
- - Call `send` operation on client with command object as input.
67
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
65
+ - Instantiate a client with configuration (e.g. credentials, region).
66
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
67
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
68
+ - Instantiate a command with input parameters.
69
+ - Call the `send` operation on the client, providing the command object as input.
68
70
 
69
71
  ```js
70
- // a client can be shared by different commands.
71
72
  const client = new PIClient({ region: "REGION" });
72
73
 
73
74
  const params = { /** input parameters */ };
@@ -76,7 +77,7 @@ const command = new ListTagsForResourceCommand(params);
76
77
 
77
78
  #### Async/await
78
79
 
79
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
80
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
80
81
  operator to wait for the promise returned by send operation as follows:
81
82
 
82
83
  ```js
@@ -91,26 +92,9 @@ try {
91
92
  }
92
93
  ```
93
94
 
94
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
95
- as compared to using Promise chains or callbacks.
96
-
97
95
  #### Promises
98
96
 
99
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
100
- to execute send operation.
101
-
102
- ```js
103
- client.send(command).then(
104
- (data) => {
105
- // process data.
106
- },
107
- (error) => {
108
- // error handling.
109
- }
110
- );
111
- ```
112
-
113
- Promises can also be called using `.catch()` and `.finally()` as follows:
97
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
114
98
 
115
99
  ```js
116
100
  client
@@ -126,27 +110,21 @@ client
126
110
  });
127
111
  ```
128
112
 
129
- #### Callbacks
130
-
131
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
132
- but they are supported by the send operation.
113
+ #### Aggregated client
133
114
 
134
- ```js
135
- // callbacks.
136
- client.send(command, (err, data) => {
137
- // process err and data.
138
- });
139
- ```
115
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
140
116
 
141
- #### v2 compatible style
117
+ `PI` extends `PIClient` and additionally supports all operations, waiters, and paginators as methods.
118
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
142
119
 
143
- The client can also send requests using v2 compatible style.
144
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
145
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
120
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`PIClient`).
121
+ More details are in the blog post on
122
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
146
123
 
147
124
  ```ts
148
- import * as AWS from "@aws-sdk/client-pi";
149
- const client = new AWS.PI({ region: "REGION" });
125
+ import { PI } from "@aws-sdk/client-pi";
126
+
127
+ const client = new PI({ region: "REGION" });
150
128
 
151
129
  // async/await.
152
130
  try {
@@ -166,7 +144,7 @@ client
166
144
  // error handling.
167
145
  });
168
146
 
169
- // callbacks.
147
+ // callbacks (not recommended).
170
148
  client.listTagsForResource(params, (err, data) => {
171
149
  // process err and data.
172
150
  });
@@ -194,12 +172,14 @@ try {
194
172
  }
195
173
  ```
196
174
 
175
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
176
+
197
177
  ## Getting Help
198
178
 
199
179
  Please use these community resources for getting help.
200
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
180
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
201
181
 
202
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
182
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
203
183
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
204
184
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
205
185
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-pi",
3
3
  "description": "AWS SDK for JavaScript Pi 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-pi",
@@ -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.20",
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.6",
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
  },