@aws-sdk/client-redshift-data 3.533.0 → 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.
Files changed (25) hide show
  1. package/dist-types/RedshiftData.d.ts +2 -1
  2. package/dist-types/RedshiftDataClient.d.ts +1 -1
  3. package/dist-types/commands/BatchExecuteStatementCommand.d.ts +2 -1
  4. package/dist-types/commands/CancelStatementCommand.d.ts +2 -1
  5. package/dist-types/commands/DescribeStatementCommand.d.ts +2 -1
  6. package/dist-types/commands/DescribeTableCommand.d.ts +2 -1
  7. package/dist-types/commands/ExecuteStatementCommand.d.ts +2 -1
  8. package/dist-types/commands/GetStatementResultCommand.d.ts +2 -1
  9. package/dist-types/commands/ListDatabasesCommand.d.ts +2 -1
  10. package/dist-types/commands/ListSchemasCommand.d.ts +2 -1
  11. package/dist-types/commands/ListStatementsCommand.d.ts +2 -1
  12. package/dist-types/commands/ListTablesCommand.d.ts +2 -1
  13. package/dist-types/models/models_0.d.ts +178 -178
  14. package/dist-types/ts3.4/RedshiftData.d.ts +1 -0
  15. package/dist-types/ts3.4/commands/BatchExecuteStatementCommand.d.ts +9 -0
  16. package/dist-types/ts3.4/commands/CancelStatementCommand.d.ts +9 -0
  17. package/dist-types/ts3.4/commands/DescribeStatementCommand.d.ts +9 -0
  18. package/dist-types/ts3.4/commands/DescribeTableCommand.d.ts +9 -0
  19. package/dist-types/ts3.4/commands/ExecuteStatementCommand.d.ts +9 -0
  20. package/dist-types/ts3.4/commands/GetStatementResultCommand.d.ts +9 -0
  21. package/dist-types/ts3.4/commands/ListDatabasesCommand.d.ts +9 -0
  22. package/dist-types/ts3.4/commands/ListSchemasCommand.d.ts +9 -0
  23. package/dist-types/ts3.4/commands/ListStatementsCommand.d.ts +9 -0
  24. package/dist-types/ts3.4/commands/ListTablesCommand.d.ts +9 -0
  25. package/package.json +40 -40
@@ -1,8 +1,8 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { RedshiftDataServiceException as __BaseException } from "./RedshiftDataServiceException";
3
3
  /**
4
- * @public
5
4
  * <p>The number of active statements exceeds the limit.</p>
5
+ * @public
6
6
  */
