@aws-sdk/client-redshift-data 3.936.0 → 3.939.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/README.md +1 -5
- package/dist-cjs/index.js +46 -21
- package/dist-es/index.js +1 -0
- package/dist-es/models/enums.js +21 -0
- package/dist-es/models/errors.js +16 -16
- package/dist-es/models/models_0.js +1 -21
- package/dist-es/schemas/schemas_0.js +5 -5
- package/dist-types/RedshiftData.d.ts +1 -5
- package/dist-types/RedshiftDataClient.d.ts +1 -5
- package/dist-types/commands/BatchExecuteStatementCommand.d.ts +5 -38
- package/dist-types/commands/CancelStatementCommand.d.ts +4 -4
- package/dist-types/commands/DescribeStatementCommand.d.ts +2 -7
- package/dist-types/commands/DescribeTableCommand.d.ts +4 -38
- package/dist-types/commands/ExecuteStatementCommand.d.ts +5 -38
- package/dist-types/commands/GetStatementResultCommand.d.ts +1 -7
- package/dist-types/commands/GetStatementResultV2Command.d.ts +1 -6
- package/dist-types/commands/ListDatabasesCommand.d.ts +4 -37
- package/dist-types/commands/ListSchemasCommand.d.ts +4 -37
- package/dist-types/commands/ListStatementsCommand.d.ts +4 -10
- package/dist-types/commands/ListTablesCommand.d.ts +4 -38
- package/dist-types/index.d.ts +2 -5
- package/dist-types/models/enums.d.ts +45 -0
- package/dist-types/models/errors.d.ts +22 -22
- package/dist-types/models/models_0.d.ts +52 -202
- package/dist-types/ts3.4/index.d.ts +1 -0
- package/dist-types/ts3.4/models/enums.d.ts +26 -0
- package/dist-types/ts3.4/models/errors.d.ts +9 -9
- package/dist-types/ts3.4/models/models_0.d.ts +8 -29
- package/package.json +2 -2
|
@@ -1,25 +1,10 @@
|
|
|
1
|
-
|
|
2
|
-
* @public
|
|
3
|
-
* @enum
|
|
4
|
-
*/
|
|
5
|
-
export declare const ResultFormatString: {
|
|
6
|
-
readonly CSV: "CSV";
|
|
7
|
-
readonly JSON: "JSON";
|
|
8
|
-
};
|
|
9
|
-
/**
|
|
10
|
-
* @public
|
|
11
|
-
*/
|
|
12
|
-
export type ResultFormatString = (typeof ResultFormatString)[keyof typeof ResultFormatString];
|
|
1
|
+
import { ResultFormatString, StatementStatusString, StatusString } from "./enums";
|
|
13
2
|
/**
|
|
14
3
|
* @public
|
|
15
4
|
*/
|
|
16
5
|
export interface BatchExecuteStatementInput {
|
|
17
6
|
/**
|
|
18
|
-
* <p>One or more SQL statements to run.
|
|
19
|
-
*
|
|
20
|
-
* The SQL statements are run as a single transaction. They run serially in the order of the array.
|
|
21
|
-
* Subsequent SQL statements don't start until the previous statement in the array completes.
|
|
22
|
-
* If any SQL statement fails, then because they are run as one transaction, all work is rolled back.</p>
|
|
7
|
+
* <p>One or more SQL statements to run. The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back.</p>
|
|
23
8
|
* @public
|
|
24
9
|
*/
|
|
25
10
|
Sqls: string[] | undefined;
|
|
@@ -63,6 +48,11 @@ export interface BatchExecuteStatementInput {
|
|
|
63
48
|
* @public
|
|
64
49
|
*/
|
|
65
50
|
ClientToken?: string | undefined;
|
|
51
|
+
/**
|
|
52
|
+
* <p>The data format of the result of the SQL statement. If no format is specified, the default is JSON.</p>
|
|
53
|
+
* @public
|
|
54
|
+
*/
|
|
55
|
+
ResultFormat?: ResultFormatString | undefined;
|
|
66
56
|
/**
|
|
67
57
|
* <p>The number of seconds to keep the session alive after the query finishes. The maximum time a session can keep alive is 24 hours. After 24 hours, the session is forced closed and the query is terminated.</p>
|
|
68
58
|
* @public
|
|
@@ -73,19 +63,13 @@ export interface BatchExecuteStatementInput {
|
|
|
73
63
|
* @public
|
|
74
64
|
*/
|
|
75
65
|
SessionId?: string | undefined;
|
|
76
|
-
/**
|
|
77
|
-
* <p>The data format of the result of the SQL statement. If no format is specified, the default is JSON.</p>
|
|
78
|
-
* @public
|
|
79
|
-
*/
|
|
80
|
-
ResultFormat?: ResultFormatString | undefined;
|
|
81
66
|
}
|
|
82
67
|
/**
|
|
83
68
|
* @public
|
|
84
69
|
*/
|
|
85
70
|
export interface BatchExecuteStatementOutput {
|
|
86
71
|
/**
|
|
87
|
-
* <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.
|
|
88
|
-
* This identifier is returned by <code>BatchExecuteStatment</code>. </p>
|
|
72
|
+
* <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. This identifier is returned by <code>BatchExecuteStatment</code>. </p>
|
|
89
73
|
* @public
|
|
90
74
|
*/
|
|
91
75
|
Id?: string | undefined;
|
|
@@ -135,8 +119,7 @@ export interface BatchExecuteStatementOutput {
|
|
|
135
119
|
*/
|
|
136
120
|
export interface CancelStatementRequest {
|
|
137
121
|
/**
|
|
138
|
-
* <p>The identifier of the SQL statement to cancel. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
|
|
139
|
-
* This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatment</code>, and <code>ListStatements</code>. </p>
|
|
122
|
+
* <p>The identifier of the SQL statement to cancel. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatment</code>, and <code>ListStatements</code>. </p>
|
|
140
123
|
* @public
|
|
141
124
|
*/
|
|
142
125
|
Id: string | undefined;
|
|
@@ -227,10 +210,7 @@ export interface ColumnMetadata {
|
|
|
227
210
|
*/
|
|
228
211
|
export interface DescribeStatementRequest {
|
|
229
212
|
/**
|
|
230
|
-
* <p>The identifier of the SQL statement to describe. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
|
|
231
|
-
* A suffix indicates the number of the SQL statement.
|
|
232
|
-
* 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.
|
|
233
|
-
* This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatement</code>, and <code>ListStatements</code>. </p>
|
|
213
|
+
* <p>The identifier of the SQL statement to describe. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates the number of the SQL statement. 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. This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatement</code>, and <code>ListStatements</code>. </p>
|
|
234
214
|
* @public
|
|
235
215
|
*/
|
|
236
216
|
Id: string | undefined;
|
|
@@ -246,56 +226,18 @@ export interface SqlParameter {
|
|
|
246
226
|
*/
|
|
247
227
|
name: string | undefined;
|
|
248
228
|
/**
|
|
249
|
-
* <p>The value of the parameter.
|
|
250
|
-
* Amazon Redshift implicitly converts to the proper data type. For more information, see
|
|
251
|
-
* <a href="https://docs.aws.amazon.com/redshift/latest/dg/c_Supported_data_types.html">Data types</a> in the
|
|
252
|
-
* <i>Amazon Redshift Database Developer Guide</i>. </p>
|
|
229
|
+
* <p>The value of the parameter. Amazon Redshift implicitly converts to the proper data type. For more information, see <a href="https://docs.aws.amazon.com/redshift/latest/dg/c_Supported_data_types.html">Data types</a> in the <i>Amazon Redshift Database Developer Guide</i>. </p>
|
|
253
230
|
* @public
|
|
254
231
|
*/
|
|
255
232
|
value: string | undefined;
|
|
256
233
|
}
|
|
257
|
-
/**
|
|
258
|
-
* @public
|
|
259
|
-
* @enum
|
|
260
|
-
*/
|
|
261
|
-
export declare const StatusString: {
|
|
262
|
-
readonly ABORTED: "ABORTED";
|
|
263
|
-
readonly ALL: "ALL";
|
|
264
|
-
readonly FAILED: "FAILED";
|
|
265
|
-
readonly FINISHED: "FINISHED";
|
|
266
|
-
readonly PICKED: "PICKED";
|
|
267
|
-
readonly STARTED: "STARTED";
|
|
268
|
-
readonly SUBMITTED: "SUBMITTED";
|
|
269
|
-
};
|
|
270
|
-
/**
|
|
271
|
-
* @public
|
|
272
|
-
*/
|
|
273
|
-
export type StatusString = (typeof StatusString)[keyof typeof StatusString];
|
|
274
|
-
/**
|
|
275
|
-
* @public
|
|
276
|
-
* @enum
|
|
277
|
-
*/
|
|
278
|
-
export declare const StatementStatusString: {
|
|
279
|
-
readonly ABORTED: "ABORTED";
|
|
280
|
-
readonly FAILED: "FAILED";
|
|
281
|
-
readonly FINISHED: "FINISHED";
|
|
282
|
-
readonly PICKED: "PICKED";
|
|
283
|
-
readonly STARTED: "STARTED";
|
|
284
|
-
readonly SUBMITTED: "SUBMITTED";
|
|
285
|
-
};
|
|
286
|
-
/**
|
|
287
|
-
* @public
|
|
288
|
-
*/
|
|
289
|
-
export type StatementStatusString = (typeof StatementStatusString)[keyof typeof StatementStatusString];
|
|
290
234
|
/**
|
|
291
235
|
* <p>Information about an SQL statement.</p>
|
|
292
236
|
* @public
|
|
293
237
|
*/
|
|
294
238
|
export interface SubStatementData {
|
|
295
239
|
/**
|
|
296
|
-
* <p>The identifier of the SQL statement. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
|
|
297
|
-
* A suffix indicates the number of the SQL statement.
|
|
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.</p>
|
|
240
|
+
* <p>The identifier of the SQL statement. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates the number of the SQL statement. 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>
|
|
299
241
|
* @public
|
|
300
242
|
*/
|
|
301
243
|
Id: string | undefined;
|
|
@@ -310,9 +252,7 @@ export interface SubStatementData {
|
|
|
310
252
|
*/
|
|
311
253
|
Error?: string | undefined;
|
|
312
254
|
/**
|
|
313
|
-
* <p>The status of the SQL statement. An
|
|
314
|
-
* example is the that the SQL statement finished.
|
|
315
|
-
* </p>
|
|
255
|
+
* <p>The status of the SQL statement. An example is the that the SQL statement finished. </p>
|
|
316
256
|
* @public
|
|
317
257
|
*/
|
|
318
258
|
Status?: StatementStatusString | undefined;
|
|
@@ -332,9 +272,7 @@ export interface SubStatementData {
|
|
|
332
272
|
*/
|
|
333
273
|
QueryString?: string | undefined;
|
|
334
274
|
/**
|
|
335
|
-
* <p>Either the number of rows returned from the SQL statement or the number of rows affected.
|
|
336
|
-
* 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.
|
|
337
|
-
* A <code>-1</code> indicates the value is null.</p>
|
|
275
|
+
* <p>Either the number of rows returned from the SQL statement or the number of rows affected. 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. A <code>-1</code> indicates the value is null.</p>
|
|
338
276
|
* @public
|
|
339
277
|
*/
|
|
340
278
|
ResultRows?: number | undefined;
|
|
@@ -394,30 +332,7 @@ export interface DescribeStatementResponse {
|
|
|
394
332
|
*/
|
|
395
333
|
Error?: string | undefined;
|
|
396
334
|
/**
|
|
397
|
-
* <p>The status of the SQL statement being described. Status values are defined as follows: </p>
|
|
398
|
-
* <ul>
|
|
399
|
-
* <li>
|
|
400
|
-
* <p>ABORTED - The query run was stopped by the user. </p>
|
|
401
|
-
* </li>
|
|
402
|
-
* <li>
|
|
403
|
-
* <p>ALL - A status value that includes all query statuses. This value can be used to filter results. </p>
|
|
404
|
-
* </li>
|
|
405
|
-
* <li>
|
|
406
|
-
* <p>FAILED - The query run failed. </p>
|
|
407
|
-
* </li>
|
|
408
|
-
* <li>
|
|
409
|
-
* <p>FINISHED - The query has finished running. </p>
|
|
410
|
-
* </li>
|
|
411
|
-
* <li>
|
|
412
|
-
* <p>PICKED - The query has been chosen to be run. </p>
|
|
413
|
-
* </li>
|
|
414
|
-
* <li>
|
|
415
|
-
* <p>STARTED - The query run has started. </p>
|
|
416
|
-
* </li>
|
|
417
|
-
* <li>
|
|
418
|
-
* <p>SUBMITTED - The query was submitted, but not yet processed. </p>
|
|
419
|
-
* </li>
|
|
420
|
-
* </ul>
|
|
335
|
+
* <p>The status of the SQL statement being described. Status values are defined as follows: </p> <ul> <li> <p>ABORTED - The query run was stopped by the user. </p> </li> <li> <p>ALL - A status value that includes all query statuses. This value can be used to filter results. </p> </li> <li> <p>FAILED - The query run failed. </p> </li> <li> <p>FINISHED - The query has finished running. </p> </li> <li> <p>PICKED - The query has been chosen to be run. </p> </li> <li> <p>STARTED - The query run has started. </p> </li> <li> <p>SUBMITTED - The query was submitted, but not yet processed. </p> </li> </ul>
|
|
421
336
|
* @public
|
|
422
337
|
*/
|
|
423
338
|
Status?: StatusString | undefined;
|
|
@@ -427,8 +342,7 @@ export interface DescribeStatementResponse {
|
|
|
427
342
|
*/
|
|
428
343
|
CreatedAt?: Date | undefined;
|
|
429
344
|
/**
|
|
430
|
-
* <p>The date and time (UTC) that the metadata for the SQL statement was last updated. An
|
|
431
|
-
* example is the time the status last changed. </p>
|
|
345
|
+
* <p>The date and time (UTC) that the metadata for the SQL statement was last updated. An example is the time the status last changed. </p>
|
|
432
346
|
* @public
|
|
433
347
|
*/
|
|
434
348
|
UpdatedAt?: Date | undefined;
|
|
@@ -438,8 +352,7 @@ export interface DescribeStatementResponse {
|
|
|
438
352
|
*/
|
|
439
353
|
RedshiftPid?: number | undefined;
|
|
440
354
|
/**
|
|
441
|
-
* <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.
|
|
442
|
-
* The value is true if any substatement returns a result set.</p>
|
|
355
|
+
* <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. The value is true if any substatement returns a result set.</p>
|
|
443
356
|
* @public
|
|
444
357
|
*/
|
|
445
358
|
HasResultSet?: boolean | undefined;
|
|
@@ -449,9 +362,7 @@ export interface DescribeStatementResponse {
|
|
|
449
362
|
*/
|
|
450
363
|
QueryString?: string | undefined;
|
|
451
364
|
/**
|
|
452
|
-
* <p>Either the number of rows returned from the SQL statement or the number of rows affected.
|
|
453
|
-
* 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.
|
|
454
|
-
* A <code>-1</code> indicates the value is null.</p>
|
|
365
|
+
* <p>Either the number of rows returned from the SQL statement or the number of rows affected. 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. A <code>-1</code> indicates the value is null.</p>
|
|
455
366
|
* @public
|
|
456
367
|
*/
|
|
457
368
|
ResultRows?: number | undefined;
|
|
@@ -461,8 +372,7 @@ export interface DescribeStatementResponse {
|
|
|
461
372
|
*/
|
|
462
373
|
ResultSize?: number | undefined;
|
|
463
374
|
/**
|
|
464
|
-
* <p>The identifier of the query generated by Amazon Redshift.
|
|
465
|
-
* These identifiers are also available in the <code>query</code> column of the <code>STL_QUERY</code> system view. </p>
|
|
375
|
+
* <p>The identifier of the query generated by Amazon Redshift. These identifiers are also available in the <code>query</code> column of the <code>STL_QUERY</code> system view. </p>
|
|
466
376
|
* @public
|
|
467
377
|
*/
|
|
468
378
|
RedshiftQueryId?: number | undefined;
|
|
@@ -482,15 +392,15 @@ export interface DescribeStatementResponse {
|
|
|
482
392
|
*/
|
|
483
393
|
WorkgroupName?: string | undefined;
|
|
484
394
|
/**
|
|
485
|
-
* <p>The
|
|
395
|
+
* <p>The data format of the result of the SQL statement.</p>
|
|
486
396
|
* @public
|
|
487
397
|
*/
|
|
488
|
-
|
|
398
|
+
ResultFormat?: ResultFormatString | undefined;
|
|
489
399
|
/**
|
|
490
|
-
* <p>The
|
|
400
|
+
* <p>The session identifier of the query.</p>
|
|
491
401
|
* @public
|
|
492
402
|
*/
|
|
493
|
-
|
|
403
|
+
SessionId?: string | undefined;
|
|
494
404
|
}
|
|
495
405
|
/**
|
|
496
406
|
* @public
|
|
@@ -512,8 +422,7 @@ export interface DescribeTableRequest {
|
|
|
512
422
|
*/
|
|
513
423
|
DbUser?: string | undefined;
|
|
514
424
|
/**
|
|
515
|
-
* <p>The name of the database that contains the tables to be described.
|
|
516
|
-
* If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
|
|
425
|
+
* <p>The name of the database that contains the tables to be described. If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
|
|
517
426
|
* @public
|
|
518
427
|
*/
|
|
519
428
|
Database: string | undefined;
|
|
@@ -528,8 +437,7 @@ export interface DescribeTableRequest {
|
|
|
528
437
|
*/
|
|
529
438
|
Schema?: string | undefined;
|
|
530
439
|
/**
|
|
531
|
-
* <p>The table name. If no table is specified, then all tables for all matching schemas are returned.
|
|
532
|
-
* If no table and no schema is specified, then all tables for all schemas in the database are returned</p>
|
|
440
|
+
* <p>The table name. If no table is specified, then all tables for all matching schemas are returned. If no table and no schema is specified, then all tables for all schemas in the database are returned</p>
|
|
533
441
|
* @public
|
|
534
442
|
*/
|
|
535
443
|
Table?: string | undefined;
|
|
@@ -539,8 +447,7 @@ export interface DescribeTableRequest {
|
|
|
539
447
|
*/
|
|
540
448
|
NextToken?: string | undefined;
|
|
541
449
|
/**
|
|
542
|
-
* <p>The maximum number of tables to return in the response.
|
|
543
|
-
* If more tables exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
|
|
450
|
+
* <p>The maximum number of tables to return in the response. If more tables exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
|
|
544
451
|
* @public
|
|
545
452
|
*/
|
|
546
453
|
MaxResults?: number | undefined;
|
|
@@ -624,6 +531,11 @@ export interface ExecuteStatementInput {
|
|
|
624
531
|
* @public
|
|
625
532
|
*/
|
|
626
533
|
ClientToken?: string | undefined;
|
|
534
|
+
/**
|
|
535
|
+
* <p>The data format of the result of the SQL statement. If no format is specified, the default is JSON.</p>
|
|
536
|
+
* @public
|
|
537
|
+
*/
|
|
538
|
+
ResultFormat?: ResultFormatString | undefined;
|
|
627
539
|
/**
|
|
628
540
|
* <p>The number of seconds to keep the session alive after the query finishes. The maximum time a session can keep alive is 24 hours. After 24 hours, the session is forced closed and the query is terminated.</p>
|
|
629
541
|
* @public
|
|
@@ -634,11 +546,6 @@ export interface ExecuteStatementInput {
|
|
|
634
546
|
* @public
|
|
635
547
|
*/
|
|
636
548
|
SessionId?: string | undefined;
|
|
637
|
-
/**
|
|
638
|
-
* <p>The data format of the result of the SQL statement. If no format is specified, the default is JSON.</p>
|
|
639
|
-
* @public
|
|
640
|
-
*/
|
|
641
|
-
ResultFormat?: ResultFormatString | undefined;
|
|
642
549
|
}
|
|
643
550
|
/**
|
|
644
551
|
* @public
|
|
@@ -841,10 +748,7 @@ export declare namespace QueryRecords {
|
|
|
841
748
|
*/
|
|
842
749
|
export interface GetStatementResultRequest {
|
|
843
750
|
/**
|
|
844
|
-
* <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.
|
|
845
|
-
* A suffix indicates then number of the SQL statement.
|
|
846
|
-
* 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.
|
|
847
|
-
* This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatment</code>, and <code>ListStatements</code>. </p>
|
|
751
|
+
* <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. A suffix indicates then number of the SQL statement. 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. This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatment</code>, and <code>ListStatements</code>. </p>
|
|
848
752
|
* @public
|
|
849
753
|
*/
|
|
850
754
|
Id: string | undefined;
|
|
@@ -869,8 +773,7 @@ export interface GetStatementResultResponse {
|
|
|
869
773
|
*/
|
|
870
774
|
ColumnMetadata?: ColumnMetadata[] | undefined;
|
|
871
775
|
/**
|
|
872
|
-
* <p>The total number of rows in the result set returned from a query.
|
|
873
|
-
* 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
|
+
* <p>The total number of rows in the result set returned from a query. You can use this number to estimate the number of calls to the <code>GetStatementResult</code> operation needed to page through the results. </p>
|
|
874
777
|
* @public
|
|
875
778
|
*/
|
|
876
779
|
TotalNumRows?: number | undefined;
|
|
@@ -885,10 +788,7 @@ export interface GetStatementResultResponse {
|
|
|
885
788
|
*/
|
|
886
789
|
export interface GetStatementResultV2Request {
|
|
887
790
|
/**
|
|
888
|
-
* <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.
|
|
889
|
-
* A suffix indicates then number of the SQL statement.
|
|
890
|
-
* 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.
|
|
891
|
-
* This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatment</code>, and <code>ListStatements</code>. </p>
|
|
791
|
+
* <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. A suffix indicates then number of the SQL statement. 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. This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatment</code>, and <code>ListStatements</code>. </p>
|
|
892
792
|
* @public
|
|
893
793
|
*/
|
|
894
794
|
Id: string | undefined;
|
|
@@ -913,8 +813,7 @@ export interface GetStatementResultV2Response {
|
|
|
913
813
|
*/
|
|
914
814
|
ColumnMetadata?: ColumnMetadata[] | undefined;
|
|
915
815
|
/**
|
|
916
|
-
* <p>The total number of rows in the result set returned from a query.
|
|
917
|
-
* You can use this number to estimate the number of calls to the <code>GetStatementResultV2</code> operation needed to page through the results. </p>
|
|
816
|
+
* <p>The total number of rows in the result set returned from a query. You can use this number to estimate the number of calls to the <code>GetStatementResultV2</code> operation needed to page through the results. </p>
|
|
918
817
|
* @public
|
|
919
818
|
*/
|
|
920
819
|
TotalNumRows?: number | undefined;
|
|
@@ -959,8 +858,7 @@ export interface ListDatabasesRequest {
|
|
|
959
858
|
*/
|
|
960
859
|
NextToken?: string | undefined;
|
|
961
860
|
/**
|
|
962
|
-
* <p>The maximum number of databases to return in the response.
|
|
963
|
-
* If more databases exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
|
|
861
|
+
* <p>The maximum number of databases to return in the response. If more databases exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
|
|
964
862
|
* @public
|
|
965
863
|
*/
|
|
966
864
|
MaxResults?: number | undefined;
|
|
@@ -1005,8 +903,7 @@ export interface ListSchemasRequest {
|
|
|
1005
903
|
*/
|
|
1006
904
|
DbUser?: string | undefined;
|
|
1007
905
|
/**
|
|
1008
|
-
* <p>The name of the database that contains the schemas to list.
|
|
1009
|
-
* If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
|
|
906
|
+
* <p>The name of the database that contains the schemas to list. If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
|
|
1010
907
|
* @public
|
|
1011
908
|
*/
|
|
1012
909
|
Database: string | undefined;
|
|
@@ -1016,9 +913,7 @@ export interface ListSchemasRequest {
|
|
|
1016
913
|
*/
|
|
1017
914
|
ConnectedDatabase?: string | undefined;
|
|
1018
915
|
/**
|
|
1019
|
-
* <p>A pattern to filter results by schema name. Within a schema pattern, "%" means match any
|
|
1020
|
-
* substring of 0 or more characters and "_" means match any one character. Only schema name
|
|
1021
|
-
* entries matching the search pattern are returned. </p>
|
|
916
|
+
* <p>A pattern to filter results by schema name. Within a schema pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only schema name entries matching the search pattern are returned. </p>
|
|
1022
917
|
* @public
|
|
1023
918
|
*/
|
|
1024
919
|
SchemaPattern?: string | undefined;
|
|
@@ -1028,8 +923,7 @@ export interface ListSchemasRequest {
|
|
|
1028
923
|
*/
|
|
1029
924
|
NextToken?: string | undefined;
|
|
1030
925
|
/**
|
|
1031
|
-
* <p>The maximum number of schemas to return in the response.
|
|
1032
|
-
* If more schemas exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
|
|
926
|
+
* <p>The maximum number of schemas to return in the response. If more schemas exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
|
|
1033
927
|
* @public
|
|
1034
928
|
*/
|
|
1035
929
|
MaxResults?: number | undefined;
|
|
@@ -1064,68 +958,37 @@ export interface ListStatementsRequest {
|
|
|
1064
958
|
*/
|
|
1065
959
|
NextToken?: string | undefined;
|
|
1066
960
|
/**
|
|
1067
|
-
* <p>The maximum number of SQL statements to return in the response.
|
|
1068
|
-
* If more SQL statements exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
|
|
961
|
+
* <p>The maximum number of SQL statements to return in the response. If more SQL statements exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
|
|
1069
962
|
* @public
|
|
1070
963
|
*/
|
|
1071
964
|
MaxResults?: number | undefined;
|
|
1072
965
|
/**
|
|
1073
|
-
* <p>The name of the SQL statement specified as input to <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> to identify the query.
|
|
1074
|
-
* You can list multiple statements by providing a prefix that matches the beginning of the statement name.
|
|
1075
|
-
* For example, to list myStatement1, myStatement2, myStatement3, and so on, then provide the a value of <code>myStatement</code>.
|
|
1076
|
-
* Data API does a case-sensitive match of SQL statement names to the prefix value you provide. </p>
|
|
966
|
+
* <p>The name of the SQL statement specified as input to <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> to identify the query. You can list multiple statements by providing a prefix that matches the beginning of the statement name. For example, to list myStatement1, myStatement2, myStatement3, and so on, then provide the a value of <code>myStatement</code>. Data API does a case-sensitive match of SQL statement names to the prefix value you provide. </p>
|
|
1077
967
|
* @public
|
|
1078
968
|
*/
|
|
1079
969
|
StatementName?: string | undefined;
|
|
1080
970
|
/**
|
|
1081
|
-
* <p>The status of the SQL statement to list. Status values are defined as follows: </p>
|
|
1082
|
-
* <ul>
|
|
1083
|
-
* <li>
|
|
1084
|
-
* <p>ABORTED - The query run was stopped by the user. </p>
|
|
1085
|
-
* </li>
|
|
1086
|
-
* <li>
|
|
1087
|
-
* <p>ALL - A status value that includes all query statuses. This value can be used to filter results. </p>
|
|
1088
|
-
* </li>
|
|
1089
|
-
* <li>
|
|
1090
|
-
* <p>FAILED - The query run failed. </p>
|
|
1091
|
-
* </li>
|
|
1092
|
-
* <li>
|
|
1093
|
-
* <p>FINISHED - The query has finished running. </p>
|
|
1094
|
-
* </li>
|
|
1095
|
-
* <li>
|
|
1096
|
-
* <p>PICKED - The query has been chosen to be run. </p>
|
|
1097
|
-
* </li>
|
|
1098
|
-
* <li>
|
|
1099
|
-
* <p>STARTED - The query run has started. </p>
|
|
1100
|
-
* </li>
|
|
1101
|
-
* <li>
|
|
1102
|
-
* <p>SUBMITTED - The query was submitted, but not yet processed. </p>
|
|
1103
|
-
* </li>
|
|
1104
|
-
* </ul>
|
|
971
|
+
* <p>The status of the SQL statement to list. Status values are defined as follows: </p> <ul> <li> <p>ABORTED - The query run was stopped by the user. </p> </li> <li> <p>ALL - A status value that includes all query statuses. This value can be used to filter results. </p> </li> <li> <p>FAILED - The query run failed. </p> </li> <li> <p>FINISHED - The query has finished running. </p> </li> <li> <p>PICKED - The query has been chosen to be run. </p> </li> <li> <p>STARTED - The query run has started. </p> </li> <li> <p>SUBMITTED - The query was submitted, but not yet processed. </p> </li> </ul>
|
|
1105
972
|
* @public
|
|
1106
973
|
*/
|
|
1107
974
|
Status?: StatusString | undefined;
|
|
1108
975
|
/**
|
|
1109
|
-
* <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.
|
|
1110
|
-
* If false, only statements run by the caller's IAM role in the current IAM session are returned. The default is true. </p>
|
|
976
|
+
* <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. If false, only statements run by the caller's IAM role in the current IAM session are returned. The default is true. </p>
|
|
1111
977
|
* @public
|
|
1112
978
|
*/
|
|
1113
979
|
RoleLevel?: boolean | undefined;
|
|
1114
980
|
/**
|
|
1115
|
-
* <p>The name of the database when listing statements run against a <code>ClusterIdentifier</code> or <code>WorkgroupName</code>.
|
|
1116
|
-
* </p>
|
|
981
|
+
* <p>The name of the database when listing statements run against a <code>ClusterIdentifier</code> or <code>WorkgroupName</code>. </p>
|
|
1117
982
|
* @public
|
|
1118
983
|
*/
|
|
1119
984
|
Database?: string | undefined;
|
|
1120
985
|
/**
|
|
1121
|
-
* <p>The cluster identifier. Only statements that ran on this cluster are returned.
|
|
1122
|
-
* When providing <code>ClusterIdentifier</code>, then <code>WorkgroupName</code> can't be specified.</p>
|
|
986
|
+
* <p>The cluster identifier. Only statements that ran on this cluster are returned. When providing <code>ClusterIdentifier</code>, then <code>WorkgroupName</code> can't be specified.</p>
|
|
1123
987
|
* @public
|
|
1124
988
|
*/
|
|
1125
989
|
ClusterIdentifier?: string | undefined;
|
|
1126
990
|
/**
|
|
1127
|
-
* <p>The serverless workgroup name or Amazon Resource Name (ARN). Only statements that ran on this workgroup are returned.
|
|
1128
|
-
* When providing <code>WorkgroupName</code>, then <code>ClusterIdentifier</code> can't be specified.</p>
|
|
991
|
+
* <p>The serverless workgroup name or Amazon Resource Name (ARN). Only statements that ran on this workgroup are returned. When providing <code>WorkgroupName</code>, then <code>ClusterIdentifier</code> can't be specified.</p>
|
|
1129
992
|
* @public
|
|
1130
993
|
*/
|
|
1131
994
|
WorkgroupName?: string | undefined;
|
|
@@ -1156,9 +1019,7 @@ export interface StatementData {
|
|
|
1156
1019
|
*/
|
|
1157
1020
|
SecretArn?: string | undefined;
|
|
1158
1021
|
/**
|
|
1159
|
-
* <p>The status of the SQL statement. An
|
|
1160
|
-
* example is the that the SQL statement finished.
|
|
1161
|
-
* </p>
|
|
1022
|
+
* <p>The status of the SQL statement. An example is the that the SQL statement finished. </p>
|
|
1162
1023
|
* @public
|
|
1163
1024
|
*/
|
|
1164
1025
|
Status?: StatusString | undefined;
|
|
@@ -1233,8 +1094,7 @@ export interface ListTablesRequest {
|
|
|
1233
1094
|
*/
|
|
1234
1095
|
DbUser?: string | undefined;
|
|
1235
1096
|
/**
|
|
1236
|
-
* <p>The name of the database that contains the tables to list.
|
|
1237
|
-
* If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
|
|
1097
|
+
* <p>The name of the database that contains the tables to list. If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
|
|
1238
1098
|
* @public
|
|
1239
1099
|
*/
|
|
1240
1100
|
Database: string | undefined;
|
|
@@ -1244,20 +1104,12 @@ export interface ListTablesRequest {
|
|
|
1244
1104
|
*/
|
|
1245
1105
|
ConnectedDatabase?: string | undefined;
|
|
1246
1106
|
/**
|
|
1247
|
-
* <p>A pattern to filter results by schema name. Within a schema pattern, "%" means match any
|
|
1248
|
-
* substring of 0 or more characters and "_" means match any one character. Only schema name
|
|
1249
|
-
* entries matching the search pattern are returned. If <code>SchemaPattern</code> is not specified, then all tables that match
|
|
1250
|
-
* <code>TablePattern</code> are returned.
|
|
1251
|
-
* If neither <code>SchemaPattern</code> or <code>TablePattern</code> are specified, then all tables are returned. </p>
|
|
1107
|
+
* <p>A pattern to filter results by schema name. Within a schema pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only schema name entries matching the search pattern are returned. If <code>SchemaPattern</code> is not specified, then all tables that match <code>TablePattern</code> are returned. If neither <code>SchemaPattern</code> or <code>TablePattern</code> are specified, then all tables are returned. </p>
|
|
1252
1108
|
* @public
|
|
1253
1109
|
*/
|
|
1254
1110
|
SchemaPattern?: string | undefined;
|
|
1255
1111
|
/**
|
|
1256
|
-
* <p>A pattern to filter results by table name. Within a table pattern, "%" means match any
|
|
1257
|
-
* substring of 0 or more characters and "_" means match any one character. Only table name
|
|
1258
|
-
* entries matching the search pattern are returned. If <code>TablePattern</code> is not specified, then all tables that match
|
|
1259
|
-
* <code>SchemaPattern</code>are returned.
|
|
1260
|
-
* If neither <code>SchemaPattern</code> or <code>TablePattern</code> are specified, then all tables are returned. </p>
|
|
1112
|
+
* <p>A pattern to filter results by table name. Within a table pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only table name entries matching the search pattern are returned. If <code>TablePattern</code> is not specified, then all tables that match <code>SchemaPattern</code>are returned. If neither <code>SchemaPattern</code> or <code>TablePattern</code> are specified, then all tables are returned. </p>
|
|
1261
1113
|
* @public
|
|
1262
1114
|
*/
|
|
1263
1115
|
TablePattern?: string | undefined;
|
|
@@ -1267,8 +1119,7 @@ export interface ListTablesRequest {
|
|
|
1267
1119
|
*/
|
|
1268
1120
|
NextToken?: string | undefined;
|
|
1269
1121
|
/**
|
|
1270
|
-
* <p>The maximum number of tables to return in the response.
|
|
1271
|
-
* If more tables exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
|
|
1122
|
+
* <p>The maximum number of tables to return in the response. If more tables exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
|
|
1272
1123
|
* @public
|
|
1273
1124
|
*/
|
|
1274
1125
|
MaxResults?: number | undefined;
|
|
@@ -1289,8 +1140,7 @@ export interface TableMember {
|
|
|
1289
1140
|
*/
|
|
1290
1141
|
name?: string | undefined;
|
|
1291
1142
|
/**
|
|
1292
|
-
* <p>The type of the table. Possible values include TABLE, VIEW, SYSTEM TABLE, GLOBAL
|
|
1293
|
-
* TEMPORARY, LOCAL TEMPORARY, ALIAS, and SYNONYM. </p>
|
|
1143
|
+
* <p>The type of the table. Possible values include TABLE, VIEW, SYSTEM TABLE, GLOBAL TEMPORARY, LOCAL TEMPORARY, ALIAS, and SYNONYM. </p>
|
|
1294
1144
|
* @public
|
|
1295
1145
|
*/
|
|
1296
1146
|
type?: string | undefined;
|
|
@@ -5,6 +5,7 @@ export { RuntimeExtension } from "./runtimeExtensions";
|
|
|
5
5
|
export { RedshiftDataExtensionConfiguration } from "./extensionConfiguration";
|
|
6
6
|
export * from "./commands";
|
|
7
7
|
export * from "./pagination";
|
|
8
|
+
export * from "./models/enums";
|
|
8
9
|
export * from "./models/errors";
|
|
9
10
|
export * from "./models/models_0";
|
|
10
11
|
export { RedshiftDataServiceException } from "./models/RedshiftDataServiceException";
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
export declare const ResultFormatString: {
|
|
2
|
+
readonly CSV: "CSV";
|
|
3
|
+
readonly JSON: "JSON";
|
|
4
|
+
};
|
|
5
|
+
export type ResultFormatString =
|
|
6
|
+
(typeof ResultFormatString)[keyof typeof ResultFormatString];
|
|
7
|
+
export declare const StatusString: {
|
|
8
|
+
readonly ABORTED: "ABORTED";
|
|
9
|
+
readonly ALL: "ALL";
|
|
10
|
+
readonly FAILED: "FAILED";
|
|
11
|
+
readonly FINISHED: "FINISHED";
|
|
12
|
+
readonly PICKED: "PICKED";
|
|
13
|
+
readonly STARTED: "STARTED";
|
|
14
|
+
readonly SUBMITTED: "SUBMITTED";
|
|
15
|
+
};
|
|
16
|
+
export type StatusString = (typeof StatusString)[keyof typeof StatusString];
|
|
17
|
+
export declare const StatementStatusString: {
|
|
18
|
+
readonly ABORTED: "ABORTED";
|
|
19
|
+
readonly FAILED: "FAILED";
|
|
20
|
+
readonly FINISHED: "FINISHED";
|
|
21
|
+
readonly PICKED: "PICKED";
|
|
22
|
+
readonly STARTED: "STARTED";
|
|
23
|
+
readonly SUBMITTED: "SUBMITTED";
|
|
24
|
+
};
|
|
25
|
+
export type StatementStatusString =
|
|
26
|
+
(typeof StatementStatusString)[keyof typeof StatementStatusString];
|
|
@@ -39,6 +39,15 @@ export declare class InternalServerException extends __BaseException {
|
|
|
39
39
|
opts: __ExceptionOptionType<InternalServerException, __BaseException>
|
|
40
40
|
);
|
|
41
41
|
}
|
|
42
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
43
|
+
readonly name: "ResourceNotFoundException";
|
|
44
|
+
readonly $fault: "client";
|
|
45
|
+
Message: string | undefined;
|
|
46
|
+
ResourceId: string | undefined;
|
|
47
|
+
constructor(
|
|
48
|
+
opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>
|
|
49
|
+
);
|
|
50
|
+
}
|
|
42
51
|
export declare class ValidationException extends __BaseException {
|
|
43
52
|
readonly name: "ValidationException";
|
|
44
53
|
readonly $fault: "client";
|
|
@@ -55,15 +64,6 @@ export declare class DatabaseConnectionException extends __BaseException {
|
|
|
55
64
|
opts: __ExceptionOptionType<DatabaseConnectionException, __BaseException>
|
|
56
65
|
);
|
|
57
66
|
}
|
|
58
|
-
export declare class ResourceNotFoundException extends __BaseException {
|
|
59
|
-
readonly name: "ResourceNotFoundException";
|
|
60
|
-
readonly $fault: "client";
|
|
61
|
-
Message: string | undefined;
|
|
62
|
-
ResourceId: string | undefined;
|
|
63
|
-
constructor(
|
|
64
|
-
opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>
|
|
65
|
-
);
|
|
66
|
-
}
|
|
67
67
|
export declare class QueryTimeoutException extends __BaseException {
|
|
68
68
|
readonly name: "QueryTimeoutException";
|
|
69
69
|
readonly $fault: "client";
|