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