@aws-sdk/client-redshift-data 3.936.0 → 3.937.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (23) hide show
  1. package/README.md +1 -5
  2. package/dist-cjs/index.js +21 -21
  3. package/dist-es/models/errors.js +16 -16
  4. package/dist-es/schemas/schemas_0.js +5 -5
  5. package/dist-types/RedshiftData.d.ts +1 -5
  6. package/dist-types/RedshiftDataClient.d.ts +1 -5
  7. package/dist-types/commands/BatchExecuteStatementCommand.d.ts +5 -38
  8. package/dist-types/commands/CancelStatementCommand.d.ts +4 -4
  9. package/dist-types/commands/DescribeStatementCommand.d.ts +2 -7
  10. package/dist-types/commands/DescribeTableCommand.d.ts +4 -38
  11. package/dist-types/commands/ExecuteStatementCommand.d.ts +5 -38
  12. package/dist-types/commands/GetStatementResultCommand.d.ts +1 -7
  13. package/dist-types/commands/GetStatementResultV2Command.d.ts +1 -6
  14. package/dist-types/commands/ListDatabasesCommand.d.ts +4 -37
  15. package/dist-types/commands/ListSchemasCommand.d.ts +4 -37
  16. package/dist-types/commands/ListStatementsCommand.d.ts +4 -10
  17. package/dist-types/commands/ListTablesCommand.d.ts +4 -38
  18. package/dist-types/index.d.ts +1 -5
  19. package/dist-types/models/errors.d.ts +22 -22
  20. package/dist-types/models/models_0.d.ts +51 -157
  21. package/dist-types/ts3.4/models/errors.d.ts +9 -9
  22. package/dist-types/ts3.4/models/models_0.d.ts +3 -3
  23. package/package.json +1 -1
package/dist-types/commands/ListStatementsCommand.d.ts CHANGED
@@ -27,16 +27,7 @@ declare const ListStatementsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>List of SQL statements. By default, only finished statements are shown.
31
- * A token is returned to page through the statement list. </p>
32
- * <p>When you use identity-enhanced role sessions to list statements, you must provide either the
33
- * <code>cluster-identifier</code> or <code>workgroup-name</code> parameter. This ensures that the IdC user
34
- * can only access the Amazon Redshift IdC applications they are assigned. For more information, see
35
- * <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/trustedidentitypropagation-overview.html">
36
- * Trusted identity propagation overview</a>.</p>
37
- * <p>For more information about the Amazon Redshift Data API and CLI usage examples, see
38
- * <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the
39
- * <i>Amazon Redshift Management Guide</i>. </p>
30
+ * <p>List of SQL statements. By default, only finished statements are shown. A token is returned to page through the statement list. </p> <p>When you use identity-enhanced role sessions to list statements, you must provide either the <code>cluster-identifier</code> or <code>workgroup-name</code> parameter. This ensures that the IdC user can only access the Amazon Redshift IdC applications they are assigned. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/trustedidentitypropagation-overview.html"> Trusted identity propagation overview</a>.</p> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
40
31
  * @example
41
32
  * Use a bare-bones client and the command you need to make an API call.
42
33
  * ```javascript
@@ -95,6 +86,9 @@ declare const ListStatementsCommand_base: {
95
86
  * @throws {@link InternalServerException} (server fault)
96
87
  * <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
97
88
  *
89
+ * @throws {@link ResourceNotFoundException} (client fault)
90
+ * <p>The Amazon Redshift Data API operation failed due to a missing resource. </p>
91
+ *
98
92
  * @throws {@link ValidationException} (client fault)
99
93
  * <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
100
94
  *
package/dist-types/commands/ListTablesCommand.d.ts CHANGED
@@ -27,44 +27,7 @@ declare const ListTablesCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>List the tables in a database. If neither <code>SchemaPattern</code> nor <code>TablePattern</code> are specified, then
31
- * all tables in the database are returned.
32
- * A token is returned to page through the table list.
33
- * Depending on the authorization method, use one of the
34
- * following combinations of request parameters: </p>
35
- * <ul>
36
- * <li>
37
- * <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret
38
- * stored in Secrets Manager which has <code>username</code> and <code>password</code>.
39
- * The specified secret contains credentials
40
- * to connect to the <code>database</code> you specify.
41
- * When you are connecting to a cluster, you also supply the database name,
42
- * If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret.
43
- * When you are connecting to a serverless workgroup, you also supply the database name.</p>
44
- * </li>
45
- * <li>
46
- * <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p>
47
- * <ul>
48
- * <li>
49
- * <p>When connecting to a serverless workgroup, specify the workgroup name and database name.
50
- * The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>.
51
- * Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required.</p>
52
- * </li>
53
- * <li>
54
- * <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name.
55
- * The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>.
56
- * Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p>
57
- * </li>
58
- * <li>
59
- * <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name.
60
- * Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p>
61
- * </li>
62
- * </ul>
63
- * </li>
64
- * </ul>
65
- * <p>For more information about the Amazon Redshift Data API and CLI usage examples, see
66
- * <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the
67
- * <i>Amazon Redshift Management Guide</i>. </p>
30
+ * <p>List the tables in a database. If neither <code>SchemaPattern</code> nor <code>TablePattern</code> are specified, then all tables in the database are returned. A token is returned to page through the table list. Depending on the authorization method, use one of the following combinations of request parameters: </p> <ul> <li> <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret stored in Secrets Manager which has <code>username</code> and <code>password</code>. The specified secret contains credentials to connect to the <code>database</code> you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.</p> </li> <li> <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p> <ul> <li> <p>When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>. Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required.</p> </li> <li> <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>. Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p> </li> <li> <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p> </li> </ul> </li> </ul> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
68
31
  * @example
69
32
  * Use a bare-bones client and the command you need to make an API call.
70
33
  * ```javascript
