@aws-sdk/client-redshift-data 3.36.0 → 3.36.1
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/CHANGELOG.md +11 -0
- package/dist-cjs/RedshiftData.js +0 -7
- package/dist-cjs/RedshiftDataClient.js +0 -12
- package/dist-cjs/commands/BatchExecuteStatementCommand.js +0 -38
- package/dist-cjs/commands/CancelStatementCommand.js +0 -24
- package/dist-cjs/commands/DescribeStatementCommand.js +0 -26
- package/dist-cjs/commands/DescribeTableCommand.js +0 -39
- package/dist-cjs/commands/ExecuteStatementCommand.js +0 -38
- package/dist-cjs/commands/GetStatementResultCommand.js +0 -25
- package/dist-cjs/commands/ListDatabasesCommand.js +0 -38
- package/dist-cjs/commands/ListSchemasCommand.js +0 -38
- package/dist-cjs/commands/ListStatementsCommand.js +0 -25
- package/dist-cjs/commands/ListTablesCommand.js +0 -39
- package/dist-cjs/models/models_0.js +0 -96
- package/dist-cjs/pagination/DescribeTablePaginator.js +0 -10
- package/dist-cjs/pagination/GetStatementResultPaginator.js +0 -10
- package/dist-cjs/pagination/ListDatabasesPaginator.js +0 -10
- package/dist-cjs/pagination/ListSchemasPaginator.js +0 -10
- package/dist-cjs/pagination/ListStatementsPaginator.js +0 -10
- package/dist-cjs/pagination/ListTablesPaginator.js +0 -10
- package/dist-cjs/protocols/Aws_json1_1.js +0 -5
- package/dist-cjs/runtimeConfig.browser.js +1 -5
- package/dist-cjs/runtimeConfig.js +1 -5
- package/dist-cjs/runtimeConfig.native.js +0 -3
- package/dist-cjs/runtimeConfig.shared.js +0 -3
- package/dist-types/ts3.4/RedshiftData.d.ts +11 -127
- package/dist-types/ts3.4/RedshiftDataClient.d.ts +24 -93
- package/dist-types/ts3.4/commands/BatchExecuteStatementCommand.d.ts +2 -34
- package/dist-types/ts3.4/commands/CancelStatementCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/DescribeStatementCommand.d.ts +2 -22
- package/dist-types/ts3.4/commands/DescribeTableCommand.d.ts +2 -35
- package/dist-types/ts3.4/commands/ExecuteStatementCommand.d.ts +2 -34
- package/dist-types/ts3.4/commands/GetStatementResultCommand.d.ts +2 -21
- package/dist-types/ts3.4/commands/ListDatabasesCommand.d.ts +2 -34
- package/dist-types/ts3.4/commands/ListSchemasCommand.d.ts +2 -34
- package/dist-types/ts3.4/commands/ListStatementsCommand.d.ts +2 -21
- package/dist-types/ts3.4/commands/ListTablesCommand.d.ts +2 -35
- package/dist-types/ts3.4/models/models_0.d.ts +198 -688
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
- package/package.json +3 -3
|
@@ -1,283 +1,165 @@
|
|
|
1
1
|
import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
|
|
2
|
-
|
|
3
|
-
* <p>The number of active statements exceeds the limit.</p>
|
|
4
|
-
*/
|
|
2
|
+
|
|
5
3
|
export interface ActiveStatementsExceededException extends __SmithyException, $MetadataBearer {
|
|
6
4
|
name: "ActiveStatementsExceededException";
|
|
7
5
|
$fault: "client";
|
|
8
6
|
Message?: string;
|
|
9
7
|
}
|
|
10
8
|
export declare namespace ActiveStatementsExceededException {
|
|
11
|
-
|
|
12
|
-
* @internal
|
|
13
|
-
*/
|
|
9
|
+
|
|
14
10
|
const filterSensitiveLog: (obj: ActiveStatementsExceededException) => any;
|
|
15
11
|
}
|
|
16
|
-
|
|
17
|
-
* <p>An SQL statement encountered an environmental error while running.</p>
|
|
18
|
-
*/
|
|
12
|
+
|
|
19
13
|
export interface BatchExecuteStatementException extends __SmithyException, $MetadataBearer {
|
|
20
14
|
name: "BatchExecuteStatementException";
|
|
21
15
|
$fault: "server";
|
|
22
16
|
Message: string | undefined;
|
|
23
|
-
|
|
24
|
-
* <p>Statement identifier of the exception.</p>
|
|
25
|
-
*/
|
|
17
|
+
|
|
26
18
|
StatementId: string | undefined;
|
|
27
19
|
}
|
|
28
20
|
export declare namespace BatchExecuteStatementException {
|
|
29
|
-
|
|
30
|
-
* @internal
|
|
31
|
-
*/
|
|
21
|
+
|
|
32
22
|
const filterSensitiveLog: (obj: BatchExecuteStatementException) => any;
|
|
33
23
|
}
|
|
34
24
|
export interface BatchExecuteStatementInput {
|
|
35
|
-
|
|
36
|
-
* <p>One or more SQL statements to run. </p>
|
|
37
|
-
*/
|
|
25
|
+
|
|
38
26
|
Sqls: string[] | undefined;
|
|
39
|
-
|
|
40
|
-
* <p>The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
|
|
41
|
-
*/
|
|
27
|
+
|
|
42
28
|
ClusterIdentifier: string | undefined;
|
|
43
|
-
|
|
44
|
-
* <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
|
|
45
|
-
*/
|
|
29
|
+
|
|
46
30
|
SecretArn?: string;
|
|
47
|
-
|
|
48
|
-
* <p>The database user name. This parameter is required when authenticating using temporary credentials. </p>
|
|
49
|
-
*/
|
|
31
|
+
|
|
50
32
|
DbUser?: string;
|
|
51
|
-
|
|
52
|
-
* <p>The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
|
|
53
|
-
*/
|
|
33
|
+
|
|
54
34
|
Database: string | undefined;
|
|
55
|
-
|
|
56
|
-
* <p>A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statements run. </p>
|
|
57
|
-
*/
|
|
35
|
+
|
|
58
36
|
WithEvent?: boolean;
|
|
59
|
-
|
|
60
|
-
* <p>The name of the SQL statements. You can name the SQL statements when you create them to identify the query. </p>
|
|
61
|
-
*/
|
|
37
|
+
|
|
62
38
|
StatementName?: string;
|
|
63
39
|
}
|
|
64
40
|
export declare namespace BatchExecuteStatementInput {
|
|
65
|
-
|
|
66
|
-
* @internal
|
|
67
|
-
*/
|
|
41
|
+
|
|
68
42
|
const filterSensitiveLog: (obj: BatchExecuteStatementInput) => any;
|
|
69
43
|
}
|
|
70
44
|
export interface BatchExecuteStatementOutput {
|
|
71
|
-
|
|
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.
|
|
73
|
-
* This identifier is returned by <code>BatchExecuteStatment</code>. </p>
|
|
74
|
-
*/
|
|
45
|
+
|
|
75
46
|
Id?: string;
|
|
76
|
-
|
|
77
|
-
* <p>The date and time (UTC) the statement was created. </p>
|
|
78
|
-
*/
|
|
47
|
+
|
|
79
48
|
CreatedAt?: Date;
|
|
80
|
-
|
|
81
|
-
* <p>The cluster identifier. </p>
|
|
82
|
-
*/
|
|
49
|
+
|
|
83
50
|
ClusterIdentifier?: string;
|
|
84
|
-
|
|
85
|
-
* <p>The database user name.</p>
|
|
86
|
-
*/
|
|
51
|
+
|
|
87
52
|
DbUser?: string;
|
|
88
|
-
|
|
89
|
-
* <p>The name of the database.</p>
|
|
90
|
-
*/
|
|
53
|
+
|
|
91
54
|
Database?: string;
|
|
92
|
-
|
|
93
|
-
* <p>The name or ARN of the secret that enables access to the database. </p>
|
|
94
|
-
*/
|
|
55
|
+
|
|
95
56
|
SecretArn?: string;
|
|
96
57
|
}
|
|
97
58
|
export declare namespace BatchExecuteStatementOutput {
|
|
98
|
-
|
|
99
|
-
* @internal
|
|
100
|
-
*/
|
|
59
|
+
|
|
101
60
|
const filterSensitiveLog: (obj: BatchExecuteStatementOutput) => any;
|
|
102
61
|
}
|
|
103
|
-
|
|
104
|
-
* <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
|
|
105
|
-
*/
|
|
62
|
+
|
|
106
63
|
export interface ValidationException extends __SmithyException, $MetadataBearer {
|
|
107
64
|
name: "ValidationException";
|
|
108
65
|
$fault: "client";
|
|
109
|
-
|
|
110
|
-
* <p>The exception message.</p>
|
|
111
|
-
*/
|
|
66
|
+
|
|
112
67
|
Message?: string;
|
|
113
68
|
}
|
|
114
69
|
export declare namespace ValidationException {
|
|
115
|
-
|
|
116
|
-
* @internal
|
|
117
|
-
*/
|
|
70
|
+
|
|
118
71
|
const filterSensitiveLog: (obj: ValidationException) => any;
|
|
119
72
|
}
|
|
120
73
|
export interface CancelStatementRequest {
|
|
121
|
-
|
|
122
|
-
* <p>The identifier of the SQL statement to cancel. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
|
|
123
|
-
* This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatment</code>, and <code>ListStatements</code>. </p>
|
|
124
|
-
*/
|
|
74
|
+
|
|
125
75
|
Id: string | undefined;
|
|
126
76
|
}
|
|
127
77
|
export declare namespace CancelStatementRequest {
|
|
128
|
-
|
|
129
|
-
* @internal
|
|
130
|
-
*/
|
|
78
|
+
|
|
131
79
|
const filterSensitiveLog: (obj: CancelStatementRequest) => any;
|
|
132
80
|
}
|
|
133
81
|
export interface CancelStatementResponse {
|
|
134
|
-
|
|
135
|
-
* <p>A value that indicates whether the cancel statement succeeded (true). </p>
|
|
136
|
-
*/
|
|
82
|
+
|
|
137
83
|
Status?: boolean;
|
|
138
84
|
}
|
|
139
85
|
export declare namespace CancelStatementResponse {
|
|
140
|
-
|
|
141
|
-
* @internal
|
|
142
|
-
*/
|
|
86
|
+
|
|
143
87
|
const filterSensitiveLog: (obj: CancelStatementResponse) => any;
|
|
144
88
|
}
|
|
145
|
-
|
|
146
|
-
* <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
|
|
147
|
-
*/
|
|
89
|
+
|
|
148
90
|
export interface InternalServerException extends __SmithyException, $MetadataBearer {
|
|
149
91
|
name: "InternalServerException";
|
|
150
92
|
$fault: "server";
|
|
151
|
-
|
|
152
|
-
* <p>The exception message.</p>
|
|
153
|
-
*/
|
|
93
|
+
|
|
154
94
|
Message: string | undefined;
|
|
155
95
|
}
|
|
156
96
|
export declare namespace InternalServerException {
|
|
157
|
-
|
|
158
|
-
* @internal
|
|
159
|
-
*/
|
|
97
|
+
|
|
160
98
|
const filterSensitiveLog: (obj: InternalServerException) => any;
|
|
161
99
|
}
|
|
162
|
-
|
|
163
|
-
* <p>The Amazon Redshift Data API operation failed due to a missing resource. </p>
|
|
164
|
-
*/
|
|
100
|
+
|
|
165
101
|
export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
|
|
166
102
|
name: "ResourceNotFoundException";
|
|
167
103
|
$fault: "client";
|
|
168
|
-
|
|
169
|
-
* <p>The exception message.</p>
|
|
170
|
-
*/
|
|
104
|
+
|
|
171
105
|
Message: string | undefined;
|
|
172
|
-
|
|
173
|
-
* <p>Resource identifier associated with the exception.</p>
|
|
174
|
-
*/
|
|
106
|
+
|
|
175
107
|
ResourceId: string | undefined;
|
|
176
108
|
}
|
|
177
109
|
export declare namespace ResourceNotFoundException {
|
|
178
|
-
|
|
179
|
-
* @internal
|
|
180
|
-
*/
|
|
110
|
+
|
|
181
111
|
const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
|
|
182
112
|
}
|
|
183
|
-
|
|
184
|
-
* <p>The properties (metadata) of a column. </p>
|
|
185
|
-
*/
|
|
113
|
+
|
|
186
114
|
export interface ColumnMetadata {
|
|
187
|
-
|
|
188
|
-
* <p>A value that indicates whether the column is case-sensitive. </p>
|
|
189
|
-
*/
|
|
115
|
+
|
|
190
116
|
isCaseSensitive?: boolean;
|
|
191
|
-
|
|
192
|
-
* <p>A value that indicates whether the column contains currency values.</p>
|
|
193
|
-
*/
|
|
117
|
+
|
|
194
118
|
isCurrency?: boolean;
|
|
195
|
-
|
|
196
|
-
* <p>A value that indicates whether an integer column is signed.</p>
|
|
197
|
-
*/
|
|
119
|
+
|
|
198
120
|
isSigned?: boolean;
|
|
199
|
-
|
|
200
|
-
* <p>The label for the column. </p>
|
|
201
|
-
*/
|
|
121
|
+
|
|
202
122
|
label?: string;
|
|
203
|
-
|
|
204
|
-
* <p>The name of the column. </p>
|
|
205
|
-
*/
|
|
123
|
+
|
|
206
124
|
name?: string;
|
|
207
|
-
|
|
208
|
-
* <p>A value that indicates whether the column is nullable. </p>
|
|
209
|
-
*/
|
|
125
|
+
|
|
210
126
|
nullable?: number;
|
|
211
|
-
|
|
212
|
-
* <p>The precision value of a decimal number column. </p>
|
|
213
|
-
*/
|
|
127
|
+
|
|
214
128
|
precision?: number;
|
|
215
|
-
|
|
216
|
-
* <p>The scale value of a decimal number column. </p>
|
|
217
|
-
*/
|
|
129
|
+
|
|
218
130
|
scale?: number;
|
|
219
|
-
|
|
220
|
-
* <p>The name of the schema that contains the table that includes the column.</p>
|
|
221
|
-
*/
|
|
131
|
+
|
|
222
132
|
schemaName?: string;
|
|
223
|
-
|
|
224
|
-
* <p>The name of the table that includes the column. </p>
|
|
225
|
-
*/
|
|
133
|
+
|
|
226
134
|
tableName?: string;
|
|
227
|
-
|
|
228
|
-
* <p>The database-specific data type of the column. </p>
|
|
229
|
-
*/
|
|
135
|
+
|
|
230
136
|
typeName?: string;
|
|
231
|
-
|
|
232
|
-
* <p>The length of the column.</p>
|
|
233
|
-
*/
|
|
137
|
+
|
|
234
138
|
length?: number;
|
|
235
|
-
|
|
236
|
-
* <p>The default value of the column. </p>
|
|
237
|
-
*/
|
|
139
|
+
|
|
238
140
|
columnDefault?: string;
|
|
239
141
|
}
|
|
240
142
|
export declare namespace ColumnMetadata {
|
|
241
|
-
|
|
242
|
-
* @internal
|
|
243
|
-
*/
|
|
143
|
+
|
|
244
144
|
const filterSensitiveLog: (obj: ColumnMetadata) => any;
|
|
245
145
|
}
|
|
246
146
|
export interface DescribeStatementRequest {
|
|
247
|
-
|
|
248
|
-
* <p>The identifier of the SQL statement to describe. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
|
|
249
|
-
* A suffix indicates the number of the SQL statement.
|
|
250
|
-
* 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.
|
|
251
|
-
* This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatement</code>, and <code>ListStatements</code>. </p>
|
|
252
|
-
*/
|
|
147
|
+
|
|
253
148
|
Id: string | undefined;
|
|
254
149
|
}
|
|
255
150
|
export declare namespace DescribeStatementRequest {
|
|
256
|
-
|
|
257
|
-
* @internal
|
|
258
|
-
*/
|
|
151
|
+
|
|
259
152
|
const filterSensitiveLog: (obj: DescribeStatementRequest) => any;
|
|
260
153
|
}
|
|
261
|
-
|
|
262
|
-
* <p>A parameter used in a SQL statement.</p>
|
|
263
|
-
*/
|
|
154
|
+
|
|
264
155
|
export interface SqlParameter {
|
|
265
|
-
|
|
266
|
-
* <p>The name of the parameter.</p>
|
|
267
|
-
*/
|
|
156
|
+
|
|
268
157
|
name: string | undefined;
|
|
269
|
-
|
|
270
|
-
* <p>The value of the parameter.
|
|
271
|
-
* Amazon Redshift implicitly converts to the proper data type. For more inforation, see
|
|
272
|
-
* <a href="https://docs.aws.amazon.com/redshift/latest/dg/c_Supported_data_types.html">Data types</a> in the
|
|
273
|
-
* <i>Amazon Redshift Database Developer Guide</i>. </p>
|
|
274
|
-
*/
|
|
158
|
+
|
|
275
159
|
value: string | undefined;
|
|
276
160
|
}
|
|
277
161
|
export declare namespace SqlParameter {
|
|
278
|
-
|
|
279
|
-
* @internal
|
|
280
|
-
*/
|
|
162
|
+
|
|
281
163
|
const filterSensitiveLog: (obj: SqlParameter) => any;
|
|
282
164
|
}
|
|
283
165
|
export declare enum StatusString {
|
|
@@ -297,342 +179,170 @@ export declare enum StatementStatusString {
|
|
|
297
179
|
STARTED = "STARTED",
|
|
298
180
|
SUBMITTED = "SUBMITTED"
|
|
299
181
|
}
|
|
300
|
-
|
|
301
|
-
* <p>Information about an SQL statement.</p>
|
|
302
|
-
*/
|
|
182
|
+
|
|
303
183
|
export interface SubStatementData {
|
|
304
|
-
|
|
305
|
-
* <p>The identifier of the SQL statement. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
|
|
306
|
-
* A suffix indicates the number of the SQL statement.
|
|
307
|
-
* 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>
|
|
308
|
-
*/
|
|
184
|
+
|
|
309
185
|
Id: string | undefined;
|
|
310
|
-
|
|
311
|
-
* <p>The amount of time in nanoseconds that the statement ran.</p>
|
|
312
|
-
*/
|
|
186
|
+
|
|
313
187
|
Duration?: number;
|
|
314
|
-
|
|
315
|
-
* <p>The error message from the cluster if the SQL statement encountered an error while running.</p>
|
|
316
|
-
*/
|
|
188
|
+
|
|
317
189
|
Error?: string;
|
|
318
|
-
|
|
319
|
-
* <p>The status of the SQL statement. An
|
|
320
|
-
* example is the that the SQL statement finished.
|
|
321
|
-
* </p>
|
|
322
|
-
*/
|
|
190
|
+
|
|
323
191
|
Status?: StatementStatusString | string;
|
|
324
|
-
|
|
325
|
-
* <p>The date and time (UTC) the statement was created. </p>
|
|
326
|
-
*/
|
|
192
|
+
|
|
327
193
|
CreatedAt?: Date;
|
|
328
|
-
|
|
329
|
-
* <p>The date and time (UTC) that the statement metadata was last updated.</p>
|
|
330
|
-
*/
|
|
194
|
+
|
|
331
195
|
UpdatedAt?: Date;
|
|
332
|
-
|
|
333
|
-
* <p>The SQL statement text.</p>
|
|
334
|
-
*/
|
|
196
|
+
|
|
335
197
|
QueryString?: string;
|
|
336
|
-
|
|
337
|
-
* <p>Either the number of rows returned from the SQL statement or the number of rows affected.
|
|
338
|
-
* 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.
|
|
339
|
-
* A <code>-1</code> indicates the value is null.</p>
|
|
340
|
-
*/
|
|
198
|
+
|
|
341
199
|
ResultRows?: number;
|
|
342
|
-
|
|
343
|
-
* <p>The size in bytes of the returned results. A <code>-1</code> indicates the value is null.</p>
|
|
344
|
-
*/
|
|
200
|
+
|
|
345
201
|
ResultSize?: number;
|
|
346
|
-
|
|
347
|
-
* <p>The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. </p>
|
|
348
|
-
*/
|
|
202
|
+
|
|
349
203
|
RedshiftQueryId?: number;
|
|
350
|
-
|
|
351
|
-
* <p>A value that indicates whether the statement has a result set. The result set can be empty.</p>
|
|
352
|
-
*/
|
|
204
|
+
|
|
353
205
|
HasResultSet?: boolean;
|
|
354
206
|
}
|
|
355
207
|
export declare namespace SubStatementData {
|
|
356
|
-
|
|
357
|
-
* @internal
|
|
358
|
-
*/
|
|
208
|
+
|
|
359
209
|
const filterSensitiveLog: (obj: SubStatementData) => any;
|
|
360
210
|
}
|
|
361
211
|
export interface DescribeStatementResponse {
|
|
362
|
-
|
|
363
|
-
* <p>The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. </p>
|
|
364
|
-
*/
|
|
212
|
+
|
|
365
213
|
Id: string | undefined;
|
|
366
|
-
|
|
367
|
-
* <p>The name or Amazon Resource Name (ARN) of the secret that enables access to the database. </p>
|
|
368
|
-
*/
|
|
214
|
+
|
|
369
215
|
SecretArn?: string;
|
|
370
|
-
|
|
371
|
-
* <p>The database user name. </p>
|
|
372
|
-
*/
|
|
216
|
+
|
|
373
217
|
DbUser?: string;
|
|
374
|
-
|
|
375
|
-
* <p>The name of the database. </p>
|
|
376
|
-
*/
|
|
218
|
+
|
|
377
219
|
Database?: string;
|
|
378
|
-
|
|
379
|
-
* <p>The cluster identifier. </p>
|
|
380
|
-
*/
|
|
220
|
+
|
|
381
221
|
ClusterIdentifier?: string;
|
|
382
|
-
|
|
383
|
-
* <p>The amount of time in nanoseconds that the statement ran. </p>
|
|
384
|
-
*/
|
|
222
|
+
|
|
385
223
|
Duration?: number;
|
|
386
|
-
|
|
387
|
-
* <p>The error message from the cluster if the SQL statement encountered an error while running. </p>
|
|
388
|
-
*/
|
|
224
|
+
|
|
389
225
|
Error?: string;
|
|
390
|
-
|
|
391
|
-
* <p>The status of the SQL statement being described. Status values are defined as follows: </p>
|
|
392
|
-
* <ul>
|
|
393
|
-
* <li>
|
|
394
|
-
* <p>ABORTED - The query run was stopped by the user. </p>
|
|
395
|
-
* </li>
|
|
396
|
-
* <li>
|
|
397
|
-
* <p>ALL - A status value that includes all query statuses. This value can be used to filter results. </p>
|
|
398
|
-
* </li>
|
|
399
|
-
* <li>
|
|
400
|
-
* <p>FAILED - The query run failed. </p>
|
|
401
|
-
* </li>
|
|
402
|
-
* <li>
|
|
403
|
-
* <p>FINISHED - The query has finished running. </p>
|
|
404
|
-
* </li>
|
|
405
|
-
* <li>
|
|
406
|
-
* <p>PICKED - The query has been chosen to be run. </p>
|
|
407
|
-
* </li>
|
|
408
|
-
* <li>
|
|
409
|
-
* <p>STARTED - The query run has started. </p>
|
|
410
|
-
* </li>
|
|
411
|
-
* <li>
|
|
412
|
-
* <p>SUBMITTED - The query was submitted, but not yet processed. </p>
|
|
413
|
-
* </li>
|
|
414
|
-
* </ul>
|
|
415
|
-
*/
|
|
226
|
+
|
|
416
227
|
Status?: StatusString | string;
|
|
417
|
-
|
|
418
|
-
* <p>The date and time (UTC) when the SQL statement was submitted to run. </p>
|
|
419
|
-
*/
|
|
228
|
+
|
|
420
229
|
CreatedAt?: Date;
|
|
421
|
-
|
|
422
|
-
* <p>The date and time (UTC) that the metadata for the SQL statement was last updated. An
|
|
423
|
-
* example is the time the status last changed. </p>
|
|
424
|
-
*/
|
|
230
|
+
|
|
425
231
|
UpdatedAt?: Date;
|
|
426
|
-
|
|
427
|
-
* <p>The process identifier from Amazon Redshift. </p>
|
|
428
|
-
*/
|
|
232
|
+
|
|
429
233
|
RedshiftPid?: number;
|
|
430
|
-
|
|
431
|
-
* <p>A value that indicates whether the statement has a result set. The result set can be empty. </p>
|
|
432
|
-
*/
|
|
234
|
+
|
|
433
235
|
HasResultSet?: boolean;
|
|
434
|
-
|
|
435
|
-
* <p>The SQL statement text. </p>
|
|
436
|
-
*/
|
|
236
|
+
|
|
437
237
|
QueryString?: string;
|
|
438
|
-
|
|
439
|
-
* <p>Either the number of rows returned from the SQL statement or the number of rows affected.
|
|
440
|
-
* 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.
|
|
441
|
-
* A <code>-1</code> indicates the value is null.</p>
|
|
442
|
-
*/
|
|
238
|
+
|
|
443
239
|
ResultRows?: number;
|
|
444
|
-
|
|
445
|
-
* <p>The size in bytes of the returned results. A <code>-1</code> indicates the value is null.</p>
|
|
446
|
-
*/
|
|
240
|
+
|
|
447
241
|
ResultSize?: number;
|
|
448
|
-
|
|
449
|
-
* <p>The identifier of the query generated by Amazon Redshift.
|
|
450
|
-
* These identifiers are also available in the <code>query</code> column of the <code>STL_QUERY</code> system view. </p>
|
|
451
|
-
*/
|
|
242
|
+
|
|
452
243
|
RedshiftQueryId?: number;
|
|
453
|
-
|
|
454
|
-
* <p>The parameters for the SQL statement.</p>
|
|
455
|
-
*/
|
|
244
|
+
|
|
456
245
|
QueryParameters?: SqlParameter[];
|
|
457
|
-
|
|
458
|
-
* <p>The SQL statements from a multiple statement run.</p>
|
|
459
|
-
*/
|
|
246
|
+
|
|
460
247
|
SubStatements?: SubStatementData[];
|
|
461
248
|
}
|
|
462
249
|
export declare namespace DescribeStatementResponse {
|
|
463
|
-
|
|
464
|
-
* @internal
|
|
465
|
-
*/
|
|
250
|
+
|
|
466
251
|
const filterSensitiveLog: (obj: DescribeStatementResponse) => any;
|
|
467
252
|
}
|
|
468
253
|
export interface DescribeTableRequest {
|
|
469
|
-
|
|
470
|
-
* <p>The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
|
|
471
|
-
*/
|
|
254
|
+
|
|
472
255
|
ClusterIdentifier: string | undefined;
|
|
473
|
-
|
|
474
|
-
* <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
|
|
475
|
-
*/
|
|
256
|
+
|
|
476
257
|
SecretArn?: string;
|
|
477
|
-
|
|
478
|
-
* <p>The database user name. This parameter is required when authenticating using temporary credentials. </p>
|
|
479
|
-
*/
|
|
258
|
+
|
|
480
259
|
DbUser?: string;
|
|
481
|
-
|
|
482
|
-
* <p>The name of the database that contains the tables to be described.
|
|
483
|
-
* If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
|
|
484
|
-
*/
|
|
260
|
+
|
|
485
261
|
Database: string | undefined;
|
|
486
|
-
|
|
487
|
-
* <p>A database name. The connected database is specified when you connect with your authentication credentials. </p>
|
|
488
|
-
*/
|
|
262
|
+
|
|
489
263
|
ConnectedDatabase?: string;
|
|
490
|
-
|
|
491
|
-
* <p>The schema that contains the table. If no schema is specified, then matching tables for all schemas are returned. </p>
|
|
492
|
-
*/
|
|
264
|
+
|
|
493
265
|
Schema?: string;
|
|
494
|
-
|
|
495
|
-
* <p>The table name. If no table is specified, then all tables for all matching schemas are returned.
|
|
496
|
-
* If no table and no schema is specified, then all tables for all schemas in the database are returned</p>
|
|
497
|
-
*/
|
|
266
|
+
|
|
498
267
|
Table?: string;
|
|
499
|
-
|
|
500
|
-
* <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>
|
|
501
|
-
*/
|
|
268
|
+
|
|
502
269
|
NextToken?: string;
|
|
503
|
-
|
|
504
|
-
* <p>The maximum number of tables to return in the response.
|
|
505
|
-
* If more tables exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
|
|
506
|
-
*/
|
|
270
|
+
|
|
507
271
|
MaxResults?: number;
|
|
508
272
|
}
|
|
509
273
|
export declare namespace DescribeTableRequest {
|
|
510
|
-
|
|
511
|
-
* @internal
|
|
512
|
-
*/
|
|
274
|
+
|
|
513
275
|
const filterSensitiveLog: (obj: DescribeTableRequest) => any;
|
|
514
276
|
}
|
|
515
277
|
export interface DescribeTableResponse {
|
|
516
|
-
|
|
517
|
-
* <p>The table name. </p>
|
|
518
|
-
*/
|
|
278
|
+
|
|
519
279
|
TableName?: string;
|
|
520
|
-
|
|
521
|
-
* <p>A list of columns in the table. </p>
|
|
522
|
-
*/
|
|
280
|
+
|
|
523
281
|
ColumnList?: ColumnMetadata[];
|
|
524
|
-
|
|
525
|
-
* <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>
|
|
526
|
-
*/
|
|
282
|
+
|
|
527
283
|
NextToken?: string;
|
|
528
284
|
}
|
|
529
285
|
export declare namespace DescribeTableResponse {
|
|
530
|
-
|
|
531
|
-
* @internal
|
|
532
|
-
*/
|
|
286
|
+
|
|
533
287
|
const filterSensitiveLog: (obj: DescribeTableResponse) => any;
|
|
534
288
|
}
|
|
535
|
-
|
|
536
|
-
* <p>The SQL statement encountered an environmental error while running.</p>
|
|
537
|
-
*/
|
|
289
|
+
|
|
538
290
|
export interface ExecuteStatementException extends __SmithyException, $MetadataBearer {
|
|
539
291
|
name: "ExecuteStatementException";
|
|
540
292
|
$fault: "server";
|
|
541
|
-
|
|
542
|
-
* <p>The exception message.</p>
|
|
543
|
-
*/
|
|
293
|
+
|
|
544
294
|
Message: string | undefined;
|
|
545
|
-
|
|
546
|
-
* <p>Statement identifier of the exception.</p>
|
|
547
|
-
*/
|
|
295
|
+
|
|
548
296
|
StatementId: string | undefined;
|
|
549
297
|
}
|
|
550
298
|
export declare namespace ExecuteStatementException {
|
|
551
|
-
|
|
552
|
-
* @internal
|
|
553
|
-
*/
|
|
299
|
+
|
|
554
300
|
const filterSensitiveLog: (obj: ExecuteStatementException) => any;
|
|
555
301
|
}
|
|
556
302
|
export interface ExecuteStatementInput {
|
|
557
|
-
|
|
558
|
-
* <p>The SQL statement text to run. </p>
|
|
559
|
-
*/
|
|
303
|
+
|
|
560
304
|
Sql: string | undefined;
|
|
561
|
-
|
|
562
|
-
* <p>The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
|
|
563
|
-
*/
|
|
305
|
+
|
|
564
306
|
ClusterIdentifier: string | undefined;
|
|
565
|
-
|
|
566
|
-
* <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
|
|
567
|
-
*/
|
|
307
|
+
|
|
568
308
|
SecretArn?: string;
|
|
569
|
-
|
|
570
|
-
* <p>The database user name. This parameter is required when authenticating using temporary credentials. </p>
|
|
571
|
-
*/
|
|
309
|
+
|
|
572
310
|
DbUser?: string;
|
|
573
|
-
|
|
574
|
-
* <p>The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
|
|
575
|
-
*/
|
|
311
|
+
|
|
576
312
|
Database: string | undefined;
|
|
577
|
-
|
|
578
|
-
* <p>A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs. </p>
|
|
579
|
-
*/
|
|
313
|
+
|
|
580
314
|
WithEvent?: boolean;
|
|
581
|
-
|
|
582
|
-
* <p>The name of the SQL statement. You can name the SQL statement when you create it to identify the query. </p>
|
|
583
|
-
*/
|
|
315
|
+
|
|
584
316
|
StatementName?: string;
|
|
585
|
-
|
|
586
|
-
* <p>The parameters for the SQL statement.</p>
|
|
587
|
-
*/
|
|
317
|
+
|
|
588
318
|
Parameters?: SqlParameter[];
|
|
589
319
|
}
|
|
590
320
|
export declare namespace ExecuteStatementInput {
|
|
591
|
-
|
|
592
|
-
* @internal
|
|
593
|
-
*/
|
|
321
|
+
|
|
594
322
|
const filterSensitiveLog: (obj: ExecuteStatementInput) => any;
|
|
595
323
|
}
|
|
596
324
|
export interface ExecuteStatementOutput {
|
|
597
|
-
|
|
598
|
-
* <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>
|
|
599
|
-
*/
|
|
325
|
+
|
|
600
326
|
Id?: string;
|
|
601
|
-
|
|
602
|
-
* <p>The date and time (UTC) the statement was created. </p>
|
|
603
|
-
*/
|
|
327
|
+
|
|
604
328
|
CreatedAt?: Date;
|
|
605
|
-
|
|
606
|
-
* <p>The cluster identifier. </p>
|
|
607
|
-
*/
|
|
329
|
+
|
|
608
330
|
ClusterIdentifier?: string;
|
|
609
|
-
|
|
610
|
-
* <p>The database user name.</p>
|
|
611
|
-
*/
|
|
331
|
+
|
|
612
332
|
DbUser?: string;
|
|
613
|
-
|
|
614
|
-
* <p>The name of the database.</p>
|
|
615
|
-
*/
|
|
333
|
+
|
|
616
334
|
Database?: string;
|
|
617
|
-
|
|
618
|
-
* <p>The name or ARN of the secret that enables access to the database. </p>
|
|
619
|
-
*/
|
|
335
|
+
|
|
620
336
|
SecretArn?: string;
|
|
621
337
|
}
|
|
622
338
|
export declare namespace ExecuteStatementOutput {
|
|
623
|
-
|
|
624
|
-
* @internal
|
|
625
|
-
*/
|
|
339
|
+
|
|
626
340
|
const filterSensitiveLog: (obj: ExecuteStatementOutput) => any;
|
|
627
341
|
}
|
|
628
|
-
|
|
629
|
-
* <p>A data value in a column. </p>
|
|
630
|
-
*/
|
|
342
|
+
|
|
631
343
|
export declare type Field = Field.BlobValueMember | Field.BooleanValueMember | Field.DoubleValueMember | Field.IsNullMember | Field.LongValueMember | Field.StringValueMember | Field.$UnknownMember;
|
|
632
344
|
export declare namespace Field {
|
|
633
|
-
|
|
634
|
-
* <p>A value that indicates whether the data is NULL. </p>
|
|
635
|
-
*/
|
|
345
|
+
|
|
636
346
|
interface IsNullMember {
|
|
637
347
|
isNull: boolean;
|
|
638
348
|
booleanValue?: never;
|
|
@@ -642,9 +352,7 @@ export declare namespace Field {
|
|
|
642
352
|
blobValue?: never;
|
|
643
353
|
$unknown?: never;
|
|
644
354
|
}
|
|
645
|
-
|
|
646
|
-
* <p>A value of the Boolean data type. </p>
|
|
647
|
-
*/
|
|
355
|
+
|
|
648
356
|
interface BooleanValueMember {
|
|
649
357
|
isNull?: never;
|
|
650
358
|
booleanValue: boolean;
|
|
@@ -654,9 +362,7 @@ export declare namespace Field {
|
|
|
654
362
|
blobValue?: never;
|
|
655
363
|
$unknown?: never;
|
|
656
364
|
}
|
|
657
|
-
|
|
658
|
-
* <p>A value of the long data type. </p>
|
|
659
|
-
*/
|
|
365
|
+
|
|
660
366
|
interface LongValueMember {
|
|
661
367
|
isNull?: never;
|
|
662
368
|
booleanValue?: never;
|
|
@@ -666,9 +372,7 @@ export declare namespace Field {
|
|
|
666
372
|
blobValue?: never;
|
|
667
373
|
$unknown?: never;
|
|
668
374
|
}
|
|
669
|
-
|
|
670
|
-
* <p>A value of the double data type. </p>
|
|
671
|
-
*/
|
|
375
|
+
|
|
672
376
|
interface DoubleValueMember {
|
|
673
377
|
isNull?: never;
|
|
674
378
|
booleanValue?: never;
|
|
@@ -678,9 +382,7 @@ export declare namespace Field {
|
|
|
678
382
|
blobValue?: never;
|
|
679
383
|
$unknown?: never;
|
|
680
384
|
}
|
|
681
|
-
|
|
682
|
-
* <p>A value of the string data type. </p>
|
|
683
|
-
*/
|
|
385
|
+
|
|
684
386
|
interface StringValueMember {
|
|
685
387
|
isNull?: never;
|
|
686
388
|
booleanValue?: never;
|
|
@@ -690,9 +392,7 @@ export declare namespace Field {
|
|
|
690
392
|
blobValue?: never;
|
|
691
393
|
$unknown?: never;
|
|
692
394
|
}
|
|
693
|
-
|
|
694
|
-
* <p>A value of the BLOB data type. </p>
|
|
695
|
-
*/
|
|
395
|
+
|
|
696
396
|
interface BlobValueMember {
|
|
697
397
|
isNull?: never;
|
|
698
398
|
booleanValue?: never;
|
|
@@ -724,380 +424,190 @@ export declare namespace Field {
|
|
|
724
424
|
_: (name: string, value: any) => T;
|
|
725
425
|
}
|
|
726
426
|
const visit: <T>(value: Field, visitor: Visitor<T>) => T;
|
|
727
|
-
|
|
728
|
-
* @internal
|
|
729
|
-
*/
|
|
427
|
+
|
|
730
428
|
const filterSensitiveLog: (obj: Field) => any;
|
|
731
429
|
}
|
|
732
430
|
export interface GetStatementResultRequest {
|
|
733
|
-
|
|
734
|
-
* <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.
|
|
735
|
-
* A suffix indicates then number of the SQL statement.
|
|
736
|
-
* 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.
|
|
737
|
-
* This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatment</code>, and <code>ListStatements</code>. </p>
|
|
738
|
-
*/
|
|
431
|
+
|
|
739
432
|
Id: string | undefined;
|
|
740
|
-
|
|
741
|
-
* <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>
|
|
742
|
-
*/
|
|
433
|
+
|
|
743
434
|
NextToken?: string;
|
|
744
435
|
}
|
|
745
436
|
export declare namespace GetStatementResultRequest {
|
|
746
|
-
|
|
747
|
-
* @internal
|
|
748
|
-
*/
|
|
437
|
+
|
|
749
438
|
const filterSensitiveLog: (obj: GetStatementResultRequest) => any;
|
|
750
439
|
}
|
|
751
440
|
export interface GetStatementResultResponse {
|
|
752
|
-
|
|
753
|
-
* <p>The results of the SQL statement.</p>
|
|
754
|
-
*/
|
|
441
|
+
|
|
755
442
|
Records: Field[][] | undefined;
|
|
756
|
-
|
|
757
|
-
* <p>The properties (metadata) of a column. </p>
|
|
758
|
-
*/
|
|
443
|
+
|
|
759
444
|
ColumnMetadata?: ColumnMetadata[];
|
|
760
|
-
|
|
761
|
-
* <p>The total number of rows in the result set returned from a query.
|
|
762
|
-
* You can use this number to estimate the number of calls to the <code>GetStatementResult</code> operation needed to page through the results. </p>
|
|
763
|
-
*/
|
|
445
|
+
|
|
764
446
|
TotalNumRows?: number;
|
|
765
|
-
|
|
766
|
-
* <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>
|
|
767
|
-
*/
|
|
447
|
+
|
|
768
448
|
NextToken?: string;
|
|
769
449
|
}
|
|
770
450
|
export declare namespace GetStatementResultResponse {
|
|
771
|
-
|
|
772
|
-
* @internal
|
|
773
|
-
*/
|
|
451
|
+
|
|
774
452
|
const filterSensitiveLog: (obj: GetStatementResultResponse) => any;
|
|
775
453
|
}
|
|
776
454
|
export interface ListDatabasesRequest {
|
|
777
|
-
|
|
778
|
-
* <p>The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
|
|
779
|
-
*/
|
|
455
|
+
|
|
780
456
|
ClusterIdentifier: string | undefined;
|
|
781
|
-
|
|
782
|
-
* <p>The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
|
|
783
|
-
*/
|
|
457
|
+
|
|
784
458
|
Database: string | undefined;
|
|
785
|
-
|
|
786
|
-
* <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
|
|
787
|
-
*/
|
|
459
|
+
|
|
788
460
|
SecretArn?: string;
|
|
789
|
-
|
|
790
|
-
* <p>The database user name. This parameter is required when authenticating using temporary credentials. </p>
|
|
791
|
-
*/
|
|
461
|
+
|
|
792
462
|
DbUser?: string;
|
|
793
|
-
|
|
794
|
-
* <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>
|
|
795
|
-
*/
|
|
463
|
+
|
|
796
464
|
NextToken?: string;
|
|
797
|
-
|
|
798
|
-
* <p>The maximum number of databases to return in the response.
|
|
799
|
-
* If more databases exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
|
|
800
|
-
*/
|
|
465
|
+
|
|
801
466
|
MaxResults?: number;
|
|
802
467
|
}
|
|
803
468
|
export declare namespace ListDatabasesRequest {
|
|
804
|
-
|
|
805
|
-
* @internal
|
|
806
|
-
*/
|
|
469
|
+
|
|
807
470
|
const filterSensitiveLog: (obj: ListDatabasesRequest) => any;
|
|
808
471
|
}
|
|
809
472
|
export interface ListDatabasesResponse {
|
|
810
|
-
|
|
811
|
-
* <p>The names of databases. </p>
|
|
812
|
-
*/
|
|
473
|
+
|
|
813
474
|
Databases?: string[];
|
|
814
|
-
|
|
815
|
-
* <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>
|
|
816
|
-
*/
|
|
475
|
+
|
|
817
476
|
NextToken?: string;
|
|
818
477
|
}
|
|
819
478
|
export declare namespace ListDatabasesResponse {
|
|
820
|
-
|
|
821
|
-
* @internal
|
|
822
|
-
*/
|
|
479
|
+
|
|
823
480
|
const filterSensitiveLog: (obj: ListDatabasesResponse) => any;
|
|
824
481
|
}
|
|
825
482
|
export interface ListSchemasRequest {
|
|
826
|
-
|
|
827
|
-
* <p>The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
|
|
828
|
-
*/
|
|
483
|
+
|
|
829
484
|
ClusterIdentifier: string | undefined;
|
|
830
|
-
|
|
831
|
-
* <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
|
|
832
|
-
*/
|
|
485
|
+
|
|
833
486
|
SecretArn?: string;
|
|
834
|
-
|
|
835
|
-
* <p>The database user name. This parameter is required when authenticating using temporary credentials. </p>
|
|
836
|
-
*/
|
|
487
|
+
|
|
837
488
|
DbUser?: string;
|
|
838
|
-
|
|
839
|
-
* <p>The name of the database that contains the schemas to list.
|
|
840
|
-
* If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
|
|
841
|
-
*/
|
|
489
|
+
|
|
842
490
|
Database: string | undefined;
|
|
843
|
-
|
|
844
|
-
* <p>A database name. The connected database is specified when you connect with your authentication credentials. </p>
|
|
845
|
-
*/
|
|
491
|
+
|
|
846
492
|
ConnectedDatabase?: string;
|
|
847
|
-
|
|
848
|
-
* <p>A pattern to filter results by schema name. Within a schema pattern, "%" means match any
|
|
849
|
-
* substring of 0 or more characters and "_" means match any one character. Only schema name
|
|
850
|
-
* entries matching the search pattern are returned. </p>
|
|
851
|
-
*/
|
|
493
|
+
|
|
852
494
|
SchemaPattern?: string;
|
|
853
|
-
|
|
854
|
-
* <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>
|
|
855
|
-
*/
|
|
495
|
+
|
|
856
496
|
NextToken?: string;
|
|
857
|
-
|
|
858
|
-
* <p>The maximum number of schemas to return in the response.
|
|
859
|
-
* If more schemas exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
|
|
860
|
-
*/
|
|
497
|
+
|
|
861
498
|
MaxResults?: number;
|
|
862
499
|
}
|
|
863
500
|
export declare namespace ListSchemasRequest {
|
|
864
|
-
|
|
865
|
-
* @internal
|
|
866
|
-
*/
|
|
501
|
+
|
|
867
502
|
const filterSensitiveLog: (obj: ListSchemasRequest) => any;
|
|
868
503
|
}
|
|
869
504
|
export interface ListSchemasResponse {
|
|
870
|
-
|
|
871
|
-
* <p>The schemas that match the request pattern. </p>
|
|
872
|
-
*/
|
|
505
|
+
|
|
873
506
|
Schemas?: string[];
|
|
874
|
-
|
|
875
|
-
* <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>
|
|
876
|
-
*/
|
|
507
|
+
|
|
877
508
|
NextToken?: string;
|
|
878
509
|
}
|
|
879
510
|
export declare namespace ListSchemasResponse {
|
|
880
|
-
|
|
881
|
-
* @internal
|
|
882
|
-
*/
|
|
511
|
+
|
|
883
512
|
const filterSensitiveLog: (obj: ListSchemasResponse) => any;
|
|
884
513
|
}
|
|
885
514
|
export interface ListStatementsRequest {
|
|
886
|
-
|
|
887
|
-
* <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>
|
|
888
|
-
*/
|
|
515
|
+
|
|
889
516
|
NextToken?: string;
|
|
890
|
-
|
|
891
|
-
* <p>The maximum number of SQL statements to return in the response.
|
|
892
|
-
* If more SQL statements exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
|
|
893
|
-
*/
|
|
517
|
+
|
|
894
518
|
MaxResults?: number;
|
|
895
|
-
|
|
896
|
-
* <p>The name of the SQL statement specified as input to <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> to identify the query.
|
|
897
|
-
* You can list multiple statements by providing a prefix that matches the beginning of the statement name.
|
|
898
|
-
* For example, to list myStatement1, myStatement2, myStatement3, and so on, then provide the a value of <code>myStatement</code>.
|
|
899
|
-
* Data API does a case-sensitive match of SQL statement names to the prefix value you provide. </p>
|
|
900
|
-
*/
|
|
519
|
+
|
|
901
520
|
StatementName?: string;
|
|
902
|
-
|
|
903
|
-
* <p>The status of the SQL statement to list. Status values are defined as follows: </p>
|
|
904
|
-
* <ul>
|
|
905
|
-
* <li>
|
|
906
|
-
* <p>ABORTED - The query run was stopped by the user. </p>
|
|
907
|
-
* </li>
|
|
908
|
-
* <li>
|
|
909
|
-
* <p>ALL - A status value that includes all query statuses. This value can be used to filter results. </p>
|
|
910
|
-
* </li>
|
|
911
|
-
* <li>
|
|
912
|
-
* <p>FAILED - The query run failed. </p>
|
|
913
|
-
* </li>
|
|
914
|
-
* <li>
|
|
915
|
-
* <p>FINISHED - The query has finished running. </p>
|
|
916
|
-
* </li>
|
|
917
|
-
* <li>
|
|
918
|
-
* <p>PICKED - The query has been chosen to be run. </p>
|
|
919
|
-
* </li>
|
|
920
|
-
* <li>
|
|
921
|
-
* <p>STARTED - The query run has started. </p>
|
|
922
|
-
* </li>
|
|
923
|
-
* <li>
|
|
924
|
-
* <p>SUBMITTED - The query was submitted, but not yet processed. </p>
|
|
925
|
-
* </li>
|
|
926
|
-
* </ul>
|
|
927
|
-
*/
|
|
521
|
+
|
|
928
522
|
Status?: StatusString | string;
|
|
929
|
-
|
|
930
|
-
* <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.
|
|
931
|
-
* If false, only statements run by the caller's IAM role in the current IAM session are returned. The default is true. </p>
|
|
932
|
-
*/
|
|
523
|
+
|
|
933
524
|
RoleLevel?: boolean;
|
|
934
525
|
}
|
|
935
526
|
export declare namespace ListStatementsRequest {
|
|
936
|
-
|
|
937
|
-
* @internal
|
|
938
|
-
*/
|
|
527
|
+
|
|
939
528
|
const filterSensitiveLog: (obj: ListStatementsRequest) => any;
|
|
940
529
|
}
|
|
941
|
-
|
|
942
|
-
* <p>The SQL statement to run.</p>
|
|
943
|
-
*/
|
|
530
|
+
|
|
944
531
|
export interface StatementData {
|
|
945
|
-
|
|
946
|
-
* <p>The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. </p>
|
|
947
|
-
*/
|
|
532
|
+
|
|
948
533
|
Id: string | undefined;
|
|
949
|
-
|
|
950
|
-
* <p>The SQL statement.</p>
|
|
951
|
-
*/
|
|
534
|
+
|
|
952
535
|
QueryString?: string;
|
|
953
|
-
|
|
954
|
-
* <p>One or more SQL statements. Each query string in the array corresponds to one of the queries in a batch query request.</p>
|
|
955
|
-
*/
|
|
536
|
+
|
|
956
537
|
QueryStrings?: string[];
|
|
957
|
-
|
|
958
|
-
* <p>The name or Amazon Resource Name (ARN) of the secret that enables access to the database. </p>
|
|
959
|
-
*/
|
|
538
|
+
|
|
960
539
|
SecretArn?: string;
|
|
961
|
-
|
|
962
|
-
* <p>The status of the SQL statement. An
|
|
963
|
-
* example is the that the SQL statement finished.
|
|
964
|
-
* </p>
|
|
965
|
-
*/
|
|
540
|
+
|
|
966
541
|
Status?: StatusString | string;
|
|
967
|
-
|
|
968
|
-
* <p>The name of the SQL statement. </p>
|
|
969
|
-
*/
|
|
542
|
+
|
|
970
543
|
StatementName?: string;
|
|
971
|
-
|
|
972
|
-
* <p>The date and time (UTC) the statement was created. </p>
|
|
973
|
-
*/
|
|
544
|
+
|
|
974
545
|
CreatedAt?: Date;
|
|
975
|
-
|
|
976
|
-
* <p>The date and time (UTC) that the statement metadata was last updated.</p>
|
|
977
|
-
*/
|
|
546
|
+
|
|
978
547
|
UpdatedAt?: Date;
|
|
979
|
-
|
|
980
|
-
* <p>The parameters used in a SQL statement.</p>
|
|
981
|
-
*/
|
|
548
|
+
|
|
982
549
|
QueryParameters?: SqlParameter[];
|
|
983
|
-
|
|
984
|
-
* <p>A value that indicates whether the statement is a batch query request.</p>
|
|
985
|
-
*/
|
|
550
|
+
|
|
986
551
|
IsBatchStatement?: boolean;
|
|
987
552
|
}
|
|
988
553
|
export declare namespace StatementData {
|
|
989
|
-
|
|
990
|
-
* @internal
|
|
991
|
-
*/
|
|
554
|
+
|
|
992
555
|
const filterSensitiveLog: (obj: StatementData) => any;
|
|
993
556
|
}
|
|
994
557
|
export interface ListStatementsResponse {
|
|
995
|
-
|
|
996
|
-
* <p>The SQL statements. </p>
|
|
997
|
-
*/
|
|
558
|
+
|
|
998
559
|
Statements: StatementData[] | undefined;
|
|
999
|
-
|
|
1000
|
-
* <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>
|
|
1001
|
-
*/
|
|
560
|
+
|
|
1002
561
|
NextToken?: string;
|
|
1003
562
|
}
|
|
1004
563
|
export declare namespace ListStatementsResponse {
|
|
1005
|
-
|
|
1006
|
-
* @internal
|
|
1007
|
-
*/
|
|
564
|
+
|
|
1008
565
|
const filterSensitiveLog: (obj: ListStatementsResponse) => any;
|
|
1009
566
|
}
|
|
1010
567
|
export interface ListTablesRequest {
|
|
1011
|
-
|
|
1012
|
-
* <p>The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
|
|
1013
|
-
*/
|
|
568
|
+
|
|
1014
569
|
ClusterIdentifier: string | undefined;
|
|
1015
|
-
|
|
1016
|
-
* <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
|
|
1017
|
-
*/
|
|
570
|
+
|
|
1018
571
|
SecretArn?: string;
|
|
1019
|
-
|
|
1020
|
-
* <p>The database user name. This parameter is required when authenticating using temporary credentials. </p>
|
|
1021
|
-
*/
|
|
572
|
+
|
|
1022
573
|
DbUser?: string;
|
|
1023
|
-
|
|
1024
|
-
* <p>The name of the database that contains the tables to list.
|
|
1025
|
-
* If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
|
|
1026
|
-
*/
|
|
574
|
+
|
|
1027
575
|
Database: string | undefined;
|
|
1028
|
-
|
|
1029
|
-
* <p>A database name. The connected database is specified when you connect with your authentication credentials. </p>
|
|
1030
|
-
*/
|
|
576
|
+
|
|
1031
577
|
ConnectedDatabase?: string;
|
|
1032
|
-
|
|
1033
|
-
* <p>A pattern to filter results by schema name. Within a schema pattern, "%" means match any
|
|
1034
|
-
* substring of 0 or more characters and "_" means match any one character. Only schema name
|
|
1035
|
-
* entries matching the search pattern are returned. If <code>SchemaPattern</code> is not specified, then all tables that match
|
|
1036
|
-
* <code>TablePattern</code> are returned.
|
|
1037
|
-
* If neither <code>SchemaPattern</code> or <code>TablePattern</code> are specified, then all tables are returned. </p>
|
|
1038
|
-
*/
|
|
578
|
+
|
|
1039
579
|
SchemaPattern?: string;
|
|
1040
|
-
|
|
1041
|
-
* <p>A pattern to filter results by table name. Within a table pattern, "%" means match any
|
|
1042
|
-
* substring of 0 or more characters and "_" means match any one character. Only table name
|
|
1043
|
-
* entries matching the search pattern are returned. If <code>TablePattern</code> is not specified, then all tables that match
|
|
1044
|
-
* <code>SchemaPattern</code>are returned.
|
|
1045
|
-
* If neither <code>SchemaPattern</code> or <code>TablePattern</code> are specified, then all tables are returned. </p>
|
|
1046
|
-
*/
|
|
580
|
+
|
|
1047
581
|
TablePattern?: string;
|
|
1048
|
-
|
|
1049
|
-
* <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>
|
|
1050
|
-
*/
|
|
582
|
+
|
|
1051
583
|
NextToken?: string;
|
|
1052
|
-
|
|
1053
|
-
* <p>The maximum number of tables to return in the response.
|
|
1054
|
-
* If more tables exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
|
|
1055
|
-
*/
|
|
584
|
+
|
|
1056
585
|
MaxResults?: number;
|
|
1057
586
|
}
|
|
1058
587
|
export declare namespace ListTablesRequest {
|
|
1059
|
-
|
|
1060
|
-
* @internal
|
|
1061
|
-
*/
|
|
588
|
+
|
|
1062
589
|
const filterSensitiveLog: (obj: ListTablesRequest) => any;
|
|
1063
590
|
}
|
|
1064
|
-
|
|
1065
|
-
* <p>The properties of a table. </p>
|
|
1066
|
-
*/
|
|
591
|
+
|
|
1067
592
|
export interface TableMember {
|
|
1068
|
-
|
|
1069
|
-
* <p>The name of the table. </p>
|
|
1070
|
-
*/
|
|
593
|
+
|
|
1071
594
|
name?: string;
|
|
1072
|
-
|
|
1073
|
-
* <p>The type of the table. Possible values include TABLE, VIEW, SYSTEM TABLE, GLOBAL
|
|
1074
|
-
* TEMPORARY, LOCAL TEMPORARY, ALIAS, and SYNONYM. </p>
|
|
1075
|
-
*/
|
|
595
|
+
|
|
1076
596
|
type?: string;
|
|
1077
|
-
|
|
1078
|
-
* <p>The schema containing the table. </p>
|
|
1079
|
-
*/
|
|
597
|
+
|
|
1080
598
|
schema?: string;
|
|
1081
599
|
}
|
|
1082
600
|
export declare namespace TableMember {
|
|
1083
|
-
|
|
1084
|
-
* @internal
|
|
1085
|
-
*/
|
|
601
|
+
|
|
1086
602
|
const filterSensitiveLog: (obj: TableMember) => any;
|
|
1087
603
|
}
|
|
1088
604
|
export interface ListTablesResponse {
|
|
1089
|
-
|
|
1090
|
-
* <p>The tables that match the request pattern. </p>
|
|
1091
|
-
*/
|
|
605
|
+
|
|
1092
606
|
Tables?: TableMember[];
|
|
1093
|
-
|
|
1094
|
-
* <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>
|
|
1095
|
-
*/
|
|
607
|
+
|
|
1096
608
|
NextToken?: string;
|
|
1097
609
|
}
|
|
1098
610
|
export declare namespace ListTablesResponse {
|
|
1099
|
-
|
|
1100
|
-
* @internal
|
|
1101
|
-
*/
|
|
611
|
+
|
|
1102
612
|
const filterSensitiveLog: (obj: ListTablesResponse) => any;
|
|
1103
613
|
}
|