Navigation Guide
You are on the package index page for the Client of a service. Return to the Client landing page

@aws-sdk/client-rds-data

Description

RDS Data API

Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora DB cluster. To run these statements, you use the RDS Data API (Data API).

Data API is available with the following types of Aurora databases:

Aurora PostgreSQL - Serverless v2, provisioned, and Serverless v1
Aurora MySQL - Serverless v2, provisioned, and Serverless v1

For more information about the Data API, see Using RDS Data API in the Amazon Aurora User Guide.

Installation

NPM

npm install @aws-sdk/client-rds-data

Yarn

yarn add @aws-sdk/client-rds-data

pnpm

pnpm add @aws-sdk/client-rds-data

Types

Type Name	Type
_Record	Interface
AccessDeniedException	Class
ArrayValue	Namespace
ArrayValue	TypeAlias
BadRequestException	Class
BatchExecuteStatementCommand	Class
BatchExecuteStatementCommandInput	Interface
BatchExecuteStatementCommandOutput	Interface
BatchExecuteStatementRequest	Interface
BatchExecuteStatementResponse	Interface
BeginTransactionCommand	Class
BeginTransactionCommandInput	Interface
BeginTransactionCommandOutput	Interface
BeginTransactionRequest	Interface
BeginTransactionResponse	Interface
ClientDefaults	Interface
ClientInputEndpointParameters	Interface
ColumnMetadata	Interface
CommitTransactionCommand	Class
CommitTransactionCommandInput	Interface
CommitTransactionCommandOutput	Interface
CommitTransactionRequest	Interface
CommitTransactionResponse	Interface
DatabaseErrorException	Class
DatabaseNotFoundException	Class
DatabaseResumingException	Class
DatabaseUnavailableException	Class
DecimalReturnType	TypeAlias
DecimalReturnTypeenum	Variable
ExecuteSqlCommanddeprecated	Class
ExecuteSqlCommandInput	Interface
ExecuteSqlCommandOutput	Interface
ExecuteSqlRequest	Interface
ExecuteSqlResponse	Interface
ExecuteStatementCommand	Class
ExecuteStatementCommandInput	Interface
ExecuteStatementCommandOutput	Interface
ExecuteStatementRequest	Interface
ExecuteStatementResponse	Interface
Field	Namespace
Field	TypeAlias
ForbiddenException	Class
HttpEndpointNotEnabledException	Class
InternalServerErrorException	Class
InvalidResourceStateException	Class
InvalidSecretException	Class
LongReturnType	TypeAlias
LongReturnTypeenum	Variable
NotFoundException	Class
RDSData	Class
RDSData	Interface
RDSDataClient	Class
RDSDataClientConfig	Interface
RDSDataClientConfigType	TypeAlias
RDSDataClientResolvedConfig	Interface
RDSDataClientResolvedConfigType	TypeAlias
RDSDataServiceException	Class
RecordsFormatType	TypeAlias
RecordsFormatTypeenum	Variable
ResultFrame	Interface
ResultSetMetadata	Interface
ResultSetOptions	Interface
RollbackTransactionCommand	Class
RollbackTransactionCommandInput	Interface
RollbackTransactionCommandOutput	Interface
RollbackTransactionRequest	Interface
RollbackTransactionResponse	Interface
RuntimeExtension	Interface
SecretsErrorException	Class
ServiceInputTypes	TypeAlias
ServiceOutputTypes	TypeAlias
ServiceUnavailableError	Class
SqlParameter	Interface
SqlStatementResult	Interface
StatementTimeoutException	Class
StructValue	Interface
TransactionNotFoundException	Class
TypeHint	TypeAlias
TypeHintenum	Variable
UnsupportedResultException	Class
UpdateResult	Interface
Value	Namespace
Value	TypeAlias

Getting Started

References

@aws-sdk/client-rds-data

Description

Installation

Types

Table of Contents

Search