AWS SDK for JavaScript Rds Client for Node.js, Browser and React Native
npm install @aws-sdk/client-rdsAWS SDK for JavaScript RDS Client for Node.js, Browser and React Native.
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.
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.
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.
Amazon RDS API Reference
For the alphabetical list of API actions, see API Actions.
For the alphabetical list of data types, see Data Types.
For a list of common query parameters, see Common Parameters.
For descriptions of the error codes, see Common Errors.
Amazon RDS User Guide
For a summary of the Amazon RDS interfaces, see Available RDS Interfaces.
For more information about how to use the Query API, see Using the Query API.
npm install @aws-sdk/client-rdsyarn add @aws-sdk/client-rdspnpm add @aws-sdk/client-rdsThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the RDSClient and
the commands you need, for example ListTagsForResourceCommand:
``js`
// ES5 example
const { RDSClient, ListTagsForResourceCommand } = require("@aws-sdk/client-rds");
`ts`
// ES6+ example
import { RDSClient, ListTagsForResourceCommand } from "@aws-sdk/client-rds";
To send a request, you:
- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.destroy()
- If you are using a custom http handler, you may call to close open connections.
`js
// a client can be shared by different commands.
const client = new RDSClient({ region: "REGION" });
const params = { /* input parameters / };
const command = new ListTagsForResourceCommand(params);
`
#### Async/await
We recommend using await
operator to wait for the promise returned by send operation as follows:
`js`
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.
#### Promises
You can also use Promise chaining
to execute send operation.
`js`
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
`js`
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
#### Callbacks
We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.
`js`
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
#### v2 compatible style
The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript
`ts
import * as AWS from "@aws-sdk/client-rds";
const client = new AWS.RDS({ region: "REGION" });
// async/await.
try {
const data = await client.listTagsForResource(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listTagsForResource(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listTagsForResource(params, (err, data) => {
// process err and data.
});
`
When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).
`js`
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.
To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-rds` package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.
AddRoleToDBCluster
Command API Reference / Input / Output
AddRoleToDBInstance
Command API Reference / Input / Output
AddSourceIdentifierToSubscription
Command API Reference / Input / Output
AddTagsToResource
Command API Reference / Input / Output
ApplyPendingMaintenanceAction
Command API Reference / Input / Output
AuthorizeDBSecurityGroupIngress
Command API Reference / Input / Output
BacktrackDBCluster
Command API Reference / Input / Output
CancelExportTask
Command API Reference / Input / Output
CopyDBClusterParameterGroup
Command API Reference / Input / Output
CopyDBClusterSnapshot
Command API Reference / Input / Output
CopyDBParameterGroup
Command API Reference / Input / Output
CopyDBSnapshot
Command API Reference / Input / Output
CopyOptionGroup
Command API Reference / Input / Output
CreateBlueGreenDeployment
Command API Reference / Input / Output
CreateCustomDBEngineVersion
Command API Reference / Input / Output
CreateDBCluster
Command API Reference / Input / Output
CreateDBClusterEndpoint
Command API Reference / Input / Output
CreateDBClusterParameterGroup
Command API Reference / Input / Output
CreateDBClusterSnapshot
Command API Reference / Input / Output
CreateDBInstance
Command API Reference / Input / Output
CreateDBInstanceReadReplica
Command API Reference / Input / Output
CreateDBParameterGroup
Command API Reference / Input / Output
CreateDBProxy
Command API Reference / Input / Output
CreateDBProxyEndpoint
Command API Reference / Input / Output
CreateDBSecurityGroup
Command API Reference / Input / Output
CreateDBShardGroup
Command API Reference / Input / Output
CreateDBSnapshot
Command API Reference / Input / Output
CreateDBSubnetGroup
Command API Reference / Input / Output
CreateEventSubscription
Command API Reference / Input / Output
CreateGlobalCluster
Command API Reference / Input / Output
CreateIntegration
Command API Reference / Input / Output
CreateOptionGroup
Command API Reference / Input / Output
CreateTenantDatabase
Command API Reference / Input / Output
DeleteBlueGreenDeployment
Command API Reference / Input / Output
DeleteCustomDBEngineVersion
Command API Reference / Input / Output
DeleteDBCluster
Command API Reference / Input / Output
DeleteDBClusterAutomatedBackup
Command API Reference / Input / Output
DeleteDBClusterEndpoint
Command API Reference / Input / Output
DeleteDBClusterParameterGroup
Command API Reference / Input / Output
DeleteDBClusterSnapshot
Command API Reference / Input / Output
DeleteDBInstance
Command API Reference / Input / Output
DeleteDBInstanceAutomatedBackup
Command API Reference / Input / Output
DeleteDBParameterGroup
Command API Reference / Input / Output
DeleteDBProxy
Command API Reference / Input / Output
DeleteDBProxyEndpoint
Command API Reference / Input / Output
DeleteDBSecurityGroup
Command API Reference / Input / Output
DeleteDBShardGroup
Command API Reference / Input / Output
DeleteDBSnapshot
Command API Reference / Input / Output
DeleteDBSubnetGroup
Command API Reference / Input / Output
DeleteEventSubscription
Command API Reference / Input / Output
DeleteGlobalCluster
Command API Reference / Input / Output
DeleteIntegration
Command API Reference / Input / Output
DeleteOptionGroup
Command API Reference / Input / Output
DeleteTenantDatabase
Command API Reference / Input / Output
DeregisterDBProxyTargets
Command API Reference / Input / Output
DescribeAccountAttributes
Command API Reference / Input / Output
DescribeBlueGreenDeployments
Command API Reference / Input / Output
DescribeCertificates
Command API Reference / Input / Output
DescribeDBClusterAutomatedBackups
Command API Reference / Input / Output
DescribeDBClusterBacktracks
Command API Reference / Input / Output
DescribeDBClusterEndpoints
Command API Reference / Input / Output
DescribeDBClusterParameterGroups
Command API Reference / Input / Output
DescribeDBClusterParameters
Command API Reference / Input / Output
DescribeDBClusters
Command API Reference / Input / Output
DescribeDBClusterSnapshotAttributes
Command API Reference / Input / Output
DescribeDBClusterSnapshots
Command API Reference / Input / Output
DescribeDBEngineVersions
Command API Reference / Input / Output
DescribeDBInstanceAutomatedBackups
Command API Reference / Input / Output
DescribeDBInstances
Command API Reference / Input / Output
DescribeDBLogFiles
Command API Reference / Input / Output
DescribeDBMajorEngineVersions
Command API Reference / Input / Output
DescribeDBParameterGroups
Command API Reference / Input / Output
DescribeDBParameters
Command API Reference / Input / Output
DescribeDBProxies
Command API Reference / Input / Output
DescribeDBProxyEndpoints
Command API Reference / Input / Output
DescribeDBProxyTargetGroups
Command API Reference / Input / Output
DescribeDBProxyTargets
Command API Reference / Input / Output
DescribeDBRecommendations
Command API Reference / Input / Output
DescribeDBSecurityGroups
Command API Reference / Input / Output
DescribeDBShardGroups
Command API Reference / Input / Output
DescribeDBSnapshotAttributes
Command API Reference / Input / Output
DescribeDBSnapshots
Command API Reference / Input / Output
DescribeDBSnapshotTenantDatabases
Command API Reference / Input / Output
DescribeDBSubnetGroups
Command API Reference / Input / Output
DescribeEngineDefaultClusterParameters
Command API Reference / Input / Output
DescribeEngineDefaultParameters
Command API Reference / Input / Output
DescribeEventCategories
Command API Reference / Input / Output
DescribeEvents
Command API Reference / Input / Output
DescribeEventSubscriptions
Command API Reference / Input / Output
DescribeExportTasks
Command API Reference / Input / Output
DescribeGlobalClusters
Command API Reference / Input / Output
DescribeIntegrations
Command API Reference / Input / Output
DescribeOptionGroupOptions
Command API Reference / Input / Output
DescribeOptionGroups
Command API Reference / Input / Output
DescribeOrderableDBInstanceOptions
Command API Reference / Input / Output
DescribePendingMaintenanceActions
Command API Reference / Input / Output
DescribeReservedDBInstances
Command API Reference / Input / Output
DescribeReservedDBInstancesOfferings
Command API Reference / Input / Output
DescribeSourceRegions
Command API Reference / Input / Output
DescribeTenantDatabases
Command API Reference / Input / Output
DescribeValidDBInstanceModifications
Command API Reference / Input / Output
DisableHttpEndpoint
Command API Reference / Input / Output
DownloadDBLogFilePortion
Command API Reference / Input / Output
EnableHttpEndpoint
Command API Reference / Input / Output
FailoverDBCluster
Command API Reference / Input / Output
FailoverGlobalCluster
Command API Reference / Input / Output
ListTagsForResource
Command API Reference / Input / Output
ModifyActivityStream
Command API Reference / Input / Output
ModifyCertificates
Command API Reference / Input / Output
ModifyCurrentDBClusterCapacity
Command API Reference / Input / Output
ModifyCustomDBEngineVersion
Command API Reference / Input / Output
ModifyDBCluster
Command API Reference / Input / Output
ModifyDBClusterEndpoint
Command API Reference / Input / Output
ModifyDBClusterParameterGroup
Command API Reference / Input / Output
ModifyDBClusterSnapshotAttribute
Command API Reference / Input / Output
ModifyDBInstance
Command API Reference / Input / Output
ModifyDBParameterGroup
Command API Reference / Input / Output
ModifyDBProxy
Command API Reference / Input / Output
ModifyDBProxyEndpoint
Command API Reference / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-rds/Interface/ModifyDBProxyEndpointComm