@aws-sdk/client-securityhub 3.1008.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
|
@@ -80,8 +80,9 @@ second. <code>BurstLimit</code> of 5 requests per second.</p>
|
|
|
80
80
|
</ul>
|
|
81
81
|
|
|
82
82
|
## Installing
|
|
83
|
-
|
|
84
|
-
|
|
83
|
+
|
|
84
|
+
To install this package, use the CLI of your favorite package manager:
|
|
85
|
+
|
|
85
86
|
- `npm install @aws-sdk/client-securityhub`
|
|
86
87
|
- `yarn add @aws-sdk/client-securityhub`
|
|
87
88
|
- `pnpm add @aws-sdk/client-securityhub`
|
|
@@ -106,15 +107,15 @@ import { SecurityHubClient, ListMembersCommand } from "@aws-sdk/client-securityh
|
|
|
106
107
|
|
|
107
108
|
### Usage
|
|
108
109
|
|
|
109
|
-
To send a request
|
|
110
|
+
To send a request:
|
|
110
111
|
|
|
111
|
-
-
|
|
112
|
-
-
|
|
113
|
-
-
|
|
114
|
-
-
|
|
112
|
+
- Instantiate a client with configuration (e.g. credentials, region).
|
|
113
|
+
- See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
|
|
114
|
+
- See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
|
|
115
|
+
- Instantiate a command with input parameters.
|
|
116
|
+
- Call the `send` operation on the client, providing the command object as input.
|
|
115
117
|
|
|
116
118
|
```js
|
|
117
|
-
// a client can be shared by different commands.
|
|
118
119
|
const client = new SecurityHubClient({ region: "REGION" });
|
|
119
120
|
|
|
120
121
|
const params = { /** input parameters */ };
|
|
@@ -123,7 +124,7 @@ const command = new ListMembersCommand(params);
|
|
|
123
124
|
|
|
124
125
|
#### Async/await
|
|
125
126
|
|
|
126
|
-
We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
|
|
127
|
+
We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
|
|
127
128
|
operator to wait for the promise returned by send operation as follows:
|
|
128
129
|
|
|
129
130
|
```js
|
|
@@ -138,26 +139,9 @@ try {
|
|
|
138
139
|
}
|
|
139
140
|
```
|
|
140
141
|
|
|
141
|
-
Async-await is clean, concise, intuitive, easy to debug and has better error handling
|
|
142
|
-
as compared to using Promise chains or callbacks.
|
|
143
|
-
|
|
144
142
|
#### Promises
|
|
145
143
|
|
|
146
|
-
You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
|
|
147
|
-
to execute send operation.
|
|
148
|
-
|
|
149
|
-
```js
|
|
150
|
-
client.send(command).then(
|
|
151
|
-
(data) => {
|
|
152
|
-
// process data.
|
|
153
|
-
},
|
|
154
|
-
(error) => {
|
|
155
|
-
// error handling.
|
|
156
|
-
}
|
|
157
|
-
);
|
|
158
|
-
```
|
|
159
|
-
|
|
160
|
-
Promises can also be called using `.catch()` and `.finally()` as follows:
|
|
144
|
+
You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
|
|
161
145
|
|
|
162
146
|
```js
|
|
163
147
|
client
|
|
@@ -173,27 +157,21 @@ client
|
|
|
173
157
|
});
|
|
174
158
|
```
|
|
175
159
|
|
|
176
|
-
####
|
|
177
|
-
|
|
178
|
-
We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
|
|
179
|
-
but they are supported by the send operation.
|
|
160
|
+
#### Aggregated client
|
|
180
161
|
|
|
181
|
-
|
|
182
|
-
// callbacks.
|
|
183
|
-
client.send(command, (err, data) => {
|
|
184
|
-
// process err and data.
|
|
185
|
-
});
|
|
186
|
-
```
|
|
162
|
+
The aggregated client class is exported from the same package, but without the "Client" suffix.
|
|
187
163
|
|
|
188
|
-
|
|
164
|
+
`SecurityHub` extends `SecurityHubClient` and additionally supports all operations, waiters, and paginators as methods.
|
|
165
|
+
This style may be familiar to you from the AWS SDK for JavaScript v2.
|
|
189
166
|
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
167
|
+
If you are bundling the AWS SDK, we recommend using only the bare-bones client (`SecurityHubClient`).
|
|
168
|
+
More details are in the blog post on
|
|
169
|
+
[modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
|
|
193
170
|
|
|
194
171
|
```ts
|
|
195
|
-
import
|
|
196
|
-
|
|
172
|
+
import { SecurityHub } from "@aws-sdk/client-securityhub";
|
|
173
|
+
|
|
174
|
+
const client = new SecurityHub({ region: "REGION" });
|
|
197
175
|
|
|
198
176
|
// async/await.
|
|
199
177
|
try {
|
|
@@ -213,7 +191,7 @@ client
|
|
|
213
191
|
// error handling.
|
|
214
192
|
});
|
|
215
193
|
|
|
216
|
-
// callbacks.
|
|
194
|
+
// callbacks (not recommended).
|
|
217
195
|
client.listMembers(params, (err, data) => {
|
|
218
196
|
// process err and data.
|
|
219
197
|
});
|
|
@@ -241,12 +219,14 @@ try {
|
|
|
241
219
|
}
|
|
242
220
|
```
|
|
243
221
|
|
|
222
|
+
See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
|
|
223
|
+
|
|
244
224
|
## Getting Help
|
|
245
225
|
|
|
246
226
|
Please use these community resources for getting help.
|
|
247
|
-
We use
|
|
227
|
+
We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
|
|
248
228
|
|
|
249
|
-
- Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
|
|
229
|
+
- Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
|
|
250
230
|
or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
|
|
251
231
|
- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
|
|
252
232
|
on AWS Developer Blog.
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-securityhub",
|
|
3
3
|
"description": "AWS SDK for JavaScript Securityhub 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-securityhub",
|
|
@@ -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
|
},
|