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