@aws-sdk/client-rds-data 3.379.1 → 3.382.0

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

@@ -85,6 +85,7 @@ export declare class StatementTimeoutException extends __BaseException {
     readonly name: "StatementTimeoutException";
     readonly $fault: "client";
     /**
+     * @public
      * <p>The database connection ID that executed the SQL statement.</p>
      */
     dbConnectionId?: number;
@@ -100,18 +101,22 @@ export declare class StatementTimeoutException extends __BaseException {
  */
 export interface BeginTransactionRequest {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.</p>
      */
     resourceArn: string | undefined;
     /**
+     * @public
      * <p>The name or ARN of the secret that enables access to the DB cluster.</p>
      */
     secretArn: string | undefined;
     /**
+     * @public
      * <p>The name of the database.</p>
      */
     database?: string;
     /**
+     * @public
      * <p>The name of the database schema.</p>
      */
     schema?: string;
@@ -123,6 +128,7 @@ export interface BeginTransactionRequest {
  */
 export interface BeginTransactionResponse {
     /**
+     * @public
      * <p>The transaction ID of the transaction started by the call.</p>
      */
     transactionId?: string;
@@ -133,58 +139,72 @@ export interface BeginTransactionResponse {
  */
 export interface ColumnMetadata {
     /**
+     * @public
      * <p>The name of the column.</p>
      */
     name?: string;
     /**
+     * @public
      * <p>The type of the column.</p>
      */
     type?: number;
     /**
+     * @public
      * <p>The database-specific data type of the column.</p>
      */
     typeName?: string;
     /**
+     * @public
      * <p>The label for the column.</p>
      */
     label?: string;
     /**
+     * @public
      * <p>The name of the schema that owns the table that includes the column.</p>
      */
     schemaName?: string;
     /**
+     * @public
      * <p>The name of the table that includes the column.</p>
      */
     tableName?: string;
     /**
+     * @public
      * <p>A value that indicates whether the column increments automatically.</p>
      */
     isAutoIncrement?: boolean;
     /**
+     * @public
      * <p>A value that indicates whether an integer column is signed.</p>
      */
     isSigned?: boolean;
     /**
+     * @public
      * <p>A value that indicates whether the column contains currency values.</p>
      */
     isCurrency?: boolean;
     /**
+     * @public
      * <p>A value that indicates whether the column is case-sensitive.</p>
      */
     isCaseSensitive?: boolean;
     /**
+     * @public
      * <p>A value that indicates whether the column is nullable.</p>
      */
     nullable?: number;
     /**
+     * @public
      * <p>The precision value of a decimal number column.</p>
      */
     precision?: number;
     /**
+     * @public
      * <p>The scale value of a decimal number column.</p>
      */
     scale?: number;
     /**
+     * @public
      * <p>The type of the column.</p>
      */
     arrayBaseColumnType?: number;
@@ -195,14 +215,17 @@ export interface ColumnMetadata {
  */
 export interface CommitTransactionRequest {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.</p>
      */
     resourceArn: string | undefined;
     /**
+     * @public
      * <p>The name or ARN of the secret that enables access to the DB cluster.</p>
      */
     secretArn: string | undefined;
     /**
+     * @public
      * <p>The identifier of the transaction to end and commit.</p>
      */
     transactionId: string | undefined;
@@ -213,6 +236,7 @@ export interface CommitTransactionRequest {
  */
 export interface CommitTransactionResponse {
     /**
+     * @public
      * <p>The status of the commit operation.</p>
      */
     transactionStatus?: string;
@@ -248,16 +272,19 @@ export type DecimalReturnType = (typeof DecimalReturnType)[keyof typeof DecimalR
  */
 export interface ExecuteSqlRequest {
     /**
+     * @public
      * <p>The ARN of the Aurora Serverless DB cluster.</p>
      */
     dbClusterOrInstanceArn: string | undefined;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the secret that enables access to the DB cluster. Enter the database user name and password
      *             for the credentials in the secret.</p>
      *         <p>For information about creating the secret, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html">Create a database secret</a>.</p>
      */
     awsSecretStoreArn: string | undefined;
     /**
+     * @public
      * <p>One or more SQL statements to run on the DB cluster.</p>
      *         <p>You can separate SQL statements from each other with a semicolon (;). Any valid SQL
      *             statement is permitted, including data definition, data manipulation, and commit
@@ -265,10 +292,12 @@ export interface ExecuteSqlRequest {
      */
     sqlStatements: string | undefined;
     /**
+     * @public
      * <p>The name of the database.</p>
      */
     database?: string;
     /**
+     * @public
      * <p>The name of the database schema.</p>
      */
     schema?: string;
@@ -279,10 +308,12 @@ export interface ExecuteSqlRequest {
  */
 export interface ResultSetMetadata {
     /**
+     * @public
      * <p>The number of columns in the result set.</p>
      */
     columnCount?: number;
     /**
+     * @public
      * <p>The metadata of the columns in the result set.</p>
      */
     columnMetadata?: ColumnMetadata[];
@@ -317,6 +348,7 @@ export type LongReturnType = (typeof LongReturnType)[keyof typeof LongReturnType
  */
 export interface ResultSetOptions {
     /**
+     * @public
      * <p>A value that indicates how a field of <code>DECIMAL</code> type is represented
      *             in the response. The value of <code>STRING</code>, the default, specifies that
      *             it is converted to a String value. The value of <code>DOUBLE_OR_LONG</code>
@@ -329,6 +361,7 @@ export interface ResultSetOptions {
      */
     decimalReturnType?: DecimalReturnType | string;
     /**
+     * @public
      * <p>A value that indicates how a field of <code>LONG</code> type is represented.
      *         Allowed values are <code>LONG</code> and <code>STRING</code>. The default
      *         is <code>LONG</code>. Specify <code>STRING</code> if the length or
@@ -344,14 +377,17 @@ export interface ResultSetOptions {
  */
 export interface RollbackTransactionRequest {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.</p>
      */
     resourceArn: string | undefined;
     /**
+     * @public
      * <p>The name or ARN of the secret that enables access to the DB cluster.</p>
      */
     secretArn: string | undefined;
     /**
+     * @public
      * <p>The identifier of the transaction to roll back.</p>
      */
     transactionId: string | undefined;
@@ -363,6 +399,7 @@ export interface RollbackTransactionRequest {
  */
 export interface RollbackTransactionResponse {
     /**
+     * @public
      * <p>The status of the rollback operation.</p>
      */
     transactionStatus?: string;
@@ -377,6 +414,7 @@ export type ArrayValue = ArrayValue.ArrayValuesMember | ArrayValue.BooleanValues
  */
 export declare namespace ArrayValue {
     /**
+     * @public
      * <p>An array of Boolean values.</p>
      */
     interface BooleanValuesMember {
@@ -388,6 +426,7 @@ export declare namespace ArrayValue {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>An array of integers.</p>
      */
     interface LongValuesMember {
@@ -399,6 +438,7 @@ export declare namespace ArrayValue {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>An array of floating-point numbers.</p>
      */
     interface DoubleValuesMember {
@@ -410,6 +450,7 @@ export declare namespace ArrayValue {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>An array of strings.</p>
      */
     interface StringValuesMember {
@@ -421,6 +462,7 @@ export declare namespace ArrayValue {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>An array of arrays.</p>
      */
     interface ArrayValuesMember {
@@ -431,6 +473,9 @@ export declare namespace ArrayValue {
         arrayValues: ArrayValue[];
         $unknown?: never;
     }
+    /**
+     * @public
+     */
     interface $UnknownMember {
         booleanValues?: never;
         longValues?: never;
@@ -459,6 +504,7 @@ export type Field = Field.ArrayValueMember | Field.BlobValueMember | Field.Boole
  */
 export declare namespace Field {
     /**
+     * @public
      * <p>A NULL value.</p>
      */
     interface IsNullMember {
@@ -472,6 +518,7 @@ export declare namespace Field {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>A value of Boolean data type.</p>
      */
     interface BooleanValueMember {
@@ -485,6 +532,7 @@ export declare namespace Field {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>A value of long data type.</p>
      */
     interface LongValueMember {
@@ -498,6 +546,7 @@ export declare namespace Field {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>A value of double data type.</p>
      */
     interface DoubleValueMember {
@@ -511,6 +560,7 @@ export declare namespace Field {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>A value of string data type.</p>
      */
     interface StringValueMember {
@@ -524,6 +574,7 @@ export declare namespace Field {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>A value of BLOB data type.</p>
      */
     interface BlobValueMember {
@@ -537,6 +588,7 @@ export declare namespace Field {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>An array of values.</p>
      */
     interface ArrayValueMember {
@@ -549,6 +601,9 @@ export declare namespace Field {
         arrayValue: ArrayValue;
         $unknown?: never;
     }
+    /**
+     * @public
+     */
     interface $UnknownMember {
         isNull?: never;
         booleanValue?: never;
@@ -577,14 +632,17 @@ export declare namespace Field {
  */
 export interface SqlParameter {
     /**
+     * @public
      * <p>The name of the parameter.</p>
      */
     name?: string;
     /**
+     * @public
      * <p>The value of the parameter.</p>
      */
     value?: Field;
     /**
+     * @public
      * <p>A hint that specifies the correct object type for data type mapping. Possible values
      *             are as follows:</p>
      *         <ul>
@@ -629,6 +687,7 @@ export interface SqlParameter {
  */
 export interface UpdateResult {
     /**
+     * @public
      * <p>Values for fields generated during the request.</p>
      */
     generatedFields?: Field[];
@@ -648,6 +707,7 @@ export type Value = Value.ArrayValuesMember | Value.BigIntValueMember | Value.Bi
  */
 export declare namespace Value {
     /**
+     * @public
      * <p>A NULL value.</p>
      */
     interface IsNullMember {
@@ -664,6 +724,7 @@ export declare namespace Value {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>A value for a column of BIT data type.</p>
      */
     interface BitValueMember {
@@ -680,6 +741,7 @@ export declare namespace Value {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>A value for a column of big integer data type.</p>
      */
     interface BigIntValueMember {
@@ -696,6 +758,7 @@ export declare namespace Value {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>A value for a column of integer data type.</p>
      */
     interface IntValueMember {
@@ -712,6 +775,7 @@ export declare namespace Value {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>A value for a column of double data type.</p>
      */
     interface DoubleValueMember {
@@ -728,6 +792,7 @@ export declare namespace Value {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>A value for a column of real data type.</p>
      */
     interface RealValueMember {
@@ -744,6 +809,7 @@ export declare namespace Value {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>A value for a column of string data type.</p>
      */
     interface StringValueMember {
@@ -760,6 +826,7 @@ export declare namespace Value {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>A value for a column of BLOB data type.</p>
      */
     interface BlobValueMember {
@@ -776,6 +843,7 @@ export declare namespace Value {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>An array of column values.</p>
      */
     interface ArrayValuesMember {
@@ -792,6 +860,7 @@ export declare namespace Value {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>A value for a column of STRUCT data type.</p>
      */
     interface StructValueMember {
@@ -807,6 +876,9 @@ export declare namespace Value {
         structValue: StructValue;
         $unknown?: never;
     }
+    /**
+     * @public
+     */
     interface $UnknownMember {
         isNull?: never;
         bitValue?: never;
@@ -842,24 +914,29 @@ export declare namespace Value {
  */
 export interface ExecuteStatementRequest {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.</p>
      */
     resourceArn: string | undefined;
     /**
+     * @public
      * <p>The ARN of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in
      *             the secret.</p>
      *         <p>For information about creating the secret, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html">Create a database secret</a>.</p>
      */
     secretArn: string | undefined;
     /**
+     * @public
      * <p>The SQL statement to run.</p>
      */
     sql: string | undefined;
     /**
+     * @public
      * <p>The name of the database.</p>
      */
     database?: string;
     /**
+     * @public
      * <p>The name of the database schema.</p>
      *         <note>
      *             <p>Currently, the <code>schema</code> parameter isn't supported.</p>
@@ -867,6 +944,7 @@ export interface ExecuteStatementRequest {
      */
     schema?: string;
     /**
+     * @public
      * <p>The parameters for the SQL statement.</p>
      *         <note>
      *             <p>Array parameters are not supported.</p>
@@ -874,6 +952,7 @@ export interface ExecuteStatementRequest {
      */
     parameters?: SqlParameter[];
     /**
+     * @public
      * <p>The identifier of a transaction that was started by using the
      *                 <code>BeginTransaction</code> operation. Specify the transaction ID of the
      *             transaction that you want to include the SQL statement in.</p>
@@ -881,10 +960,12 @@ export interface ExecuteStatementRequest {
      */
     transactionId?: string;
     /**
+     * @public
      * <p>A value that indicates whether to include metadata in the results.</p>
      */
     includeResultMetadata?: boolean;
     /**
+     * @public
      * <p>A value that indicates whether to continue running the statement after
      *             the call times out. By default, the statement stops running when the call
      *             times out.</p>
@@ -896,10 +977,12 @@ export interface ExecuteStatementRequest {
      */
     continueAfterTimeout?: boolean;
     /**
+     * @public
      * <p>Options that control how the result set is returned.</p>
      */
     resultSetOptions?: ResultSetOptions;
     /**
+     * @public
      * <p>A value that indicates whether to format the result set as a single JSON string.
      *         This parameter only applies to <code>SELECT</code> statements and is ignored for
      *         other types of statements. Allowed values are <code>NONE</code> and <code>JSON</code>.
@@ -920,6 +1003,7 @@ export interface ExecuteStatementRequest {
  */
 export interface StructValue {
     /**
+     * @public
      * <p>The attributes returned in the record.</p>
      */
     attributes?: Value[];
@@ -931,24 +1015,29 @@ export interface StructValue {
  */
 export interface BatchExecuteStatementRequest {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.</p>
      */
     resourceArn: string | undefined;
     /**
+     * @public
      * <p>The ARN of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in
      *             the secret.</p>
      *         <p>For information about creating the secret, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html">Create a database secret</a>.</p>
      */
     secretArn: string | undefined;
     /**
+     * @public
      * <p>The SQL statement to run. Don't include a semicolon (;) at the end of the SQL statement.</p>
      */
     sql: string | undefined;
     /**
+     * @public
      * <p>The name of the database.</p>
      */
     database?: string;
     /**
+     * @public
      * <p>The name of the database schema.</p>
      *         <note>
      *             <p>Currently, the <code>schema</code> parameter isn't supported.</p>
@@ -956,6 +1045,7 @@ export interface BatchExecuteStatementRequest {
      */
     schema?: string;
     /**
+     * @public
      * <p>The parameter set for the batch operation.</p>
      *         <p>The SQL statement is executed as many times as the number of parameter sets provided.
      *           To execute a SQL statement with no parameters, use one of the following options:</p>
@@ -973,6 +1063,7 @@ export interface BatchExecuteStatementRequest {
      */
     parameterSets?: SqlParameter[][];
     /**
+     * @public
      * <p>The identifier of a transaction that was started by using the
      *                 <code>BeginTransaction</code> operation. Specify the transaction ID of the
      *             transaction that you want to include the SQL statement in.</p>
@@ -988,6 +1079,7 @@ export interface BatchExecuteStatementRequest {
  */
 export interface BatchExecuteStatementResponse {
     /**
+     * @public
      * <p>The execution results of each batch entry.</p>
      */
     updateResults?: UpdateResult[];
@@ -1002,6 +1094,7 @@ export interface BatchExecuteStatementResponse {
  */
 export interface _Record {
     /**
+     * @public
      * <p>The values returned in the record.</p>
      */
     values?: Value[];
@@ -1013,20 +1106,24 @@ export interface _Record {
  */
 export interface ExecuteStatementResponse {
     /**
+     * @public
      * <p>The records returned by the SQL statement. This field is blank if the
      *         <code>formatRecordsAs</code> parameter is set to <code>JSON</code>.</p>
      */
     records?: Field[][];
     /**
+     * @public
      * <p>Metadata for the columns included in the results. This field is blank if the
      *         <code>formatRecordsAs</code> parameter is set to <code>JSON</code>.</p>
      */
     columnMetadata?: ColumnMetadata[];
     /**
+     * @public
      * <p>The number of records updated by the request.</p>
      */
     numberOfRecordsUpdated?: number;
     /**
+     * @public
      * <p>Values for fields generated during a DML request.</p>
      *
      *         <note>
@@ -1038,6 +1135,7 @@ export interface ExecuteStatementResponse {
      */
     generatedFields?: Field[];
     /**
+     * @public
      * <p>A string value that represents the result set of a <code>SELECT</code> statement
      *         in JSON format. This value is only present when the <code>formatRecordsAs</code>
      *         parameter is set to <code>JSON</code>.</p>
@@ -1056,10 +1154,12 @@ export interface ExecuteStatementResponse {
  */
 export interface ResultFrame {
     /**
+     * @public
      * <p>The result-set metadata in the result set.</p>
      */
     resultSetMetadata?: ResultSetMetadata;
     /**
+     * @public
      * <p>The records in the result set.</p>
      */
     records?: _Record[];
@@ -1075,10 +1175,12 @@ export interface ResultFrame {
  */
 export interface SqlStatementResult {
     /**
+     * @public
      * <p>The result set of the SQL statement.</p>
      */
     resultFrame?: ResultFrame;
     /**
+     * @public
      * <p>The number of records updated by a SQL statement.</p>
      */
     numberOfRecordsUpdated?: number;
@@ -1090,6 +1192,7 @@ export interface SqlStatementResult {
  */
 export interface ExecuteSqlResponse {
     /**
+     * @public
      * <p>The results of the SQL statement or statements.</p>
      */
     sqlStatementResults?: SqlStatementResult[];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-rds-data",
   "description": "AWS SDK for JavaScript Rds Data Client for Node.js, Browser and React Native",
-  "version": "3.379.1",
+  "version": "3.382.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.379.1",
-    "@aws-sdk/credential-provider-node": "3.379.1",
+    "@aws-sdk/client-sts": "3.382.0",
+    "@aws-sdk/credential-provider-node": "3.382.0",
     "@aws-sdk/middleware-host-header": "3.379.1",
     "@aws-sdk/middleware-logger": "3.378.0",
     "@aws-sdk/middleware-recursion-detection": "3.378.0",
     "@aws-sdk/middleware-signing": "3.379.1",
-    "@aws-sdk/middleware-user-agent": "3.379.1",
+    "@aws-sdk/middleware-user-agent": "3.382.0",
     "@aws-sdk/types": "3.378.0",
-    "@aws-sdk/util-endpoints": "3.378.0",
+    "@aws-sdk/util-endpoints": "3.382.0",
     "@aws-sdk/util-user-agent-browser": "3.378.0",
     "@aws-sdk/util-user-agent-node": "3.378.0",
     "@smithy/config-resolver": "^2.0.1",