@aws-sdk/client-redshift-data 3.935.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.
- package/README.md +1 -5
- package/dist-cjs/index.js +21 -21
- package/dist-es/models/errors.js +16 -16
- package/dist-es/schemas/schemas_0.js +5 -5
- package/dist-types/RedshiftData.d.ts +1 -5
- package/dist-types/RedshiftDataClient.d.ts +1 -5
- package/dist-types/commands/BatchExecuteStatementCommand.d.ts +5 -38
- package/dist-types/commands/CancelStatementCommand.d.ts +4 -4
- package/dist-types/commands/DescribeStatementCommand.d.ts +2 -7
- package/dist-types/commands/DescribeTableCommand.d.ts +4 -38
- package/dist-types/commands/ExecuteStatementCommand.d.ts +5 -38
- package/dist-types/commands/GetStatementResultCommand.d.ts +1 -7
- package/dist-types/commands/GetStatementResultV2Command.d.ts +1 -6
- package/dist-types/commands/ListDatabasesCommand.d.ts +4 -37
- package/dist-types/commands/ListSchemasCommand.d.ts +4 -37
- package/dist-types/commands/ListStatementsCommand.d.ts +4 -10
- package/dist-types/commands/ListTablesCommand.d.ts +4 -38
- package/dist-types/index.d.ts +1 -5
- package/dist-types/models/errors.d.ts +22 -22
- package/dist-types/models/models_0.d.ts +51 -157
- package/dist-types/ts3.4/models/errors.d.ts +9 -9
- package/dist-types/ts3.4/models/models_0.d.ts +3 -3
- package/package.json +12 -12
package/README.md
CHANGED
|
@@ -6,11 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
AWS SDK for JavaScript RedshiftData Client for Node.js, Browser and React Native.
|
|
8
8
|
|
|
9
|
-
<p>You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You
|
|
10
|
-
can run SQL statements, which are committed if the statement succeeds. </p>
|
|
11
|
-
<p>For more information about the Amazon Redshift Data API and CLI usage examples, see
|
|
12
|
-
<a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the
|
|
13
|
-
<i>Amazon Redshift Management Guide</i>. </p>
|
|
9
|
+
<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>
|
|
14
10
|
|
|
15
11
|
## Installing
|
|
16
12
|
|
package/dist-cjs/index.js
CHANGED
|
@@ -175,6 +175,22 @@ let InternalServerException$1 = class InternalServerException extends RedshiftDa
|
|
|
175
175
|
this.Message = opts.Message;
|
|
176
176
|
}
|
|
177
177
|
};
|
|
178
|
+
let ResourceNotFoundException$1 = class ResourceNotFoundException extends RedshiftDataServiceException$1 {
|
|
179
|
+
name = "ResourceNotFoundException";
|
|
180
|
+
$fault = "client";
|
|
181
|
+
Message;
|
|
182
|
+
ResourceId;
|
|
183
|
+
constructor(opts) {
|
|
184
|
+
super({
|
|
185
|
+
name: "ResourceNotFoundException",
|
|
186
|
+
$fault: "client",
|
|
187
|
+
...opts,
|
|
188
|
+
});
|
|
189
|
+
Object.setPrototypeOf(this, ResourceNotFoundException.prototype);
|
|
190
|
+
this.Message = opts.Message;
|
|
191
|
+
this.ResourceId = opts.ResourceId;
|
|
192
|
+
}
|
|
193
|
+
};
|
|
178
194
|
let ValidationException$1 = class ValidationException extends RedshiftDataServiceException$1 {
|
|
179
195
|
name = "ValidationException";
|
|
180
196
|
$fault = "client";
|
|
@@ -203,22 +219,6 @@ let DatabaseConnectionException$1 = class DatabaseConnectionException extends Re
|
|
|
203
219
|
this.Message = opts.Message;
|
|
204
220
|
}
|
|
205
221
|
};
|
|
206
|
-
let ResourceNotFoundException$1 = class ResourceNotFoundException extends RedshiftDataServiceException$1 {
|
|
207
|
-
name = "ResourceNotFoundException";
|
|
208
|
-
$fault = "client";
|
|
209
|
-
Message;
|
|
210
|
-
ResourceId;
|
|
211
|
-
constructor(opts) {
|
|
212
|
-
super({
|
|
213
|
-
name: "ResourceNotFoundException",
|
|
214
|
-
$fault: "client",
|
|
215
|
-
...opts,
|
|
216
|
-
});
|
|
217
|
-
Object.setPrototypeOf(this, ResourceNotFoundException.prototype);
|
|
218
|
-
this.Message = opts.Message;
|
|
219
|
-
this.ResourceId = opts.ResourceId;
|
|
220
|
-
}
|
|
221
|
-
};
|
|
222
222
|
let QueryTimeoutException$1 = class QueryTimeoutException extends RedshiftDataServiceException$1 {
|
|
223
223
|
name = "QueryTimeoutException";
|
|
224
224
|
$fault = "client";
|
|
@@ -427,8 +427,8 @@ var BatchExecuteStatementInput = [
|
|
|
427
427
|
n0,
|
|
428
428
|
_BESI,
|
|
429
429
|
0,
|
|
430
|
-
[_S, _CI, _SA, _DU, _D, _WE, _SN, _WN, _CT, _SKAS, _SIe
|
|
431
|
-
[64 | 0, 0, 0, 0, 0, 2, 0, 0, [0, 4],
|
|
430
|
+
[_S, _CI, _SA, _DU, _D, _WE, _SN, _WN, _CT, _RF, _SKAS, _SIe],
|
|
431
|
+
[64 | 0, 0, 0, 0, 0, 2, 0, 0, [0, 4], 0, 1, 0],
|
|
432
432
|
];
|
|
433
433
|
var BatchExecuteStatementOutput = [
|
|
434
434
|
3,
|
|
@@ -466,7 +466,7 @@ var DescribeStatementResponse = [
|
|
|
466
466
|
n0,
|
|
467
467
|
_DSRe,
|
|
468
468
|
0,
|
|
469
|
-
[_I, _SA, _DU, _D, _CI, _Du, _E, _St, _CA, _UA, _RP, _HRS, _QS, _RR, _RS, _RQI, _QP, _SS, _WN,
|
|
469
|
+
[_I, _SA, _DU, _D, _CI, _Du, _E, _St, _CA, _UA, _RP, _HRS, _QS, _RR, _RS, _RQI, _QP, _SS, _WN, _RF, _SIe],
|
|
470
470
|
[0, 0, 0, 0, 0, 1, 0, 0, 4, 4, 1, 2, 0, 1, 1, 1, () => SqlParametersList, () => SubStatementList, 0, 0, 0],
|
|
471
471
|
];
|
|
472
472
|
var DescribeTableRequest = [
|
|
@@ -495,8 +495,8 @@ var ExecuteStatementInput = [
|
|
|
495
495
|
n0,
|
|
496
496
|
_ESI,
|
|
497
497
|
0,
|
|
498
|
-
[_Sq, _CI, _SA, _DU, _D, _WE, _SN, _P, _WN, _CT, _SKAS, _SIe
|
|
499
|
-
[0, 0, 0, 0, 0, 2, 0, () => SqlParametersList, 0, [0, 4],
|
|
498
|
+
[_Sq, _CI, _SA, _DU, _D, _WE, _SN, _P, _WN, _CT, _RF, _SKAS, _SIe],
|
|
499
|
+
[0, 0, 0, 0, 0, 2, 0, () => SqlParametersList, 0, [0, 4], 0, 1, 0],
|
|
500
500
|
];
|
|
501
501
|
var ExecuteStatementOutput = [
|
|
502
502
|
3,
|
package/dist-es/models/errors.js
CHANGED
|
@@ -57,6 +57,22 @@ export class InternalServerException extends __BaseException {
|
|
|
57
57
|
this.Message = opts.Message;
|
|
58
58
|
}
|
|
59
59
|
}
|
|
60
|
+
export class ResourceNotFoundException extends __BaseException {
|
|
61
|
+
name = "ResourceNotFoundException";
|
|
62
|
+
$fault = "client";
|
|
63
|
+
Message;
|
|
64
|
+
ResourceId;
|
|
65
|
+
constructor(opts) {
|
|
66
|
+
super({
|
|
67
|
+
name: "ResourceNotFoundException",
|
|
68
|
+
$fault: "client",
|
|
69
|
+
...opts,
|
|
70
|
+
});
|
|
71
|
+
Object.setPrototypeOf(this, ResourceNotFoundException.prototype);
|
|
72
|
+
this.Message = opts.Message;
|
|
73
|
+
this.ResourceId = opts.ResourceId;
|
|
74
|
+
}
|
|
75
|
+
}
|
|
60
76
|
export class ValidationException extends __BaseException {
|
|
61
77
|
name = "ValidationException";
|
|
62
78
|
$fault = "client";
|
|
@@ -85,22 +101,6 @@ export class DatabaseConnectionException extends __BaseException {
|
|
|
85
101
|
this.Message = opts.Message;
|
|
86
102
|
}
|
|
87
103
|
}
|
|
88
|
-
export class ResourceNotFoundException extends __BaseException {
|
|
89
|
-
name = "ResourceNotFoundException";
|
|
90
|
-
$fault = "client";
|
|
91
|
-
Message;
|
|
92
|
-
ResourceId;
|
|
93
|
-
constructor(opts) {
|
|
94
|
-
super({
|
|
95
|
-
name: "ResourceNotFoundException",
|
|
96
|
-
$fault: "client",
|
|
97
|
-
...opts,
|
|
98
|
-
});
|
|
99
|
-
Object.setPrototypeOf(this, ResourceNotFoundException.prototype);
|
|
100
|
-
this.Message = opts.Message;
|
|
101
|
-
this.ResourceId = opts.ResourceId;
|
|
102
|
-
}
|
|
103
|
-
}
|
|
104
104
|
export class QueryTimeoutException extends __BaseException {
|
|
105
105
|
name = "QueryTimeoutException";
|
|
106
106
|
$fault = "client";
|
|
@@ -178,8 +178,8 @@ export var BatchExecuteStatementInput = [
|
|
|
178
178
|
n0,
|
|
179
179
|
_BESI,
|
|
180
180
|
0,
|
|
181
|
-
[_S, _CI, _SA, _DU, _D, _WE, _SN, _WN, _CT, _SKAS, _SIe
|
|
182
|
-
[64 | 0, 0, 0, 0, 0, 2, 0, 0, [0, 4],
|
|
181
|
+
[_S, _CI, _SA, _DU, _D, _WE, _SN, _WN, _CT, _RF, _SKAS, _SIe],
|
|
182
|
+
[64 | 0, 0, 0, 0, 0, 2, 0, 0, [0, 4], 0, 1, 0],
|
|
183
183
|
];
|
|
184
184
|
export var BatchExecuteStatementOutput = [
|
|
185
185
|
3,
|
|
@@ -217,7 +217,7 @@ export var DescribeStatementResponse = [
|
|
|
217
217
|
n0,
|
|
218
218
|
_DSRe,
|
|
219
219
|
0,
|
|
220
|
-
[_I, _SA, _DU, _D, _CI, _Du, _E, _St, _CA, _UA, _RP, _HRS, _QS, _RR, _RS, _RQI, _QP, _SS, _WN,
|
|
220
|
+
[_I, _SA, _DU, _D, _CI, _Du, _E, _St, _CA, _UA, _RP, _HRS, _QS, _RR, _RS, _RQI, _QP, _SS, _WN, _RF, _SIe],
|
|
221
221
|
[0, 0, 0, 0, 0, 1, 0, 0, 4, 4, 1, 2, 0, 1, 1, 1, () => SqlParametersList, () => SubStatementList, 0, 0, 0],
|
|
222
222
|
];
|
|
223
223
|
export var DescribeTableRequest = [
|
|
@@ -246,8 +246,8 @@ export var ExecuteStatementInput = [
|
|
|
246
246
|
n0,
|
|
247
247
|
_ESI,
|
|
248
248
|
0,
|
|
249
|
-
[_Sq, _CI, _SA, _DU, _D, _WE, _SN, _P, _WN, _CT, _SKAS, _SIe
|
|
250
|
-
[0, 0, 0, 0, 0, 2, 0, () => SqlParametersList, 0, [0, 4],
|
|
249
|
+
[_Sq, _CI, _SA, _DU, _D, _WE, _SN, _P, _WN, _CT, _RF, _SKAS, _SIe],
|
|
250
|
+
[0, 0, 0, 0, 0, 2, 0, () => SqlParametersList, 0, [0, 4], 0, 1, 0],
|
|
251
251
|
];
|
|
252
252
|
export var ExecuteStatementOutput = [
|
|
253
253
|
3,
|
|
@@ -81,11 +81,7 @@ export interface RedshiftData {
|
|
|
81
81
|
listTables(args: ListTablesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTablesCommandOutput) => void): void;
|
|
82
82
|
}
|
|
83
83
|
/**
|
|
84
|
-
* <p>You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You
|
|
85
|
-
* can run SQL statements, which are committed if the statement succeeds. </p>
|
|
86
|
-
* <p>For more information about the Amazon Redshift Data API and CLI usage examples, see
|
|
87
|
-
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the
|
|
88
|
-
* <i>Amazon Redshift Management Guide</i>. </p>
|
|
84
|
+
* <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>
|
|
89
85
|
* @public
|
|
90
86
|
*/
|
|
91
87
|
export declare class RedshiftData extends RedshiftDataClient implements RedshiftData {
|
|
@@ -189,11 +189,7 @@ export type RedshiftDataClientResolvedConfigType = __SmithyResolvedConfiguration
|
|
|
189
189
|
export interface RedshiftDataClientResolvedConfig extends RedshiftDataClientResolvedConfigType {
|
|
190
190
|
}
|
|
191
191
|
/**
|
|
192
|
-
* <p>You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You
|
|
193
|
-
* can run SQL statements, which are committed if the statement succeeds. </p>
|
|
194
|
-
* <p>For more information about the Amazon Redshift Data API and CLI usage examples, see
|
|
195
|
-
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the
|
|
196
|
-
* <i>Amazon Redshift Management Guide</i>. </p>
|
|
192
|
+
* <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>
|
|
197
193
|
* @public
|
|
198
194
|
*/
|
|
199
195
|
export declare class RedshiftDataClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, RedshiftDataClientResolvedConfig> {
|
|
@@ -27,43 +27,7 @@ declare const BatchExecuteStatementCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Runs one or more SQL statements, which can be data manipulation language (DML) or data definition
|
|
31
|
-
* language (DDL).
|
|
32
|
-
* Depending on the authorization
|
|
33
|
-
* method, use one of the following combinations of request parameters: </p>
|
|
34
|
-
* <ul>
|
|
35
|
-
* <li>
|
|
36
|
-
* <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret
|
|
37
|
-
* stored in Secrets Manager which has <code>username</code> and <code>password</code>.
|
|
38
|
-
* The specified secret contains credentials
|
|
39
|
-
* to connect to the <code>database</code> you specify.
|
|
40
|
-
* When you are connecting to a cluster, you also supply the database name,
|
|
41
|
-
* If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret.
|
|
42
|
-
* When you are connecting to a serverless workgroup, you also supply the database name.</p>
|
|
43
|
-
* </li>
|
|
44
|
-
* <li>
|
|
45
|
-
* <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p>
|
|
46
|
-
* <ul>
|
|
47
|
-
* <li>
|
|
48
|
-
* <p>When connecting to a serverless workgroup, specify the workgroup name and database name.
|
|
49
|
-
* 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>.
|
|
50
|
-
* Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required.</p>
|
|
51
|
-
* </li>
|
|
52
|
-
* <li>
|
|
53
|
-
* <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name.
|
|
54
|
-
* 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>.
|
|
55
|
-
* Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p>
|
|
56
|
-
* </li>
|
|
57
|
-
* <li>
|
|
58
|
-
* <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name.
|
|
59
|
-
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p>
|
|
60
|
-
* </li>
|
|
61
|
-
* </ul>
|
|
62
|
-
* </li>
|
|
63
|
-
* </ul>
|
|
64
|
-
* <p>For more information about the Amazon Redshift Data API and CLI usage examples, see
|
|
65
|
-
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the
|
|
66
|
-
* <i>Amazon Redshift Management Guide</i>. </p>
|
|
30
|
+
* <p>Runs one or more SQL statements, which can be data manipulation language (DML) or data definition language (DDL). 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>
|
|
67
31
|
* @example
|
|
68
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
69
33
|
* ```javascript
|
|
@@ -84,9 +48,9 @@ declare const BatchExecuteStatementCommand_base: {
|
|
|
84
48
|
* StatementName: "STRING_VALUE",
|
|
85
49
|
* WorkgroupName: "STRING_VALUE",
|
|
86
50
|
* ClientToken: "STRING_VALUE",
|
|
51
|
+
* ResultFormat: "STRING_VALUE",
|
|
87
52
|
* SessionKeepAliveSeconds: Number("int"),
|
|
88
53
|
* SessionId: "STRING_VALUE",
|
|
89
|
-
* ResultFormat: "STRING_VALUE",
|
|
90
54
|
* };
|
|
91
55
|
* const command = new BatchExecuteStatementCommand(input);
|
|
92
56
|
* const response = await client.send(command);
|
|
@@ -124,6 +88,9 @@ declare const BatchExecuteStatementCommand_base: {
|
|
|
124
88
|
* @throws {@link InternalServerException} (server fault)
|
|
125
89
|
* <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
|
|
126
90
|
*
|
|
91
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
92
|
+
* <p>The Amazon Redshift Data API operation failed due to a missing resource. </p>
|
|
93
|
+
*
|
|
127
94
|
* @throws {@link ValidationException} (client fault)
|
|
128
95
|
* <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
|
|
129
96
|
*
|
|
@@ -27,10 +27,7 @@ declare const CancelStatementCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Cancels a running query. To be canceled, a query must be running. </p>
|
|
31
|
-
* <p>For more information about the Amazon Redshift Data API and CLI usage examples, see
|
|
32
|
-
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the
|
|
33
|
-
* <i>Amazon Redshift Management Guide</i>. </p>
|
|
30
|
+
* <p>Cancels a running query. To be canceled, a query must be running. </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>
|
|
34
31
|
* @example
|
|
35
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
33
|
* ```javascript
|
|
@@ -62,6 +59,9 @@ declare const CancelStatementCommand_base: {
|
|
|
62
59
|
* @throws {@link InternalServerException} (server fault)
|
|
63
60
|
* <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
|
|
64
61
|
*
|
|
62
|
+
* @throws {@link QueryTimeoutException} (client fault)
|
|
63
|
+
* <p>The Amazon Redshift Data API operation failed due to timeout.</p>
|
|
64
|
+
*
|
|
65
65
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
66
66
|
* <p>The Amazon Redshift Data API operation failed due to a missing resource. </p>
|
|
67
67
|
*
|
|
@@ -27,12 +27,7 @@ declare const DescribeStatementCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Describes the details about a specific instance when a query was run by the Amazon Redshift Data API. The information
|
|
31
|
-
* includes when the query started, when it finished, the query status, the number of rows returned, and the SQL
|
|
32
|
-
* statement. </p>
|
|
33
|
-
* <p>For more information about the Amazon Redshift Data API and CLI usage examples, see
|
|
34
|
-
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the
|
|
35
|
-
* <i>Amazon Redshift Management Guide</i>. </p>
|
|
30
|
+
* <p>Describes the details about a specific instance when a query was run by the Amazon Redshift Data API. The information includes when the query started, when it finished, the query status, the number of rows returned, and the SQL statement. </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>
|
|
36
31
|
* @example
|
|
37
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
38
33
|
* ```javascript
|
|
@@ -85,8 +80,8 @@ declare const DescribeStatementCommand_base: {
|
|
|
85
80
|
* // },
|
|
86
81
|
* // ],
|
|
87
82
|
* // WorkgroupName: "STRING_VALUE",
|
|
88
|
-
* // SessionId: "STRING_VALUE",
|
|
89
83
|
* // ResultFormat: "STRING_VALUE",
|
|
84
|
+
* // SessionId: "STRING_VALUE",
|
|
90
85
|
* // };
|
|
91
86
|
*
|
|
92
87
|
* ```
|
|
@@ -27,44 +27,7 @@ declare const DescribeTableCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Describes the detailed information about a table from metadata in the cluster. The
|
|
31
|
-
* information includes its columns.
|
|
32
|
-
* A token is returned to page through the column 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>Describes the detailed information about a table from metadata in the cluster. The information includes its columns. A token is returned to page through the column 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
|
|
@@ -126,6 +89,9 @@ declare const DescribeTableCommand_base: {
|
|
|
126
89
|
* @throws {@link QueryTimeoutException} (client fault)
|
|
127
90
|
* <p>The Amazon Redshift Data API operation failed due to timeout.</p>
|
|
128
91
|
*
|
|
92
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
93
|
+
* <p>The Amazon Redshift Data API operation failed due to a missing resource. </p>
|
|
94
|
+
*
|
|
129
95
|
* @throws {@link ValidationException} (client fault)
|
|
130
96
|
* <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
|
|
131
97
|
*
|
|
@@ -27,43 +27,7 @@ declare const ExecuteStatementCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Runs an SQL statement, which can be data manipulation language (DML) or data definition
|
|
31
|
-
* language (DDL). This statement must be a single SQL statement.
|
|
32
|
-
* Depending on the authorization
|
|
33
|
-
* method, use one of the following combinations of request parameters: </p>
|
|
34
|
-
* <ul>
|
|
35
|
-
* <li>
|
|
36
|
-
* <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret
|
|
37
|
-
* stored in Secrets Manager which has <code>username</code> and <code>password</code>.
|
|
38
|
-
* The specified secret contains credentials
|
|
39
|
-
* to connect to the <code>database</code> you specify.
|
|
40
|
-
* When you are connecting to a cluster, you also supply the database name,
|
|
41
|
-
* If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret.
|
|
42
|
-
* When you are connecting to a serverless workgroup, you also supply the database name.</p>
|
|
43
|
-
* </li>
|
|
44
|
-
* <li>
|
|
45
|
-
* <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p>
|
|
46
|
-
* <ul>
|
|
47
|
-
* <li>
|
|
48
|
-
* <p>When connecting to a serverless workgroup, specify the workgroup name and database name.
|
|
49
|
-
* 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>.
|
|
50
|
-
* Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required.</p>
|
|
51
|
-
* </li>
|
|
52
|
-
* <li>
|
|
53
|
-
* <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name.
|
|
54
|
-
* 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>.
|
|
55
|
-
* Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p>
|
|
56
|
-
* </li>
|
|
57
|
-
* <li>
|
|
58
|
-
* <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name.
|
|
59
|
-
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p>
|
|
60
|
-
* </li>
|
|
61
|
-
* </ul>
|
|
62
|
-
* </li>
|
|
63
|
-
* </ul>
|
|
64
|
-
* <p>For more information about the Amazon Redshift Data API and CLI usage examples, see
|
|
65
|
-
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the
|
|
66
|
-
* <i>Amazon Redshift Management Guide</i>. </p>
|
|
30
|
+
* <p>Runs an SQL statement, which can be data manipulation language (DML) or data definition language (DDL). This statement must be a single SQL statement. 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>
|
|
67
31
|
* @example
|
|
68
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
69
33
|
* ```javascript
|
|
@@ -88,9 +52,9 @@ declare const ExecuteStatementCommand_base: {
|
|
|
88
52
|
* ],
|
|
89
53
|
* WorkgroupName: "STRING_VALUE",
|
|
90
54
|
* ClientToken: "STRING_VALUE",
|
|
55
|
+
* ResultFormat: "STRING_VALUE",
|
|
91
56
|
* SessionKeepAliveSeconds: Number("int"),
|
|
92
57
|
* SessionId: "STRING_VALUE",
|
|
93
|
-
* ResultFormat: "STRING_VALUE",
|
|
94
58
|
* };
|
|
95
59
|
* const command = new ExecuteStatementCommand(input);
|
|
96
60
|
* const response = await client.send(command);
|
|
@@ -128,6 +92,9 @@ declare const ExecuteStatementCommand_base: {
|
|
|
128
92
|
* @throws {@link InternalServerException} (server fault)
|
|
129
93
|
* <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
|
|
130
94
|
*
|
|
95
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
96
|
+
* <p>The Amazon Redshift Data API operation failed due to a missing resource. </p>
|
|
97
|
+
*
|
|
131
98
|
* @throws {@link ValidationException} (client fault)
|
|
132
99
|
* <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
|
|
133
100
|
*
|
|
@@ -27,13 +27,7 @@ declare const GetStatementResultCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Fetches the temporarily cached result of an SQL statement in JSON format.
|
|
31
|
-
* The <code>ExecuteStatement</code> or <code>BatchExecuteStatement</code> operation that ran the SQL statement must have specified <code>ResultFormat</code> as <code>JSON</code>
|
|
32
|
-
* , or let the format default to JSON.
|
|
33
|
-
* A token is returned to page through the statement results.</p>
|
|
34
|
-
* <p>For more information about the Amazon Redshift Data API and CLI usage examples, see
|
|
35
|
-
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the
|
|
36
|
-
* <i>Amazon Redshift Management Guide</i>. </p>
|
|
30
|
+
* <p>Fetches the temporarily cached result of an SQL statement in JSON format. The <code>ExecuteStatement</code> or <code>BatchExecuteStatement</code> operation that ran the SQL statement must have specified <code>ResultFormat</code> as <code>JSON</code> , or let the format default to JSON. A token is returned to page through the statement results.</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>
|
|
37
31
|
* @example
|
|
38
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
39
33
|
* ```javascript
|
|
@@ -27,12 +27,7 @@ declare const GetStatementResultV2Command_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Fetches the temporarily cached result of an SQL statement in CSV format.
|
|
31
|
-
* The <code>ExecuteStatement</code> or <code>BatchExecuteStatement</code> operation that ran the SQL statement must have specified <code>ResultFormat</code> as <code>CSV</code>.
|
|
32
|
-
* A token is returned to page through the statement results.</p>
|
|
33
|
-
* <p>For more information about the Amazon Redshift Data API and CLI usage examples, see
|
|
34
|
-
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the
|
|
35
|
-
* <i>Amazon Redshift Management Guide</i>. </p>
|
|
30
|
+
* <p>Fetches the temporarily cached result of an SQL statement in CSV format. The <code>ExecuteStatement</code> or <code>BatchExecuteStatement</code> operation that ran the SQL statement must have specified <code>ResultFormat</code> as <code>CSV</code>. A token is returned to page through the statement results.</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>
|
|
36
31
|
* @example
|
|
37
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
38
33
|
* ```javascript
|
|
@@ -27,43 +27,7 @@ declare const ListDatabasesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>List the databases in a cluster.
|
|
31
|
-
* A token is returned to page through the database list.
|
|
32
|
-
* Depending on the authorization method, use one of the
|
|
33
|
-
* following combinations of request parameters: </p>
|
|
34
|
-
* <ul>
|
|
35
|
-
* <li>
|
|
36
|
-
* <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret
|
|
37
|
-
* stored in Secrets Manager which has <code>username</code> and <code>password</code>.
|
|
38
|
-
* The specified secret contains credentials
|
|
39
|
-
* to connect to the <code>database</code> you specify.
|
|
40
|
-
* When you are connecting to a cluster, you also supply the database name,
|
|
41
|
-
* If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret.
|
|
42
|
-
* When you are connecting to a serverless workgroup, you also supply the database name.</p>
|
|
43
|
-
* </li>
|
|
44
|
-
* <li>
|
|
45
|
-
* <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p>
|
|
46
|
-
* <ul>
|
|
47
|
-
* <li>
|
|
48
|
-
* <p>When connecting to a serverless workgroup, specify the workgroup name and database name.
|
|
49
|
-
* 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>.
|
|
50
|
-
* Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required.</p>
|
|
51
|
-
* </li>
|
|
52
|
-
* <li>
|
|
53
|
-
* <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name.
|
|
54
|
-
* 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>.
|
|
55
|
-
* Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p>
|
|
56
|
-
* </li>
|
|
57
|
-
* <li>
|
|
58
|
-
* <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name.
|
|
59
|
-
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p>
|
|
60
|
-
* </li>
|
|
61
|
-
* </ul>
|
|
62
|
-
* </li>
|
|
63
|
-
* </ul>
|
|
64
|
-
* <p>For more information about the Amazon Redshift Data API and CLI usage examples, see
|
|
65
|
-
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the
|
|
66
|
-
* <i>Amazon Redshift Management Guide</i>. </p>
|
|
30
|
+
* <p>List the databases in a cluster. A token is returned to page through the database 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>
|
|
67
31
|
* @example
|
|
68
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
69
33
|
* ```javascript
|
|
@@ -107,6 +71,9 @@ declare const ListDatabasesCommand_base: {
|
|
|
107
71
|
* @throws {@link QueryTimeoutException} (client fault)
|
|
108
72
|
* <p>The Amazon Redshift Data API operation failed due to timeout.</p>
|
|
109
73
|
*
|
|
74
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
75
|
+
* <p>The Amazon Redshift Data API operation failed due to a missing resource. </p>
|
|
76
|
+
*
|
|
110
77
|
* @throws {@link ValidationException} (client fault)
|
|
111
78
|
* <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
|
|
112
79
|
*
|
|
@@ -27,43 +27,7 @@ declare const ListSchemasCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Lists the schemas in a database.
|
|
31
|
-
* A token is returned to page through the schema list.
|
|
32
|
-
* Depending on the authorization method, use one of the
|
|
33
|
-
* following combinations of request parameters: </p>
|
|
34
|
-
* <ul>
|
|
35
|
-
* <li>
|
|
36
|
-
* <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret
|
|
37
|
-
* stored in Secrets Manager which has <code>username</code> and <code>password</code>.
|
|
38
|
-
* The specified secret contains credentials
|
|
39
|
-
* to connect to the <code>database</code> you specify.
|
|
40
|
-
* When you are connecting to a cluster, you also supply the database name,
|
|
41
|
-
* If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret.
|
|
42
|
-
* When you are connecting to a serverless workgroup, you also supply the database name.</p>
|
|
43
|
-
* </li>
|
|
44
|
-
* <li>
|
|
45
|
-
* <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p>
|
|
46
|
-
* <ul>
|
|
47
|
-
* <li>
|
|
48
|
-
* <p>When connecting to a serverless workgroup, specify the workgroup name and database name.
|
|
49
|
-
* 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>.
|
|
50
|
-
* Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required.</p>
|
|
51
|
-
* </li>
|
|
52
|
-
* <li>
|
|
53
|
-
* <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name.
|
|
54
|
-
* 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>.
|
|
55
|
-
* Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p>
|
|
56
|
-
* </li>
|
|
57
|
-
* <li>
|
|
58
|
-
* <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name.
|
|
59
|
-
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p>
|
|
60
|
-
* </li>
|
|
61
|
-
* </ul>
|
|
62
|
-
* </li>
|
|
63
|
-
* </ul>
|
|
64
|
-
* <p>For more information about the Amazon Redshift Data API and CLI usage examples, see
|
|
65
|
-
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the
|
|
66
|
-
* <i>Amazon Redshift Management Guide</i>. </p>
|
|
30
|
+
* <p>Lists the schemas in a database. A token is returned to page through the schema 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>
|
|
67
31
|
* @example
|
|
68
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
69
33
|
* ```javascript
|
|
@@ -109,6 +73,9 @@ declare const ListSchemasCommand_base: {
|
|
|
109
73
|
* @throws {@link QueryTimeoutException} (client fault)
|
|
110
74
|
* <p>The Amazon Redshift Data API operation failed due to timeout.</p>
|
|
111
75
|
*
|
|
76
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
77
|
+
* <p>The Amazon Redshift Data API operation failed due to a missing resource. </p>
|
|
78
|
+
*
|
|
112
79
|
* @throws {@link ValidationException} (client fault)
|
|
113
80
|
* <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
|
|
114
81
|
*
|