7
7
  export declare class ActiveStatementsExceededException extends __BaseException {
8
8
  readonly name: "ActiveStatementsExceededException";
@@ -14,16 +14,16 @@ export declare class ActiveStatementsExceededException extends __BaseException {
14
14
  constructor(opts: __ExceptionOptionType<ActiveStatementsExceededException, __BaseException>);
15
15
  }
16
16
  /**
17
- * @public
18
17
  * <p>An SQL statement encountered an environmental error while running.</p>
18
+ * @public
19
19
  */
20
20
  export declare class BatchExecuteStatementException extends __BaseException {
21
21
  readonly name: "BatchExecuteStatementException";
22
22
  readonly $fault: "server";
23
23
  Message: string | undefined;
24
24
  /**
25
- * @public
26
25
  * <p>Statement identifier of the exception.</p>
26
+ * @public
27
27
  */
28
28
  StatementId: string | undefined;
29
29
  /**
@@ -36,52 +36,52 @@ export declare class BatchExecuteStatementException extends __BaseException {
36
36
  */
37
37
  export interface BatchExecuteStatementInput {
38
38
  /**
39
- * @public
40
39
  * <p>One or more SQL statements to run.
41
40
  *
42
41
  * The SQL statements are run as a single transaction. They run serially in the order of the array.
43
42
  * Subsequent SQL statements don't start until the previous statement in the array completes.
44
43
  * If any SQL statement fails, then because they are run as one transaction, all work is rolled back.</p>
44
+ * @public
45
45
  */
46
46
  Sqls: string[] | undefined;
47
47
  /**
48
- * @public
49
48
  * <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
49
+ * @public
50
50
  */
51
51
  ClusterIdentifier?: string;
52
52
  /**
53
- * @public
54
53
  * <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
54
+ * @public
55
55
  */
56
56
  SecretArn?: string;
57
57
  /**
58
- * @public
59
58
  * <p>The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials. </p>
59
+ * @public
60
60
  */
61
61
  DbUser?: string;
62
62
  /**
63
- * @public
64
63
  * <p>The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
64
+ * @public
65
65
  */
66
66
  Database: string | undefined;
67
67
  /**
68
- * @public
69
68
  * <p>A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statements run. </p>
69
+ * @public
70
70
  */
71
71
  WithEvent?: boolean;
72
72
  /**
73
- * @public
74
73
  * <p>The name of the SQL statements. You can name the SQL statements when you create them to identify the query. </p>
74
+ * @public
75
75
  */
76
76
  StatementName?: string;
77
77
  /**
78
- * @public
79
78
  * <p>The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.</p>
79
+ * @public
80
80
  */
81
81
  WorkgroupName?: string;
82
82
  /**
83
- * @public
84
83
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
84
+ * @public
85
85
  */
86
86
  ClientToken?: string;
87
87
  }
@@ -90,52 +90,52 @@ export interface BatchExecuteStatementInput {
90
90
  */
91
91
  export interface BatchExecuteStatementOutput {
92
92
  /**
93
- * @public
94
93
  * <p>The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
95
94
  * This identifier is returned by <code>BatchExecuteStatment</code>. </p>
95
+ * @public
96
96
  */
97
97
  Id?: string;
98
98
  /**
99
- * @public
100
99
  * <p>The date and time (UTC) the statement was created. </p>
100
+ * @public
101
101
  */
102
102
  CreatedAt?: Date;
103
103
  /**
104
- * @public
105
104
  * <p>The cluster identifier. This element is not returned when connecting to a serverless workgroup. </p>
105
+ * @public
106
106
  */
107
107
  ClusterIdentifier?: string;
108
108
  /**
109
- * @public
110
109
  * <p>The database user name.</p>
110
+ * @public
111
111
  */
112
112
  DbUser?: string;
113
113
  /**
114
- * @public
115
114
  * <p>The name of the database.</p>
115
+ * @public
116
116
  */
117
117
  Database?: string;
118
118
  /**
119
- * @public
120
119
  * <p>The name or ARN of the secret that enables access to the database. </p>
120
+ * @public
121
121
  */
122
122
  SecretArn?: string;
123
123
  /**
124
- * @public
125
124
  * <p>The serverless workgroup name or Amazon Resource Name (ARN). This element is not returned when connecting to a provisioned cluster.</p>
125
+ * @public
126
126
  */
127
127
  WorkgroupName?: string;
128
128
  }
129
129
  /**
130
- * @public
131
130
  * <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
131
+ * @public
132
132
  */
133
133
  export declare class ValidationException extends __BaseException {
134
134
  readonly name: "ValidationException";
135
135
  readonly $fault: "client";
136
136
  /**
137
- * @public
138
137
  * <p>The exception message.</p>
138
+ * @public
139
139
  */
140
140
  Message?: string;
141
141
  /**
@@ -148,9 +148,9 @@ export declare class ValidationException extends __BaseException {
148
148
  */
149
149
  export interface CancelStatementRequest {
150
150
  /**
151
- * @public
152
151
  * <p>The identifier of the SQL statement to cancel. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
153
152
  * This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatment</code>, and <code>ListStatements</code>. </p>
153
+ * @public
154
154
  */
155
155
  Id: string | undefined;
156
156
  }
@@ -159,14 +159,14 @@ export interface CancelStatementRequest {
159
159
  */
160
160
  export interface CancelStatementResponse {
161
161
  /**
162
- * @public
163
162
  * <p>A value that indicates whether the cancel statement succeeded (true). </p>
163
+ * @public
164
164
  */
165
165
  Status?: boolean;
166
166
  }
167
167
  /**
168
- * @public
169
168
  * <p>Connection to a database failed.</p>
169
+ * @public
170
170
  */
171
171
  export declare class DatabaseConnectionException extends __BaseException {
172
172
  readonly name: "DatabaseConnectionException";
@@ -178,15 +178,15 @@ export declare class DatabaseConnectionException extends __BaseException {
178
178
  constructor(opts: __ExceptionOptionType<DatabaseConnectionException, __BaseException>);
179
179
  }
180
180
  /**
181
- * @public
182
181
  * <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
182
+ * @public
183
183
  */
184
184
  export declare class InternalServerException extends __BaseException {
185
185
  readonly name: "InternalServerException";
186
186
  readonly $fault: "server";
187
187
  /**
188
- * @public
189
188
  * <p>The exception message.</p>
189
+ * @public
190
190
  */
191
191
  Message: string | undefined;
192
192
  /**
@@ -195,20 +195,20 @@ export declare class InternalServerException extends __BaseException {
195
195
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
196
196
  }
197
197
  /**
198
- * @public
199
198
  * <p>The Amazon Redshift Data API operation failed due to a missing resource. </p>
199
+ * @public
200
200
  */
201
201
  export declare class ResourceNotFoundException extends __BaseException {
202
202
  readonly name: "ResourceNotFoundException";
203
203
  readonly $fault: "client";
204
204
  /**
205
- * @public
206
205
  * <p>The exception message.</p>
206
+ * @public
207
207
  */
208
208
  Message: string | undefined;
209
209
  /**
210
- * @public
211
210
  * <p>Resource identifier associated with the exception.</p>
211
+ * @public
212
212
  */
213
213
  ResourceId: string | undefined;
214
214
  /**
@@ -217,73 +217,73 @@ export declare class ResourceNotFoundException extends __BaseException {
217
217
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
218
218
  }
219
219
  /**
220
- * @public
221
220
  * <p>The properties (metadata) of a column. </p>
221
+ * @public
222
222
  */
223
223
  export interface ColumnMetadata {
224
224
  /**
225
- * @public
226
225
  * <p>A value that indicates whether the column is case-sensitive. </p>
226
+ * @public
227
227
  */
228
228
  isCaseSensitive?: boolean;
229
229
  /**
230
- * @public
231
230
  * <p>A value that indicates whether the column contains currency values.</p>
231
+ * @public
232
232
  */
233
233
  isCurrency?: boolean;
234
234
  /**
235
- * @public
236
235
  * <p>A value that indicates whether an integer column is signed.</p>
236
+ * @public
237
237
  */
238
238
  isSigned?: boolean;
239
239
  /**
240
- * @public
241
240
  * <p>The label for the column. </p>
241
+ * @public
242
242
  */
243
243
  label?: string;
244
244
  /**
245
- * @public
246
245
  * <p>The name of the column. </p>
246
+ * @public
247
247
  */
248
248
  name?: string;
249
249
  /**
250
- * @public
251
250
  * <p>A value that indicates whether the column is nullable. </p>
251
+ * @public
252
252
  */
253
253
  nullable?: number;
254
254
  /**
255
- * @public
256
255
  * <p>The precision value of a decimal number column. </p>
256
+ * @public
257
257
  */
258
258
  precision?: number;
259
259
  /**
260
- * @public
261
260
  * <p>The scale value of a decimal number column. </p>
261
+ * @public
262
262
  */
263
263
  scale?: number;
264
264
  /**
265
- * @public
266
265
  * <p>The name of the schema that contains the table that includes the column.</p>
266
+ * @public
267
267
  */
268
268
  schemaName?: string;
269
269
  /**
270
- * @public
271
270
  * <p>The name of the table that includes the column. </p>
271
+ * @public
272
272
  */
273
273
  tableName?: string;
274
274
  /**
275
- * @public
276
275
  * <p>The database-specific data type of the column. </p>
276
+ * @public
277
277
  */
278
278
  typeName?: string;
279
279
  /**
280
- * @public
281
280
  * <p>The length of the column.</p>
281
+ * @public
282
282
  */
283
283
  length?: number;
284
284
  /**
285
- * @public
286
285
  * <p>The default value of the column. </p>
286
+ * @public
287
287
  */
288
288
  columnDefault?: string;
289
289
  }
@@ -292,30 +292,30 @@ export interface ColumnMetadata {
292
292
  */
293
293
  export interface DescribeStatementRequest {
294
294
  /**
295
- * @public
296
295
  * <p>The identifier of the SQL statement to describe. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
297
296
  * A suffix indicates the number of the SQL statement.
298
297
  * For example, <code>d9b6c0c9-0747-4bf4-b142-e8883122f766:2</code> has a suffix of <code>:2</code> that indicates the second SQL statement of a batch query.
299
298
  * This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatement</code>, and <code>ListStatements</code>. </p>
299
+ * @public
300
300
  */
301
301
  Id: string | undefined;
302
302
  }
303
303
  /**
304
- * @public
305
304
  * <p>A parameter used in a SQL statement.</p>
305
+ * @public
306
306
  */
307
307
  export interface SqlParameter {
308
308
  /**
309
- * @public
310
309
  * <p>The name of the parameter.</p>
310
+ * @public
311
311
  */
312
312
  name: string | undefined;
313
313
  /**
314
- * @public
315
314
  * <p>The value of the parameter.
316
315
  * Amazon Redshift implicitly converts to the proper data type. For more information, see
317
316
  * <a href="https://docs.aws.amazon.com/redshift/latest/dg/c_Supported_data_types.html">Data types</a> in the
318
317
  * <i>Amazon Redshift Database Developer Guide</i>. </p>
318
+ * @public
319
319
  */
320
320
  value: string | undefined;
321
321
  }
@@ -353,69 +353,69 @@ export declare const StatementStatusString: {
353
353
  */
354
354
  export type StatementStatusString = (typeof StatementStatusString)[keyof typeof StatementStatusString];
355
355
  /**
356
- * @public
357
356
  * <p>Information about an SQL statement.</p>
357
+ * @public
358
358
  */
359
359
  export interface SubStatementData {
360
360
  /**
361
- * @public
362
361
  * <p>The identifier of the SQL statement. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
363
362
  * A suffix indicates the number of the SQL statement.
364
363
  * For example, <code>d9b6c0c9-0747-4bf4-b142-e8883122f766:2</code> has a suffix of <code>:2</code> that indicates the second SQL statement of a batch query.</p>
364
+ * @public
365
365
  */
366
366
  Id: string | undefined;
367
367
  /**
368
- * @public
369
368
  * <p>The amount of time in nanoseconds that the statement ran.</p>
369
+ * @public
370
370
  */
371
371
  Duration?: number;
372
372
  /**
373
- * @public
374
373
  * <p>The error message from the cluster if the SQL statement encountered an error while running.</p>
374
+ * @public
375
375
  */
376
376
  Error?: string;
377
377
  /**
378
- * @public
379
378
  * <p>The status of the SQL statement. An
380
379
  * example is the that the SQL statement finished.
381
380
  * </p>
381
+ * @public
382
382
  */
383
383
  Status?: StatementStatusString;
384
384
  /**
385
- * @public
386
385
  * <p>The date and time (UTC) the statement was created. </p>
386
+ * @public
387
387
  */
388
388
  CreatedAt?: Date;
389
389
  /**
390
- * @public
391
390
  * <p>The date and time (UTC) that the statement metadata was last updated.</p>
391
+ * @public
392
392
  */
393
393
  UpdatedAt?: Date;
394
394
  /**
395
- * @public
396
395
  * <p>The SQL statement text.</p>
396
+ * @public
397
397
  */
398
398
  QueryString?: string;
399
399
  /**
400
- * @public
401
400
  * <p>Either the number of rows returned from the SQL statement or the number of rows affected.
402
401
  * If result size is greater than zero, the result rows can be the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and others.
403
402
  * A <code>-1</code> indicates the value is null.</p>
403
+ * @public
404
404
  */
405
405
  ResultRows?: number;
406
406
  /**
407
- * @public
408
407
  * <p>The size in bytes of the returned results. A <code>-1</code> indicates the value is null.</p>
408
+ * @public
409
409
  */
410
410
  ResultSize?: number;
411
411
  /**
412
- * @public
413
412
  * <p>The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. </p>
413
+ * @public
414
414
  */
415
415
  RedshiftQueryId?: number;
416
416
  /**
417
- * @public
418
417
  * <p>A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set.</p>
418
+ * @public
419
419
  */
420
420
  HasResultSet?: boolean;
421
421
  }
@@ -424,42 +424,41 @@ export interface SubStatementData {
424
424
  */
425
425
  export interface DescribeStatementResponse {
426
426
  /**
427
- * @public
428
427
  * <p>The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. </p>
428
+ * @public
429
429
  */
430
430
  Id: string | undefined;
431
431
  /**
432
- * @public
433
432
  * <p>The name or Amazon Resource Name (ARN) of the secret that enables access to the database. </p>
433
+ * @public
434
434
  */
435
435
  SecretArn?: string;
436
436
  /**
437
- * @public
438
437
  * <p>The database user name. </p>
438
+ * @public
439
439
  */
440
440
  DbUser?: string;
441
441
  /**
442
- * @public
443
442
  * <p>The name of the database. </p>
443
+ * @public
444
444
  */
445
445
  Database?: string;
446
446
  /**
447
- * @public
448
447
  * <p>The cluster identifier. </p>
448
+ * @public
449
449
  */
450
450
  ClusterIdentifier?: string;
451
451
  /**
452
- * @public
453
452
  * <p>The amount of time in nanoseconds that the statement ran. </p>
453
+ * @public
454
454
  */
455
455
  Duration?: number;
456
456
  /**
457
- * @public
458
457
  * <p>The error message from the cluster if the SQL statement encountered an error while running. </p>
458
+ * @public
459
459
  */
460
460
  Error?: string;
461
461
  /**
462
- * @public
463
462
  * <p>The status of the SQL statement being described. Status values are defined as follows: </p>
464
463
  * <ul>
465
464
  * <li>
@@ -484,66 +483,67 @@ export interface DescribeStatementResponse {
484
483
  * <p>SUBMITTED - The query was submitted, but not yet processed. </p>
485
484
  * </li>
486
485
  * </ul>
486
+ * @public
487
487
  */
488
488
  Status?: StatusString;
489
489
  /**
490
- * @public
491
490
  * <p>The date and time (UTC) when the SQL statement was submitted to run. </p>
491
+ * @public
492
492
  */
493
493
  CreatedAt?: Date;
494
494
  /**
495
- * @public
496
495
  * <p>The date and time (UTC) that the metadata for the SQL statement was last updated. An
497
496
  * example is the time the status last changed. </p>
497
+ * @public
498
498
  */
499
499
  UpdatedAt?: Date;
500
500
  /**
501
- * @public
502
501
  * <p>The process identifier from Amazon Redshift. </p>
502
+ * @public
503
503
  */
504
504
  RedshiftPid?: number;
505
505
  /**
506
- * @public
507
506
  * <p>A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set.
508
507
  * The value is true if any substatement returns a result set.</p>
508
+ * @public
509
509
  */
510
510
  HasResultSet?: boolean;
511
511
  /**
512
- * @public
513
512
  * <p>The SQL statement text. </p>
513
+ * @public
514
514
  */
515
515
  QueryString?: string;
516
516
  /**
517
- * @public
518
517
  * <p>Either the number of rows returned from the SQL statement or the number of rows affected.
519
518
  * If result size is greater than zero, the result rows can be the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and others.
520
519
  * A <code>-1</code> indicates the value is null.</p>
520
+ * @public
521
521
  */
522
522
  ResultRows?: number;
523
523
  /**
524
- * @public
525
524
  * <p>The size in bytes of the returned results. A <code>-1</code> indicates the value is null.</p>
525
+ * @public
526
526
  */
527
527
  ResultSize?: number;
528
528
  /**
529
- * @public
530
529
  * <p>The identifier of the query generated by Amazon Redshift.
531
530
  * These identifiers are also available in the <code>query</code> column of the <code>STL_QUERY</code> system view. </p>
531
+ * @public
532
532
  */
533
533
  RedshiftQueryId?: number;
534
534
  /**
535
- * @public
536
535
  * <p>The parameters for the SQL statement.</p>
536
+ * @public
537
537
  */
538
538
  QueryParameters?: SqlParameter[];
539
539
  /**
540
- * @public
541
540
  * <p>The SQL statements from a multiple statement run.</p>
541
+ * @public
542
542
  */
543
543
  SubStatements?: SubStatementData[];
544
544
  /**
545
- * @public
546
545
  * <p>The serverless workgroup name or Amazon Resource Name (ARN).</p>
546
+ * @public
547
547
  */
548
548
  WorkgroupName?: string;
549
549
  }
@@ -552,56 +552,56 @@ export interface DescribeStatementResponse {
552
552
  */
553
553
  export interface DescribeTableRequest {
554
554
  /**
555
- * @public
556
555
  * <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
556
+ * @public
557
557
  */
558
558
  ClusterIdentifier?: string;
559
559
  /**
560
- * @public
561
560
  * <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
561
+ * @public
562
562
  */
563
563
  SecretArn?: string;
564
564
  /**
565
- * @public
566
565
  * <p>The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials. </p>
566
+ * @public
567
567
  */
568
568
  DbUser?: string;
569
569
  /**
570
- * @public
571
570
  * <p>The name of the database that contains the tables to be described.
572
571
  * If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
572
+ * @public
573
573
  */
574
574
  Database: string | undefined;
575
575
  /**
576
- * @public
577
576
  * <p>A database name. The connected database is specified when you connect with your authentication credentials. </p>
577
+ * @public
578
578
  */
579
579
  ConnectedDatabase?: string;
580
580
  /**
581
- * @public
582
581
  * <p>The schema that contains the table. If no schema is specified, then matching tables for all schemas are returned. </p>
582
+ * @public
583
583
  */
584
584
  Schema?: string;
585
585
  /**
586
- * @public
587
586
  * <p>The table name. If no table is specified, then all tables for all matching schemas are returned.
588
587
  * If no table and no schema is specified, then all tables for all schemas in the database are returned</p>
588
+ * @public
589
589
  */
590
590
  Table?: string;
591
591
  /**
592
- * @public
593
592
  * <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
593
+ * @public
594
594
  */
595
595
  NextToken?: string;
596
596
  /**
597
- * @public
598
597
  * <p>The maximum number of tables to return in the response.
599
598
  * If more tables exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
599
+ * @public
600
600
  */
601
601
  MaxResults?: number;
602
602
  /**
603
- * @public
604
603
  * <p>The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.</p>
604
+ * @public
605
605
  */
606
606
  WorkgroupName?: string;
607
607
  }
@@ -610,36 +610,36 @@ export interface DescribeTableRequest {
610
610
  */
611
611
  export interface DescribeTableResponse {
612
612
  /**
613
- * @public
614
613
  * <p>The table name. </p>
614
+ * @public
615
615
  */
616
616
  TableName?: string;
617
617
  /**
618
- * @public
619
618
  * <p>A list of columns in the table. </p>
619
+ * @public
620
620
  */
621
621
  ColumnList?: ColumnMetadata[];
622
622
  /**
623
- * @public
624
623
  * <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
624
+ * @public
625
625
  */
626
626
  NextToken?: string;
627
627
  }
628
628
  /**
629
- * @public
630
629
  * <p>The SQL statement encountered an environmental error while running.</p>
630
+ * @public
631
631
  */
632
632
  export declare class ExecuteStatementException extends __BaseException {
633
633
  readonly name: "ExecuteStatementException";
634
634
  readonly $fault: "server";
635
635
  /**
636
- * @public
637
636
  * <p>The exception message.</p>
637
+ * @public
638
638
  */
639
639
  Message: string | undefined;
640
640
  /**
641
- * @public
642
641
  * <p>Statement identifier of the exception.</p>
642
+ * @public
643
643
  */
644
644
  StatementId: string | undefined;
645
645
  /**
@@ -652,53 +652,53 @@ export declare class ExecuteStatementException extends __BaseException {
652
652
  */
653
653
  export interface ExecuteStatementInput {
654
654
  /**
655
- * @public
656
655
  * <p>The SQL statement text to run. </p>
656
+ * @public
657
657
  */
658
658
  Sql: string | undefined;
659
659
  /**
660
- * @public
661
660
  * <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
661
+ * @public
662
662
  */
663
663
  ClusterIdentifier?: string;
664
664
  /**
665
- * @public
666
665
  * <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
666
+ * @public
667
667
  */
668
668
  SecretArn?: string;
669
669
  /**
670
- * @public
671
670
  * <p>The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials. </p>
671
+ * @public
672
672
  */
673
673
  DbUser?: string;
674
674
  /**
675
- * @public
676
675
  * <p>The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
676
+ * @public
677
677
  */
678
678
  Database: string | undefined;
679
679
  /**
680
- * @public
681
680
  * <p>A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs. </p>
681
+ * @public
682
682
  */
683
683
  WithEvent?: boolean;
684
684
  /**
685
- * @public
686
685
  * <p>The name of the SQL statement. You can name the SQL statement when you create it to identify the query. </p>
686
+ * @public
687
687
  */
688
688
  StatementName?: string;
689
689
  /**
690
- * @public
691
690
  * <p>The parameters for the SQL statement.</p>
691
+ * @public
692
692
  */
693
693
  Parameters?: SqlParameter[];
694
694
  /**
695
- * @public
696
695
  * <p>The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.</p>
696
+ * @public
697
697
  */
698
698
  WorkgroupName?: string;
699
699
  /**
700
- * @public
701
700
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
701
+ * @public
702
702
  */
703
703
  ClientToken?: string;
704
704
  }
@@ -707,44 +707,44 @@ export interface ExecuteStatementInput {
707
707
  */
708
708
  export interface ExecuteStatementOutput {
709
709
  /**
710
- * @public
711
710
  * <p>The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. </p>
711
+ * @public
712
712
  */
713
713
  Id?: string;
714
714
  /**
715
- * @public
716
715
  * <p>The date and time (UTC) the statement was created. </p>
716
+ * @public
717
717
  */
718
718
  CreatedAt?: Date;
719
719
  /**
720
- * @public
721
720
  * <p>The cluster identifier. This element is not returned when connecting to a serverless workgroup. </p>
721
+ * @public
722
722
  */
723
723
  ClusterIdentifier?: string;
724
724
  /**
725
- * @public
726
725
  * <p>The database user name.</p>
726
+ * @public
727
727
  */
728
728
  DbUser?: string;
729
729
  /**
730
- * @public
731
730
  * <p>The name of the database.</p>
731
+ * @public
732
732
  */
733
733
  Database?: string;
734
734
  /**
735
- * @public
736
735
  * <p>The name or ARN of the secret that enables access to the database. </p>
736
+ * @public
737
737
  */
738
738
  SecretArn?: string;
739
739
  /**
740
- * @public
741
740
  * <p>The serverless workgroup name or Amazon Resource Name (ARN). This element is not returned when connecting to a provisioned cluster.</p>
741
+ * @public
742
742
  */
743
743
  WorkgroupName?: string;
744
744
  }
745
745
  /**
746
- * @public
747
746
  * <p>A data value in a column. </p>
747
+ * @public
748
748
  */
749
749
  export type Field = Field.BlobValueMember | Field.BooleanValueMember | Field.DoubleValueMember | Field.IsNullMember | Field.LongValueMember | Field.StringValueMember | Field.$UnknownMember;
750
750
  /**
@@ -752,8 +752,8 @@ export type Field = Field.BlobValueMember | Field.BooleanValueMember | Field.Dou
752
752
  */
753
753
  export declare namespace Field {
754
754
  /**
755
- * @public
756
755
  * <p>A value that indicates whether the data is NULL. </p>
756
+ * @public
757
757
  */
758
758
  interface IsNullMember {
759
759
  isNull: boolean;
@@ -765,8 +765,8 @@ export declare namespace Field {
765
765
  $unknown?: never;
766
766
  }
767
767
  /**
768
- * @public
769
768
  * <p>A value of the Boolean data type. </p>
769
+ * @public
770
770
  */
771
771
  interface BooleanValueMember {
772
772
  isNull?: never;
@@ -778,8 +778,8 @@ export declare namespace Field {
778
778
  $unknown?: never;
779
779
  }
780
780
  /**
781
- * @public
782
781
  * <p>A value of the long data type. </p>
782
+ * @public
783
783
  */
784
784
  interface LongValueMember {
785
785
  isNull?: never;
@@ -791,8 +791,8 @@ export declare namespace Field {
791
791
  $unknown?: never;
792
792
  }
793
793
  /**
794
- * @public
795
794
  * <p>A value of the double data type. </p>
795
+ * @public
796
796
  */
797
797
  interface DoubleValueMember {
798
798
  isNull?: never;
@@ -804,8 +804,8 @@ export declare namespace Field {
804
804
  $unknown?: never;
805
805
  }
806
806
  /**
807
- * @public
808
807
  * <p>A value of the string data type. </p>
808
+ * @public
809
809
  */
810
810
  interface StringValueMember {
811
811
  isNull?: never;
@@ -817,8 +817,8 @@ export declare namespace Field {
817
817
  $unknown?: never;
818
818
  }
819
819
  /**
820
- * @public
821
820
  * <p>A value of the BLOB data type. </p>
821
+ * @public
822
822
  */
823
823
  interface BlobValueMember {
824
824
  isNull?: never;
@@ -857,16 +857,16 @@ export declare namespace Field {
857
857
  */
858
858
  export interface GetStatementResultRequest {
859
859
  /**
860
- * @public
861
860
  * <p>The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
862
861
  * A suffix indicates then number of the SQL statement.
863
862
  * For example, <code>d9b6c0c9-0747-4bf4-b142-e8883122f766:2</code> has a suffix of <code>:2</code> that indicates the second SQL statement of a batch query.
864
863
  * This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatment</code>, and <code>ListStatements</code>. </p>
864
+ * @public
865
865
  */
866
866
  Id: string | undefined;
867
867
  /**
868
- * @public
869
868
  * <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
869
+ * @public
870
870
  */
871
871
  NextToken?: string;
872
872
  }
@@ -875,24 +875,24 @@ export interface GetStatementResultRequest {
875
875
  */
876
876
  export interface GetStatementResultResponse {
877
877
  /**
878
- * @public
879
878
  * <p>The results of the SQL statement.</p>
879
+ * @public
880
880
  */
881
881
  Records: Field[][] | undefined;
882
882
  /**
883
- * @public
884
883
  * <p>The properties (metadata) of a column. </p>
884
+ * @public
885
885
  */
886
886
  ColumnMetadata?: ColumnMetadata[];
887
887
  /**
888
- * @public
889
888
  * <p>The total number of rows in the result set returned from a query.
890
889
  * You can use this number to estimate the number of calls to the <code>GetStatementResult</code> operation needed to page through the results. </p>
890
+ * @public
891
891
  */
892
892
  TotalNumRows?: number;
893
893
  /**
894
- * @public
895
894
  * <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
895
+ * @public
896
896
  */
897
897
  NextToken?: string;
898
898
  }
@@ -901,39 +901,39 @@ export interface GetStatementResultResponse {
901
901
  */
902
902
  export interface ListDatabasesRequest {
903
903
  /**
904
- * @public
905
904
  * <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
905
+ * @public
906
906
  */
907
907
  ClusterIdentifier?: string;
908
908
  /**
909
- * @public
910
909
  * <p>The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
910
+ * @public
911
911
  */
912
912
  Database: string | undefined;
913
913
  /**
914
- * @public
915
914
  * <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
915
+ * @public
916
916
  */
917
917
  SecretArn?: string;
918
918
  /**
919
- * @public
920
919
  * <p>The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials. </p>
920
+ * @public
921
921
  */
922
922
  DbUser?: string;
923
923
  /**
924
- * @public
925
924
  * <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
925
+ * @public
926
926
  */
927
927
  NextToken?: string;
928
928
  /**
929
- * @public
930
929
  * <p>The maximum number of databases to return in the response.
931
930
  * If more databases exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
931
+ * @public
932
932
  */
933
933
  MaxResults?: number;
934
934
  /**
935
- * @public
936
935
  * <p>The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.</p>
936
+ * @public
937
937
  */
938
938
  WorkgroupName?: string;
939
939
  }
@@ -942,13 +942,13 @@ export interface ListDatabasesRequest {
942
942
  */
943
943
  export interface ListDatabasesResponse {
944
944
  /**
945
- * @public
946
945
  * <p>The names of databases. </p>
946
+ * @public
947
947
  */
948
948
  Databases?: string[];
949
949
  /**
950
- * @public
951
950
  * <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
951
+ * @public
952
952
  */
953
953
  NextToken?: string;
954
954
  }
@@ -957,52 +957,52 @@ export interface ListDatabasesResponse {
957
957
  */
958
958
  export interface ListSchemasRequest {
959
959
  /**
960
- * @public
961
960
  * <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
961
+ * @public
962
962
  */
963
963
  ClusterIdentifier?: string;
964
964
  /**
965
- * @public
966
965
  * <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
966
+ * @public
967
967
  */
968
968
  SecretArn?: string;
969
969
  /**
970
- * @public
971
970
  * <p>The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials. </p>
971
+ * @public
972
972
  */
973
973
  DbUser?: string;
974
974
  /**
975
- * @public
976
975
  * <p>The name of the database that contains the schemas to list.
977
976
  * If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
977
+ * @public
978
978
  */
979
979
  Database: string | undefined;
980
980
  /**
981
- * @public
982
981
  * <p>A database name. The connected database is specified when you connect with your authentication credentials. </p>
982
+ * @public
983
983
  */
984
984
  ConnectedDatabase?: string;
985
985
  /**
986
- * @public
987
986
  * <p>A pattern to filter results by schema name. Within a schema pattern, "%" means match any
988
987
  * substring of 0 or more characters and "_" means match any one character. Only schema name
989
988
  * entries matching the search pattern are returned. </p>
989
+ * @public
990
990
  */
991
991
  SchemaPattern?: string;
992
992
  /**
993
- * @public
994
993
  * <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
994
+ * @public
995
995
  */
996
996
  NextToken?: string;
997
997
  /**
998
- * @public
999
998
  * <p>The maximum number of schemas to return in the response.
1000
999
  * If more schemas exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
1000
+ * @public
1001
1001
  */
1002
1002
  MaxResults?: number;
1003
1003
  /**
1004
- * @public
1005
1004
  * <p>The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.</p>
1005
+ * @public
1006
1006
  */
1007
1007
  WorkgroupName?: string;
1008
1008
  }
@@ -1011,13 +1011,13 @@ export interface ListSchemasRequest {
1011
1011
  */
1012
1012
  export interface ListSchemasResponse {
1013
1013
  /**
1014
- * @public
1015
1014
  * <p>The schemas that match the request pattern. </p>
1015
+ * @public
1016
1016
  */
1017
1017
  Schemas?: string[];
1018
1018
  /**
1019
- * @public
1020
1019
  * <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
1020
+ * @public
1021
1021
  */
1022
1022
  NextToken?: string;
1023
1023
  }
@@ -1026,26 +1026,25 @@ export interface ListSchemasResponse {
1026
1026
  */
1027
1027
  export interface ListStatementsRequest {
1028
1028
  /**
1029
- * @public
1030
1029
  * <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
1030
+ * @public
1031
1031
  */
1032
1032
  NextToken?: string;
1033
1033
  /**
1034
- * @public
1035
1034
  * <p>The maximum number of SQL statements to return in the response.
1036
1035
  * If more SQL statements exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
1036
+ * @public
1037
1037
  */
1038
1038
  MaxResults?: number;
1039
1039
  /**
1040
- * @public
1041
1040
  * <p>The name of the SQL statement specified as input to <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> to identify the query.
1042
1041
  * You can list multiple statements by providing a prefix that matches the beginning of the statement name.
1043
1042
  * For example, to list myStatement1, myStatement2, myStatement3, and so on, then provide the a value of <code>myStatement</code>.
1044
1043
  * Data API does a case-sensitive match of SQL statement names to the prefix value you provide. </p>
1044
+ * @public
1045
1045
  */
1046
1046
  StatementName?: string;
1047
1047
  /**
1048
- * @public
1049
1048
  * <p>The status of the SQL statement to list. Status values are defined as follows: </p>
1050
1049
  * <ul>
1051
1050
  * <li>
@@ -1070,70 +1069,71 @@ export interface ListStatementsRequest {
1070
1069
  * <p>SUBMITTED - The query was submitted, but not yet processed. </p>
1071
1070
  * </li>
1072
1071
  * </ul>
1072
+ * @public
1073
1073
  */
1074
1074
  Status?: StatusString;
1075
1075
  /**
1076
- * @public
1077
1076
  * <p>A value that filters which statements to return in the response. If true, all statements run by the caller's IAM role are returned.
1078
1077
  * If false, only statements run by the caller's IAM role in the current IAM session are returned. The default is true. </p>
1078
+ * @public
1079
1079
  */
1080
1080
  RoleLevel?: boolean;
1081
1081
  }
1082
1082
  /**
1083
- * @public
1084
1083
  * <p>The SQL statement to run.</p>
1084
+ * @public
1085
1085
  */
1086
1086
  export interface StatementData {
1087
1087
  /**
1088
- * @public
1089
1088
  * <p>The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. </p>
1089
+ * @public
1090
1090
  */
1091
1091
  Id: string | undefined;
1092
1092
  /**
1093
- * @public
1094
1093
  * <p>The SQL statement.</p>
1094
+ * @public
1095
1095
  */
1096
1096
  QueryString?: string;
1097
1097
  /**
1098
- * @public
1099
1098
  * <p>One or more SQL statements. Each query string in the array corresponds to one of the queries in a batch query request.</p>
1099
+ * @public
1100
1100
  */
1101
1101
  QueryStrings?: string[];
1102
1102
  /**
1103
- * @public
1104
1103
  * <p>The name or Amazon Resource Name (ARN) of the secret that enables access to the database. </p>
1104
+ * @public
1105
1105
  */
1106
1106
  SecretArn?: string;
1107
1107
  /**
1108
- * @public
1109
1108
  * <p>The status of the SQL statement. An
1110
1109
  * example is the that the SQL statement finished.
1111
1110
  * </p>
1111
+ * @public
1112
1112
  */
1113
1113
  Status?: StatusString;
1114
1114
  /**
1115
- * @public
1116
1115
  * <p>The name of the SQL statement. </p>
1116
+ * @public
1117
1117
  */
1118
1118
  StatementName?: string;
1119
1119
  /**
1120
- * @public
1121
1120
  * <p>The date and time (UTC) the statement was created. </p>
1121
+ * @public
1122
1122
  */
1123
1123
  CreatedAt?: Date;
1124
1124
  /**
1125
- * @public
1126
1125
  * <p>The date and time (UTC) that the statement metadata was last updated.</p>
1126
+ * @public
1127
1127
  */
1128
1128
  UpdatedAt?: Date;
1129
1129
  /**
1130
- * @public
1131
1130
  * <p>The parameters used in a SQL statement.</p>
1131
+ * @public
1132
1132
  */
1133
1133
  QueryParameters?: SqlParameter[];
1134
1134
  /**
1135
- * @public
1136
1135
  * <p>A value that indicates whether the statement is a batch query request.</p>
1136
+ * @public
1137
1137
  */
1138
1138
  IsBatchStatement?: boolean;
1139
1139
  }
@@ -1142,13 +1142,13 @@ export interface StatementData {
1142
1142
  */
1143
1143
  export interface ListStatementsResponse {
1144
1144
  /**
1145
- * @public
1146
1145
  * <p>The SQL statements. </p>
1146
+ * @public
1147
1147
  */
1148
1148
  Statements: StatementData[] | undefined;
1149
1149
  /**
1150
- * @public
1151
1150
  * <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
1151
+ * @public
1152
1152
  */
1153
1153
  NextToken?: string;
1154
1154
  }
@@ -1157,85 +1157,85 @@ export interface ListStatementsResponse {
1157
1157
  */
1158
1158
  export interface ListTablesRequest {
1159
1159
  /**
1160
- * @public
1161
1160
  * <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
1161
+ * @public
1162
1162
  */
1163
1163
  ClusterIdentifier?: string;
1164
1164
  /**
1165
- * @public
1166
1165
  * <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
1166
+ * @public
1167
1167
  */
1168
1168
  SecretArn?: string;
1169
1169
  /**
1170
- * @public
1171
1170
  * <p>The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials. </p>
1171
+ * @public
1172
1172
  */
1173
1173
  DbUser?: string;
1174
1174
  /**
1175
- * @public
1176
1175
  * <p>The name of the database that contains the tables to list.
1177
1176
  * If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
1177
+ * @public
1178
1178
  */
1179
1179
  Database: string | undefined;
1180
1180
  /**
1181
- * @public
1182
1181
  * <p>A database name. The connected database is specified when you connect with your authentication credentials. </p>
1182
+ * @public
1183
1183
  */
1184
1184
  ConnectedDatabase?: string;
1185
1185
  /**
1186
- * @public
1187
1186
  * <p>A pattern to filter results by schema name. Within a schema pattern, "%" means match any
1188
1187
  * substring of 0 or more characters and "_" means match any one character. Only schema name
1189
1188
  * entries matching the search pattern are returned. If <code>SchemaPattern</code> is not specified, then all tables that match
1190
1189
  * <code>TablePattern</code> are returned.
1191
1190
  * If neither <code>SchemaPattern</code> or <code>TablePattern</code> are specified, then all tables are returned. </p>
1191
+ * @public
1192
1192
  */
1193
1193
  SchemaPattern?: string;
1194
1194
  /**
1195
- * @public
1196
1195
  * <p>A pattern to filter results by table name. Within a table pattern, "%" means match any
1197
1196
  * substring of 0 or more characters and "_" means match any one character. Only table name
1198
1197
  * entries matching the search pattern are returned. If <code>TablePattern</code> is not specified, then all tables that match
1199
1198
  * <code>SchemaPattern</code>are returned.
1200
1199
  * If neither <code>SchemaPattern</code> or <code>TablePattern</code> are specified, then all tables are returned. </p>
1200
+ * @public
1201
1201
  */
1202
1202
  TablePattern?: string;
1203
1203
  /**
1204
- * @public
1205
1204
  * <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
1205
+ * @public
1206
1206
  */
1207
1207
  NextToken?: string;
1208
1208
  /**
1209
- * @public
1210
1209
  * <p>The maximum number of tables to return in the response.
1211
1210
  * If more tables exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
1211
+ * @public
1212
1212
  */
1213
1213
  MaxResults?: number;
1214
1214
  /**
1215
- * @public
1216
1215
  * <p>The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.</p>
1216
+ * @public
1217
1217
  */
1218
1218
  WorkgroupName?: string;
1219
1219
  }
1220
1220
  /**
1221
- * @public
1222
1221
  * <p>The properties of a table. </p>
1222
+ * @public
1223
1223
  */
1224
1224
  export interface TableMember {
1225
1225
  /**
1226
- * @public
1227
1226
  * <p>The name of the table. </p>
1227
+ * @public
1228
1228
  */
1229
1229
  name?: string;
1230
1230
  /**
1231
- * @public
1232
1231
  * <p>The type of the table. Possible values include TABLE, VIEW, SYSTEM TABLE, GLOBAL
1233
1232
  * TEMPORARY, LOCAL TEMPORARY, ALIAS, and SYNONYM. </p>
1233
+ * @public
1234
1234
  */
1235
1235
  type?: string;
1236
1236
  /**
1237
- * @public
1238
1237
  * <p>The schema containing the table. </p>
1238
+ * @public
1239
1239
  */
1240
1240
  schema?: string;
1241
1241
  }
@@ -1244,13 +1244,13 @@ export interface TableMember {
1244
1244
  */
1245
1245
  export interface ListTablesResponse {
1246
1246
  /**
1247
- * @public
1248
1247
  * <p>The tables that match the request pattern. </p>
1248
+ * @public
1249
1249
  */
1250
1250
  Tables?: TableMember[];
1251
1251
  /**
1252
- * @public
1253
1252
  * <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
1253
+ * @public
1254
1254
  */
1255
1255
  NextToken?: string;
1256
1256
  }