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