@aws-sdk/client-redshift-data 3.686.0 → 3.691.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 +159 -159
- package/dist-types/ts3.4/models/models_0.d.ts +159 -159
- package/package.json +7 -7
|
@@ -7,7 +7,7 @@ import { RedshiftDataServiceException as __BaseException } from "./RedshiftDataS
|
|
|
7
7
|
export declare class ActiveSessionsExceededException extends __BaseException {
|
|
8
8
|
readonly name: "ActiveSessionsExceededException";
|
|
9
9
|
readonly $fault: "client";
|
|
10
|
-
Message?: string;
|
|
10
|
+
Message?: string | undefined;
|
|
11
11
|
/**
|
|
12
12
|
* @internal
|
|
13
13
|
*/
|
|
@@ -20,7 +20,7 @@ export declare class ActiveSessionsExceededException extends __BaseException {
|
|
|
20
20
|
export declare class ActiveStatementsExceededException extends __BaseException {
|
|
21
21
|
readonly name: "ActiveStatementsExceededException";
|
|
22
22
|
readonly $fault: "client";
|
|
23
|
-
Message?: string;
|
|
23
|
+
Message?: string | undefined;
|
|
24
24
|
/**
|
|
25
25
|
* @internal
|
|
26
26
|
*/
|
|
@@ -73,57 +73,57 @@ export interface BatchExecuteStatementInput {
|
|
|
73
73
|
* <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
|
|
74
74
|
* @public
|
|
75
75
|
*/
|
|
76
|
-
ClusterIdentifier?: string;
|
|
76
|
+
ClusterIdentifier?: string | undefined;
|
|
77
77
|
/**
|
|
78
78
|
* <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
|
|
79
79
|
* @public
|
|
80
80
|
*/
|
|
81
|
-
SecretArn?: string;
|
|
81
|
+
SecretArn?: string | undefined;
|
|
82
82
|
/**
|
|
83
83
|
* <p>The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials. </p>
|
|
84
84
|
* @public
|
|
85
85
|
*/
|
|
86
|
-
DbUser?: string;
|
|
86
|
+
DbUser?: string | undefined;
|
|
87
87
|
/**
|
|
88
88
|
* <p>The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
|
|
89
89
|
* @public
|
|
90
90
|
*/
|
|
91
|
-
Database?: string;
|
|
91
|
+
Database?: string | undefined;
|
|
92
92
|
/**
|
|
93
93
|
* <p>A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statements run. </p>
|
|
94
94
|
* @public
|
|
95
95
|
*/
|
|
96
|
-
WithEvent?: boolean;
|
|
96
|
+
WithEvent?: boolean | undefined;
|
|
97
97
|
/**
|
|
98
98
|
* <p>The name of the SQL statements. You can name the SQL statements when you create them to identify the query. </p>
|
|
99
99
|
* @public
|
|
100
100
|
*/
|
|
101
|
-
StatementName?: string;
|
|
101
|
+
StatementName?: string | undefined;
|
|
102
102
|
/**
|
|
103
103
|
* <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>
|
|
104
104
|
* @public
|
|
105
105
|
*/
|
|
106
|
-
WorkgroupName?: string;
|
|
106
|
+
WorkgroupName?: string | undefined;
|
|
107
107
|
/**
|
|
108
108
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
|
|
109
109
|
* @public
|
|
110
110
|
*/
|
|
111
|
-
ClientToken?: string;
|
|
111
|
+
ClientToken?: string | undefined;
|
|
112
112
|
/**
|
|
113
113
|
* <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>
|
|
114
114
|
* @public
|
|
115
115
|
*/
|
|
116
|
-
SessionKeepAliveSeconds?: number;
|
|
116
|
+
SessionKeepAliveSeconds?: number | undefined;
|
|
117
117
|
/**
|
|
118
118
|
* <p>The session identifier of the query.</p>
|
|
119
119
|
* @public
|
|
120
120
|
*/
|
|
121
|
-
SessionId?: string;
|
|
121
|
+
SessionId?: string | undefined;
|
|
122
122
|
/**
|
|
123
123
|
* <p>The data format of the result of the SQL statement. If no format is specified, the default is JSON.</p>
|
|
124
124
|
* @public
|
|
125
125
|
*/
|
|
126
|
-
ResultFormat?: ResultFormatString;
|
|
126
|
+
ResultFormat?: ResultFormatString | undefined;
|
|
127
127
|
}
|
|
128
128
|
/**
|
|
129
129
|
* @public
|
|
@@ -134,47 +134,47 @@ export interface BatchExecuteStatementOutput {
|
|
|
134
134
|
* This identifier is returned by <code>BatchExecuteStatment</code>. </p>
|
|
135
135
|
* @public
|
|
136
136
|
*/
|
|
137
|
-
Id?: string;
|
|
137
|
+
Id?: string | undefined;
|
|
138
138
|
/**
|
|
139
139
|
* <p>The date and time (UTC) the statement was created. </p>
|
|
140
140
|
* @public
|
|
141
141
|
*/
|
|
142
|
-
CreatedAt?: Date;
|
|
142
|
+
CreatedAt?: Date | undefined;
|
|
143
143
|
/**
|
|
144
144
|
* <p>The cluster identifier. This element is not returned when connecting to a serverless workgroup. </p>
|
|
145
145
|
* @public
|
|
146
146
|
*/
|
|
147
|
-
ClusterIdentifier?: string;
|
|
147
|
+
ClusterIdentifier?: string | undefined;
|
|
148
148
|
/**
|
|
149
149
|
* <p>The database user name.</p>
|
|
150
150
|
* @public
|
|
151
151
|
*/
|
|
152
|
-
DbUser?: string;
|
|
152
|
+
DbUser?: string | undefined;
|
|
153
153
|
/**
|
|
154
154
|
* <p>A list of colon (:) separated names of database groups.</p>
|
|
155
155
|
* @public
|
|
156
156
|
*/
|
|
157
|
-
DbGroups?: string[];
|
|
157
|
+
DbGroups?: string[] | undefined;
|
|
158
158
|
/**
|
|
159
159
|
* <p>The name of the database.</p>
|
|
160
160
|
* @public
|
|
161
161
|
*/
|
|
162
|
-
Database?: string;
|
|
162
|
+
Database?: string | undefined;
|
|
163
163
|
/**
|
|
164
164
|
* <p>The name or ARN of the secret that enables access to the database. </p>
|
|
165
165
|
* @public
|
|
166
166
|
*/
|
|
167
|
-
SecretArn?: string;
|
|
167
|
+
SecretArn?: string | undefined;
|
|
168
168
|
/**
|
|
169
169
|
* <p>The serverless workgroup name or Amazon Resource Name (ARN). This element is not returned when connecting to a provisioned cluster.</p>
|
|
170
170
|
* @public
|
|
171
171
|
*/
|
|
172
|
-
WorkgroupName?: string;
|
|
172
|
+
WorkgroupName?: string | undefined;
|
|
173
173
|
/**
|
|
174
174
|
* <p>The session identifier of the query.</p>
|
|
175
175
|
* @public
|
|
176
176
|
*/
|
|
177
|
-
SessionId?: string;
|
|
177
|
+
SessionId?: string | undefined;
|
|
178
178
|
}
|
|
179
179
|
/**
|
|
180
180
|
* <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
|
|
@@ -204,7 +204,7 @@ export declare class ValidationException extends __BaseException {
|
|
|
204
204
|
* <p>The exception message.</p>
|
|
205
205
|
* @public
|
|
206
206
|
*/
|
|
207
|
-
Message?: string;
|
|
207
|
+
Message?: string | undefined;
|
|
208
208
|
/**
|
|
209
209
|
* @internal
|
|
210
210
|
*/
|
|
@@ -229,7 +229,7 @@ export interface CancelStatementResponse {
|
|
|
229
229
|
* <p>A value that indicates whether the cancel statement succeeded (true). </p>
|
|
230
230
|
* @public
|
|
231
231
|
*/
|
|
232
|
-
Status?: boolean;
|
|
232
|
+
Status?: boolean | undefined;
|
|
233
233
|
}
|
|
234
234
|
/**
|
|
235
235
|
* <p>Connection to a database failed.</p>
|
|
@@ -275,67 +275,67 @@ export interface ColumnMetadata {
|
|
|
275
275
|
* <p>A value that indicates whether the column is case-sensitive. </p>
|
|
276
276
|
* @public
|
|
277
277
|
*/
|
|
278
|
-
isCaseSensitive?: boolean;
|
|
278
|
+
isCaseSensitive?: boolean | undefined;
|
|
279
279
|
/**
|
|
280
280
|
* <p>A value that indicates whether the column contains currency values.</p>
|
|
281
281
|
* @public
|
|
282
282
|
*/
|
|
283
|
-
isCurrency?: boolean;
|
|
283
|
+
isCurrency?: boolean | undefined;
|
|
284
284
|
/**
|
|
285
285
|
* <p>A value that indicates whether an integer column is signed.</p>
|
|
286
286
|
* @public
|
|
287
287
|
*/
|
|
288
|
-
isSigned?: boolean;
|
|
288
|
+
isSigned?: boolean | undefined;
|
|
289
289
|
/**
|
|
290
290
|
* <p>The label for the column. </p>
|
|
291
291
|
* @public
|
|
292
292
|
*/
|
|
293
|
-
label?: string;
|
|
293
|
+
label?: string | undefined;
|
|
294
294
|
/**
|
|
295
295
|
* <p>The name of the column. </p>
|
|
296
296
|
* @public
|
|
297
297
|
*/
|
|
298
|
-
name?: string;
|
|
298
|
+
name?: string | undefined;
|
|
299
299
|
/**
|
|
300
300
|
* <p>A value that indicates whether the column is nullable. </p>
|
|
301
301
|
* @public
|
|
302
302
|
*/
|
|
303
|
-
nullable?: number;
|
|
303
|
+
nullable?: number | undefined;
|
|
304
304
|
/**
|
|
305
305
|
* <p>The precision value of a decimal number column. </p>
|
|
306
306
|
* @public
|
|
307
307
|
*/
|
|
308
|
-
precision?: number;
|
|
308
|
+
precision?: number | undefined;
|
|
309
309
|
/**
|
|
310
310
|
* <p>The scale value of a decimal number column. </p>
|
|
311
311
|
* @public
|
|
312
312
|
*/
|
|
313
|
-
scale?: number;
|
|
313
|
+
scale?: number | undefined;
|
|
314
314
|
/**
|
|
315
315
|
* <p>The name of the schema that contains the table that includes the column.</p>
|
|
316
316
|
* @public
|
|
317
317
|
*/
|
|
318
|
-
schemaName?: string;
|
|
318
|
+
schemaName?: string | undefined;
|
|
319
319
|
/**
|
|
320
320
|
* <p>The name of the table that includes the column. </p>
|
|
321
321
|
* @public
|
|
322
322
|
*/
|
|
323
|
-
tableName?: string;
|
|
323
|
+
tableName?: string | undefined;
|
|
324
324
|
/**
|
|
325
325
|
* <p>The database-specific data type of the column. </p>
|
|
326
326
|
* @public
|
|
327
327
|
*/
|
|
328
|
-
typeName?: string;
|
|
328
|
+
typeName?: string | undefined;
|
|
329
329
|
/**
|
|
330
330
|
* <p>The length of the column.</p>
|
|
331
331
|
* @public
|
|
332
332
|
*/
|
|
333
|
-
length?: number;
|
|
333
|
+
length?: number | undefined;
|
|
334
334
|
/**
|
|
335
335
|
* <p>The default value of the column. </p>
|
|
336
336
|
* @public
|
|
337
337
|
*/
|
|
338
|
-
columnDefault?: string;
|
|
338
|
+
columnDefault?: string | undefined;
|
|
339
339
|
}
|
|
340
340
|
/**
|
|
341
341
|
* @public
|
|
@@ -418,56 +418,56 @@ export interface SubStatementData {
|
|
|
418
418
|
* <p>The amount of time in nanoseconds that the statement ran.</p>
|
|
419
419
|
* @public
|
|
420
420
|
*/
|
|
421
|
-
Duration?: number;
|
|
421
|
+
Duration?: number | undefined;
|
|
422
422
|
/**
|
|
423
423
|
* <p>The error message from the cluster if the SQL statement encountered an error while running.</p>
|
|
424
424
|
* @public
|
|
425
425
|
*/
|
|
426
|
-
Error?: string;
|
|
426
|
+
Error?: string | undefined;
|
|
427
427
|
/**
|
|
428
428
|
* <p>The status of the SQL statement. An
|
|
429
429
|
* example is the that the SQL statement finished.
|
|
430
430
|
* </p>
|
|
431
431
|
* @public
|
|
432
432
|
*/
|
|
433
|
-
Status?: StatementStatusString;
|
|
433
|
+
Status?: StatementStatusString | undefined;
|
|
434
434
|
/**
|
|
435
435
|
* <p>The date and time (UTC) the statement was created. </p>
|
|
436
436
|
* @public
|
|
437
437
|
*/
|
|
438
|
-
CreatedAt?: Date;
|
|
438
|
+
CreatedAt?: Date | undefined;
|
|
439
439
|
/**
|
|
440
440
|
* <p>The date and time (UTC) that the statement metadata was last updated.</p>
|
|
441
441
|
* @public
|
|
442
442
|
*/
|
|
443
|
-
UpdatedAt?: Date;
|
|
443
|
+
UpdatedAt?: Date | undefined;
|
|
444
444
|
/**
|
|
445
445
|
* <p>The SQL statement text.</p>
|
|
446
446
|
* @public
|
|
447
447
|
*/
|
|
448
|
-
QueryString?: string;
|
|
448
|
+
QueryString?: string | undefined;
|
|
449
449
|
/**
|
|
450
450
|
* <p>Either the number of rows returned from the SQL statement or the number of rows affected.
|
|
451
451
|
* 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.
|
|
452
452
|
* A <code>-1</code> indicates the value is null.</p>
|
|
453
453
|
* @public
|
|
454
454
|
*/
|
|
455
|
-
ResultRows?: number;
|
|
455
|
+
ResultRows?: number | undefined;
|
|
456
456
|
/**
|
|
457
457
|
* <p>The size in bytes of the returned results. A <code>-1</code> indicates the value is null.</p>
|
|
458
458
|
* @public
|
|
459
459
|
*/
|
|
460
|
-
ResultSize?: number;
|
|
460
|
+
ResultSize?: number | undefined;
|
|
461
461
|
/**
|
|
462
462
|
* <p>The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. </p>
|
|
463
463
|
* @public
|
|
464
464
|
*/
|
|
465
|
-
RedshiftQueryId?: number;
|
|
465
|
+
RedshiftQueryId?: number | undefined;
|
|
466
466
|
/**
|
|
467
467
|
* <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>
|
|
468
468
|
* @public
|
|
469
469
|
*/
|
|
470
|
-
HasResultSet?: boolean;
|
|
470
|
+
HasResultSet?: boolean | undefined;
|
|
471
471
|
}
|
|
472
472
|
/**
|
|
473
473
|
* @public
|
|
@@ -482,32 +482,32 @@ export interface DescribeStatementResponse {
|
|
|
482
482
|
* <p>The name or Amazon Resource Name (ARN) of the secret that enables access to the database. </p>
|
|
483
483
|
* @public
|
|
484
484
|
*/
|
|
485
|
-
SecretArn?: string;
|
|
485
|
+
SecretArn?: string | undefined;
|
|
486
486
|
/**
|
|
487
487
|
* <p>The database user name. </p>
|
|
488
488
|
* @public
|
|
489
489
|
*/
|
|
490
|
-
DbUser?: string;
|
|
490
|
+
DbUser?: string | undefined;
|
|
491
491
|
/**
|
|
492
492
|
* <p>The name of the database. </p>
|
|
493
493
|
* @public
|
|
494
494
|
*/
|
|
495
|
-
Database?: string;
|
|
495
|
+
Database?: string | undefined;
|
|
496
496
|
/**
|
|
497
497
|
* <p>The cluster identifier. </p>
|
|
498
498
|
* @public
|
|
499
499
|
*/
|
|
500
|
-
ClusterIdentifier?: string;
|
|
500
|
+
ClusterIdentifier?: string | undefined;
|
|
501
501
|
/**
|
|
502
502
|
* <p>The amount of time in nanoseconds that the statement ran. </p>
|
|
503
503
|
* @public
|
|
504
504
|
*/
|
|
505
|
-
Duration?: number;
|
|
505
|
+
Duration?: number | undefined;
|
|
506
506
|
/**
|
|
507
507
|
* <p>The error message from the cluster if the SQL statement encountered an error while running. </p>
|
|
508
508
|
* @public
|
|
509
509
|
*/
|
|
510
|
-
Error?: string;
|
|
510
|
+
Error?: string | undefined;
|
|
511
511
|
/**
|
|
512
512
|
* <p>The status of the SQL statement being described. Status values are defined as follows: </p>
|
|
513
513
|
* <ul>
|
|
@@ -535,77 +535,77 @@ export interface DescribeStatementResponse {
|
|
|
535
535
|
* </ul>
|
|
536
536
|
* @public
|
|
537
537
|
*/
|
|
538
|
-
Status?: StatusString;
|
|
538
|
+
Status?: StatusString | undefined;
|
|
539
539
|
/**
|
|
540
540
|
* <p>The date and time (UTC) when the SQL statement was submitted to run. </p>
|
|
541
541
|
* @public
|
|
542
542
|
*/
|
|
543
|
-
CreatedAt?: Date;
|
|
543
|
+
CreatedAt?: Date | undefined;
|
|
544
544
|
/**
|
|
545
545
|
* <p>The date and time (UTC) that the metadata for the SQL statement was last updated. An
|
|
546
546
|
* example is the time the status last changed. </p>
|
|
547
547
|
* @public
|
|
548
548
|
*/
|
|
549
|
-
UpdatedAt?: Date;
|
|
549
|
+
UpdatedAt?: Date | undefined;
|
|
550
550
|
/**
|
|
551
551
|
* <p>The process identifier from Amazon Redshift. </p>
|
|
552
552
|
* @public
|
|
553
553
|
*/
|
|
554
|
-
RedshiftPid?: number;
|
|
554
|
+
RedshiftPid?: number | undefined;
|
|
555
555
|
/**
|
|
556
556
|
* <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.
|
|
557
557
|
* The value is true if any substatement returns a result set.</p>
|
|
558
558
|
* @public
|
|
559
559
|
*/
|
|
560
|
-
HasResultSet?: boolean;
|
|
560
|
+
HasResultSet?: boolean | undefined;
|
|
561
561
|
/**
|
|
562
562
|
* <p>The SQL statement text. </p>
|
|
563
563
|
* @public
|
|
564
564
|
*/
|
|
565
|
-
QueryString?: string;
|
|
565
|
+
QueryString?: string | undefined;
|
|
566
566
|
/**
|
|
567
567
|
* <p>Either the number of rows returned from the SQL statement or the number of rows affected.
|
|
568
568
|
* 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.
|
|
569
569
|
* A <code>-1</code> indicates the value is null.</p>
|
|
570
570
|
* @public
|
|
571
571
|
*/
|
|
572
|
-
ResultRows?: number;
|
|
572
|
+
ResultRows?: number | undefined;
|
|
573
573
|
/**
|
|
574
574
|
* <p>The size in bytes of the returned results. A <code>-1</code> indicates the value is null.</p>
|
|
575
575
|
* @public
|
|
576
576
|
*/
|
|
577
|
-
ResultSize?: number;
|
|
577
|
+
ResultSize?: number | undefined;
|
|
578
578
|
/**
|
|
579
579
|
* <p>The identifier of the query generated by Amazon Redshift.
|
|
580
580
|
* These identifiers are also available in the <code>query</code> column of the <code>STL_QUERY</code> system view. </p>
|
|
581
581
|
* @public
|
|
582
582
|
*/
|
|
583
|
-
RedshiftQueryId?: number;
|
|
583
|
+
RedshiftQueryId?: number | undefined;
|
|
584
584
|
/**
|
|
585
585
|
* <p>The parameters for the SQL statement.</p>
|
|
586
586
|
* @public
|
|
587
587
|
*/
|
|
588
|
-
QueryParameters?: SqlParameter[];
|
|
588
|
+
QueryParameters?: SqlParameter[] | undefined;
|
|
589
589
|
/**
|
|
590
590
|
* <p>The SQL statements from a multiple statement run.</p>
|
|
591
591
|
* @public
|
|
592
592
|
*/
|
|
593
|
-
SubStatements?: SubStatementData[];
|
|
593
|
+
SubStatements?: SubStatementData[] | undefined;
|
|
594
594
|
/**
|
|
595
595
|
* <p>The serverless workgroup name or Amazon Resource Name (ARN).</p>
|
|
596
596
|
* @public
|
|
597
597
|
*/
|
|
598
|
-
WorkgroupName?: string;
|
|
598
|
+
WorkgroupName?: string | undefined;
|
|
599
599
|
/**
|
|
600
600
|
* <p>The session identifier of the query.</p>
|
|
601
601
|
* @public
|
|
602
602
|
*/
|
|
603
|
-
SessionId?: string;
|
|
603
|
+
SessionId?: string | undefined;
|
|
604
604
|
/**
|
|
605
605
|
* <p>The data format of the result of the SQL statement.</p>
|
|
606
606
|
* @public
|
|
607
607
|
*/
|
|
608
|
-
ResultFormat?: ResultFormatString;
|
|
608
|
+
ResultFormat?: ResultFormatString | undefined;
|
|
609
609
|
}
|
|
610
610
|
/**
|
|
611
611
|
* @public
|
|
@@ -615,17 +615,17 @@ export interface DescribeTableRequest {
|
|
|
615
615
|
* <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
|
|
616
616
|
* @public
|
|
617
617
|
*/
|
|
618
|
-
ClusterIdentifier?: string;
|
|
618
|
+
ClusterIdentifier?: string | undefined;
|
|
619
619
|
/**
|
|
620
620
|
* <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
|
|
621
621
|
* @public
|
|
622
622
|
*/
|
|
623
|
-
SecretArn?: string;
|
|
623
|
+
SecretArn?: string | undefined;
|
|
624
624
|
/**
|
|
625
625
|
* <p>The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials. </p>
|
|
626
626
|
* @public
|
|
627
627
|
*/
|
|
628
|
-
DbUser?: string;
|
|
628
|
+
DbUser?: string | undefined;
|
|
629
629
|
/**
|
|
630
630
|
* <p>The name of the database that contains the tables to be described.
|
|
631
631
|
* If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
|
|
@@ -636,34 +636,34 @@ export interface DescribeTableRequest {
|
|
|
636
636
|
* <p>A database name. The connected database is specified when you connect with your authentication credentials. </p>
|
|
637
637
|
* @public
|
|
638
638
|
*/
|
|
639
|
-
ConnectedDatabase?: string;
|
|
639
|
+
ConnectedDatabase?: string | undefined;
|
|
640
640
|
/**
|
|
641
641
|
* <p>The schema that contains the table. If no schema is specified, then matching tables for all schemas are returned. </p>
|
|
642
642
|
* @public
|
|
643
643
|
*/
|
|
644
|
-
Schema?: string;
|
|
644
|
+
Schema?: string | undefined;
|
|
645
645
|
/**
|
|
646
646
|
* <p>The table name. If no table is specified, then all tables for all matching schemas are returned.
|
|
647
647
|
* If no table and no schema is specified, then all tables for all schemas in the database are returned</p>
|
|
648
648
|
* @public
|
|
649
649
|
*/
|
|
650
|
-
Table?: string;
|
|
650
|
+
Table?: string | undefined;
|
|
651
651
|
/**
|
|
652
652
|
* <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>
|
|
653
653
|
* @public
|
|
654
654
|
*/
|
|
655
|
-
NextToken?: string;
|
|
655
|
+
NextToken?: string | undefined;
|
|
656
656
|
/**
|
|
657
657
|
* <p>The maximum number of tables to return in the response.
|
|
658
658
|
* If more tables exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
|
|
659
659
|
* @public
|
|
660
660
|
*/
|
|
661
|
-
MaxResults?: number;
|
|
661
|
+
MaxResults?: number | undefined;
|
|
662
662
|
/**
|
|
663
663
|
* <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>
|
|
664
664
|
* @public
|
|
665
665
|
*/
|
|
666
|
-
WorkgroupName?: string;
|
|
666
|
+
WorkgroupName?: string | undefined;
|
|
667
667
|
}
|
|
668
668
|
/**
|
|
669
669
|
* @public
|
|
@@ -673,17 +673,17 @@ export interface DescribeTableResponse {
|
|
|
673
673
|
* <p>The table name. </p>
|
|
674
674
|
* @public
|
|
675
675
|
*/
|
|
676
|
-
TableName?: string;
|
|
676
|
+
TableName?: string | undefined;
|
|
677
677
|
/**
|
|
678
678
|
* <p>A list of columns in the table. </p>
|
|
679
679
|
* @public
|
|
680
680
|
*/
|
|
681
|
-
ColumnList?: ColumnMetadata[];
|
|
681
|
+
ColumnList?: ColumnMetadata[] | undefined;
|
|
682
682
|
/**
|
|
683
683
|
* <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>
|
|
684
684
|
* @public
|
|
685
685
|
*/
|
|
686
|
-
NextToken?: string;
|
|
686
|
+
NextToken?: string | undefined;
|
|
687
687
|
}
|
|
688
688
|
/**
|
|
689
689
|
* <p>The Amazon Redshift Data API operation failed due to timeout.</p>
|
|
@@ -692,7 +692,7 @@ export interface DescribeTableResponse {
|
|
|
692
692
|
export declare class QueryTimeoutException extends __BaseException {
|
|
693
693
|
readonly name: "QueryTimeoutException";
|
|
694
694
|
readonly $fault: "client";
|
|
695
|
-
Message?: string;
|
|
695
|
+
Message?: string | undefined;
|
|
696
696
|
/**
|
|
697
697
|
* @internal
|
|
698
698
|
*/
|
|
@@ -733,62 +733,62 @@ export interface ExecuteStatementInput {
|
|
|
733
733
|
* <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
|
|
734
734
|
* @public
|
|
735
735
|
*/
|
|
736
|
-
ClusterIdentifier?: string;
|
|
736
|
+
ClusterIdentifier?: string | undefined;
|
|
737
737
|
/**
|
|
738
738
|
* <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
|
|
739
739
|
* @public
|
|
740
740
|
*/
|
|
741
|
-
SecretArn?: string;
|
|
741
|
+
SecretArn?: string | undefined;
|
|
742
742
|
/**
|
|
743
743
|
* <p>The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials. </p>
|
|
744
744
|
* @public
|
|
745
745
|
*/
|
|
746
|
-
DbUser?: string;
|
|
746
|
+
DbUser?: string | undefined;
|
|
747
747
|
/**
|
|
748
748
|
* <p>The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
|
|
749
749
|
* @public
|
|
750
750
|
*/
|
|
751
|
-
Database?: string;
|
|
751
|
+
Database?: string | undefined;
|
|
752
752
|
/**
|
|
753
753
|
* <p>A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs. </p>
|
|
754
754
|
* @public
|
|
755
755
|
*/
|
|
756
|
-
WithEvent?: boolean;
|
|
756
|
+
WithEvent?: boolean | undefined;
|
|
757
757
|
/**
|
|
758
758
|
* <p>The name of the SQL statement. You can name the SQL statement when you create it to identify the query. </p>
|
|
759
759
|
* @public
|
|
760
760
|
*/
|
|
761
|
-
StatementName?: string;
|
|
761
|
+
StatementName?: string | undefined;
|
|
762
762
|
/**
|
|
763
763
|
* <p>The parameters for the SQL statement.</p>
|
|
764
764
|
* @public
|
|
765
765
|
*/
|
|
766
|
-
Parameters?: SqlParameter[];
|
|
766
|
+
Parameters?: SqlParameter[] | undefined;
|
|
767
767
|
/**
|
|
768
768
|
* <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>
|
|
769
769
|
* @public
|
|
770
770
|
*/
|
|
771
|
-
WorkgroupName?: string;
|
|
771
|
+
WorkgroupName?: string | undefined;
|
|
772
772
|
/**
|
|
773
773
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
|
|
774
774
|
* @public
|
|
775
775
|
*/
|
|
776
|
-
ClientToken?: string;
|
|
776
|
+
ClientToken?: string | undefined;
|
|
777
777
|
/**
|
|
778
778
|
* <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>
|
|
779
779
|
* @public
|
|
780
780
|
*/
|
|
781
|
-
SessionKeepAliveSeconds?: number;
|
|
781
|
+
SessionKeepAliveSeconds?: number | undefined;
|
|
782
782
|
/**
|
|
783
783
|
* <p>The session identifier of the query.</p>
|
|
784
784
|
* @public
|
|
785
785
|
*/
|
|
786
|
-
SessionId?: string;
|
|
786
|
+
SessionId?: string | undefined;
|
|
787
787
|
/**
|
|
788
788
|
* <p>The data format of the result of the SQL statement. If no format is specified, the default is JSON.</p>
|
|
789
789
|
* @public
|
|
790
790
|
*/
|
|
791
|
-
ResultFormat?: ResultFormatString;
|
|
791
|
+
ResultFormat?: ResultFormatString | undefined;
|
|
792
792
|
}
|
|
793
793
|
/**
|
|
794
794
|
* @public
|
|
@@ -798,47 +798,47 @@ export interface ExecuteStatementOutput {
|
|
|
798
798
|
* <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>
|
|
799
799
|
* @public
|
|
800
800
|
*/
|
|
801
|
-
Id?: string;
|
|
801
|
+
Id?: string | undefined;
|
|
802
802
|
/**
|
|
803
803
|
* <p>The date and time (UTC) the statement was created. </p>
|
|
804
804
|
* @public
|
|
805
805
|
*/
|
|
806
|
-
CreatedAt?: Date;
|
|
806
|
+
CreatedAt?: Date | undefined;
|
|
807
807
|
/**
|
|
808
808
|
* <p>The cluster identifier. This element is not returned when connecting to a serverless workgroup. </p>
|
|
809
809
|
* @public
|
|
810
810
|
*/
|
|
811
|
-
ClusterIdentifier?: string;
|
|
811
|
+
ClusterIdentifier?: string | undefined;
|
|
812
812
|
/**
|
|
813
813
|
* <p>The database user name.</p>
|
|
814
814
|
* @public
|
|
815
815
|
*/
|
|
816
|
-
DbUser?: string;
|
|
816
|
+
DbUser?: string | undefined;
|
|
817
817
|
/**
|
|
818
818
|
* <p>A list of colon (:) separated names of database groups.</p>
|
|
819
819
|
* @public
|
|
820
820
|
*/
|
|
821
|
-
DbGroups?: string[];
|
|
821
|
+
DbGroups?: string[] | undefined;
|
|
822
822
|
/**
|
|
823
823
|
* <p>The name of the database.</p>
|
|
824
824
|
* @public
|
|
825
825
|
*/
|
|
826
|
-
Database?: string;
|
|
826
|
+
Database?: string | undefined;
|
|
827
827
|
/**
|
|
828
828
|
* <p>The name or ARN of the secret that enables access to the database. </p>
|
|
829
829
|
* @public
|
|
830
830
|
*/
|
|
831
|
-
SecretArn?: string;
|
|
831
|
+
SecretArn?: string | undefined;
|
|
832
832
|
/**
|
|
833
833
|
* <p>The serverless workgroup name or Amazon Resource Name (ARN). This element is not returned when connecting to a provisioned cluster.</p>
|
|
834
834
|
* @public
|
|
835
835
|
*/
|
|
836
|
-
WorkgroupName?: string;
|
|
836
|
+
WorkgroupName?: string | undefined;
|
|
837
837
|
/**
|
|
838
838
|
* <p>The session identifier of the query.</p>
|
|
839
839
|
* @public
|
|
840
840
|
*/
|
|
841
|
-
SessionId?: string;
|
|
841
|
+
SessionId?: string | undefined;
|
|
842
842
|
}
|
|
843
843
|
/**
|
|
844
844
|
* <p>A data value in a column. </p>
|
|
@@ -996,7 +996,7 @@ export interface GetStatementResultRequest {
|
|
|
996
996
|
* <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>
|
|
997
997
|
* @public
|
|
998
998
|
*/
|
|
999
|
-
NextToken?: string;
|
|
999
|
+
NextToken?: string | undefined;
|
|
1000
1000
|
}
|
|
1001
1001
|
/**
|
|
1002
1002
|
* @public
|
|
@@ -1011,18 +1011,18 @@ export interface GetStatementResultResponse {
|
|
|
1011
1011
|
* <p>The properties (metadata) of a column. </p>
|
|
1012
1012
|
* @public
|
|
1013
1013
|
*/
|
|
1014
|
-
ColumnMetadata?: ColumnMetadata[];
|
|
1014
|
+
ColumnMetadata?: ColumnMetadata[] | undefined;
|
|
1015
1015
|
/**
|
|
1016
1016
|
* <p>The total number of rows in the result set returned from a query.
|
|
1017
1017
|
* You can use this number to estimate the number of calls to the <code>GetStatementResult</code> operation needed to page through the results. </p>
|
|
1018
1018
|
* @public
|
|
1019
1019
|
*/
|
|
1020
|
-
TotalNumRows?: number;
|
|
1020
|
+
TotalNumRows?: number | undefined;
|
|
1021
1021
|
/**
|
|
1022
1022
|
* <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>
|
|
1023
1023
|
* @public
|
|
1024
1024
|
*/
|
|
1025
|
-
NextToken?: string;
|
|
1025
|
+
NextToken?: string | undefined;
|
|
1026
1026
|
}
|
|
1027
1027
|
/**
|
|
1028
1028
|
* @public
|
|
@@ -1040,7 +1040,7 @@ export interface GetStatementResultV2Request {
|
|
|
1040
1040
|
* <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>
|
|
1041
1041
|
* @public
|
|
1042
1042
|
*/
|
|
1043
|
-
NextToken?: string;
|
|
1043
|
+
NextToken?: string | undefined;
|
|
1044
1044
|
}
|
|
1045
1045
|
/**
|
|
1046
1046
|
* @public
|
|
@@ -1055,23 +1055,23 @@ export interface GetStatementResultV2Response {
|
|
|
1055
1055
|
* <p>The properties (metadata) of a column.</p>
|
|
1056
1056
|
* @public
|
|
1057
1057
|
*/
|
|
1058
|
-
ColumnMetadata?: ColumnMetadata[];
|
|
1058
|
+
ColumnMetadata?: ColumnMetadata[] | undefined;
|
|
1059
1059
|
/**
|
|
1060
1060
|
* <p>The total number of rows in the result set returned from a query.
|
|
1061
1061
|
* You can use this number to estimate the number of calls to the <code>GetStatementResultV2</code> operation needed to page through the results. </p>
|
|
1062
1062
|
* @public
|
|
1063
1063
|
*/
|
|
1064
|
-
TotalNumRows?: number;
|
|
1064
|
+
TotalNumRows?: number | undefined;
|
|
1065
1065
|
/**
|
|
1066
1066
|
* <p>The data format of the result of the SQL statement.</p>
|
|
1067
1067
|
* @public
|
|
1068
1068
|
*/
|
|
1069
|
-
ResultFormat?: ResultFormatString;
|
|
1069
|
+
ResultFormat?: ResultFormatString | undefined;
|
|
1070
1070
|
/**
|
|
1071
1071
|
* <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>
|
|
1072
1072
|
* @public
|
|
1073
1073
|
*/
|
|
1074
|
-
NextToken?: string;
|
|
1074
|
+
NextToken?: string | undefined;
|
|
1075
1075
|
}
|
|
1076
1076
|
/**
|
|
1077
1077
|
* @public
|
|
@@ -1081,7 +1081,7 @@ export interface ListDatabasesRequest {
|
|
|
1081
1081
|
* <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
|
|
1082
1082
|
* @public
|
|
1083
1083
|
*/
|
|
1084
|
-
ClusterIdentifier?: string;
|
|
1084
|
+
ClusterIdentifier?: string | undefined;
|
|
1085
1085
|
/**
|
|
1086
1086
|
* <p>The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
|
|
1087
1087
|
* @public
|
|
@@ -1091,28 +1091,28 @@ export interface ListDatabasesRequest {
|
|
|
1091
1091
|
* <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
|
|
1092
1092
|
* @public
|
|
1093
1093
|
*/
|
|
1094
|
-
SecretArn?: string;
|
|
1094
|
+
SecretArn?: string | undefined;
|
|
1095
1095
|
/**
|
|
1096
1096
|
* <p>The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials. </p>
|
|
1097
1097
|
* @public
|
|
1098
1098
|
*/
|
|
1099
|
-
DbUser?: string;
|
|
1099
|
+
DbUser?: string | undefined;
|
|
1100
1100
|
/**
|
|
1101
1101
|
* <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>
|
|
1102
1102
|
* @public
|
|
1103
1103
|
*/
|
|
1104
|
-
NextToken?: string;
|
|
1104
|
+
NextToken?: string | undefined;
|
|
1105
1105
|
/**
|
|
1106
1106
|
* <p>The maximum number of databases to return in the response.
|
|
1107
1107
|
* If more databases exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
|
|
1108
1108
|
* @public
|
|
1109
1109
|
*/
|
|
1110
|
-
MaxResults?: number;
|
|
1110
|
+
MaxResults?: number | undefined;
|
|
1111
1111
|
/**
|
|
1112
1112
|
* <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>
|
|
1113
1113
|
* @public
|
|
1114
1114
|
*/
|
|
1115
|
-
WorkgroupName?: string;
|
|
1115
|
+
WorkgroupName?: string | undefined;
|
|
1116
1116
|
}
|
|
1117
1117
|
/**
|
|
1118
1118
|
* @public
|
|
@@ -1122,12 +1122,12 @@ export interface ListDatabasesResponse {
|
|
|
1122
1122
|
* <p>The names of databases. </p>
|
|
1123
1123
|
* @public
|
|
1124
1124
|
*/
|
|
1125
|
-
Databases?: string[];
|
|
1125
|
+
Databases?: string[] | undefined;
|
|
1126
1126
|
/**
|
|
1127
1127
|
* <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>
|
|
1128
1128
|
* @public
|
|
1129
1129
|
*/
|
|
1130
|
-
NextToken?: string;
|
|
1130
|
+
NextToken?: string | undefined;
|
|
1131
1131
|
}
|
|
1132
1132
|
/**
|
|
1133
1133
|
* @public
|
|
@@ -1137,17 +1137,17 @@ export interface ListSchemasRequest {
|
|
|
1137
1137
|
* <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
|
|
1138
1138
|
* @public
|
|
1139
1139
|
*/
|
|
1140
|
-
ClusterIdentifier?: string;
|
|
1140
|
+
ClusterIdentifier?: string | undefined;
|
|
1141
1141
|
/**
|
|
1142
1142
|
* <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
|
|
1143
1143
|
* @public
|
|
1144
1144
|
*/
|
|
1145
|
-
SecretArn?: string;
|
|
1145
|
+
SecretArn?: string | undefined;
|
|
1146
1146
|
/**
|
|
1147
1147
|
* <p>The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials. </p>
|
|
1148
1148
|
* @public
|
|
1149
1149
|
*/
|
|
1150
|
-
DbUser?: string;
|
|
1150
|
+
DbUser?: string | undefined;
|
|
1151
1151
|
/**
|
|
1152
1152
|
* <p>The name of the database that contains the schemas to list.
|
|
1153
1153
|
* If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
|
|
@@ -1158,30 +1158,30 @@ export interface ListSchemasRequest {
|
|
|
1158
1158
|
* <p>A database name. The connected database is specified when you connect with your authentication credentials. </p>
|
|
1159
1159
|
* @public
|
|
1160
1160
|
*/
|
|
1161
|
-
ConnectedDatabase?: string;
|
|
1161
|
+
ConnectedDatabase?: string | undefined;
|
|
1162
1162
|
/**
|
|
1163
1163
|
* <p>A pattern to filter results by schema name. Within a schema pattern, "%" means match any
|
|
1164
1164
|
* substring of 0 or more characters and "_" means match any one character. Only schema name
|
|
1165
1165
|
* entries matching the search pattern are returned. </p>
|
|
1166
1166
|
* @public
|
|
1167
1167
|
*/
|
|
1168
|
-
SchemaPattern?: string;
|
|
1168
|
+
SchemaPattern?: string | undefined;
|
|
1169
1169
|
/**
|
|
1170
1170
|
* <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>
|
|
1171
1171
|
* @public
|
|
1172
1172
|
*/
|
|
1173
|
-
NextToken?: string;
|
|
1173
|
+
NextToken?: string | undefined;
|
|
1174
1174
|
/**
|
|
1175
1175
|
* <p>The maximum number of schemas to return in the response.
|
|
1176
1176
|
* If more schemas exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
|
|
1177
1177
|
* @public
|
|
1178
1178
|
*/
|
|
1179
|
-
MaxResults?: number;
|
|
1179
|
+
MaxResults?: number | undefined;
|
|
1180
1180
|
/**
|
|
1181
1181
|
* <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>
|
|
1182
1182
|
* @public
|
|
1183
1183
|
*/
|
|
1184
|
-
WorkgroupName?: string;
|
|
1184
|
+
WorkgroupName?: string | undefined;
|
|
1185
1185
|
}
|
|
1186
1186
|
/**
|
|
1187
1187
|
* @public
|
|
@@ -1191,12 +1191,12 @@ export interface ListSchemasResponse {
|
|
|
1191
1191
|
* <p>The schemas that match the request pattern. </p>
|
|
1192
1192
|
* @public
|
|
1193
1193
|
*/
|
|
1194
|
-
Schemas?: string[];
|
|
1194
|
+
Schemas?: string[] | undefined;
|
|
1195
1195
|
/**
|
|
1196
1196
|
* <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>
|
|
1197
1197
|
* @public
|
|
1198
1198
|
*/
|
|
1199
|
-
NextToken?: string;
|
|
1199
|
+
NextToken?: string | undefined;
|
|
1200
1200
|
}
|
|
1201
1201
|
/**
|
|
1202
1202
|
* @public
|
|
@@ -1206,13 +1206,13 @@ export interface ListStatementsRequest {
|
|
|
1206
1206
|
* <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>
|
|
1207
1207
|
* @public
|
|
1208
1208
|
*/
|
|
1209
|
-
NextToken?: string;
|
|
1209
|
+
NextToken?: string | undefined;
|
|
1210
1210
|
/**
|
|
1211
1211
|
* <p>The maximum number of SQL statements to return in the response.
|
|
1212
1212
|
* If more SQL statements exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
|
|
1213
1213
|
* @public
|
|
1214
1214
|
*/
|
|
1215
|
-
MaxResults?: number;
|
|
1215
|
+
MaxResults?: number | undefined;
|
|
1216
1216
|
/**
|
|
1217
1217
|
* <p>The name of the SQL statement specified as input to <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> to identify the query.
|
|
1218
1218
|
* You can list multiple statements by providing a prefix that matches the beginning of the statement name.
|
|
@@ -1220,7 +1220,7 @@ export interface ListStatementsRequest {
|
|
|
1220
1220
|
* Data API does a case-sensitive match of SQL statement names to the prefix value you provide. </p>
|
|
1221
1221
|
* @public
|
|
1222
1222
|
*/
|
|
1223
|
-
StatementName?: string;
|
|
1223
|
+
StatementName?: string | undefined;
|
|
1224
1224
|
/**
|
|
1225
1225
|
* <p>The status of the SQL statement to list. Status values are defined as follows: </p>
|
|
1226
1226
|
* <ul>
|
|
@@ -1248,13 +1248,13 @@ export interface ListStatementsRequest {
|
|
|
1248
1248
|
* </ul>
|
|
1249
1249
|
* @public
|
|
1250
1250
|
*/
|
|
1251
|
-
Status?: StatusString;
|
|
1251
|
+
Status?: StatusString | undefined;
|
|
1252
1252
|
/**
|
|
1253
1253
|
* <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.
|
|
1254
1254
|
* If false, only statements run by the caller's IAM role in the current IAM session are returned. The default is true. </p>
|
|
1255
1255
|
* @public
|
|
1256
1256
|
*/
|
|
1257
|
-
RoleLevel?: boolean;
|
|
1257
|
+
RoleLevel?: boolean | undefined;
|
|
1258
1258
|
}
|
|
1259
1259
|
/**
|
|
1260
1260
|
* <p>The SQL statement to run.</p>
|
|
@@ -1270,59 +1270,59 @@ export interface StatementData {
|
|
|
1270
1270
|
* <p>The SQL statement.</p>
|
|
1271
1271
|
* @public
|
|
1272
1272
|
*/
|
|
1273
|
-
QueryString?: string;
|
|
1273
|
+
QueryString?: string | undefined;
|
|
1274
1274
|
/**
|
|
1275
1275
|
* <p>One or more SQL statements. Each query string in the array corresponds to one of the queries in a batch query request.</p>
|
|
1276
1276
|
* @public
|
|
1277
1277
|
*/
|
|
1278
|
-
QueryStrings?: string[];
|
|
1278
|
+
QueryStrings?: string[] | undefined;
|
|
1279
1279
|
/**
|
|
1280
1280
|
* <p>The name or Amazon Resource Name (ARN) of the secret that enables access to the database. </p>
|
|
1281
1281
|
* @public
|
|
1282
1282
|
*/
|
|
1283
|
-
SecretArn?: string;
|
|
1283
|
+
SecretArn?: string | undefined;
|
|
1284
1284
|
/**
|
|
1285
1285
|
* <p>The status of the SQL statement. An
|
|
1286
1286
|
* example is the that the SQL statement finished.
|
|
1287
1287
|
* </p>
|
|
1288
1288
|
* @public
|
|
1289
1289
|
*/
|
|
1290
|
-
Status?: StatusString;
|
|
1290
|
+
Status?: StatusString | undefined;
|
|
1291
1291
|
/**
|
|
1292
1292
|
* <p>The name of the SQL statement. </p>
|
|
1293
1293
|
* @public
|
|
1294
1294
|
*/
|
|
1295
|
-
StatementName?: string;
|
|
1295
|
+
StatementName?: string | undefined;
|
|
1296
1296
|
/**
|
|
1297
1297
|
* <p>The date and time (UTC) the statement was created. </p>
|
|
1298
1298
|
* @public
|
|
1299
1299
|
*/
|
|
1300
|
-
CreatedAt?: Date;
|
|
1300
|
+
CreatedAt?: Date | undefined;
|
|
1301
1301
|
/**
|
|
1302
1302
|
* <p>The date and time (UTC) that the statement metadata was last updated.</p>
|
|
1303
1303
|
* @public
|
|
1304
1304
|
*/
|
|
1305
|
-
UpdatedAt?: Date;
|
|
1305
|
+
UpdatedAt?: Date | undefined;
|
|
1306
1306
|
/**
|
|
1307
1307
|
* <p>The parameters used in a SQL statement.</p>
|
|
1308
1308
|
* @public
|
|
1309
1309
|
*/
|
|
1310
|
-
QueryParameters?: SqlParameter[];
|
|
1310
|
+
QueryParameters?: SqlParameter[] | undefined;
|
|
1311
1311
|
/**
|
|
1312
1312
|
* <p>A value that indicates whether the statement is a batch query request.</p>
|
|
1313
1313
|
* @public
|
|
1314
1314
|
*/
|
|
1315
|
-
IsBatchStatement?: boolean;
|
|
1315
|
+
IsBatchStatement?: boolean | undefined;
|
|
1316
1316
|
/**
|
|
1317
1317
|
* <p>The session identifier of the query.</p>
|
|
1318
1318
|
* @public
|
|
1319
1319
|
*/
|
|
1320
|
-
SessionId?: string;
|
|
1320
|
+
SessionId?: string | undefined;
|
|
1321
1321
|
/**
|
|
1322
1322
|
* <p>The data format of the result of the SQL statement.</p>
|
|
1323
1323
|
* @public
|
|
1324
1324
|
*/
|
|
1325
|
-
ResultFormat?: ResultFormatString;
|
|
1325
|
+
ResultFormat?: ResultFormatString | undefined;
|
|
1326
1326
|
}
|
|
1327
1327
|
/**
|
|
1328
1328
|
* @public
|
|
@@ -1337,7 +1337,7 @@ export interface ListStatementsResponse {
|
|
|
1337
1337
|
* <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>
|
|
1338
1338
|
* @public
|
|
1339
1339
|
*/
|
|
1340
|
-
NextToken?: string;
|
|
1340
|
+
NextToken?: string | undefined;
|
|
1341
1341
|
}
|
|
1342
1342
|
/**
|
|
1343
1343
|
* @public
|
|
@@ -1347,17 +1347,17 @@ export interface ListTablesRequest {
|
|
|
1347
1347
|
* <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
|
|
1348
1348
|
* @public
|
|
1349
1349
|
*/
|
|
1350
|
-
ClusterIdentifier?: string;
|
|
1350
|
+
ClusterIdentifier?: string | undefined;
|
|
1351
1351
|
/**
|
|
1352
1352
|
* <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
|
|
1353
1353
|
* @public
|
|
1354
1354
|
*/
|
|
1355
|
-
SecretArn?: string;
|
|
1355
|
+
SecretArn?: string | undefined;
|
|
1356
1356
|
/**
|
|
1357
1357
|
* <p>The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials. </p>
|
|
1358
1358
|
* @public
|
|
1359
1359
|
*/
|
|
1360
|
-
DbUser?: string;
|
|
1360
|
+
DbUser?: string | undefined;
|
|
1361
1361
|
/**
|
|
1362
1362
|
* <p>The name of the database that contains the tables to list.
|
|
1363
1363
|
* If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
|
|
@@ -1368,7 +1368,7 @@ export interface ListTablesRequest {
|
|
|
1368
1368
|
* <p>A database name. The connected database is specified when you connect with your authentication credentials. </p>
|
|
1369
1369
|
* @public
|
|
1370
1370
|
*/
|
|
1371
|
-
ConnectedDatabase?: string;
|
|
1371
|
+
ConnectedDatabase?: string | undefined;
|
|
1372
1372
|
/**
|
|
1373
1373
|
* <p>A pattern to filter results by schema name. Within a schema pattern, "%" means match any
|
|
1374
1374
|
* substring of 0 or more characters and "_" means match any one character. Only schema name
|
|
@@ -1377,7 +1377,7 @@ export interface ListTablesRequest {
|
|
|
1377
1377
|
* If neither <code>SchemaPattern</code> or <code>TablePattern</code> are specified, then all tables are returned. </p>
|
|
1378
1378
|
* @public
|
|
1379
1379
|
*/
|
|
1380
|
-
SchemaPattern?: string;
|
|
1380
|
+
SchemaPattern?: string | undefined;
|
|
1381
1381
|
/**
|
|
1382
1382
|
* <p>A pattern to filter results by table name. Within a table pattern, "%" means match any
|
|
1383
1383
|
* substring of 0 or more characters and "_" means match any one character. Only table name
|
|
@@ -1386,23 +1386,23 @@ export interface ListTablesRequest {
|
|
|
1386
1386
|
* If neither <code>SchemaPattern</code> or <code>TablePattern</code> are specified, then all tables are returned. </p>
|
|
1387
1387
|
* @public
|
|
1388
1388
|
*/
|
|
1389
|
-
TablePattern?: string;
|
|
1389
|
+
TablePattern?: string | undefined;
|
|
1390
1390
|
/**
|
|
1391
1391
|
* <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>
|
|
1392
1392
|
* @public
|
|
1393
1393
|
*/
|
|
1394
|
-
NextToken?: string;
|
|
1394
|
+
NextToken?: string | undefined;
|
|
1395
1395
|
/**
|
|
1396
1396
|
* <p>The maximum number of tables to return in the response.
|
|
1397
1397
|
* If more tables exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
|
|
1398
1398
|
* @public
|
|
1399
1399
|
*/
|
|
1400
|
-
MaxResults?: number;
|
|
1400
|
+
MaxResults?: number | undefined;
|
|
1401
1401
|
/**
|
|
1402
1402
|
* <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>
|
|
1403
1403
|
* @public
|
|
1404
1404
|
*/
|
|
1405
|
-
WorkgroupName?: string;
|
|
1405
|
+
WorkgroupName?: string | undefined;
|
|
1406
1406
|
}
|
|
1407
1407
|
/**
|
|
1408
1408
|
* <p>The properties of a table. </p>
|
|
@@ -1413,18 +1413,18 @@ export interface TableMember {
|
|
|
1413
1413
|
* <p>The name of the table. </p>
|
|
1414
1414
|
* @public
|
|
1415
1415
|
*/
|
|
1416
|
-
name?: string;
|
|
1416
|
+
name?: string | undefined;
|
|
1417
1417
|
/**
|
|
1418
1418
|
* <p>The type of the table. Possible values include TABLE, VIEW, SYSTEM TABLE, GLOBAL
|
|
1419
1419
|
* TEMPORARY, LOCAL TEMPORARY, ALIAS, and SYNONYM. </p>
|
|
1420
1420
|
* @public
|
|
1421
1421
|
*/
|
|
1422
|
-
type?: string;
|
|
1422
|
+
type?: string | undefined;
|
|
1423
1423
|
/**
|
|
1424
1424
|
* <p>The schema containing the table. </p>
|
|
1425
1425
|
* @public
|
|
1426
1426
|
*/
|
|
1427
|
-
schema?: string;
|
|
1427
|
+
schema?: string | undefined;
|
|
1428
1428
|
}
|
|
1429
1429
|
/**
|
|
1430
1430
|
* @public
|
|
@@ -1434,10 +1434,10 @@ export interface ListTablesResponse {
|
|
|
1434
1434
|
* <p>The tables that match the request pattern. </p>
|
|
1435
1435
|
* @public
|
|
1436
1436
|
*/
|
|
1437
|
-
Tables?: TableMember[];
|
|
1437
|
+
Tables?: TableMember[] | undefined;
|
|
1438
1438
|
/**
|
|
1439
1439
|
* <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>
|
|
1440
1440
|
* @public
|
|
1441
1441
|
*/
|
|
1442
|
-
NextToken?: string;
|
|
1442
|
+
NextToken?: string | undefined;
|
|
1443
1443
|
}
|