@jjrawlins/cdk-ami-builder 0.0.174 → 0.0.175

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 (61) hide show
  1. package/.jsii +11 -11
  2. package/cdkamibuilder/jsii/jsii.go +2 -2
  3. package/cdkamibuilder/version +1 -1
  4. package/lib/ImagePipeline/ImagePipeline.js +1 -1
  5. package/lib/Lambdas/CheckStateMachineStatus/CheckStateMachineStatus-function.js +1 -1
  6. package/lib/Lambdas/StartStateMachine/StartStateMachine-function.js +1 -1
  7. package/node_modules/@aws-sdk/client-ec2/README.md +26 -46
  8. package/node_modules/@aws-sdk/client-ec2/package.json +36 -36
  9. package/node_modules/@aws-sdk/client-ecs/README.md +26 -46
  10. package/node_modules/@aws-sdk/client-ecs/package.json +34 -34
  11. package/node_modules/@aws-sdk/client-kms/README.md +26 -46
  12. package/node_modules/@aws-sdk/client-kms/package.json +33 -33
  13. package/node_modules/@aws-sdk/client-s3/README.md +26 -46
  14. package/node_modules/@aws-sdk/client-s3/package.json +50 -50
  15. package/node_modules/@aws-sdk/client-secrets-manager/README.md +26 -46
  16. package/node_modules/@aws-sdk/client-secrets-manager/package.json +34 -34
  17. package/node_modules/@aws-sdk/client-sfn/README.md +26 -46
  18. package/node_modules/@aws-sdk/client-sfn/package.json +33 -33
  19. package/node_modules/@aws-sdk/client-sns/README.md +26 -46
  20. package/node_modules/@aws-sdk/client-sns/package.json +33 -33
  21. package/node_modules/@aws-sdk/client-sqs/README.md +65 -46
  22. package/node_modules/@aws-sdk/client-sqs/package.json +36 -36
  23. package/node_modules/@aws-sdk/client-ssm/README.md +26 -46
  24. package/node_modules/@aws-sdk/client-ssm/package.json +34 -34
  25. package/node_modules/@aws-sdk/core/package.json +11 -11
  26. package/node_modules/@aws-sdk/crc64-nvme/package.json +2 -2
  27. package/node_modules/@aws-sdk/credential-provider-env/package.json +5 -5
  28. package/node_modules/@aws-sdk/credential-provider-http/package.json +10 -10
  29. package/node_modules/@aws-sdk/credential-provider-ini/package.json +14 -14
  30. package/node_modules/@aws-sdk/credential-provider-login/package.json +8 -8
  31. package/node_modules/@aws-sdk/credential-provider-node/package.json +12 -12
  32. package/node_modules/@aws-sdk/credential-provider-process/package.json +6 -6
  33. package/node_modules/@aws-sdk/credential-provider-sso/package.json +8 -8
  34. package/node_modules/@aws-sdk/credential-provider-web-identity/package.json +7 -7
  35. package/node_modules/@aws-sdk/middleware-bucket-endpoint/package.json +5 -5
  36. package/node_modules/@aws-sdk/middleware-expect-continue/package.json +4 -4
  37. package/node_modules/@aws-sdk/middleware-flexible-checksums/package.json +10 -10
  38. package/node_modules/@aws-sdk/middleware-host-header/package.json +4 -4
  39. package/node_modules/@aws-sdk/middleware-location-constraint/package.json +3 -3
  40. package/node_modules/@aws-sdk/middleware-logger/package.json +3 -3
  41. package/node_modules/@aws-sdk/middleware-recursion-detection/package.json +4 -4
  42. package/node_modules/@aws-sdk/middleware-sdk-ec2/package.json +8 -8
  43. package/node_modules/@aws-sdk/middleware-sdk-s3/package.json +11 -11
  44. package/node_modules/@aws-sdk/middleware-sdk-sqs/package.json +4 -4
  45. package/node_modules/@aws-sdk/middleware-ssec/package.json +3 -3
  46. package/node_modules/@aws-sdk/middleware-user-agent/package.json +8 -8
  47. package/node_modules/@aws-sdk/nested-clients/package.json +32 -32
  48. package/node_modules/@aws-sdk/region-config-resolver/package.json +5 -5
  49. package/node_modules/@aws-sdk/signature-v4-multi-region/package.json +6 -6
  50. package/node_modules/@aws-sdk/token-providers/package.json +7 -7
  51. package/node_modules/@aws-sdk/types/package.json +2 -2
  52. package/node_modules/@aws-sdk/util-endpoints/package.json +5 -5
  53. package/node_modules/@aws-sdk/util-format-url/package.json +4 -4
  54. package/node_modules/@aws-sdk/util-user-agent-browser/package.json +3 -3
  55. package/node_modules/@aws-sdk/util-user-agent-node/package.json +5 -5
  56. package/node_modules/@aws-sdk/xml-builder/package.json +2 -2
  57. package/node_modules/fast-xml-builder/CHANGELOG.md +2 -1
  58. package/node_modules/fast-xml-builder/lib/fxb.d.cts +3 -1
  59. package/node_modules/fast-xml-builder/package.json +1 -1
  60. package/node_modules/fast-xml-builder/src/fxb.d.ts +4 -1
  61. package/package.json +11 -11
