@aws-sdk/client-rds-data 3.296.0 → 3.298.0

package/dist-types/RDSDataClient.d.ts

@@ -14,15 +14,24 @@ import { ExecuteSqlCommandInput, ExecuteSqlCommandOutput } from "./commands/Exec
 import { ExecuteStatementCommandInput, ExecuteStatementCommandOutput } from "./commands/ExecuteStatementCommand";
 import { RollbackTransactionCommandInput, RollbackTransactionCommandOutput } from "./commands/RollbackTransactionCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = BatchExecuteStatementCommandInput | BeginTransactionCommandInput | CommitTransactionCommandInput | ExecuteSqlCommandInput | ExecuteStatementCommandInput | RollbackTransactionCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = BatchExecuteStatementCommandOutput | BeginTransactionCommandOutput | CommitTransactionCommandOutput | ExecuteSqlCommandOutput | ExecuteStatementCommandOutput | RollbackTransactionCommandOutput;
+/**
+ * @public
+ */
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
     /**
      * The HTTP handler to use. Fetch in browser and Https in Nodejs.
      */
     requestHandler?: __HttpHandler;
     /**
-     * A constructor for a class implementing the {@link __Checksum} interface
+     * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
      * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
      * @internal
      */
@@ -112,23 +121,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
      */
     logger?: __Logger;
     /**
-     * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
+     * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
      */
     defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
 }
+/**
+ * @public
+ */
 type RDSDataClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of RDSDataClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of RDSDataClient class constructor that set the region, credentials and other options.
  */
 export interface RDSDataClientConfig extends RDSDataClientConfigType {
 }
+/**
+ * @public
+ */
 type RDSDataClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of RDSDataClient class. This is resolved and normalized from the {@link RDSDataClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of RDSDataClient class. This is resolved and normalized from the {@link RDSDataClientConfig | constructor configuration interface}.
  */
 export interface RDSDataClientResolvedConfig extends RDSDataClientResolvedConfigType {
 }
 /**
+ * @public
  * <fullname>Amazon RDS Data Service</fullname>
  *         <p>Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora Serverless v1 DB cluster. To run these
  *             statements, you work with the Data Service API.</p>

package/dist-types/commands/BatchExecuteStatementCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { BatchExecuteStatementRequest, BatchExecuteStatementResponse } from "../models/models_0";
 import { RDSDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RDSDataClient";
 /**
+ * @public
+ *
  * The input for {@link BatchExecuteStatementCommand}.
  */
 export interface BatchExecuteStatementCommandInput extends BatchExecuteStatementRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link BatchExecuteStatementCommand}.
  */
 export interface BatchExecuteStatementCommandOutput extends BatchExecuteStatementResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Runs a batch SQL statement over an array of data.</p>
  *         <p>You can run bulk update and insert operations for multiple records using a DML
  *             statement with different parameter sets. Bulk operations can provide a significant
@@ -38,6 +43,8 @@ export interface BatchExecuteStatementCommandOutput extends BatchExecuteStatemen
  * const response = await client.send(command);
  * ```
  *
+ * @param BatchExecuteStatementCommandInput - {@link BatchExecuteStatementCommandInput}
+ * @returns {@link BatchExecuteStatementCommandOutput}
  * @see {@link BatchExecuteStatementCommandInput} for command's `input` shape.
  * @see {@link BatchExecuteStatementCommandOutput} for command's `response` shape.
  * @see {@link RDSDataClientResolvedConfig | config} for RDSDataClient's `config` shape.
@@ -66,11 +73,20 @@ export interface BatchExecuteStatementCommandOutput extends BatchExecuteStatemen
 export declare class BatchExecuteStatementCommand extends $Command<BatchExecuteStatementCommandInput, BatchExecuteStatementCommandOutput, RDSDataClientResolvedConfig> {
     readonly input: BatchExecuteStatementCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: BatchExecuteStatementCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RDSDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchExecuteStatementCommandInput, BatchExecuteStatementCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/BeginTransactionCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { BeginTransactionRequest, BeginTransactionResponse } from "../models/models_0";
 import { RDSDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RDSDataClient";
 /**
+ * @public
+ *
  * The input for {@link BeginTransactionCommand}.
  */
 export interface BeginTransactionCommandInput extends BeginTransactionRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link BeginTransactionCommand}.
  */
 export interface BeginTransactionCommandOutput extends BeginTransactionResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Starts a SQL transaction.</p>
  *         <note>
  *             <p>A transaction can run for a maximum of 24 hours. A transaction is terminated and rolled back automatically after 24
@@ -33,6 +38,8 @@ export interface BeginTransactionCommandOutput extends BeginTransactionResponse,
  * const response = await client.send(command);
  * ```
  *
