@aws-sdk/client-rds-data 3.529.1 → 3.535.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.
@@ -1,8 +1,8 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { RDSDataServiceException as __BaseException } from "./RDSDataServiceException";
3
3
  /**
4
- * @public
5
4
  * <p>You don't have sufficient access to perform this action.</p>
5
+ * @public
6
6
  */
7
7
  export declare class AccessDeniedException extends __BaseException {
8
8
  readonly name: "AccessDeniedException";
@@ -13,8 +13,8 @@ export declare class AccessDeniedException extends __BaseException {
13
13
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
14
14
  }
15
15
  /**
16
- * @public
17
16
  * <p>There is an error in the call or in a SQL statement. (This error only appears in calls from Aurora Serverless v1 databases.)</p>
17
+ * @public
18
18
  */
19
19
  export declare class BadRequestException extends __BaseException {
20
20
  readonly name: "BadRequestException";
@@ -41,8 +41,8 @@ export declare const TypeHint: {
41
41
  */
42
42
  export type TypeHint = (typeof TypeHint)[keyof typeof TypeHint];
43
43
  /**
44
- * @public
45
44
  * <p>There was an error in processing the SQL statement.</p>
45
+ * @public
46
46
  */
47
47
  export declare class DatabaseErrorException extends __BaseException {
48
48
  readonly name: "DatabaseErrorException";
@@ -53,8 +53,8 @@ export declare class DatabaseErrorException extends __BaseException {
53
53
  constructor(opts: __ExceptionOptionType<DatabaseErrorException, __BaseException>);
54
54
  }
55
55
  /**
56
- * @public
57
56
  * <p>The DB cluster doesn't have a DB instance.</p>
57
+ * @public
58
58
  */
59
59
  export declare class DatabaseNotFoundException extends __BaseException {
60
60
  readonly name: "DatabaseNotFoundException";
@@ -65,8 +65,8 @@ export declare class DatabaseNotFoundException extends __BaseException {
65
65
  constructor(opts: __ExceptionOptionType<DatabaseNotFoundException, __BaseException>);
66
66
  }
67
67
  /**
68
- * @public
69
68
  * <p>The writer instance in the DB cluster isn't available.</p>
69
+ * @public
70
70
  */
71
71
  export declare class DatabaseUnavailableException extends __BaseException {
72
72
  readonly name: "DatabaseUnavailableException";
@@ -77,8 +77,8 @@ export declare class DatabaseUnavailableException extends __BaseException {
77
77
  constructor(opts: __ExceptionOptionType<DatabaseUnavailableException, __BaseException>);
78
78
  }
79
79
  /**
80
- * @public
81
80
  * <p>There are insufficient privileges to make the call.</p>
81
+ * @public
82
82
  */
83
83
  export declare class ForbiddenException extends __BaseException {
84
84
  readonly name: "ForbiddenException";
@@ -89,8 +89,8 @@ export declare class ForbiddenException extends __BaseException {
89
89
  constructor(opts: __ExceptionOptionType<ForbiddenException, __BaseException>);
90
90
  }
91
91
  /**
92
- * @public
93
92
  * <p>The HTTP endpoint for using RDS Data API isn't enabled for the DB cluster.</p>
93
+ * @public
94
94
  */
95
95
  export declare class HttpEndpointNotEnabledException extends __BaseException {
96
96
  readonly name: "HttpEndpointNotEnabledException";
@@ -101,8 +101,8 @@ export declare class HttpEndpointNotEnabledException extends __BaseException {
101
101
  constructor(opts: __ExceptionOptionType<HttpEndpointNotEnabledException, __BaseException>);
102
102
  }
103
103
  /**
104
- * @public
105
104
  * <p>An internal error occurred.</p>
105
+ * @public
106
106
  */
107
107
  export declare class InternalServerErrorException extends __BaseException {
108
108
  readonly name: "InternalServerErrorException";
@@ -113,8 +113,8 @@ export declare class InternalServerErrorException extends __BaseException {
113
113
  constructor(opts: __ExceptionOptionType<InternalServerErrorException, __BaseException>);
114
114
  }
115
115
  /**
116
- * @public
117
116
  * <p>The Secrets Manager secret used with the request isn't valid.</p>
117
+ * @public
118
118
  */
119
119
  export declare class InvalidSecretException extends __BaseException {
120
120
  readonly name: "InvalidSecretException";
@@ -125,7 +125,6 @@ export declare class InvalidSecretException extends __BaseException {
125
125
  constructor(opts: __ExceptionOptionType<InvalidSecretException, __BaseException>);
126
126
  }
127
127
  /**
128
- * @public
129
128
  * <p>There was a problem with the Secrets Manager secret used with the request, caused by one of the following conditions:</p>
130
129
  * <ul>
131
130
  * <li>
@@ -138,6 +137,7 @@ export declare class InvalidSecretException extends __BaseException {
138
137
  * <p>The secret couldn't be decrypted.</p>
139
138
  * </li>
140
139
  * </ul>
140
+ * @public
141
141
  */
142
142
  export declare class SecretsErrorException extends __BaseException {
143
143
  readonly name: "SecretsErrorException";
@@ -148,9 +148,9 @@ export declare class SecretsErrorException extends __BaseException {
148
148
  constructor(opts: __ExceptionOptionType<SecretsErrorException, __BaseException>);
149
149
  }
150
150
  /**
151
- * @public
152
151
  * <p>The service specified by the <code>resourceArn</code> parameter isn't
153
152
  * available.</p>
153
+ * @public
154
154
  */
155
155
  export declare class ServiceUnavailableError extends __BaseException {
156
156
  readonly name: "ServiceUnavailableError";
@@ -161,15 +161,15 @@ export declare class ServiceUnavailableError extends __BaseException {
161
161
  constructor(opts: __ExceptionOptionType<ServiceUnavailableError, __BaseException>);
162
162
  }
163
163
  /**
164
- * @public
165
164
  * <p>The execution of the SQL statement timed out.</p>
165
+ * @public
166
166
  */
167
167
  export declare class StatementTimeoutException extends __BaseException {
168
168
  readonly name: "StatementTimeoutException";
169
169
  readonly $fault: "client";
170
170
  /**
171
- * @public
172
171
  * <p>The database connection ID that executed the SQL statement.</p>
172
+ * @public
173
173
  */
174
174
  dbConnectionId?: number;
175
175
  /**
@@ -178,8 +178,8 @@ export declare class StatementTimeoutException extends __BaseException {
178
178
  constructor(opts: __ExceptionOptionType<StatementTimeoutException, __BaseException>);
179
179
  }
180
180
  /**
181
- * @public
182
181
  * <p>The transaction ID wasn't found.</p>
182
+ * @public
183
183
  */
184
184
  export declare class TransactionNotFoundException extends __BaseException {
185
185
  readonly name: "TransactionNotFoundException";
@@ -190,155 +190,155 @@ export declare class TransactionNotFoundException extends __BaseException {
190
190
  constructor(opts: __ExceptionOptionType<TransactionNotFoundException, __BaseException>);
191
191
  }
192
192
  /**
193
- * @public
194
193
  * <p>The request parameters represent the input of a request to start a SQL
195
194
  * transaction.</p>
195
+ * @public
196
196
  */
197
197
  export interface BeginTransactionRequest {
198
198
  /**
199
- * @public
200
199
  * <p>The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.</p>
200
+ * @public
201
201
  */
202
202
  resourceArn: string | undefined;
203
203
  /**
204
- * @public
205
204
  * <p>The name or ARN of the secret that enables access to the DB cluster.</p>
205
+ * @public
206
206
  */
207
207
  secretArn: string | undefined;
208
208
  /**
209
- * @public
210
209
  * <p>The name of the database.</p>
210
+ * @public
211
211
  */
212
212
  database?: string;
213
213
  /**
214
- * @public
215
214
  * <p>The name of the database schema.</p>
215
+ * @public
216
216
  */
217
217
  schema?: string;
218
218
  }
219
219
  /**
220
- * @public
221
220
  * <p>The response elements represent the output of a request to start a SQL
222
221
  * transaction.</p>
222
+ * @public
223
223
  */
224
224
  export interface BeginTransactionResponse {
225
225
  /**
226
- * @public
227
226
  * <p>The transaction ID of the transaction started by the call.</p>
227
+ * @public
228
228
  */
229
229
  transactionId?: string;
230
230
  }
231
231
  /**
232
- * @public
233
232
  * <p>Contains the metadata for a column.</p>
233
+ * @public
234
234
  */
235
235
  export interface ColumnMetadata {
236
236
  /**
237
- * @public
238
237
  * <p>The name of the column.</p>
238
+ * @public
239
239
  */
240
240
  name?: string;
241
241
  /**
242
- * @public
243
242
  * <p>The type of the column.</p>
243
+ * @public
244
244
  */
245
245
  type?: number;
246
246
  /**
247
- * @public
248
247
  * <p>The database-specific data type of the column.</p>
248
+ * @public
249
249
  */
250
250
  typeName?: string;
251
251
  /**
252
- * @public
253
252
  * <p>The label for the column.</p>
253
+ * @public
254
254
  */
255
255
  label?: string;
256
256
  /**
257
- * @public
258
257
  * <p>The name of the schema that owns the table that includes the column.</p>
258
+ * @public
259
259
  */
260
260
  schemaName?: string;
261
261
  /**
262
- * @public
263
262
  * <p>The name of the table that includes the column.</p>
263
+ * @public
264
264
  */
265
265
  tableName?: string;
266
266
  /**
267
- * @public
268
267
  * <p>A value that indicates whether the column increments automatically.</p>
268
+ * @public
269
269
  */
270
270
  isAutoIncrement?: boolean;
271
271
  /**
272
- * @public
273
272
  * <p>A value that indicates whether an integer column is signed.</p>
273
+ * @public
274
274
  */
275
275
  isSigned?: boolean;
276
276
  /**
277
- * @public
278
277
  * <p>A value that indicates whether the column contains currency values.</p>
278
+ * @public
279
279
  */
280
280
  isCurrency?: boolean;
281
281
  /**
282
- * @public
283
282
  * <p>A value that indicates whether the column is case-sensitive.</p>
283
+ * @public
284
284
  */
285
285
  isCaseSensitive?: boolean;
286
286
  /**
287
- * @public
288
287
  * <p>A value that indicates whether the column is nullable.</p>
288
+ * @public
289
289
  */
290
290
  nullable?: number;
291
291
  /**
292
- * @public
293
292
  * <p>The precision value of a decimal number column.</p>
293
+ * @public
294
294
  */
295
295
  precision?: number;
296
296
  /**
297
- * @public
298
297
  * <p>The scale value of a decimal number column.</p>
298
+ * @public
299
299
  */
300
300
  scale?: number;
301
301
  /**
302
- * @public
303
302
  * <p>The type of the column.</p>
303
+ * @public
304
304
  */
305
305
  arrayBaseColumnType?: number;
306
306
  }
307
307
  /**
308
- * @public
309
308
  * <p>The request parameters represent the input of a commit transaction request.</p>
309
+ * @public
310
310
  */
311
311
  export interface CommitTransactionRequest {
312
312
  /**
313
- * @public
314
313
  * <p>The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.</p>
314
+ * @public
315
315
  */
316
316
  resourceArn: string | undefined;
317
317
  /**
318
- * @public
319
318
  * <p>The name or ARN of the secret that enables access to the DB cluster.</p>
319
+ * @public
320
320
  */
321
321
  secretArn: string | undefined;
322
322
  /**
323
- * @public
324
323
  * <p>The identifier of the transaction to end and commit.</p>
324
+ * @public
325
325
  */
326
326
  transactionId: string | undefined;
327
327
  }
328
328
  /**
329
- * @public
330
329
  * <p>The response elements represent the output of a commit transaction request.</p>
330
+ * @public
331
331
  */
332
332
  export interface CommitTransactionResponse {
333
333
  /**
334
- * @public
335
334
  * <p>The status of the commit operation.</p>
335
+ * @public
336
336
  */
337
337
  transactionStatus?: string;
338
338
  }
339
339
  /**
340
- * @public
341
340
  * <p>The <code>resourceArn</code>, <code>secretArn</code>, or <code>transactionId</code> value can't be found.</p>
341
+ * @public
342
342
  */
343
343
  export declare class NotFoundException extends __BaseException {
344
344
  readonly name: "NotFoundException";
@@ -361,55 +361,55 @@ export declare const DecimalReturnType: {
361
361
  */
362
362
  export type DecimalReturnType = (typeof DecimalReturnType)[keyof typeof DecimalReturnType];
363
363
  /**
364
- * @public
365
364
  * <p>The request parameters represent the input of a request to run one or more SQL
366
365
  * statements.</p>
366
+ * @public
367
367
  */
368
368
  export interface ExecuteSqlRequest {
369
369
  /**
370
- * @public
371
370
  * <p>The ARN of the Aurora Serverless DB cluster.</p>
371
+ * @public
372
372
  */
373
373
  dbClusterOrInstanceArn: string | undefined;
374
374
  /**
375
- * @public
376
375
  * <p>The Amazon Resource Name (ARN) of the secret that enables access to the DB cluster. Enter the database user name and password
377
376
  * for the credentials in the secret.</p>
378
377
  * <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>
378
+ * @public
379
379
  */
380
380
  awsSecretStoreArn: string | undefined;
381
381
  /**
382
- * @public
383
382
  * <p>One or more SQL statements to run on the DB cluster.</p>
384
383
  * <p>You can separate SQL statements from each other with a semicolon (;). Any valid SQL
385
384
  * statement is permitted, including data definition, data manipulation, and commit
386
385
  * statements. </p>
386
+ * @public
387
387
  */
388
388
  sqlStatements: string | undefined;
389
389
  /**
390
- * @public
391
390
  * <p>The name of the database.</p>
391
+ * @public
392
392
  */
393
393
  database?: string;
394
394
  /**
395
- * @public
396
395
  * <p>The name of the database schema.</p>
396
+ * @public
397
397
  */
398
398
  schema?: string;
399
399
  }
400
400
  /**
401
- * @public
402
401
  * <p>The metadata of the result set returned by a SQL statement.</p>
402
+ * @public
403
403
  */
404
404
  export interface ResultSetMetadata {
405
405
  /**
406
- * @public
407
406
  * <p>The number of columns in the result set.</p>
407
+ * @public
408
408
  */
409
409
  columnCount?: number;
410
410
  /**
411
- * @public
412
411
  * <p>The metadata of the columns in the result set.</p>
412
+ * @public
413
413
  */
414
414
  columnMetadata?: ColumnMetadata[];
415
415
  }
@@ -438,12 +438,11 @@ export declare const LongReturnType: {
438
438
  */
439
439
  export type LongReturnType = (typeof LongReturnType)[keyof typeof LongReturnType];
440
440
  /**
441
- * @public
442
441
  * <p>Options that control how the result set is returned.</p>
442
+ * @public
443
443
  */
444
444
  export interface ResultSetOptions {
445
445
  /**
446
- * @public
447
446
  * <p>A value that indicates how a field of <code>DECIMAL</code> type is represented
448
447
  * in the response. The value of <code>STRING</code>, the default, specifies that
449
448
  * it is converted to a String value. The value of <code>DOUBLE_OR_LONG</code>
@@ -453,20 +452,20 @@ export interface ResultSetOptions {
453
452
  * <p>Conversion to Double or Long can result in roundoff errors due to precision loss.
454
453
  * We recommend converting to String, especially when working with currency values.</p>
455
454
  * </note>
455
+ * @public
456
456
  */
457
457
  decimalReturnType?: DecimalReturnType;
458
458
  /**
459
- * @public
460
459
  * <p>A value that indicates how a field of <code>LONG</code> type is represented.
461
460
  * Allowed values are <code>LONG</code> and <code>STRING</code>. The default
462
461
  * is <code>LONG</code>. Specify <code>STRING</code> if the length or
463
462
  * precision of numeric values might cause truncation or rounding errors.
464
463
  * </p>
464
+ * @public
465
465
  */
466
466
  longReturnType?: LongReturnType;
467
467
  }
468
468
  /**
469
- * @public
470
469
  * <p>There was a problem with the result because of one of the following conditions:</p>
471
470
  * <ul>
472
471
  * <li>
@@ -479,6 +478,7 @@ export interface ResultSetOptions {
479
478
  * <p>The size was too large.</p>
480
479
  * </li>
481
480
  * </ul>
481
+ * @public
482
482
  */
483
483
  export declare class UnsupportedResultException extends __BaseException {
484
484
  readonly name: "UnsupportedResultException";
@@ -489,42 +489,42 @@ export declare class UnsupportedResultException extends __BaseException {
489
489
  constructor(opts: __ExceptionOptionType<UnsupportedResultException, __BaseException>);
490
490
  }
491
491
  /**
492
- * @public
493
492
  * <p>The request parameters represent the input of a request to perform a rollback of a
494
493
  * transaction.</p>
494
+ * @public
495
495
  */
496
496
  export interface RollbackTransactionRequest {
497
497
  /**
498
- * @public
499
498
  * <p>The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.</p>
499
+ * @public
500
500
  */
501
501
  resourceArn: string | undefined;
502
502
  /**
503
- * @public
504
503
  * <p>The name or ARN of the secret that enables access to the DB cluster.</p>
504
+ * @public
505
505
  */
506
506
  secretArn: string | undefined;
507
507
  /**
508
- * @public
509
508
  * <p>The identifier of the transaction to roll back.</p>
509
+ * @public
510
510
  */
511
511
  transactionId: string | undefined;
512
512
  }
513
513
  /**
514
- * @public
515
514
  * <p>The response elements represent the output of a request to perform a rollback of a
516
515
  * transaction.</p>
516
+ * @public
517
517
  */
518
518
  export interface RollbackTransactionResponse {
519
519
  /**
520
- * @public
521
520
  * <p>The status of the rollback operation.</p>
521
+ * @public
522
522
  */
523
523
  transactionStatus?: string;
524
524
  }
525
525
  /**
526
- * @public
527
526
  * <p>Contains an array.</p>
527
+ * @public
528
528
  */
529
529
  export type ArrayValue = ArrayValue.ArrayValuesMember | ArrayValue.BooleanValuesMember | ArrayValue.DoubleValuesMember | ArrayValue.LongValuesMember | ArrayValue.StringValuesMember | ArrayValue.$UnknownMember;
530
530
  /**
@@ -532,8 +532,8 @@ export type ArrayValue = ArrayValue.ArrayValuesMember | ArrayValue.BooleanValues
532
532
  */
533
533
  export declare namespace ArrayValue {
534
534
  /**
535
- * @public
536
535
  * <p>An array of Boolean values.</p>
536
+ * @public
537
537
  */
538
538
  interface BooleanValuesMember {
539
539
  booleanValues: boolean[];
@@ -544,8 +544,8 @@ export declare namespace ArrayValue {
544
544
  $unknown?: never;
545
545
  }
546
546
  /**
547
- * @public
548
547
  * <p>An array of integers.</p>
548
+ * @public
549
549
  */
550
550
  interface LongValuesMember {
551
551
  booleanValues?: never;
@@ -556,8 +556,8 @@ export declare namespace ArrayValue {
556
556
  $unknown?: never;
557
557
  }
558
558
  /**
559
- * @public
560
559
  * <p>An array of floating-point numbers.</p>
560
+ * @public
561
561
  */
562
562
  interface DoubleValuesMember {
563
563
  booleanValues?: never;
@@ -568,8 +568,8 @@ export declare namespace ArrayValue {
568
568
  $unknown?: never;
569
569
  }
570
570
  /**
571
- * @public
572
571
  * <p>An array of strings.</p>
572
+ * @public
573
573
  */
574
574
  interface StringValuesMember {
575
575
  booleanValues?: never;
@@ -580,8 +580,8 @@ export declare namespace ArrayValue {
580
580
  $unknown?: never;
581
581
  }
582
582
  /**
583
- * @public
584
583
  * <p>An array of arrays.</p>
584
+ * @public
585
585
  */
586
586
  interface ArrayValuesMember {
587
587
  booleanValues?: never;
@@ -613,8 +613,8 @@ export declare namespace ArrayValue {
613
613
  const visit: <T>(value: ArrayValue, visitor: Visitor<T>) => T;
614
614
  }
615
615
  /**
616
- * @public
617
616
  * <p>Contains a value.</p>
617
+ * @public
618
618
  */
619
619
  export type Field = Field.ArrayValueMember | Field.BlobValueMember | Field.BooleanValueMember | Field.DoubleValueMember | Field.IsNullMember | Field.LongValueMember | Field.StringValueMember | Field.$UnknownMember;
620
620
  /**
@@ -622,8 +622,8 @@ export type Field = Field.ArrayValueMember | Field.BlobValueMember | Field.Boole
622
622
  */
623
623
  export declare namespace Field {
624
624
  /**
625
- * @public
626
625
  * <p>A NULL value.</p>
626
+ * @public
627
627
  */
628
628
  interface IsNullMember {
629
629
  isNull: boolean;
@@ -636,8 +636,8 @@ export declare namespace Field {
636
636
  $unknown?: never;
637
637
  }
638
638
  /**
639
- * @public
640
639
  * <p>A value of Boolean data type.</p>
640
+ * @public
641
641
  */
642
642
  interface BooleanValueMember {
643
643
  isNull?: never;
@@ -650,8 +650,8 @@ export declare namespace Field {
650
650
  $unknown?: never;
651
651
  }
652
652
  /**
653
- * @public
654
653
  * <p>A value of long data type.</p>
654
+ * @public
655
655
  */
656
656
  interface LongValueMember {
657
657
  isNull?: never;
@@ -664,8 +664,8 @@ export declare namespace Field {
664
664
  $unknown?: never;
665
665
  }
666
666
  /**
667
- * @public
668
667
  * <p>A value of double data type.</p>
668
+ * @public
669
669
  */
670
670
  interface DoubleValueMember {
671
671
  isNull?: never;
@@ -678,8 +678,8 @@ export declare namespace Field {
678
678
  $unknown?: never;
679
679
  }
680
680
  /**
681
- * @public
682
681
  * <p>A value of string data type.</p>
682
+ * @public
683
683
  */
684
684
  interface StringValueMember {
685
685
  isNull?: never;
@@ -692,8 +692,8 @@ export declare namespace Field {
692
692
  $unknown?: never;
693
693
  }
694
694
  /**
695
- * @public
696
695
  * <p>A value of BLOB data type.</p>
696
+ * @public
697
697
  */
698
698
  interface BlobValueMember {
699
699
  isNull?: never;
@@ -706,8 +706,8 @@ export declare namespace Field {
706
706
  $unknown?: never;
707
707
  }
708
708
  /**
709
- * @public
710
709
  * <p>An array of values.</p>
710
+ * @public
711
711
  */
712
712
  interface ArrayValueMember {
713
713
  isNull?: never;
@@ -745,22 +745,21 @@ export declare namespace Field {
745
745
  const visit: <T>(value: Field, visitor: Visitor<T>) => T;
746
746
  }
747
747
  /**
748
- * @public
749
748
  * <p>A parameter used in a SQL statement.</p>
749
+ * @public
750
750
  */
751
751
  export interface SqlParameter {
752
752
  /**
753
- * @public
754
753
  * <p>The name of the parameter.</p>
754
+ * @public
755
755
  */
756
756
  name?: string;
757
757
  /**
758
- * @public
759
758
  * <p>The value of the parameter.</p>
759
+ * @public
760
760
  */
761
761
  value?: Field;
762
762
  /**
763
- * @public
764
763
  * <p>A hint that specifies the correct object type for data type mapping. Possible values
765
764
  * are as follows:</p>
766
765
  * <ul>
@@ -796,27 +795,28 @@ export interface SqlParameter {
796
795
  * </p>
797
796
  * </li>
798
797
  * </ul>
798
+ * @public
799
799
  */
800
800
  typeHint?: TypeHint;
801
801
  }
802
802
  /**
803
- * @public
804
803
  * <p>The response elements represent the results of an update.</p>
804
+ * @public
805
805
  */
806
806
  export interface UpdateResult {
807
807
  /**
808
- * @public
809
808
  * <p>Values for fields generated during the request.</p>
809
+ * @public
810
810
  */
811
811
  generatedFields?: Field[];
812
812
  }
813
813
  /**
814
- * @public
815
814
  * <p>Contains the value of a column.</p>
816
815
  * <note>
817
816
  * <p>This data structure is only used with the deprecated <code>ExecuteSql</code> operation.
818
817
  * Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation instead.</p>
819
818
  * </note>
819
+ * @public
820
820
  */
821
821
  export type Value = Value.ArrayValuesMember | Value.BigIntValueMember | Value.BitValueMember | Value.BlobValueMember | Value.DoubleValueMember | Value.IntValueMember | Value.IsNullMember | Value.RealValueMember | Value.StringValueMember | Value.StructValueMember | Value.$UnknownMember;
822
822
  /**
@@ -824,8 +824,8 @@ export type Value = Value.ArrayValuesMember | Value.BigIntValueMember | Value.Bi
824
824
  */
825
825
  export declare namespace Value {
826
826
  /**
827
- * @public
828
827
  * <p>A NULL value.</p>
828
+ * @public
829
829
  */
830
830
  interface IsNullMember {
831
831
  isNull: boolean;
@@ -841,8 +841,8 @@ export declare namespace Value {
841
841
  $unknown?: never;
842
842
  }
843
843
  /**
844
- * @public
845
844
  * <p>A value for a column of BIT data type.</p>
845
+ * @public
846
846
  */
847
847
  interface BitValueMember {
848
848
  isNull?: never;
@@ -858,8 +858,8 @@ export declare namespace Value {
858
858
  $unknown?: never;
859
859
  }
860
860
  /**
861
- * @public
862
861
  * <p>A value for a column of big integer data type.</p>
862
+ * @public
863
863
  */
864
864
  interface BigIntValueMember {
865
865
  isNull?: never;
@@ -875,8 +875,8 @@ export declare namespace Value {
875
875
  $unknown?: never;
876
876
  }
877
877
  /**
878
- * @public
879
878
  * <p>A value for a column of integer data type.</p>
879
+ * @public
880
880
  */
881
881
  interface IntValueMember {
882
882
  isNull?: never;
@@ -892,8 +892,8 @@ export declare namespace Value {
892
892
  $unknown?: never;
893
893
  }
894
894
  /**
895
- * @public
896
895
  * <p>A value for a column of double data type.</p>
896
+ * @public
897
897
  */
898
898
  interface DoubleValueMember {
899
899
  isNull?: never;
@@ -909,8 +909,8 @@ export declare namespace Value {
909
909
  $unknown?: never;
910
910
  }
911
911
  /**
912
- * @public
913
912
  * <p>A value for a column of real data type.</p>
913
+ * @public
914
914
  */
915
915
  interface RealValueMember {
916
916
  isNull?: never;
@@ -926,8 +926,8 @@ export declare namespace Value {
926
926
  $unknown?: never;
927
927
  }
928
928
  /**
929
- * @public
930
929
  * <p>A value for a column of string data type.</p>
930
+ * @public
931
931
  */
932
932
  interface StringValueMember {
933
933
  isNull?: never;
@@ -943,8 +943,8 @@ export declare namespace Value {
943
943
  $unknown?: never;
944
944
  }
945
945
  /**
946
- * @public
947
946
  * <p>A value for a column of BLOB data type.</p>
947
+ * @public
948
948
  */
949
949
  interface BlobValueMember {
950
950
  isNull?: never;
@@ -960,8 +960,8 @@ export declare namespace Value {
960
960
  $unknown?: never;
961
961
  }
962
962
  /**
963
- * @public
964
963
  * <p>An array of column values.</p>
964
+ * @public
965
965
  */
966
966
  interface ArrayValuesMember {
967
967
  isNull?: never;
@@ -977,8 +977,8 @@ export declare namespace Value {
977
977
  $unknown?: never;
978
978
  }
979
979
  /**
980
- * @public
981
980
  * <p>A value for a column of STRUCT data type.</p>
981
+ * @public
982
982
  */
983
983
  interface StructValueMember {
984
984
  isNull?: never;
@@ -1025,64 +1025,63 @@ export declare namespace Value {
1025
1025
  const visit: <T>(value: Value, visitor: Visitor<T>) => T;
1026
1026
  }
1027
1027
  /**
1028
- * @public
1029
1028
  * <p>The request parameters represent the input of a request to run a SQL statement against
1030
1029
  * a database.</p>
1030
+ * @public
1031
1031
  */
1032
1032
  export interface ExecuteStatementRequest {
1033
1033
  /**
1034
- * @public
1035
1034
  * <p>The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.</p>
1035
+ * @public
1036
1036
  */
1037
1037
  resourceArn: string | undefined;
1038
1038
  /**
1039
- * @public
1040
1039
  * <p>The ARN of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in
1041
1040
  * the secret.</p>
1042
1041
  * <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>
1042
+ * @public
1043
1043
  */
1044
1044
  secretArn: string | undefined;
1045
1045
  /**
1046
- * @public
1047
1046
  * <p>The SQL statement to run.</p>
1047
+ * @public
1048
1048
  */
1049
1049
  sql: string | undefined;
1050
1050
  /**
1051
- * @public
1052
1051
  * <p>The name of the database.</p>
1052
+ * @public
1053
1053
  */
1054
1054
  database?: string;
1055
1055
  /**
1056
- * @public
1057
1056
  * <p>The name of the database schema.</p>
1058
1057
  * <note>
1059
1058
  * <p>Currently, the <code>schema</code> parameter isn't supported.</p>
1060
1059
  * </note>
1060
+ * @public
1061
1061
  */
1062
1062
  schema?: string;
1063
1063
  /**
1064
- * @public
1065
1064
  * <p>The parameters for the SQL statement.</p>
1066
1065
  * <note>
1067
1066
  * <p>Array parameters are not supported.</p>
1068
1067
  * </note>
1068
+ * @public
1069
1069
  */
1070
1070
  parameters?: SqlParameter[];
1071
1071
  /**
1072
- * @public
1073
1072
  * <p>The identifier of a transaction that was started by using the
1074
1073
  * <code>BeginTransaction</code> operation. Specify the transaction ID of the
1075
1074
  * transaction that you want to include the SQL statement in.</p>
1076
1075
  * <p>If the SQL statement is not part of a transaction, don't set this parameter.</p>
1076
+ * @public
1077
1077
  */
1078
1078
  transactionId?: string;
1079
1079
  /**
1080
- * @public
1081
1080
  * <p>A value that indicates whether to include metadata in the results.</p>
1081
+ * @public
1082
1082
  */
1083
1083
  includeResultMetadata?: boolean;
1084
1084
  /**
1085
- * @public
1086
1085
  * <p>A value that indicates whether to continue running the statement after
1087
1086
  * the call times out. By default, the statement stops running when the call
1088
1087
  * times out.</p>
@@ -1091,15 +1090,15 @@ export interface ExecuteStatementRequest {
1091
1090
  * the call times out. When a DDL statement terminates before it is finished
1092
1091
  * running, it can result in errors and possibly corrupted data structures.</p>
1093
1092
  * </note>
1093
+ * @public
1094
1094
  */
1095
1095
  continueAfterTimeout?: boolean;
1096
1096
  /**
1097
- * @public
1098
1097
  * <p>Options that control how the result set is returned.</p>
1098
+ * @public
1099
1099
  */
1100
1100
  resultSetOptions?: ResultSetOptions;
1101
1101
  /**
1102
- * @public
1103
1102
  * <p>A value that indicates whether to format the result set as a single JSON string.
1104
1103
  * This parameter only applies to <code>SELECT</code> statements and is ignored for
1105
1104
  * other types of statements. Allowed values are <code>NONE</code> and <code>JSON</code>.
@@ -1107,62 +1106,62 @@ export interface ExecuteStatementRequest {
1107
1106
  * <p>For usage information about the JSON format for result sets, see
1108
1107
  * <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html">Using the Data API</a>
1109
1108
  * in the <i>Amazon Aurora User Guide</i>.</p>
1109
+ * @public
1110
1110
  */
1111
1111
  formatRecordsAs?: RecordsFormatType;
1112
1112
  }
1113
1113
  /**
1114
- * @public
1115
1114
  * <p>A structure value returned by a call.</p>
1116
1115
  * <note>
1117
1116
  * <p>This data structure is only used with the deprecated <code>ExecuteSql</code> operation.
1118
1117
  * Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation instead.</p>
1119
1118
  * </note>
1119
+ * @public
1120
1120
  */
1121
1121
  export interface StructValue {
1122
1122
  /**
1123
- * @public
1124
1123
  * <p>The attributes returned in the record.</p>
1124
+ * @public
1125
1125
  */
1126
1126
  attributes?: Value[];
1127
1127
  }
1128
1128
  /**
1129
- * @public
1130
1129
  * <p>The request parameters represent the input of a SQL statement over an array of
1131
1130
  * data.</p>
1131
+ * @public
1132
1132
  */
1133
1133
  export interface BatchExecuteStatementRequest {
1134
1134
  /**
1135
- * @public
1136
1135
  * <p>The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.</p>
1136
+ * @public
1137
1137
  */
1138
1138
  resourceArn: string | undefined;
1139
1139
  /**
1140
- * @public
1141
1140
  * <p>The ARN of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in
1142
1141
  * the secret.</p>
1143
1142
  * <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>
1143
+ * @public
1144
1144
  */
1145
1145
  secretArn: string | undefined;
1146
1146
  /**
1147
- * @public
1148
1147
  * <p>The SQL statement to run. Don't include a semicolon (;) at the end of the SQL statement.</p>
1148
+ * @public
1149
1149
  */
1150
1150
  sql: string | undefined;
1151
1151
  /**
1152
- * @public
1153
1152
  * <p>The name of the database.</p>
1153
+ * @public
1154
1154
  */
1155
1155
  database?: string;
1156
1156
  /**
1157
- * @public
1158
1157
  * <p>The name of the database schema.</p>
1159
1158
  * <note>
1160
1159
  * <p>Currently, the <code>schema</code> parameter isn't supported.</p>
1161
1160
  * </note>
1161
+ * @public
1162
1162
  */
1163
1163
  schema?: string;
1164
1164
  /**
1165
- * @public
1166
1165
  * <p>The parameter set for the batch operation.</p>
1167
1166
  * <p>The SQL statement is executed as many times as the number of parameter sets provided.
1168
1167
  * To execute a SQL statement with no parameters, use one of the following options:</p>
@@ -1177,70 +1176,70 @@ export interface BatchExecuteStatementRequest {
1177
1176
  * <note>
1178
1177
  * <p>Array parameters are not supported.</p>
1179
1178
  * </note>
1179
+ * @public
1180
1180
  */
1181
1181
  parameterSets?: SqlParameter[][];
1182
1182
  /**
1183
- * @public
1184
1183
  * <p>The identifier of a transaction that was started by using the
1185
1184
  * <code>BeginTransaction</code> operation. Specify the transaction ID of the
1186
1185
  * transaction that you want to include the SQL statement in.</p>
1187
1186
  * <p>If the SQL statement is not part of a transaction, don't set this
1188
1187
  * parameter.</p>
1188
+ * @public
1189
1189
  */
1190
1190
  transactionId?: string;
1191
1191
  }
1192
1192
  /**
1193
- * @public
1194
1193
  * <p>The response elements represent the output of a SQL statement over an array of
1195
1194
  * data.</p>
1195
+ * @public
1196
1196
  */
1197
1197
  export interface BatchExecuteStatementResponse {
1198
1198
  /**
1199
- * @public
1200
1199
  * <p>The execution results of each batch entry.</p>
1200
+ * @public
1201
1201
  */
1202
1202
  updateResults?: UpdateResult[];
1203
1203
  }
1204
1204
  /**
1205
- * @public
1206
1205
  * <p>A record returned by a call.</p>
1207
1206
  * <note>
1208
1207
  * <p>This data structure is only used with the deprecated <code>ExecuteSql</code> operation.
1209
1208
  * Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation instead.</p>
1210
1209
  * </note>
1210
+ * @public
1211
1211
  */
1212
1212
  export interface _Record {
1213
1213
  /**
1214
- * @public
1215
1214
  * <p>The values returned in the record.</p>
1215
+ * @public
1216
1216
  */
1217
1217
  values?: Value[];
1218
1218
  }
1219
1219
  /**
1220
- * @public
1221
1220
  * <p>The response elements represent the output of a request to run a SQL statement against
1222
1221
  * a database.</p>
1222
+ * @public
1223
1223
  */
1224
1224
  export interface ExecuteStatementResponse {
1225
1225
  /**
1226
- * @public
1227
1226
  * <p>The records returned by the SQL statement. This field is blank if the
1228
1227
  * <code>formatRecordsAs</code> parameter is set to <code>JSON</code>.</p>
1228
+ * @public
1229
1229
  */
1230
1230
  records?: Field[][];
1231
1231
  /**
1232
- * @public
1233
1232
  * <p>Metadata for the columns included in the results. This field is blank if the
1234
1233
  * <code>formatRecordsAs</code> parameter is set to <code>JSON</code>.</p>
1234
+ * @public
1235
1235
  */
1236
1236
  columnMetadata?: ColumnMetadata[];
1237
1237
  /**
1238
- * @public
1239
1238
  * <p>The number of records updated by the request.</p>
1239
+ * @public
1240
1240
  */
1241
1241
  numberOfRecordsUpdated?: number;
1242
1242
  /**
1243
- * @public
1244
1243
  * <p>Values for fields generated during a DML request.</p>
1245
1244
  * <note>
1246
1245
  * <p>The <code>generatedFields</code> data isn't supported by Aurora PostgreSQL.
@@ -1248,67 +1247,68 @@ export interface ExecuteStatementResponse {
1248
1247
  * more information, see <a href="https://www.postgresql.org/docs/10/dml-returning.html">Returning Data From
1249
1248
  * Modified Rows</a> in the PostgreSQL documentation.</p>
1250
1249
  * </note>
1250
+ * @public
1251
1251
  */
1252
1252
  generatedFields?: Field[];
1253
1253
  /**
1254
- * @public
1255
1254
  * <p>A string value that represents the result set of a <code>SELECT</code> statement
1256
1255
  * in JSON format. This value is only present when the <code>formatRecordsAs</code>
1257
1256
  * parameter is set to <code>JSON</code>.</p>
1258
1257
  * <p>The size limit for this field is currently 10 MB. If the JSON-formatted string representing the
1259
1258
  * result set requires more than 10 MB, the call returns an error.</p>
1259
+ * @public
1260
1260
  */
1261
1261
  formattedRecords?: string;
1262
1262
  }
1263
1263
  /**
1264
- * @public
1265
1264
  * <p>The result set returned by a SQL statement.</p>
1266
1265
  * <note>
1267
1266
  * <p>This data structure is only used with the deprecated <code>ExecuteSql</code> operation.
1268
1267
  * Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation instead.</p>
1269
1268
  * </note>
1269
+ * @public
1270
1270
  */
1271
1271
  export interface ResultFrame {
1272
1272
  /**
1273
- * @public
1274
1273
  * <p>The result-set metadata in the result set.</p>
1274
+ * @public
1275
1275
  */
1276
1276
  resultSetMetadata?: ResultSetMetadata;
1277
1277
  /**
1278
- * @public
1279
1278
  * <p>The records in the result set.</p>
1279
+ * @public
1280
1280
  */
1281
1281
  records?: _Record[];
1282
1282
  }
1283
1283
  /**
1284
- * @public
1285
1284
  * <p>The result of a SQL statement.</p>
1286
1285
  * <note>
1287
1286
  * <p>This data structure is only used with the deprecated <code>ExecuteSql</code> operation.
1288
1287
  * Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation instead.</p>
1289
1288
  * </note>
1289
+ * @public
1290
1290
  */
1291
1291
  export interface SqlStatementResult {
1292
1292
  /**
1293
- * @public
1294
1293
  * <p>The result set of the SQL statement.</p>
1294
+ * @public
1295
1295
  */
1296
1296
  resultFrame?: ResultFrame;
1297
1297
  /**
1298
- * @public
1299
1298
  * <p>The number of records updated by a SQL statement.</p>
1299
+ * @public
1300
1300
  */
1301
1301
  numberOfRecordsUpdated?: number;
1302
1302
  }
1303
1303
  /**
1304
- * @public
1305
1304
  * <p>The response elements represent the output of a request to run one or more SQL
1306
1305
  * statements.</p>
1306
+ * @public
1307
1307
  */
1308
1308
  export interface ExecuteSqlResponse {
1309
1309
  /**
1310
- * @public
1311
1310
  * <p>The results of the SQL statement or statements.</p>
1311
+ * @public
1312
1312
  */
1313
1313
  sqlStatementResults?: SqlStatementResult[];
1314
1314
  }