@@ -34,8 +34,9 @@ Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail</
34
34
  To learn more about CloudTrail, including enabling it and find your log files, see the <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html">Amazon Web Services CloudTrail User Guide</a>.</p>
35
35
 
36
36
  ## Installing
37
- To install this package, simply type add or install @aws-sdk/client-secrets-manager
38
- using your favorite package manager:
37
+
38
+ To install this package, use the CLI of your favorite package manager:
39
+
39
40
  - `npm install @aws-sdk/client-secrets-manager`
40
41
  - `yarn add @aws-sdk/client-secrets-manager`
41
42
  - `pnpm add @aws-sdk/client-secrets-manager`
@@ -60,15 +61,15 @@ import { SecretsManagerClient, ListSecretsCommand } from "@aws-sdk/client-secret
60
61
 
61
62
  ### Usage
62
63
 
63
- To send a request, you:
64
+ To send a request:
64
65
 
65
- - Initiate client with configuration (e.g. credentials, region).
66
- - Initiate command with input parameters.
67
- - Call `send` operation on client with command object as input.
68
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
66
+ - Instantiate a client with configuration (e.g. credentials, region).
67
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
68
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
69
+ - Instantiate a command with input parameters.
70
+ - Call the `send` operation on the client, providing the command object as input.
69
71
 
70
72
  ```js
71
- // a client can be shared by different commands.
72
73
  const client = new SecretsManagerClient({ region: "REGION" });
73
74
 
74
75
  const params = { /** input parameters */ };
@@ -77,7 +78,7 @@ const command = new ListSecretsCommand(params);
77
78
 
78
79
  #### Async/await
79
80
 
80
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
81
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
81
82
  operator to wait for the promise returned by send operation as follows:
82
83
 
83
84
  ```js
@@ -92,26 +93,9 @@ try {
92
93
  }
93
94
  ```
94
95
 
95
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
96
- as compared to using Promise chains or callbacks.
97
-
98
96
  #### Promises
99
97
 
100
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
101
- to execute send operation.
102
-
103
- ```js
104
- client.send(command).then(
105
- (data) => {
106
- // process data.
107
- },
108
- (error) => {
109
- // error handling.
110
- }
111
- );
112
- ```
113
-
114
- Promises can also be called using `.catch()` and `.finally()` as follows:
98
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
115
99
 
116
100
  ```js
117
101
  client
@@ -127,27 +111,21 @@ client
127
111
  });
128
112
  ```
129
113
 
130
- #### Callbacks
131
-
132
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
133
- but they are supported by the send operation.
114
+ #### Aggregated client
134
115
 
135
- ```js
136
- // callbacks.
137
- client.send(command, (err, data) => {
138
- // process err and data.
139
- });
140
- ```
116
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
141
117
 
142
- #### v2 compatible style
118
+ `SecretsManager` extends `SecretsManagerClient` and additionally supports all operations, waiters, and paginators as methods.
119
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
143
120
 
144
- The client can also send requests using v2 compatible style.
145
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
146
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
121
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`SecretsManagerClient`).
122
+ More details are in the blog post on
123
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
147
124
 
148
125
  ```ts
149
- import * as AWS from "@aws-sdk/client-secrets-manager";
150
- const client = new AWS.SecretsManager({ region: "REGION" });
126
+ import { SecretsManager } from "@aws-sdk/client-secrets-manager";
127
+
128
+ const client = new SecretsManager({ region: "REGION" });
151
129
 
152
130
  // async/await.
153
131
  try {
@@ -167,7 +145,7 @@ client
167
145
  // error handling.
168
146
  });
169
147
 
170
- // callbacks.
148
+ // callbacks (not recommended).
171
149
  client.listSecrets(params, (err, data) => {
172
150
  // process err and data.
173
151
  });
