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