@aws-sdk/client-rds 3.1007.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 +36 -36
package/README.md CHANGED
@@ -9,8 +9,9 @@ AWS SDK for JavaScript RDS Client for Node.js, Browser and React Native.
9
9
  <fullname>Amazon Relational Database Service</fullname> <p/> <p>Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.</p> <p>Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, Db2, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your DB instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.</p> <p>This interface reference for Amazon RDS contains documentation for a programming or command line interface you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.</p> <p> <b>Amazon RDS API Reference</b> </p> <ul> <li> <p>For the alphabetical list of API actions, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Operations.html">API Actions</a>.</p> </li> <li> <p>For the alphabetical list of data types, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Types.html">Data Types</a>.</p> </li> <li> <p>For a list of common query parameters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/CommonParameters.html">Common Parameters</a>.</p> </li> <li> <p>For descriptions of the error codes, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/CommonErrors.html">Common Errors</a>.</p> </li> </ul> <p> <b>Amazon RDS User Guide</b> </p> <ul> <li> <p>For a summary of the Amazon RDS interfaces, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Welcome.html#Welcome.Interfaces">Available RDS Interfaces</a>.</p> </li> <li> <p>For more information about how to use the Query API, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Using_the_Query_API.html">Using the Query API</a>.</p> </li> </ul>
10
10
 
11
11
  ## Installing
12
- To install this package, simply type add or install @aws-sdk/client-rds
13
- using your favorite package manager:
12
+
13
+ To install this package, use the CLI of your favorite package manager:
14
+
14
15
  - `npm install @aws-sdk/client-rds`
15
16
  - `yarn add @aws-sdk/client-rds`
16
17
  - `pnpm add @aws-sdk/client-rds`
@@ -35,15 +36,15 @@ import { RDSClient, ListTagsForResourceCommand } from "@aws-sdk/client-rds";
35
36
 
36
37
  ### Usage
37
38
 
38
- To send a request, you:
39
+ To send a request:
39
40
 
40
- - Initiate client with configuration (e.g. credentials, region).
41
- - Initiate command with input parameters.
42
- - Call `send` operation on client with command object as input.
43
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
41
+ - Instantiate a client with configuration (e.g. credentials, region).
42
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
43
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
44
+ - Instantiate a command with input parameters.
45
+ - Call the `send` operation on the client, providing the command object as input.
44
46
 
45
47
  ```js
46
- // a client can be shared by different commands.
47
48
  const client = new RDSClient({ region: "REGION" });
48
49
 
49
50
  const params = { /** input parameters */ };
@@ -52,7 +53,7 @@ const command = new ListTagsForResourceCommand(params);
52
53
 
53
54
  #### Async/await
54
55
 
55
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
56
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
56
57
  operator to wait for the promise returned by send operation as follows:
57
58
 
58
59
  ```js
@@ -67,26 +68,9 @@ try {
67
68
  }
68
69
  ```
69
70
 
70
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
71
- as compared to using Promise chains or callbacks.
72
-
73
71
  #### Promises
74
72
 
75
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
76
- to execute send operation.
77
-
78
- ```js
79
- client.send(command).then(
80
- (data) => {
81
- // process data.
82
- },
83
- (error) => {
84
- // error handling.
85
- }
86
- );
87
- ```
88
-
89
- Promises can also be called using `.catch()` and `.finally()` as follows:
73
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
90
74
 
91
75
  ```js
92
76
  client
@@ -102,27 +86,21 @@ client
102
86
  });
103
87
  ```
104
88
 
105
- #### Callbacks
106
-
107
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
108
- but they are supported by the send operation.
89
+ #### Aggregated client
109
90
 
110
- ```js
111
- // callbacks.
112
- client.send(command, (err, data) => {
113
- // process err and data.
114
- });
115
- ```
91
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
116
92
 
117
- #### v2 compatible style
93
+ `RDS` extends `RDSClient` and additionally supports all operations, waiters, and paginators as methods.
94
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
118
95
 
119
- The client can also send requests using v2 compatible style.
120
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
121
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
96
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`RDSClient`).
97
+ More details are in the blog post on
98
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
122
99
 
123
100
  ```ts
124
- import * as AWS from "@aws-sdk/client-rds";
125
- const client = new AWS.RDS({ region: "REGION" });
101
+ import { RDS } from "@aws-sdk/client-rds";
102
+
103
+ const client = new RDS({ region: "REGION" });
126
104
 
127
105
  // async/await.
128
106
  try {
@@ -142,7 +120,7 @@ client
142
120
  // error handling.
143
121
  });
144
122
 
145
- // callbacks.
123
+ // callbacks (not recommended).
146
124
  client.listTagsForResource(params, (err, data) => {
147
125
  // process err and data.
148
126
  });
@@ -170,12 +148,14 @@ try {
170
148
  }