@@ -195,12 +173,14 @@ try {
195
173
  }
196
174
  ```
197
175
 
176
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
177
+
198
178
  ## Getting Help
199
179
 
200
180
  Please use these community resources for getting help.
201
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
181
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
202
182
 
203
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
183
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
204
184
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
205
185
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
206
186
  on AWS Developer Blog.
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-secrets-manager",
3
3
  "description": "AWS SDK for JavaScript Secrets Manager 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-secrets-manager",
@@ -25,46 +25,46 @@
25
25
  "dependencies": {
26
26
  "@aws-crypto/sha256-browser": "5.2.0",
27
27
  "@aws-crypto/sha256-js": "5.2.0",
28
- "@aws-sdk/core": "^3.973.19",
29
- "@aws-sdk/credential-provider-node": "^3.972.20",
30
- "@aws-sdk/middleware-host-header": "^3.972.7",
31
- "@aws-sdk/middleware-logger": "^3.972.7",
32
- "@aws-sdk/middleware-recursion-detection": "^3.972.7",
33
- "@aws-sdk/middleware-user-agent": "^3.972.20",
34
- "@aws-sdk/region-config-resolver": "^3.972.7",
35
- "@aws-sdk/types": "^3.973.5",
36
- "@aws-sdk/util-endpoints": "^3.996.4",
37
- "@aws-sdk/util-user-agent-browser": "^3.972.7",
38
- "@aws-sdk/util-user-agent-node": "^3.973.6",
39
- "@smithy/config-resolver": "^4.4.10",
40
- "@smithy/core": "^3.23.9",
41
- "@smithy/fetch-http-handler": "^5.3.13",
42
- "@smithy/hash-node": "^4.2.11",
43
- "@smithy/invalid-dependency": "^4.2.11",
44
- "@smithy/middleware-content-length": "^4.2.11",
45
- "@smithy/middleware-endpoint": "^4.4.23",
46
- "@smithy/middleware-retry": "^4.4.40",
47
- "@smithy/middleware-serde": "^4.2.12",
48
- "@smithy/middleware-stack": "^4.2.11",
49
- "@smithy/node-config-provider": "^4.3.11",
50
- "@smithy/node-http-handler": "^4.4.14",
51
- "@smithy/protocol-http": "^5.3.11",
52
- "@smithy/smithy-client": "^4.12.3",
53
- "@smithy/types": "^4.13.0",
54
- "@smithy/url-parser": "^4.2.11",
28
+ "@aws-sdk/core": "^3.973.20",
29
+ "@aws-sdk/credential-provider-node": "^3.972.21",
30
+ "@aws-sdk/middleware-host-header": "^3.972.8",
31
+ "@aws-sdk/middleware-logger": "^3.972.8",
32
+ "@aws-sdk/middleware-recursion-detection": "^3.972.8",
33
+ "@aws-sdk/middleware-user-agent": "^3.972.21",
34
+ "@aws-sdk/region-config-resolver": "^3.972.8",
35
+ "@aws-sdk/types": "^3.973.6",
36
+ "@aws-sdk/util-endpoints": "^3.996.5",
37
+ "@aws-sdk/util-user-agent-browser": "^3.972.8",
38
+ "@aws-sdk/util-user-agent-node": "^3.973.7",
39
+ "@smithy/config-resolver": "^4.4.11",
40
+ "@smithy/core": "^3.23.11",
41
+ "@smithy/fetch-http-handler": "^5.3.15",
42
+ "@smithy/hash-node": "^4.2.12",
43
+ "@smithy/invalid-dependency": "^4.2.12",
44
+ "@smithy/middleware-content-length": "^4.2.12",
45
+ "@smithy/middleware-endpoint": "^4.4.25",
46
+ "@smithy/middleware-retry": "^4.4.42",
47
+ "@smithy/middleware-serde": "^4.2.14",
48
+ "@smithy/middleware-stack": "^4.2.12",
49
+ "@smithy/node-config-provider": "^4.3.12",
50
+ "@smithy/node-http-handler": "^4.4.16",
51
+ "@smithy/protocol-http": "^5.3.12",
52
+ "@smithy/smithy-client": "^4.12.5",
53
+ "@smithy/types": "^4.13.1",
54
+ "@smithy/url-parser": "^4.2.12",
55
55
  "@smithy/util-base64": "^4.3.2",
56
56
  "@smithy/util-body-length-browser": "^4.2.2",
57
57
  "@smithy/util-body-length-node": "^4.2.3",
58
- "@smithy/util-defaults-mode-browser": "^4.3.39",
59
- "@smithy/util-defaults-mode-node": "^4.2.42",
60
- "@smithy/util-endpoints": "^3.3.2",
61
- "@smithy/util-middleware": "^4.2.11",
62
- "@smithy/util-retry": "^4.2.11",
58
+ "@smithy/util-defaults-mode-browser": "^4.3.41",
59
+ "@smithy/util-defaults-mode-node": "^4.2.44",
60
+ "@smithy/util-endpoints": "^3.3.3",
61
+ "@smithy/util-middleware": "^4.2.12",
62
+ "@smithy/util-retry": "^4.2.12",
63
63
  "@smithy/util-utf8": "^4.2.2",
64
64
  "tslib": "^2.6.2"
65
65
  },
66
66
  "devDependencies": {
67
- "@smithy/snapshot-testing": "^2.0.0",
67
+ "@smithy/snapshot-testing": "^2.0.2",
68
68
  "@tsconfig/node20": "20.1.8",
69
69
  "@types/node": "^20.14.8",
70
70
  "concurrently": "7.0.0",
@@ -18,8 +18,9 @@ AWS SDK for JavaScript SFN Client for Node.js, Browser and React Native.
18
18
  </important>
19
19
 
20
20
  ## Installing
21
- To install this package, simply type add or install @aws-sdk/client-sfn
22
- using your favorite package manager:
21
+
22
+ To install this package, use the CLI of your favorite package manager:
23
+
23
24
  - `npm install @aws-sdk/client-sfn`
24
25
  - `yarn add @aws-sdk/client-sfn`
25
26
  - `pnpm add @aws-sdk/client-sfn`
@@ -44,15 +45,15 @@ import { SFNClient, ListActivitiesCommand } from "@aws-sdk/client-sfn";
44
45
 
45
46
  ### Usage
46
47
 
47
- To send a request, you:
48
+ To send a request:
48
49
 
49
- - Initiate client with configuration (e.g. credentials, region).
50
- - Initiate command with input parameters.
51
- - Call `send` operation on client with command object as input.
52
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
50
+ - Instantiate a client with configuration (e.g. credentials, region).
51
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
52
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
53
+ - Instantiate a command with input parameters.
54
+ - Call the `send` operation on the client, providing the command object as input.
53
55
 
54
56
  ```js