@@ -115,6 +78,9 @@ declare const ListTablesCommand_base: {
115
78
  * @throws {@link QueryTimeoutException} (client fault)
116
79
  * <p>The Amazon Redshift Data API operation failed due to timeout.</p>
117
80
  *
81
+ * @throws {@link ResourceNotFoundException} (client fault)
82
+ * <p>The Amazon Redshift Data API operation failed due to a missing resource. </p>
83
+ *
118
84
  * @throws {@link ValidationException} (client fault)
119
85
  * <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
120
86
  *
package/dist-types/index.d.ts CHANGED
@@ -1,9 +1,5 @@
1
1
  /**
2
- * <p>You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You
3
- * can run SQL statements, which are committed if the statement succeeds. </p>
4
- * <p>For more information about the Amazon Redshift Data API and CLI usage examples, see
5
- * <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the
6
- * <i>Amazon Redshift Management Guide</i>. </p>
2
+ * <p>You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You can run SQL statements, which are committed if the statement succeeds. </p> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
7
3
  *
8
4
  * @packageDocumentation
9
5
  */
package/dist-types/models/errors.d.ts CHANGED
@@ -61,6 +61,28 @@ export declare class InternalServerException extends __BaseException {
61
61
  */
62
62
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
63
63
  }
64
+ /**
65
+ * <p>The Amazon Redshift Data API operation failed due to a missing resource. </p>
66
+ * @public
67
+ */
68
+ export declare class ResourceNotFoundException extends __BaseException {
69
+ readonly name: "ResourceNotFoundException";
70
+ readonly $fault: "client";
71
+ /**
72
+ * <p>The exception message.</p>
73
+ * @public
74
+ */
75
+ Message: string | undefined;
76
+ /**
77
+ * <p>Resource identifier associated with the exception.</p>
78
+ * @public
79
+ */
80
+ ResourceId: string | undefined;
81
+ /**
82
+ * @internal
83
+ */
84
+ constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
85
+ }
64
86
  /**
65
87
  * <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
66
88
  * @public
@@ -91,28 +113,6 @@ export declare class DatabaseConnectionException extends __BaseException {
91
113
  */
92
114
  constructor(opts: __ExceptionOptionType<DatabaseConnectionException, __BaseException>);
93
115
  }
94
- /**
95
- * <p>The Amazon Redshift Data API operation failed due to a missing resource. </p>
96
- * @public
97
- */
98
- export declare class ResourceNotFoundException extends __BaseException {
99
- readonly name: "ResourceNotFoundException";
100
- readonly $fault: "client";
101
- /**
102
- * <p>The exception message.</p>
103
- * @public
104
- */
105
- Message: string | undefined;
106
- /**
107
- * <p>Resource identifier associated with the exception.</p>
108
- * @public
109
- */
110
- ResourceId: string | undefined;
111
- /**
112
- * @internal
113
- */
114
- constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
115
- }
116
116
  /**
117
117
  * <p>The Amazon Redshift Data API operation failed due to timeout.</p>
118
118
  * @public
package/dist-types/models/models_0.d.ts CHANGED
@@ -15,11 +15,7 @@ export type ResultFormatString = (typeof ResultFormatString)[keyof typeof Result
15
15
  */