171
149
  ```
172
150
 
151
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
152
+
173
153
  ## Getting Help
174
154
 
175
155
  Please use these community resources for getting help.
176
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
156
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
177
157
 
178
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
158
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
179
159
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
180
160
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
181
161
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-rds",
3
3
  "description": "AWS SDK for JavaScript Rds Client for Node.js, Browser and React Native",
4
- "version": "3.1007.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-rds",
@@ -27,48 +27,48 @@
27
27
  "dependencies": {
28
28
  "@aws-crypto/sha256-browser": "5.2.0",
29
29
  "@aws-crypto/sha256-js": "5.2.0",
30
- "@aws-sdk/core": "^3.973.19",
31
- "@aws-sdk/credential-provider-node": "^3.972.19",
32
- "@aws-sdk/middleware-host-header": "^3.972.7",
33
- "@aws-sdk/middleware-logger": "^3.972.7",
34
- "@aws-sdk/middleware-recursion-detection": "^3.972.7",
35
- "@aws-sdk/middleware-sdk-rds": "^3.972.14",
36
- "@aws-sdk/middleware-user-agent": "^3.972.20",
37
- "@aws-sdk/region-config-resolver": "^3.972.7",
38
- "@aws-sdk/types": "^3.973.5",
39
- "@aws-sdk/util-endpoints": "^3.996.4",
40
- "@aws-sdk/util-user-agent-browser": "^3.972.7",
41
- "@aws-sdk/util-user-agent-node": "^3.973.5",
42
- "@smithy/config-resolver": "^4.4.10",
43
- "@smithy/core": "^3.23.9",
44
- "@smithy/fetch-http-handler": "^5.3.13",
45
- "@smithy/hash-node": "^4.2.11",
46
- "@smithy/invalid-dependency": "^4.2.11",
47
- "@smithy/middleware-content-length": "^4.2.11",
48
- "@smithy/middleware-endpoint": "^4.4.23",
49
- "@smithy/middleware-retry": "^4.4.40",
50
- "@smithy/middleware-serde": "^4.2.12",
51
- "@smithy/middleware-stack": "^4.2.11",
52
- "@smithy/node-config-provider": "^4.3.11",
53
- "@smithy/node-http-handler": "^4.4.14",
54
- "@smithy/protocol-http": "^5.3.11",
55
- "@smithy/smithy-client": "^4.12.3",
56
- "@smithy/types": "^4.13.0",
57
- "@smithy/url-parser": "^4.2.11",
30
+ "@aws-sdk/core": "^3.973.20",
31
+ "@aws-sdk/credential-provider-node": "^3.972.21",
32
+ "@aws-sdk/middleware-host-header": "^3.972.8",
33
+ "@aws-sdk/middleware-logger": "^3.972.8",
34
+ "@aws-sdk/middleware-recursion-detection": "^3.972.8",
35
+ "@aws-sdk/middleware-sdk-rds": "^3.972.15",
36
+ "@aws-sdk/middleware-user-agent": "^3.972.21",
37
+ "@aws-sdk/region-config-resolver": "^3.972.8",
38
+ "@aws-sdk/types": "^3.973.6",
39
+ "@aws-sdk/util-endpoints": "^3.996.5",
40
+ "@aws-sdk/util-user-agent-browser": "^3.972.8",
41
+ "@aws-sdk/util-user-agent-node": "^3.973.7",
42
+ "@smithy/config-resolver": "^4.4.11",
43
+ "@smithy/core": "^3.23.11",
44
+ "@smithy/fetch-http-handler": "^5.3.15",
45
+ "@smithy/hash-node": "^4.2.12",
46
+ "@smithy/invalid-dependency": "^4.2.12",
47
+ "@smithy/middleware-content-length": "^4.2.12",
48
+ "@smithy/middleware-endpoint": "^4.4.25",
49
+ "@smithy/middleware-retry": "^4.4.42",
50
+ "@smithy/middleware-serde": "^4.2.14",
51
+ "@smithy/middleware-stack": "^4.2.12",
52
+ "@smithy/node-config-provider": "^4.3.12",
53
+ "@smithy/node-http-handler": "^4.4.16",
54
+ "@smithy/protocol-http": "^5.3.12",
55
+ "@smithy/smithy-client": "^4.12.5",
56
+ "@smithy/types": "^4.13.1",
57
+ "@smithy/url-parser": "^4.2.12",
58
58
  "@smithy/util-base64": "^4.3.2",
59
59
  "@smithy/util-body-length-browser": "^4.2.2",
60
60
  "@smithy/util-body-length-node": "^4.2.3",
61
- "@smithy/util-defaults-mode-browser": "^4.3.39",
62
- "@smithy/util-defaults-mode-node": "^4.2.42",
63
- "@smithy/util-endpoints": "^3.3.2",
64
- "@smithy/util-middleware": "^4.2.11",
65
- "@smithy/util-retry": "^4.2.11",
61
+ "@smithy/util-defaults-mode-browser": "^4.3.41",
62
+ "@smithy/util-defaults-mode-node": "^4.2.44",
63
+ "@smithy/util-endpoints": "^3.3.3",
64
+ "@smithy/util-middleware": "^4.2.12",
65
+ "@smithy/util-retry": "^4.2.12",
66
66
  "@smithy/util-utf8": "^4.2.2",
67
- "@smithy/util-waiter": "^4.2.12",
67
+ "@smithy/util-waiter": "^4.2.13",
68
68
  "tslib": "^2.6.2"
69
69
  },
70
70
  "devDependencies": {
71
- "@smithy/snapshot-testing": "^2.0.0",
71
+ "@smithy/snapshot-testing": "^2.0.2",
72
72
  "@tsconfig/node20": "20.1.8",
73
73
  "@types/node": "^20.14.8",
74
74
  "concurrently": "7.0.0",