@aws-sdk/client-greengrassv2 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
@@ -19,8 +19,9 @@ manage deployments, and core devices.</p>
19
19
  <i>IoT Greengrass V2 Developer Guide</i>.</p>
20
20
 
21
21
  ## Installing
22
- To install this package, simply type add or install @aws-sdk/client-greengrassv2
23
- using your favorite package manager:
22
+
23
+ To install this package, use the CLI of your favorite package manager:
24
+
24
25
  - `npm install @aws-sdk/client-greengrassv2`
25
26
  - `yarn add @aws-sdk/client-greengrassv2`
26
27
  - `pnpm add @aws-sdk/client-greengrassv2`
@@ -45,15 +46,15 @@ import { GreengrassV2Client, ListComponentsCommand } from "@aws-sdk/client-green
45
46
 
46
47
  ### Usage
47
48
 
48
- To send a request, you:
49
+ To send a request:
49
50
 
50
- - Initiate client with configuration (e.g. credentials, region).
51
- - Initiate command with input parameters.
52
- - Call `send` operation on client with command object as input.
53
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
51
+ - Instantiate a client with configuration (e.g. credentials, region).
52
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
53
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
54
+ - Instantiate a command with input parameters.
55
+ - Call the `send` operation on the client, providing the command object as input.
54
56
 
55
57
  ```js
56
- // a client can be shared by different commands.
57
58
  const client = new GreengrassV2Client({ region: "REGION" });
58
59
 
59
60
  const params = { /** input parameters */ };
@@ -62,7 +63,7 @@ const command = new ListComponentsCommand(params);
62
63
 
63
64
  #### Async/await
64
65
 
65
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
66
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
66
67
  operator to wait for the promise returned by send operation as follows:
67
68
 
68
69
  ```js
@@ -77,26 +78,9 @@ try {
77
78
  }
78
79
  ```
79
80
 
80
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
81
- as compared to using Promise chains or callbacks.
82
-
83
81
  #### Promises
84
82
 
85
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
86
- to execute send operation.
87
-
88
- ```js
89
- client.send(command).then(
90
- (data) => {
91
- // process data.
92
- },
93
- (error) => {
94
- // error handling.
95
- }
96
- );
97
- ```
98
-
99
- Promises can also be called using `.catch()` and `.finally()` as follows:
83
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
100
84
 
101
85
  ```js
102
86
  client
@@ -112,27 +96,21 @@ client
112
96
  });
113
97
  ```
114
98
 
115
- #### Callbacks
116
-
117
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
118
- but they are supported by the send operation.
99
+ #### Aggregated client
119
100
 
120
- ```js
121
- // callbacks.
122
- client.send(command, (err, data) => {
123
- // process err and data.
124
- });
125
- ```
101
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
126
102
 
127
- #### v2 compatible style
103
+ `GreengrassV2` extends `GreengrassV2Client` and additionally supports all operations, waiters, and paginators as methods.
104
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
128
105
 
129
- The client can also send requests using v2 compatible style.
130
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
131
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
106
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`GreengrassV2Client`).
107
+ More details are in the blog post on
108
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
132
109
 
133
110
  ```ts
134
- import * as AWS from "@aws-sdk/client-greengrassv2";
135
- const client = new AWS.GreengrassV2({ region: "REGION" });
111
+ import { GreengrassV2 } from "@aws-sdk/client-greengrassv2";
112
+
113
+ const client = new GreengrassV2({ region: "REGION" });
136
114
 
137
115
  // async/await.
138
116
  try {
@@ -152,7 +130,7 @@ client
152
130
  // error handling.
153
131
  });
154
132
 
155
- // callbacks.
133
+ // callbacks (not recommended).
156
134
  client.listComponents(params, (err, data) => {
157
135
  // process err and data.
158
136
  });
@@ -180,12 +158,14 @@ try {
180
158
  }
181
159
  ```
182
160
 
161
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
162
+
183
163
  ## Getting Help
184
164
 
185
165
  Please use these community resources for getting help.
186
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
166
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
187
167
 
188
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
168
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
189
169
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
190
170
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
191
171
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-greengrassv2",
3
3
  "description": "AWS SDK for JavaScript Greengrassv2 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-greengrassv2",
@@ -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
  },