16
16
  export interface BatchExecuteStatementInput {
17
17
  /**
18
- * <p>One or more SQL statements to run.
19
- *
20
- * The SQL statements are run as a single transaction. They run serially in the order of the array.
21
- * Subsequent SQL statements don't start until the previous statement in the array completes.
22
- * If any SQL statement fails, then because they are run as one transaction, all work is rolled back.</p>
18
+ * <p>One or more SQL statements to run. The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back.</p>
23
19
  * @public
24
20
  */
25
21
  Sqls: string[] | undefined;
@@ -63,6 +59,11 @@ export interface BatchExecuteStatementInput {
63
59
  * @public
64
60
  */
65
61
  ClientToken?: string | undefined;
62
+ /**
63
+ * <p>The data format of the result of the SQL statement. If no format is specified, the default is JSON.</p>
64
+ * @public
65
+ */
66
+ ResultFormat?: ResultFormatString | undefined;
66
67
  /**
67
68
  * <p>The number of seconds to keep the session alive after the query finishes. The maximum time a session can keep alive is 24 hours. After 24 hours, the session is forced closed and the query is terminated.</p>
68
69
  * @public
@@ -73,19 +74,13 @@ export interface BatchExecuteStatementInput {
73
74
  * @public
74
75
  */
75
76
  SessionId?: string | undefined;
76
- /**
77
- * <p>The data format of the result of the SQL statement. If no format is specified, the default is JSON.</p>
78
- * @public
79
- */
80
- ResultFormat?: ResultFormatString | undefined;
81
77
  }
82
78
  /**
83
79
  * @public
84
80
  */
85
81
  export interface BatchExecuteStatementOutput {
86
82
  /**
87
- * <p>The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
88
- * This identifier is returned by <code>BatchExecuteStatment</code>. </p>
83
+ * <p>The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by <code>BatchExecuteStatment</code>. </p>
89
84
  * @public
90
85
  */
91
86
  Id?: string | undefined;
@@ -135,8 +130,7 @@ export interface BatchExecuteStatementOutput {
135
130
  */
136
131
  export interface CancelStatementRequest {
137
132
  /**
138
- * <p>The identifier of the SQL statement to cancel. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
139
- * This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatment</code>, and <code>ListStatements</code>. </p>
133
+ * <p>The identifier of the SQL statement to cancel. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatment</code>, and <code>ListStatements</code>. </p>
140
134
  * @public
141
135
  */
142
136
  Id: string | undefined;
@@ -227,10 +221,7 @@ export interface ColumnMetadata {
227
221
  */
228
222
  export interface DescribeStatementRequest {
229
223
  /**
230
- * <p>The identifier of the SQL statement to describe. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
231
- * A suffix indicates the number of the SQL statement.
232
- * For example, <code>d9b6c0c9-0747-4bf4-b142-e8883122f766:2</code> has a suffix of <code>:2</code> that indicates the second SQL statement of a batch query.
233
- * This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatement</code>, and <code>ListStatements</code>. </p>
224
+ * <p>The identifier of the SQL statement to describe. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates the number of the SQL statement. For example, <code>d9b6c0c9-0747-4bf4-b142-e8883122f766:2</code> has a suffix of <code>:2</code> that indicates the second SQL statement of a batch query. This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatement</code>, and <code>ListStatements</code>. </p>
234
225
  * @public
235
226
  */
236
227
  Id: string | undefined;
@@ -246,10 +237,7 @@ export interface SqlParameter {
246
237
  */
247
238
  name: string | undefined;
248
239
  /**
249
- * <p>The value of the parameter.
250
- * Amazon Redshift implicitly converts to the proper data type. For more information, see
251
- * <a href="https://docs.aws.amazon.com/redshift/latest/dg/c_Supported_data_types.html">Data types</a> in the
252
- * <i>Amazon Redshift Database Developer Guide</i>. </p>
240
+ * <p>The value of the parameter. Amazon Redshift implicitly converts to the proper data type. For more information, see <a href="https://docs.aws.amazon.com/redshift/latest/dg/c_Supported_data_types.html">Data types</a> in the <i>Amazon Redshift Database Developer Guide</i>. </p>
253
241
  * @public
254
242
  */
255
243
  value: string | undefined;
@@ -293,9 +281,7 @@ export type StatementStatusString = (typeof StatementStatusString)[keyof typeof
293
281
  */
294
282
  export interface SubStatementData {
295
283
  /**
296
- * <p>The identifier of the SQL statement. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
297
- * A suffix indicates the number of the SQL statement.
298
- * For example, <code>d9b6c0c9-0747-4bf4-b142-e8883122f766:2</code> has a suffix of <code>:2</code> that indicates the second SQL statement of a batch query.</p>
284
+ * <p>The identifier of the SQL statement. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates the number of the SQL statement. For example, <code>d9b6c0c9-0747-4bf4-b142-e8883122f766:2</code> has a suffix of <code>:2</code> that indicates the second SQL statement of a batch query.</p>
299
285
  * @public
300
286
  */
301
287
  Id: string | undefined;
@@ -310,9 +296,7 @@ export interface SubStatementData {
310
296
  */
311
297
  Error?: string | undefined;
312
298
  /**
313
- * <p>The status of the SQL statement. An
314
- * example is the that the SQL statement finished.
315
- * </p>
299
+ * <p>The status of the SQL statement. An example is the that the SQL statement finished. </p>
316
300
  * @public
317
301
  */
318
302
  Status?: StatementStatusString | undefined;
@@ -332,9 +316,7 @@ export interface SubStatementData {
332
316
  */
333
317
  QueryString?: string | undefined;
334
318
  /**
335
- * <p>Either the number of rows returned from the SQL statement or the number of rows affected.
336
- * If result size is greater than zero, the result rows can be the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and others.
337
- * A <code>-1</code> indicates the value is null.</p>
319
+ * <p>Either the number of rows returned from the SQL statement or the number of rows affected. If result size is greater than zero, the result rows can be the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and others. A <code>-1</code> indicates the value is null.</p>
338
320
  * @public
339
321
  */
340
322
  ResultRows?: number | undefined;
@@ -394,30 +376,7 @@ export interface DescribeStatementResponse {
394
376
  */
395
377
  Error?: string | undefined;
396
378
  /**
397
- * <p>The status of the SQL statement being described. Status values are defined as follows: </p>
398
- * <ul>
399
- * <li>
400
- * <p>ABORTED - The query run was stopped by the user. </p>
401
- * </li>
402
- * <li>
403
- * <p>ALL - A status value that includes all query statuses. This value can be used to filter results. </p>
404
- * </li>
405
- * <li>
406
- * <p>FAILED - The query run failed. </p>
407
- * </li>
408
- * <li>
409
- * <p>FINISHED - The query has finished running. </p>
410
- * </li>
411
- * <li>
412
- * <p>PICKED - The query has been chosen to be run. </p>
413
- * </li>
414
- * <li>
415
- * <p>STARTED - The query run has started. </p>
416
- * </li>
417
- * <li>
418
- * <p>SUBMITTED - The query was submitted, but not yet processed. </p>
419
- * </li>
420
- * </ul>
379
+ * <p>The status of the SQL statement being described. Status values are defined as follows: </p> <ul> <li> <p>ABORTED - The query run was stopped by the user. </p> </li> <li> <p>ALL - A status value that includes all query statuses. This value can be used to filter results. </p> </li> <li> <p>FAILED - The query run failed. </p> </li> <li> <p>FINISHED - The query has finished running. </p> </li> <li> <p>PICKED - The query has been chosen to be run. </p> </li> <li> <p>STARTED - The query run has started. </p> </li> <li> <p>SUBMITTED - The query was submitted, but not yet processed. </p> </li> </ul>
421
380
  * @public
422
381
  */
423
382
  Status?: StatusString | undefined;
@@ -427,8 +386,7 @@ export interface DescribeStatementResponse {
427
386
  */
428
387
  CreatedAt?: Date | undefined;
429
388
  /**
430
- * <p>The date and time (UTC) that the metadata for the SQL statement was last updated. An
431
- * example is the time the status last changed. </p>
389
+ * <p>The date and time (UTC) that the metadata for the SQL statement was last updated. An example is the time the status last changed. </p>
432
390
  * @public
433
391
  */
434
392
  UpdatedAt?: Date | undefined;
@@ -438,8 +396,7 @@ export interface DescribeStatementResponse {
438
396
  */
439
397
  RedshiftPid?: number | undefined;
440
398
  /**
441
- * <p>A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set.
442
- * The value is true if any substatement returns a result set.</p>
399
+ * <p>A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set. The value is true if any substatement returns a result set.</p>
443
400
  * @public
444
401
  */
445
402
  HasResultSet?: boolean | undefined;
@@ -449,9 +406,7 @@ export interface DescribeStatementResponse {
449
406
  */
450
407
  QueryString?: string | undefined;
451
408
  /**
452
- * <p>Either the number of rows returned from the SQL statement or the number of rows affected.
453
- * If result size is greater than zero, the result rows can be the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and others.
454
- * A <code>-1</code> indicates the value is null.</p>
409
+ * <p>Either the number of rows returned from the SQL statement or the number of rows affected. If result size is greater than zero, the result rows can be the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and others. A <code>-1</code> indicates the value is null.</p>
455
410
  * @public
456
411
  */
457
412
  ResultRows?: number | undefined;
@@ -461,8 +416,7 @@ export interface DescribeStatementResponse {
461
416
  */
462
417
  ResultSize?: number | undefined;
463
418
  /**
464
- * <p>The identifier of the query generated by Amazon Redshift.
465
- * These identifiers are also available in the <code>query</code> column of the <code>STL_QUERY</code> system view. </p>
419
+ * <p>The identifier of the query generated by Amazon Redshift. These identifiers are also available in the <code>query</code> column of the <code>STL_QUERY</code> system view. </p>
466
420
  * @public
467
421
  */
468
422
  RedshiftQueryId?: number | undefined;
@@ -482,15 +436,15 @@ export interface DescribeStatementResponse {
482
436
  */
483
437
  WorkgroupName?: string | undefined;
484
438
  /**
485
- * <p>The session identifier of the query.</p>
439
+ * <p>The data format of the result of the SQL statement.</p>
486
440
  * @public
487
441
  */
488
- SessionId?: string | undefined;
442
+ ResultFormat?: ResultFormatString | undefined;
489
443
  /**
490
- * <p>The data format of the result of the SQL statement.</p>
444
+ * <p>The session identifier of the query.</p>
491
445
  * @public
492
446
  */
493
- ResultFormat?: ResultFormatString | undefined;
447
+ SessionId?: string | undefined;
494
448
  }
495
449
  /**
496
450
  * @public
@@ -512,8 +466,7 @@ export interface DescribeTableRequest {
512
466
  */
513
467
  DbUser?: string | undefined;
514
468
  /**
515
- * <p>The name of the database that contains the tables to be described.
516
- * If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
469
+ * <p>The name of the database that contains the tables to be described. If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
517
470
  * @public
518
471
  */
519
472
  Database: string | undefined;
@@ -528,8 +481,7 @@ export interface DescribeTableRequest {
528
481
  */
529
482
  Schema?: string | undefined;
530
483
  /**
531
- * <p>The table name. If no table is specified, then all tables for all matching schemas are returned.
532
- * If no table and no schema is specified, then all tables for all schemas in the database are returned</p>
484
+ * <p>The table name. If no table is specified, then all tables for all matching schemas are returned. If no table and no schema is specified, then all tables for all schemas in the database are returned</p>
533
485
  * @public
534
486
  */
535
487
  Table?: string | undefined;
@@ -539,8 +491,7 @@ export interface DescribeTableRequest {
539
491
  */
540
492
  NextToken?: string | undefined;
541
493
  /**
542
- * <p>The maximum number of tables to return in the response.
543
- * If more tables exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
494
+ * <p>The maximum number of tables to return in the response. If more tables exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
544
495
  * @public
545
496
  */
546
497
  MaxResults?: number | undefined;
@@ -624,6 +575,11 @@ export interface ExecuteStatementInput {
624
575
  * @public
625
576
  */
626
577
  ClientToken?: string | undefined;
578
+ /**
579
+ * <p>The data format of the result of the SQL statement. If no format is specified, the default is JSON.</p>
580
+ * @public
581
+ */
582
+ ResultFormat?: ResultFormatString | undefined;
627
583
  /**
628
584
  * <p>The number of seconds to keep the session alive after the query finishes. The maximum time a session can keep alive is 24 hours. After 24 hours, the session is forced closed and the query is terminated.</p>
629
585
  * @public
@@ -634,11 +590,6 @@ export interface ExecuteStatementInput {
634
590
  * @public
635
591
  */
636
592
  SessionId?: string | undefined;
637
- /**
638
- * <p>The data format of the result of the SQL statement. If no format is specified, the default is JSON.</p>
639
- * @public
640
- */
641
- ResultFormat?: ResultFormatString | undefined;
642
593
  }
643
594
  /**
644
595
  * @public
@@ -841,10 +792,7 @@ export declare namespace QueryRecords {
841
792
  */
842
793
  export interface GetStatementResultRequest {
843
794
  /**
844
- * <p>The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
845
- * A suffix indicates then number of the SQL statement.
846
- * For example, <code>d9b6c0c9-0747-4bf4-b142-e8883122f766:2</code> has a suffix of <code>:2</code> that indicates the second SQL statement of a batch query.
847
- * This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatment</code>, and <code>ListStatements</code>. </p>
795
+ * <p>The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates then number of the SQL statement. For example, <code>d9b6c0c9-0747-4bf4-b142-e8883122f766:2</code> has a suffix of <code>:2</code> that indicates the second SQL statement of a batch query. This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatment</code>, and <code>ListStatements</code>. </p>
848
796
  * @public
849
797
  */
850
798
  Id: string | undefined;
@@ -869,8 +817,7 @@ export interface GetStatementResultResponse {
869
817
  */
870
818
  ColumnMetadata?: ColumnMetadata[] | undefined;
871
819
  /**
872
- * <p>The total number of rows in the result set returned from a query.
873
- * You can use this number to estimate the number of calls to the <code>GetStatementResult</code> operation needed to page through the results. </p>
820
+ * <p>The total number of rows in the result set returned from a query. You can use this number to estimate the number of calls to the <code>GetStatementResult</code> operation needed to page through the results. </p>
874
821
  * @public
875
822
  */
876
823
  TotalNumRows?: number | undefined;
@@ -885,10 +832,7 @@ export interface GetStatementResultResponse {
885
832
  */
886
833
  export interface GetStatementResultV2Request {
887
834
  /**
888
- * <p>The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
889
- * A suffix indicates then number of the SQL statement.
890
- * For example, <code>d9b6c0c9-0747-4bf4-b142-e8883122f766:2</code> has a suffix of <code>:2</code> that indicates the second SQL statement of a batch query.
891
- * This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatment</code>, and <code>ListStatements</code>. </p>
835
+ * <p>The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates then number of the SQL statement. For example, <code>d9b6c0c9-0747-4bf4-b142-e8883122f766:2</code> has a suffix of <code>:2</code> that indicates the second SQL statement of a batch query. This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatment</code>, and <code>ListStatements</code>. </p>
892
836
  * @public
893
837
  */
894
838
  Id: string | undefined;
@@ -913,8 +857,7 @@ export interface GetStatementResultV2Response {
913
857
  */
914
858
  ColumnMetadata?: ColumnMetadata[] | undefined;
915
859
  /**
916
- * <p>The total number of rows in the result set returned from a query.
917
- * You can use this number to estimate the number of calls to the <code>GetStatementResultV2</code> operation needed to page through the results. </p>
860
+ * <p>The total number of rows in the result set returned from a query. You can use this number to estimate the number of calls to the <code>GetStatementResultV2</code> operation needed to page through the results. </p>
918
861
  * @public
919
862
  */
920
863
  TotalNumRows?: number | undefined;
@@ -959,8 +902,7 @@ export interface ListDatabasesRequest {
959
902
  */
960
903
  NextToken?: string | undefined;
961
904
  /**
962
- * <p>The maximum number of databases to return in the response.
963
- * If more databases exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
905
+ * <p>The maximum number of databases to return in the response. If more databases exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
964
906
  * @public
965
907
  */
966
908
  MaxResults?: number | undefined;
@@ -1005,8 +947,7 @@ export interface ListSchemasRequest {
1005
947
  */
1006
948
  DbUser?: string | undefined;
1007
949
  /**
1008
- * <p>The name of the database that contains the schemas to list.
1009
- * If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
950
+ * <p>The name of the database that contains the schemas to list. If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
1010
951
  * @public
1011
952
  */
1012
953
  Database: string | undefined;
@@ -1016,9 +957,7 @@ export interface ListSchemasRequest {
1016
957
  */
1017
958
  ConnectedDatabase?: string | undefined;
1018
959
  /**
1019
- * <p>A pattern to filter results by schema name. Within a schema pattern, "%" means match any
1020
- * substring of 0 or more characters and "_" means match any one character. Only schema name
1021
- * entries matching the search pattern are returned. </p>
960
+ * <p>A pattern to filter results by schema name. Within a schema pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only schema name entries matching the search pattern are returned. </p>
1022
961
  * @public
1023
962
  */
1024
963
  SchemaPattern?: string | undefined;
@@ -1028,8 +967,7 @@ export interface ListSchemasRequest {
1028
967
  */
1029
968
  NextToken?: string | undefined;
1030
969
  /**
1031
- * <p>The maximum number of schemas to return in the response.
1032
- * If more schemas exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
970
+ * <p>The maximum number of schemas to return in the response. If more schemas exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
1033
971
  * @public
1034
972
  */
1035
973
  MaxResults?: number | undefined;
@@ -1064,68 +1002,37 @@ export interface ListStatementsRequest {
1064
1002
  */
1065
1003
  NextToken?: string | undefined;
1066
1004
  /**
1067
- * <p>The maximum number of SQL statements to return in the response.
1068
- * If more SQL statements exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
1005
+ * <p>The maximum number of SQL statements to return in the response. If more SQL statements exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
1069
1006
  * @public
1070
1007
  */
1071
1008
  MaxResults?: number | undefined;
1072
1009
  /**
1073
- * <p>The name of the SQL statement specified as input to <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> to identify the query.
1074
- * You can list multiple statements by providing a prefix that matches the beginning of the statement name.
1075
- * For example, to list myStatement1, myStatement2, myStatement3, and so on, then provide the a value of <code>myStatement</code>.
1076
- * Data API does a case-sensitive match of SQL statement names to the prefix value you provide. </p>
1010
+ * <p>The name of the SQL statement specified as input to <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> to identify the query. You can list multiple statements by providing a prefix that matches the beginning of the statement name. For example, to list myStatement1, myStatement2, myStatement3, and so on, then provide the a value of <code>myStatement</code>. Data API does a case-sensitive match of SQL statement names to the prefix value you provide. </p>
1077
1011
  * @public
1078
1012
  */
1079
1013
  StatementName?: string | undefined;
1080
1014
  /**
1081
- * <p>The status of the SQL statement to list. Status values are defined as follows: </p>
1082
- * <ul>
1083
- * <li>
1084
- * <p>ABORTED - The query run was stopped by the user. </p>
1085
- * </li>
1086
- * <li>
1087
- * <p>ALL - A status value that includes all query statuses. This value can be used to filter results. </p>
1088
- * </li>
1089
- * <li>
1090
- * <p>FAILED - The query run failed. </p>
1091
- * </li>
1092
- * <li>
1093
- * <p>FINISHED - The query has finished running. </p>
1094
- * </li>
1095
- * <li>
1096
- * <p>PICKED - The query has been chosen to be run. </p>
1097
- * </li>
1098
- * <li>
1099
- * <p>STARTED - The query run has started. </p>
1100
- * </li>
1101
- * <li>
1102
- * <p>SUBMITTED - The query was submitted, but not yet processed. </p>
1103
- * </li>
1104
- * </ul>
1015
+ * <p>The status of the SQL statement to list. Status values are defined as follows: </p> <ul> <li> <p>ABORTED - The query run was stopped by the user. </p> </li> <li> <p>ALL - A status value that includes all query statuses. This value can be used to filter results. </p> </li> <li> <p>FAILED - The query run failed. </p> </li> <li> <p>FINISHED - The query has finished running. </p> </li> <li> <p>PICKED - The query has been chosen to be run. </p> </li> <li> <p>STARTED - The query run has started. </p> </li> <li> <p>SUBMITTED - The query was submitted, but not yet processed. </p> </li> </ul>
1105
1016
  * @public
1106
1017
  */
1107
1018
  Status?: StatusString | undefined;
1108
1019
  /**
1109
- * <p>A value that filters which statements to return in the response. If true, all statements run by the caller's IAM role are returned.
1110
- * If false, only statements run by the caller's IAM role in the current IAM session are returned. The default is true. </p>
1020
+ * <p>A value that filters which statements to return in the response. If true, all statements run by the caller's IAM role are returned. If false, only statements run by the caller's IAM role in the current IAM session are returned. The default is true. </p>
1111
1021
  * @public
1112
1022
  */
1113
1023
  RoleLevel?: boolean | undefined;
1114
1024
  /**
1115
- * <p>The name of the database when listing statements run against a <code>ClusterIdentifier</code> or <code>WorkgroupName</code>.
1116
- * </p>
1025
+ * <p>The name of the database when listing statements run against a <code>ClusterIdentifier</code> or <code>WorkgroupName</code>. </p>
1117
1026
  * @public
1118
1027
  */
1119
1028
  Database?: string | undefined;
1120
1029
  /**
1121
- * <p>The cluster identifier. Only statements that ran on this cluster are returned.
1122
- * When providing <code>ClusterIdentifier</code>, then <code>WorkgroupName</code> can't be specified.</p>
1030
+ * <p>The cluster identifier. Only statements that ran on this cluster are returned. When providing <code>ClusterIdentifier</code>, then <code>WorkgroupName</code> can't be specified.</p>
1123
1031
  * @public
1124
1032
  */
1125
1033
  ClusterIdentifier?: string | undefined;
1126
1034
  /**
1127
- * <p>The serverless workgroup name or Amazon Resource Name (ARN). Only statements that ran on this workgroup are returned.
1128
- * When providing <code>WorkgroupName</code>, then <code>ClusterIdentifier</code> can't be specified.</p>
1035
+ * <p>The serverless workgroup name or Amazon Resource Name (ARN). Only statements that ran on this workgroup are returned. When providing <code>WorkgroupName</code>, then <code>ClusterIdentifier</code> can't be specified.</p>
1129
1036
  * @public
1130
1037
  */
1131
1038
  WorkgroupName?: string | undefined;
@@ -1156,9 +1063,7 @@ export interface StatementData {
1156
1063
  */
1157
1064
  SecretArn?: string | undefined;
1158
1065
  /**
1159
- * <p>The status of the SQL statement. An
1160
- * example is the that the SQL statement finished.
1161
- * </p>
1066
+ * <p>The status of the SQL statement. An example is the that the SQL statement finished. </p>
1162
1067
  * @public
1163
1068
  */
1164
1069
  Status?: StatusString | undefined;
@@ -1233,8 +1138,7 @@ export interface ListTablesRequest {
1233
1138
  */
1234
1139
  DbUser?: string | undefined;
1235
1140
  /**
1236
- * <p>The name of the database that contains the tables to list.
1237
- * If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
1141
+ * <p>The name of the database that contains the tables to list. If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
1238
1142
  * @public
1239
1143
  */
1240
1144
  Database: string | undefined;
@@ -1244,20 +1148,12 @@ export interface ListTablesRequest {
1244
1148
  */
1245
1149
  ConnectedDatabase?: string | undefined;
1246
1150
  /**
1247
- * <p>A pattern to filter results by schema name. Within a schema pattern, "%" means match any
1248
- * substring of 0 or more characters and "_" means match any one character. Only schema name
1249
- * entries matching the search pattern are returned. If <code>SchemaPattern</code> is not specified, then all tables that match
1250
- * <code>TablePattern</code> are returned.
1251
- * If neither <code>SchemaPattern</code> or <code>TablePattern</code> are specified, then all tables are returned. </p>
1151
+ * <p>A pattern to filter results by schema name. Within a schema pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only schema name entries matching the search pattern are returned. If <code>SchemaPattern</code> is not specified, then all tables that match <code>TablePattern</code> are returned. If neither <code>SchemaPattern</code> or <code>TablePattern</code> are specified, then all tables are returned. </p>
1252
1152
  * @public
1253
1153
  */
1254
1154
  SchemaPattern?: string | undefined;
1255
1155
  /**
1256
- * <p>A pattern to filter results by table name. Within a table pattern, "%" means match any
1257
- * substring of 0 or more characters and "_" means match any one character. Only table name
1258
- * entries matching the search pattern are returned. If <code>TablePattern</code> is not specified, then all tables that match
1259
- * <code>SchemaPattern</code>are returned.
1260
- * If neither <code>SchemaPattern</code> or <code>TablePattern</code> are specified, then all tables are returned. </p>
1156
+ * <p>A pattern to filter results by table name. Within a table pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only table name entries matching the search pattern are returned. If <code>TablePattern</code> is not specified, then all tables that match <code>SchemaPattern</code>are returned. If neither <code>SchemaPattern</code> or <code>TablePattern</code> are specified, then all tables are returned. </p>
1261
1157
  * @public
1262
1158
  */
1263
1159
  TablePattern?: string | undefined;
@@ -1267,8 +1163,7 @@ export interface ListTablesRequest {
1267
1163
  */
1268
1164
  NextToken?: string | undefined;
1269
1165
  /**
1270
- * <p>The maximum number of tables to return in the response.
1271
- * If more tables exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
1166
+ * <p>The maximum number of tables to return in the response. If more tables exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
1272
1167
  * @public
1273
1168
  */
1274
1169
  MaxResults?: number | undefined;
@@ -1289,8 +1184,7 @@ export interface TableMember {
1289
1184
  */
1290
1185
  name?: string | undefined;
1291
1186
  /**
1292
- * <p>The type of the table. Possible values include TABLE, VIEW, SYSTEM TABLE, GLOBAL
1293
- * TEMPORARY, LOCAL TEMPORARY, ALIAS, and SYNONYM. </p>
1187
+ * <p>The type of the table. Possible values include TABLE, VIEW, SYSTEM TABLE, GLOBAL TEMPORARY, LOCAL TEMPORARY, ALIAS, and SYNONYM. </p>
1294
1188
  * @public
1295
1189
  */
1296
1190
  type?: string | undefined;