55
- // a client can be shared by different commands.
56
57
  const client = new SFNClient({ region: "REGION" });
57
58
 
58
59
  const params = { /** input parameters */ };
@@ -61,7 +62,7 @@ const command = new ListActivitiesCommand(params);
61
62
 
62
63
  #### Async/await
63
64
 
64
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
65
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
65
66
  operator to wait for the promise returned by send operation as follows:
66
67
 
67
68
  ```js
@@ -76,26 +77,9 @@ try {
76
77
  }
77
78
  ```
78
79
 
79
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
80
- as compared to using Promise chains or callbacks.
81
-
82
80
  #### Promises
83
81
 
84
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
85
- to execute send operation.
86
-
87
- ```js
88
- client.send(command).then(
89
- (data) => {
90
- // process data.
91
- },
92
- (error) => {
93
- // error handling.
94
- }
95
- );
96
- ```
97
-
98
- Promises can also be called using `.catch()` and `.finally()` as follows:
82
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
99
83
 
100
84
  ```js
101
85
  client
@@ -111,27 +95,21 @@ client
111
95
  });
112
96
  ```
113
97
 
114
- #### Callbacks
115
-
116
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
117
- but they are supported by the send operation.
98
+ #### Aggregated client
118
99
 
119
- ```js
120
- // callbacks.
121
- client.send(command, (err, data) => {
122
- // process err and data.
123
- });
124
- ```
100
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
125
101
 
126
- #### v2 compatible style
102
+ `SFN` extends `SFNClient` and additionally supports all operations, waiters, and paginators as methods.
103
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
127
104
 
128
- The client can also send requests using v2 compatible style.
129
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
130
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
105
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`SFNClient`).
106
+ More details are in the blog post on
107
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
131
108
 
132
109
  ```ts
133
- import * as AWS from "@aws-sdk/client-sfn";
134
- const client = new AWS.SFN({ region: "REGION" });
110
+ import { SFN } from "@aws-sdk/client-sfn";
111
+
112
+ const client = new SFN({ region: "REGION" });
135
113
 
136
114
  // async/await.
137
115
  try {
@@ -151,7 +129,7 @@ client
151
129
  // error handling.
152
130
  });
153
131
 
154
- // callbacks.
132
+ // callbacks (not recommended).
155
133
  client.listActivities(params, (err, data) => {
156
134
  // process err and data.
157
135
  });
@@ -179,12 +157,14 @@ try {
179
157
  }
180
158
  ```