+ * @param BeginTransactionCommandInput - {@link BeginTransactionCommandInput}
+ * @returns {@link BeginTransactionCommandOutput}
  * @see {@link BeginTransactionCommandInput} for command's `input` shape.
  * @see {@link BeginTransactionCommandOutput} for command's `response` shape.
  * @see {@link RDSDataClientResolvedConfig | config} for RDSDataClient's `config` shape.
@@ -61,11 +68,20 @@ export interface BeginTransactionCommandOutput extends BeginTransactionResponse,
 export declare class BeginTransactionCommand extends $Command<BeginTransactionCommandInput, BeginTransactionCommandOutput, RDSDataClientResolvedConfig> {
     readonly input: BeginTransactionCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: BeginTransactionCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RDSDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BeginTransactionCommandInput, BeginTransactionCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/CommitTransactionCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CommitTransactionRequest, CommitTransactionResponse } from "../models/models_0";
 import { RDSDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RDSDataClient";
 /**
+ * @public
+ *
  * The input for {@link CommitTransactionCommand}.
  */
 export interface CommitTransactionCommandInput extends CommitTransactionRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CommitTransactionCommand}.
  */
 export interface CommitTransactionCommandOutput extends CommitTransactionResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Ends a SQL transaction started with the <code>BeginTransaction</code> operation and
  *             commits the changes.</p>
  * @example
@@ -26,6 +31,8 @@ export interface CommitTransactionCommandOutput extends CommitTransactionRespons
  * const response = await client.send(command);
  * ```
  *
+ * @param CommitTransactionCommandInput - {@link CommitTransactionCommandInput}
+ * @returns {@link CommitTransactionCommandOutput}
  * @see {@link CommitTransactionCommandInput} for command's `input` shape.
  * @see {@link CommitTransactionCommandOutput} for command's `response` shape.
  * @see {@link RDSDataClientResolvedConfig | config} for RDSDataClient's `config` shape.
@@ -57,11 +64,20 @@ export interface CommitTransactionCommandOutput extends CommitTransactionRespons
 export declare class CommitTransactionCommand extends $Command<CommitTransactionCommandInput, CommitTransactionCommandOutput, RDSDataClientResolvedConfig> {
     readonly input: CommitTransactionCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CommitTransactionCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RDSDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CommitTransactionCommandInput, CommitTransactionCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/ExecuteSqlCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ExecuteSqlRequest, ExecuteSqlResponse } from "../models/models_0";
 import { RDSDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RDSDataClient";
 /**
+ * @public
+ *
  * The input for {@link ExecuteSqlCommand}.
  */
 export interface ExecuteSqlCommandInput extends ExecuteSqlRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ExecuteSqlCommand}.
  */
 export interface ExecuteSqlCommandOutput extends ExecuteSqlResponse, __MetadataBearer {
 }
 /**
+ * @public
  * @deprecated
  *
  * <p>Runs one or more SQL statements.</p>
@@ -31,6 +36,8 @@ export interface ExecuteSqlCommandOutput extends ExecuteSqlResponse, __MetadataB
  * const response = await client.send(command);
  * ```
  *
