@aws-sdk/client-cloudtrail 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
@@ -24,8 +24,9 @@ Amazon Web Services SDKs, including how to download and install them, see <a hre
24
24
  User Guide</a> for information about the data that is included with each Amazon Web Services API call listed in the log files.</p>
25
25
 
26
26
  ## Installing
27
- To install this package, simply type add or install @aws-sdk/client-cloudtrail
28
- using your favorite package manager:
27
+
28
+ To install this package, use the CLI of your favorite package manager:
29
+
29
30
  - `npm install @aws-sdk/client-cloudtrail`
30
31
  - `yarn add @aws-sdk/client-cloudtrail`
31
32
  - `pnpm add @aws-sdk/client-cloudtrail`
@@ -50,15 +51,15 @@ import { CloudTrailClient, ListImportsCommand } from "@aws-sdk/client-cloudtrail
50
51
 
51
52
  ### Usage
52
53
 
53
- To send a request, you:
54
+ To send a request:
54
55
 
55
- - Initiate client with configuration (e.g. credentials, region).
56
- - Initiate command with input parameters.
57
- - Call `send` operation on client with command object as input.
58
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
56
+ - Instantiate a client with configuration (e.g. credentials, region).
57
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
58
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
59
+ - Instantiate a command with input parameters.
60
+ - Call the `send` operation on the client, providing the command object as input.
59
61
 
60
62
  ```js
61
- // a client can be shared by different commands.
62
63
  const client = new CloudTrailClient({ region: "REGION" });
63
64
 
64
65
  const params = { /** input parameters */ };
@@ -67,7 +68,7 @@ const command = new ListImportsCommand(params);
67
68
 
68
69
  #### Async/await
69
70
 
70
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
71
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
71
72
  operator to wait for the promise returned by send operation as follows:
72
73
 
73
74
  ```js
@@ -82,26 +83,9 @@ try {
82
83
  }
83
84
  ```
84
85
 
85
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
86
- as compared to using Promise chains or callbacks.
87
-
88
86
  #### Promises
89
87
 
90
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
91
- to execute send operation.
92
-
93
- ```js
94
- client.send(command).then(
95
- (data) => {
96
- // process data.
97
- },
98
- (error) => {
99
- // error handling.
100
- }
101
- );
102
- ```
103
-
104
- Promises can also be called using `.catch()` and `.finally()` as follows:
88
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
105
89
 
106
90
  ```js
107
91
  client
@@ -117,27 +101,21 @@ client
117
101
  });
118
102
  ```
119
103
 
120
- #### Callbacks
121
-
122
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
123
- but they are supported by the send operation.
104
+ #### Aggregated client
124
105
 
125
- ```js
126
- // callbacks.
127
- client.send(command, (err, data) => {
128
- // process err and data.
129
- });
130
- ```
106
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
131
107
 
132
- #### v2 compatible style
108
+ `CloudTrail` extends `CloudTrailClient` and additionally supports all operations, waiters, and paginators as methods.
109
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
133
110
 
134
- The client can also send requests using v2 compatible style.
135
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
136
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
111
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`CloudTrailClient`).
112
+ More details are in the blog post on
113
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
137
114
 
138
115
  ```ts
139
- import * as AWS from "@aws-sdk/client-cloudtrail";
140
- const client = new AWS.CloudTrail({ region: "REGION" });
116
+ import { CloudTrail } from "@aws-sdk/client-cloudtrail";
117
+
118
+ const client = new CloudTrail({ region: "REGION" });
141
119
 
142
120
  // async/await.
143
121
  try {
@@ -157,7 +135,7 @@ client
157
135
  // error handling.
158
136
  });
159
137
 
160
- // callbacks.
138
+ // callbacks (not recommended).
161
139
  client.listImports(params, (err, data) => {
162
140
  // process err and data.
163
141
  });
@@ -185,12 +163,14 @@ try {
185
163
  }