181
159
 
160
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
161
+
182
162
  ## Getting Help
183
163
 
184
164
  Please use these community resources for getting help.
185
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
165
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
186
166
 
187
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
167
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
188
168
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
189
169
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
190
170
  on AWS Developer Blog.
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-sfn",
3
3
  "description": "AWS SDK for JavaScript Sfn 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-sfn",
@@ -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
  },
@@ -21,8 +21,9 @@ cryptographically signing your service requests, retrying requests, and handling
21
21
  responses. For a list of available SDKs, go to <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>. </p>
22
22
 
23
23
  ## Installing
24
- To install this package, simply type add or install @aws-sdk/client-sns
25
- using your favorite package manager:
24
+
25
+ To install this package, use the CLI of your favorite package manager:
26
+
26
27
  - `npm install @aws-sdk/client-sns`
27
28
  - `yarn add @aws-sdk/client-sns`
28
29
  - `pnpm add @aws-sdk/client-sns`
@@ -47,15 +48,15 @@ import { SNSClient, ListTopicsCommand } from "@aws-sdk/client-sns";
47
48
 
48
49
  ### Usage
49
50
 
50
- To send a request, you:
51
+ To send a request:
51
52
 
52
- - Initiate client with configuration (e.g. credentials, region).
53
- - Initiate command with input parameters.
54
- - Call `send` operation on client with command object as input.
55
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
53
+ - Instantiate a client with configuration (e.g. credentials, region).
54
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
55
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
56
+ - Instantiate a command with input parameters.
57
+ - Call the `send` operation on the client, providing the command object as input.
56
58
 
57
59
  ```js
58
- // a client can be shared by different commands.
59
60
  const client = new SNSClient({ region: "REGION" });
60
61
 
61
62
  const params = { /** input parameters */ };
@@ -64,7 +65,7 @@ const command = new ListTopicsCommand(params);
64
65
 
65
66
  #### Async/await
66
67
 
67
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
68
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
68
69
  operator to wait for the promise returned by send operation as follows:
69
70
 
70
71
  ```js
@@ -79,26 +80,9 @@ try {
79
80
  }
80
81
  ```
81
82
 
82
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
83
- as compared to using Promise chains or callbacks.
84
-
85
83
  #### Promises
86
84
 
87
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
88
- to execute send operation.
89
-
90
- ```js
91
- client.send(command).then(
92
- (data) => {
93
- // process data.
94
- },
95
- (error) => {
96
- // error handling.
97
- }
98
- );
99
- ```
100
-
101
- Promises can also be called using `.catch()` and `.finally()` as follows:
85
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
102
86
 
103
87
  ```js
104
88
  client
@@ -114,27 +98,21 @@ client
114
98
  });
115
99
  ```
116
100
 
117
- #### Callbacks
118
-
119
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
120
- but they are supported by the send operation.
101
+ #### Aggregated client
121
102
 
122
- ```js
123
- // callbacks.
124
- client.send(command, (err, data) => {
125
- // process err and data.
126
- });
127
- ```
103
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
128
104
 
129
- #### v2 compatible style
105
+ `SNS` extends `SNSClient` and additionally supports all operations, waiters, and paginators as methods.
106
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
130
107
 
131
- The client can also send requests using v2 compatible style.
132
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
133
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
108
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`SNSClient`).
109
+ More details are in the blog post on
110
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
134
111
 
135
112
  ```ts
136
- import * as AWS from "@aws-sdk/client-sns";
137
- const client = new AWS.SNS({ region: "REGION" });
113
+ import { SNS } from "@aws-sdk/client-sns";
114
+
115
+ const client = new SNS({ region: "REGION" });
138
116
 
139
117
  // async/await.
140
118
  try {
@@ -154,7 +132,7 @@ client
154
132
  // error handling.
155
133
  });
156
134
 
157
- // callbacks.
135
+ // callbacks (not recommended).
158
136
  client.listTopics(params, (err, data) => {
159
137
  // process err and data.
160
138
  });
@@ -182,12 +160,14 @@ try {
182
160
  }
183
161
  ```
184
162
 
163
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
164
+
185
165
  ## Getting Help
186
166
 
187
167
  Please use these community resources for getting help.
188
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
168
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
189
169
 
190
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
170
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
191
171
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
192
172
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
193
173
  on AWS Developer Blog.