+ * @param ExecuteSqlCommandInput - {@link ExecuteSqlCommandInput}
+ * @returns {@link ExecuteSqlCommandOutput}
  * @see {@link ExecuteSqlCommandInput} for command's `input` shape.
  * @see {@link ExecuteSqlCommandOutput} for command's `response` shape.
  * @see {@link RDSDataClientResolvedConfig | config} for RDSDataClient's `config` shape.
@@ -56,11 +63,20 @@ export interface ExecuteSqlCommandOutput extends ExecuteSqlResponse, __MetadataB
 export declare class ExecuteSqlCommand extends $Command<ExecuteSqlCommandInput, ExecuteSqlCommandOutput, RDSDataClientResolvedConfig> {
     readonly input: ExecuteSqlCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ExecuteSqlCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RDSDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ExecuteSqlCommandInput, ExecuteSqlCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/ExecuteStatementCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ExecuteStatementRequest, ExecuteStatementResponse } from "../models/models_0";
 import { RDSDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RDSDataClient";
 /**
+ * @public
+ *
  * The input for {@link ExecuteStatementCommand}.
  */
 export interface ExecuteStatementCommandInput extends ExecuteStatementRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ExecuteStatementCommand}.
  */
 export interface ExecuteStatementCommandOutput extends ExecuteStatementResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Runs a SQL statement against a database.</p>
  *         <note>
  *             <p>If a call isn't part of a transaction because it doesn't include the
@@ -31,6 +36,8 @@ export interface ExecuteStatementCommandOutput extends ExecuteStatementResponse,
  * const response = await client.send(command);
  * ```
  *
+ * @param ExecuteStatementCommandInput - {@link ExecuteStatementCommandInput}
+ * @returns {@link ExecuteStatementCommandOutput}
  * @see {@link ExecuteStatementCommandInput} for command's `input` shape.
  * @see {@link ExecuteStatementCommandOutput} for command's `response` shape.
  * @see {@link RDSDataClientResolvedConfig | config} for RDSDataClient's `config` shape.
@@ -59,11 +66,20 @@ export interface ExecuteStatementCommandOutput extends ExecuteStatementResponse,
 export declare class ExecuteStatementCommand extends $Command<ExecuteStatementCommandInput, ExecuteStatementCommandOutput, RDSDataClientResolvedConfig> {
     readonly input: ExecuteStatementCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ExecuteStatementCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RDSDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ExecuteStatementCommandInput, ExecuteStatementCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/RollbackTransactionCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { RollbackTransactionRequest, RollbackTransactionResponse } from "../models/models_0";
 import { RDSDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RDSDataClient";
 /**
+ * @public
+ *
  * The input for {@link RollbackTransactionCommand}.
  */
 export interface RollbackTransactionCommandInput extends RollbackTransactionRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link RollbackTransactionCommand}.
  */
 export interface RollbackTransactionCommandOutput extends RollbackTransactionResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Performs a rollback of a transaction. Rolling back a transaction cancels its changes.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface RollbackTransactionCommandOutput extends RollbackTransactionRes
  * const response = await client.send(command);
  * ```
  *
+ * @param RollbackTransactionCommandInput - {@link RollbackTransactionCommandInput}
+ * @returns {@link RollbackTransactionCommandOutput}
  * @see {@link RollbackTransactionCommandInput} for command's `input` shape.
  * @see {@link RollbackTransactionCommandOutput} for command's `response` shape.
  * @see {@link RDSDataClientResolvedConfig | config} for RDSDataClient's `config` shape.
@@ -56,11 +63,20 @@ export interface RollbackTransactionCommandOutput extends RollbackTransactionRes
 export declare class RollbackTransactionCommand extends $Command<RollbackTransactionCommandInput, RollbackTransactionCommandOutput, RDSDataClientResolvedConfig> {
     readonly input: RollbackTransactionCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: RollbackTransactionCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RDSDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RollbackTransactionCommandInput, RollbackTransactionCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/RDSDataServiceException.d.ts

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from RDSData service.
  */
 export declare class RDSDataServiceException extends __ServiceException {