186
164
  ```
187
165
 
166
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
167
+
188
168
  ## Getting Help
189
169
 
190
170
  Please use these community resources for getting help.
191
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
171
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
192
172
 
193
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
173
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
194
174
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
195
175
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
196
176
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-cloudtrail",
3
3
  "description": "AWS SDK for JavaScript Cloudtrail 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",
@@ -23,41 +23,41 @@
23
23
  "dependencies": {
24
24
  "@aws-crypto/sha256-browser": "5.2.0",
25
25
  "@aws-crypto/sha256-js": "5.2.0",
26
- "@aws-sdk/core": "^3.973.19",
27
- "@aws-sdk/credential-provider-node": "^3.972.20",
28
- "@aws-sdk/middleware-host-header": "^3.972.7",
29
- "@aws-sdk/middleware-logger": "^3.972.7",
30
- "@aws-sdk/middleware-recursion-detection": "^3.972.7",
31
- "@aws-sdk/middleware-user-agent": "^3.972.20",
32
- "@aws-sdk/region-config-resolver": "^3.972.7",
33
- "@aws-sdk/types": "^3.973.5",
34
- "@aws-sdk/util-endpoints": "^3.996.4",
35
- "@aws-sdk/util-user-agent-browser": "^3.972.7",
36
- "@aws-sdk/util-user-agent-node": "^3.973.6",
37
- "@smithy/config-resolver": "^4.4.10",
38
- "@smithy/core": "^3.23.9",
39
- "@smithy/fetch-http-handler": "^5.3.13",
40
- "@smithy/hash-node": "^4.2.11",
41
- "@smithy/invalid-dependency": "^4.2.11",
42
- "@smithy/middleware-content-length": "^4.2.11",
43
- "@smithy/middleware-endpoint": "^4.4.23",
44
- "@smithy/middleware-retry": "^4.4.40",
45
- "@smithy/middleware-serde": "^4.2.12",
46
- "@smithy/middleware-stack": "^4.2.11",
47
- "@smithy/node-config-provider": "^4.3.11",
48
- "@smithy/node-http-handler": "^4.4.14",
49
- "@smithy/protocol-http": "^5.3.11",
50
- "@smithy/smithy-client": "^4.12.3",
51
- "@smithy/types": "^4.13.0",
52
- "@smithy/url-parser": "^4.2.11",
26
+ "@aws-sdk/core": "^3.973.20",
27
+ "@aws-sdk/credential-provider-node": "^3.972.21",
28
+ "@aws-sdk/middleware-host-header": "^3.972.8",
29
+ "@aws-sdk/middleware-logger": "^3.972.8",
30
+ "@aws-sdk/middleware-recursion-detection": "^3.972.8",
31
+ "@aws-sdk/middleware-user-agent": "^3.972.21",
32
+ "@aws-sdk/region-config-resolver": "^3.972.8",
33
+ "@aws-sdk/types": "^3.973.6",
34
+ "@aws-sdk/util-endpoints": "^3.996.5",
35
+ "@aws-sdk/util-user-agent-browser": "^3.972.8",
36
+ "@aws-sdk/util-user-agent-node": "^3.973.7",
37
+ "@smithy/config-resolver": "^4.4.11",
38
+ "@smithy/core": "^3.23.11",
39
+ "@smithy/fetch-http-handler": "^5.3.15",
40
+ "@smithy/hash-node": "^4.2.12",
41
+ "@smithy/invalid-dependency": "^4.2.12",
42
+ "@smithy/middleware-content-length": "^4.2.12",
43
+ "@smithy/middleware-endpoint": "^4.4.25",
44
+ "@smithy/middleware-retry": "^4.4.42",
45
+ "@smithy/middleware-serde": "^4.2.14",
46
+ "@smithy/middleware-stack": "^4.2.12",
47
+ "@smithy/node-config-provider": "^4.3.12",
48
+ "@smithy/node-http-handler": "^4.4.16",
49
+ "@smithy/protocol-http": "^5.3.12",
50
+ "@smithy/smithy-client": "^4.12.5",
51
+ "@smithy/types": "^4.13.1",
52
+ "@smithy/url-parser": "^4.2.12",
53
53
  "@smithy/util-base64": "^4.3.2",
54
54
  "@smithy/util-body-length-browser": "^4.2.2",
55
55
  "@smithy/util-body-length-node": "^4.2.3",
56
- "@smithy/util-defaults-mode-browser": "^4.3.39",
57
- "@smithy/util-defaults-mode-node": "^4.2.42",
58
- "@smithy/util-endpoints": "^3.3.2",
59
- "@smithy/util-middleware": "^4.2.11",
60
- "@smithy/util-retry": "^4.2.11",
56
+ "@smithy/util-defaults-mode-browser": "^4.3.41",
57
+ "@smithy/util-defaults-mode-node": "^4.2.44",
58
+ "@smithy/util-endpoints": "^3.3.3",
59
+ "@smithy/util-middleware": "^4.2.12",
60
+ "@smithy/util-retry": "^4.2.12",
61
61
  "@smithy/util-utf8": "^4.2.2",
62
62
  "tslib": "^2.6.2"
63
63
  },