@aws-sdk/client-redshift-data 3.303.0 → 3.309.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/commands/BatchExecuteStatementCommand.js +2 -2
- package/dist-cjs/commands/CancelStatementCommand.js +2 -2
- package/dist-cjs/commands/DescribeStatementCommand.js +2 -2
- package/dist-cjs/commands/DescribeTableCommand.js +2 -2
- package/dist-cjs/commands/ExecuteStatementCommand.js +2 -2
- package/dist-cjs/commands/GetStatementResultCommand.js +2 -2
- package/dist-cjs/commands/ListDatabasesCommand.js +2 -2
- package/dist-cjs/commands/ListSchemasCommand.js +2 -2
- package/dist-cjs/commands/ListStatementsCommand.js +2 -2
- package/dist-cjs/commands/ListTablesCommand.js +2 -2
- package/dist-cjs/protocols/Aws_json1_1.js +194 -200
- package/dist-es/commands/BatchExecuteStatementCommand.js +3 -3
- package/dist-es/commands/CancelStatementCommand.js +3 -3
- package/dist-es/commands/DescribeStatementCommand.js +3 -3
- package/dist-es/commands/DescribeTableCommand.js +3 -3
- package/dist-es/commands/ExecuteStatementCommand.js +3 -3
- package/dist-es/commands/GetStatementResultCommand.js +3 -3
- package/dist-es/commands/ListDatabasesCommand.js +3 -3
- package/dist-es/commands/ListSchemasCommand.js +3 -3
- package/dist-es/commands/ListStatementsCommand.js +3 -3
- package/dist-es/commands/ListTablesCommand.js +3 -3
- package/dist-es/protocols/Aws_json1_1.js +173 -179
- package/dist-types/RedshiftData.d.ts +144 -30
- package/dist-types/commands/BatchExecuteStatementCommand.d.ts +24 -5
- package/dist-types/commands/DescribeTableCommand.d.ts +24 -5
- package/dist-types/commands/ExecuteStatementCommand.d.ts +24 -5
- package/dist-types/commands/ListDatabasesCommand.d.ts +24 -5
- package/dist-types/commands/ListSchemasCommand.d.ts +24 -5
- package/dist-types/commands/ListTablesCommand.d.ts +24 -5
- package/dist-types/models/models_0.d.ts +6 -6
- package/dist-types/protocols/Aws_json1_1.d.ts +80 -20
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +20 -20
- package/package.json +29 -29
|
@@ -27,13 +27,32 @@ export declare class RedshiftData extends RedshiftDataClient {
|
|
|
27
27
|
* method, use one of the following combinations of request parameters: </p>
|
|
28
28
|
* <ul>
|
|
29
29
|
* <li>
|
|
30
|
-
* <p>Secrets Manager - when connecting to a cluster,
|
|
31
|
-
*
|
|
30
|
+
* <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret
|
|
31
|
+
* stored in Secrets Manager which has <code>username</code> and <code>password</code>.
|
|
32
|
+
* The specified secret contains credentials
|
|
33
|
+
* to connect to the <code>database</code> you specify.
|
|
34
|
+
* When you are connecting to a cluster, you also supply the database name,
|
|
35
|
+
* If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret.
|
|
36
|
+
* When you are connecting to a serverless workgroup, you also supply the database name.</p>
|
|
32
37
|
* </li>
|
|
33
38
|
* <li>
|
|
34
|
-
* <p>Temporary credentials - when connecting to
|
|
35
|
-
*
|
|
36
|
-
*
|
|
39
|
+
* <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p>
|
|
40
|
+
* <ul>
|
|
41
|
+
* <li>
|
|
42
|
+
* <p>When connecting to a serverless workgroup, specify the workgroup name and database name.
|
|
43
|
+
* 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>.
|
|
44
|
+
* Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required.</p>
|
|
45
|
+
* </li>
|
|
46
|
+
* <li>
|
|
47
|
+
* <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name.
|
|
48
|
+
* 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>.
|
|
49
|
+
* Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p>
|
|
50
|
+
* </li>
|
|
51
|
+
* <li>
|
|
52
|
+
* <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name.
|
|
53
|
+
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p>
|
|
54
|
+
* </li>
|
|
55
|
+
* </ul>
|
|
37
56
|
* </li>
|
|
38
57
|
* </ul>
|
|
39
58
|
* <p>For more information about the Amazon Redshift Data API and CLI usage examples, see
|
|
@@ -74,13 +93,32 @@ export declare class RedshiftData extends RedshiftDataClient {
|
|
|
74
93
|
* following combinations of request parameters: </p>
|
|
75
94
|
* <ul>
|
|
76
95
|
* <li>
|
|
77
|
-
* <p>Secrets Manager - when connecting to a cluster,
|
|
78
|
-
*
|
|
96
|
+
* <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret
|
|
97
|
+
* stored in Secrets Manager which has <code>username</code> and <code>password</code>.
|
|
98
|
+
* The specified secret contains credentials
|
|
99
|
+
* to connect to the <code>database</code> you specify.
|
|
100
|
+
* When you are connecting to a cluster, you also supply the database name,
|
|
101
|
+
* If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret.
|
|
102
|
+
* When you are connecting to a serverless workgroup, you also supply the database name.</p>
|
|
79
103
|
* </li>
|
|
80
104
|
* <li>
|
|
81
|
-
* <p>Temporary credentials - when connecting to
|
|
82
|
-
*
|
|
83
|
-
*
|
|
105
|
+
* <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p>
|
|
106
|
+
* <ul>
|
|
107
|
+
* <li>
|
|
108
|
+
* <p>When connecting to a serverless workgroup, specify the workgroup name and database name.
|
|
109
|
+
* 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>.
|
|
110
|
+
* Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required.</p>
|
|
111
|
+
* </li>
|
|
112
|
+
* <li>
|
|
113
|
+
* <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name.
|
|
114
|
+
* 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>.
|
|
115
|
+
* Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p>
|
|
116
|
+
* </li>
|
|
117
|
+
* <li>
|
|
118
|
+
* <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name.
|
|
119
|
+
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p>
|
|
120
|
+
* </li>
|
|
121
|
+
* </ul>
|
|
84
122
|
* </li>
|
|
85
123
|
* </ul>
|
|
86
124
|
* <p>For more information about the Amazon Redshift Data API and CLI usage examples, see
|
|
@@ -98,13 +136,32 @@ export declare class RedshiftData extends RedshiftDataClient {
|
|
|
98
136
|
* method, use one of the following combinations of request parameters: </p>
|
|
99
137
|
* <ul>
|
|
100
138
|
* <li>
|
|
101
|
-
* <p>Secrets Manager - when connecting to a cluster,
|
|
102
|
-
*
|
|
139
|
+
* <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret
|
|
140
|
+
* stored in Secrets Manager which has <code>username</code> and <code>password</code>.
|
|
141
|
+
* The specified secret contains credentials
|
|
142
|
+
* to connect to the <code>database</code> you specify.
|
|
143
|
+
* When you are connecting to a cluster, you also supply the database name,
|
|
144
|
+
* If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret.
|
|
145
|
+
* When you are connecting to a serverless workgroup, you also supply the database name.</p>
|
|
103
146
|
* </li>
|
|
104
147
|
* <li>
|
|
105
|
-
* <p>Temporary credentials - when connecting to
|
|
106
|
-
*
|
|
107
|
-
*
|
|
148
|
+
* <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p>
|
|
149
|
+
* <ul>
|
|
150
|
+
* <li>
|
|
151
|
+
* <p>When connecting to a serverless workgroup, specify the workgroup name and database name.
|
|
152
|
+
* 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>.
|
|
153
|
+
* Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required.</p>
|
|
154
|
+
* </li>
|
|
155
|
+
* <li>
|
|
156
|
+
* <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name.
|
|
157
|
+
* 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>.
|
|
158
|
+
* Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p>
|
|
159
|
+
* </li>
|
|
160
|
+
* <li>
|
|
161
|
+
* <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name.
|
|
162
|
+
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p>
|
|
163
|
+
* </li>
|
|
164
|
+
* </ul>
|
|
108
165
|
* </li>
|
|
109
166
|
* </ul>
|
|
110
167
|
* <p>For more information about the Amazon Redshift Data API and CLI usage examples, see
|
|
@@ -133,13 +190,32 @@ export declare class RedshiftData extends RedshiftDataClient {
|
|
|
133
190
|
* following combinations of request parameters: </p>
|
|
134
191
|
* <ul>
|
|
135
192
|
* <li>
|
|
136
|
-
* <p>Secrets Manager - when connecting to a cluster,
|
|
137
|
-
*
|
|
193
|
+
* <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret
|
|
194
|
+
* stored in Secrets Manager which has <code>username</code> and <code>password</code>.
|
|
195
|
+
* The specified secret contains credentials
|
|
196
|
+
* to connect to the <code>database</code> you specify.
|
|
197
|
+
* When you are connecting to a cluster, you also supply the database name,
|
|
198
|
+
* If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret.
|
|
199
|
+
* When you are connecting to a serverless workgroup, you also supply the database name.</p>
|
|
138
200
|
* </li>
|
|
139
201
|
* <li>
|
|
140
|
-
* <p>Temporary credentials - when connecting to
|
|
141
|
-
*
|
|
142
|
-
*
|
|
202
|
+
* <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p>
|
|
203
|
+
* <ul>
|
|
204
|
+
* <li>
|
|
205
|
+
* <p>When connecting to a serverless workgroup, specify the workgroup name and database name.
|
|
206
|
+
* 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>.
|
|
207
|
+
* Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required.</p>
|
|
208
|
+
* </li>
|
|
209
|
+
* <li>
|
|
210
|
+
* <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name.
|
|
211
|
+
* 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>.
|
|
212
|
+
* Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p>
|
|
213
|
+
* </li>
|
|
214
|
+
* <li>
|
|
215
|
+
* <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name.
|
|
216
|
+
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p>
|
|
217
|
+
* </li>
|
|
218
|
+
* </ul>
|
|
143
219
|
* </li>
|
|
144
220
|
* </ul>
|
|
145
221
|
* <p>For more information about the Amazon Redshift Data API and CLI usage examples, see
|
|
@@ -157,13 +233,32 @@ export declare class RedshiftData extends RedshiftDataClient {
|
|
|
157
233
|
* following combinations of request parameters: </p>
|
|
158
234
|
* <ul>
|
|
159
235
|
* <li>
|
|
160
|
-
* <p>Secrets Manager - when connecting to a cluster,
|
|
161
|
-
*
|
|
236
|
+
* <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret
|
|
237
|
+
* stored in Secrets Manager which has <code>username</code> and <code>password</code>.
|
|
238
|
+
* The specified secret contains credentials
|
|
239
|
+
* to connect to the <code>database</code> you specify.
|
|
240
|
+
* When you are connecting to a cluster, you also supply the database name,
|
|
241
|
+
* If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret.
|
|
242
|
+
* When you are connecting to a serverless workgroup, you also supply the database name.</p>
|
|
162
243
|
* </li>
|
|
163
244
|
* <li>
|
|
164
|
-
* <p>Temporary credentials - when connecting to
|
|
165
|
-
*
|
|
166
|
-
*
|
|
245
|
+
* <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p>
|
|
246
|
+
* <ul>
|
|
247
|
+
* <li>
|
|
248
|
+
* <p>When connecting to a serverless workgroup, specify the workgroup name and database name.
|
|
249
|
+
* 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>.
|
|
250
|
+
* Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required.</p>
|
|
251
|
+
* </li>
|
|
252
|
+
* <li>
|
|
253
|
+
* <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name.
|
|
254
|
+
* 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>.
|
|
255
|
+
* Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p>
|
|
256
|
+
* </li>
|
|
257
|
+
* <li>
|
|
258
|
+
* <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name.
|
|
259
|
+
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p>
|
|
260
|
+
* </li>
|
|
261
|
+
* </ul>
|
|
167
262
|
* </li>
|
|
168
263
|
* </ul>
|
|
169
264
|
* <p>For more information about the Amazon Redshift Data API and CLI usage examples, see
|
|
@@ -193,13 +288,32 @@ export declare class RedshiftData extends RedshiftDataClient {
|
|
|
193
288
|
* following combinations of request parameters: </p>
|
|
194
289
|
* <ul>
|
|
195
290
|
* <li>
|
|
196
|
-
* <p>Secrets Manager - when connecting to a cluster,
|
|
197
|
-
*
|
|
291
|
+
* <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret
|
|
292
|
+
* stored in Secrets Manager which has <code>username</code> and <code>password</code>.
|
|
293
|
+
* The specified secret contains credentials
|
|
294
|
+
* to connect to the <code>database</code> you specify.
|
|
295
|
+
* When you are connecting to a cluster, you also supply the database name,
|
|
296
|
+
* If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret.
|
|
297
|
+
* When you are connecting to a serverless workgroup, you also supply the database name.</p>
|
|
198
298
|
* </li>
|
|
199
299
|
* <li>
|
|
200
|
-
* <p>Temporary credentials - when connecting to
|
|
201
|
-
*
|
|
202
|
-
*
|
|
300
|
+
* <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p>
|
|
301
|
+
* <ul>
|
|
302
|
+
* <li>
|
|
303
|
+
* <p>When connecting to a serverless workgroup, specify the workgroup name and database name.
|
|
304
|
+
* 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>.
|
|
305
|
+
* Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required.</p>
|
|
306
|
+
* </li>
|
|
307
|
+
* <li>
|
|
308
|
+
* <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name.
|
|
309
|
+
* 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>.
|
|
310
|
+
* Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p>
|
|
311
|
+
* </li>
|
|
312
|
+
* <li>
|
|
313
|
+
* <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name.
|
|
314
|
+
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p>
|
|
315
|
+
* </li>
|
|
316
|
+
* </ul>
|
|
203
317
|
* </li>
|
|
204
318
|
* </ul>
|
|
205
319
|
* <p>For more information about the Amazon Redshift Data API and CLI usage examples, see
|
|
@@ -25,13 +25,32 @@ export interface BatchExecuteStatementCommandOutput extends BatchExecuteStatemen
|
|
|
25
25
|
* method, use one of the following combinations of request parameters: </p>
|
|
26
26
|
* <ul>
|
|
27
27
|
* <li>
|
|
28
|
-
* <p>Secrets Manager - when connecting to a cluster,
|
|
29
|
-
*
|
|
28
|
+
* <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret
|
|
29
|
+
* stored in Secrets Manager which has <code>username</code> and <code>password</code>.
|
|
30
|
+
* The specified secret contains credentials
|
|
31
|
+
* to connect to the <code>database</code> you specify.
|
|
32
|
+
* When you are connecting to a cluster, you also supply the database name,
|
|
33
|
+
* If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret.
|
|
34
|
+
* When you are connecting to a serverless workgroup, you also supply the database name.</p>
|
|
30
35
|
* </li>
|
|
31
36
|
* <li>
|
|
32
|
-
* <p>Temporary credentials - when connecting to
|
|
33
|
-
*
|
|
34
|
-
*
|
|
37
|
+
* <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p>
|
|
38
|
+
* <ul>
|
|
39
|
+
* <li>
|
|
40
|
+
* <p>When connecting to a serverless workgroup, specify the workgroup name and database name.
|
|
41
|
+
* 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>.
|
|
42
|
+
* Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required.</p>
|
|
43
|
+
* </li>
|
|
44
|
+
* <li>
|
|
45
|
+
* <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name.
|
|
46
|
+
* 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>.
|
|
47
|
+
* Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p>
|
|
48
|
+
* </li>
|
|
49
|
+
* <li>
|
|
50
|
+
* <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name.
|
|
51
|
+
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p>
|
|
52
|
+
* </li>
|
|
53
|
+
* </ul>
|
|
35
54
|
* </li>
|
|
36
55
|
* </ul>
|
|
37
56
|
* <p>For more information about the Amazon Redshift Data API and CLI usage examples, see
|
|
@@ -26,13 +26,32 @@ export interface DescribeTableCommandOutput extends DescribeTableResponse, __Met
|
|
|
26
26
|
* following combinations of request parameters: </p>
|
|
27
27
|
* <ul>
|
|
28
28
|
* <li>
|
|
29
|
-
* <p>Secrets Manager - when connecting to a cluster,
|
|
30
|
-
*
|
|
29
|
+
* <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret
|
|
30
|
+
* stored in Secrets Manager which has <code>username</code> and <code>password</code>.
|
|
31
|
+
* The specified secret contains credentials
|
|
32
|
+
* to connect to the <code>database</code> you specify.
|
|
33
|
+
* When you are connecting to a cluster, you also supply the database name,
|
|
34
|
+
* If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret.
|
|
35
|
+
* When you are connecting to a serverless workgroup, you also supply the database name.</p>
|
|
31
36
|
* </li>
|
|
32
37
|
* <li>
|
|
33
|
-
* <p>Temporary credentials - when connecting to
|
|
34
|
-
*
|
|
35
|
-
*
|
|
38
|
+
* <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p>
|
|
39
|
+
* <ul>
|
|
40
|
+
* <li>
|
|
41
|
+
* <p>When connecting to a serverless workgroup, specify the workgroup name and database name.
|
|
42
|
+
* 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>.
|
|
43
|
+
* Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required.</p>
|
|
44
|
+
* </li>
|
|
45
|
+
* <li>
|
|
46
|
+
* <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name.
|
|
47
|
+
* 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>.
|
|
48
|
+
* Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p>
|
|
49
|
+
* </li>
|
|
50
|
+
* <li>
|
|
51
|
+
* <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name.
|
|
52
|
+
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p>
|
|
53
|
+
* </li>
|
|
54
|
+
* </ul>
|
|
36
55
|
* </li>
|
|
37
56
|
* </ul>
|
|
38
57
|
* <p>For more information about the Amazon Redshift Data API and CLI usage examples, see
|
|
@@ -25,13 +25,32 @@ export interface ExecuteStatementCommandOutput extends ExecuteStatementOutput, _
|
|
|
25
25
|
* method, use one of the following combinations of request parameters: </p>
|
|
26
26
|
* <ul>
|
|
27
27
|
* <li>
|
|
28
|
-
* <p>Secrets Manager - when connecting to a cluster,
|
|
29
|
-
*
|
|
28
|
+
* <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret
|
|
29
|
+
* stored in Secrets Manager which has <code>username</code> and <code>password</code>.
|
|
30
|
+
* The specified secret contains credentials
|
|
31
|
+
* to connect to the <code>database</code> you specify.
|
|
32
|
+
* When you are connecting to a cluster, you also supply the database name,
|
|
33
|
+
* If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret.
|
|
34
|
+
* When you are connecting to a serverless workgroup, you also supply the database name.</p>
|
|
30
35
|
* </li>
|
|
31
36
|
* <li>
|
|
32
|
-
* <p>Temporary credentials - when connecting to
|
|
33
|
-
*
|
|
34
|
-
*
|
|
37
|
+
* <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p>
|
|
38
|
+
* <ul>
|
|
39
|
+
* <li>
|
|
40
|
+
* <p>When connecting to a serverless workgroup, specify the workgroup name and database name.
|
|
41
|
+
* 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>.
|
|
42
|
+
* Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required.</p>
|
|
43
|
+
* </li>
|
|
44
|
+
* <li>
|
|
45
|
+
* <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name.
|
|
46
|
+
* 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>.
|
|
47
|
+
* Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p>
|
|
48
|
+
* </li>
|
|
49
|
+
* <li>
|
|
50
|
+
* <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name.
|
|
51
|
+
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p>
|
|
52
|
+
* </li>
|
|
53
|
+
* </ul>
|
|
35
54
|
* </li>
|
|
36
55
|
* </ul>
|
|
37
56
|
* <p>For more information about the Amazon Redshift Data API and CLI usage examples, see
|
|
@@ -25,13 +25,32 @@ export interface ListDatabasesCommandOutput extends ListDatabasesResponse, __Met
|
|
|
25
25
|
* following combinations of request parameters: </p>
|
|
26
26
|
* <ul>
|
|
27
27
|
* <li>
|
|
28
|
-
* <p>Secrets Manager - when connecting to a cluster,
|
|
29
|
-
*
|
|
28
|
+
* <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret
|
|
29
|
+
* stored in Secrets Manager which has <code>username</code> and <code>password</code>.
|
|
30
|
+
* The specified secret contains credentials
|
|
31
|
+
* to connect to the <code>database</code> you specify.
|
|
32
|
+
* When you are connecting to a cluster, you also supply the database name,
|
|
33
|
+
* If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret.
|
|
34
|
+
* When you are connecting to a serverless workgroup, you also supply the database name.</p>
|
|
30
35
|
* </li>
|
|
31
36
|
* <li>
|
|
32
|
-
* <p>Temporary credentials - when connecting to
|
|
33
|
-
*
|
|
34
|
-
*
|
|
37
|
+
* <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p>
|
|
38
|
+
* <ul>
|
|
39
|
+
* <li>
|
|
40
|
+
* <p>When connecting to a serverless workgroup, specify the workgroup name and database name.
|
|
41
|
+
* 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>.
|
|
42
|
+
* Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required.</p>
|
|
43
|
+
* </li>
|
|
44
|
+
* <li>
|
|
45
|
+
* <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name.
|
|
46
|
+
* 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>.
|
|
47
|
+
* Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p>
|
|
48
|
+
* </li>
|
|
49
|
+
* <li>
|
|
50
|
+
* <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name.
|
|
51
|
+
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p>
|
|
52
|
+
* </li>
|
|
53
|
+
* </ul>
|
|
35
54
|
* </li>
|
|
36
55
|
* </ul>
|
|
37
56
|
* <p>For more information about the Amazon Redshift Data API and CLI usage examples, see
|
|
@@ -25,13 +25,32 @@ export interface ListSchemasCommandOutput extends ListSchemasResponse, __Metadat
|
|
|
25
25
|
* following combinations of request parameters: </p>
|
|
26
26
|
* <ul>
|
|
27
27
|
* <li>
|
|
28
|
-
* <p>Secrets Manager - when connecting to a cluster,
|
|
29
|
-
*
|
|
28
|
+
* <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret
|
|
29
|
+
* stored in Secrets Manager which has <code>username</code> and <code>password</code>.
|
|
30
|
+
* The specified secret contains credentials
|
|
31
|
+
* to connect to the <code>database</code> you specify.
|
|
32
|
+
* When you are connecting to a cluster, you also supply the database name,
|
|
33
|
+
* If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret.
|
|
34
|
+
* When you are connecting to a serverless workgroup, you also supply the database name.</p>
|
|
30
35
|
* </li>
|
|
31
36
|
* <li>
|
|
32
|
-
* <p>Temporary credentials - when connecting to
|
|
33
|
-
*
|
|
34
|
-
*
|
|
37
|
+
* <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p>
|
|
38
|
+
* <ul>
|
|
39
|
+
* <li>
|
|
40
|
+
* <p>When connecting to a serverless workgroup, specify the workgroup name and database name.
|
|
41
|
+
* 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>.
|
|
42
|
+
* Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required.</p>
|
|
43
|
+
* </li>
|
|
44
|
+
* <li>
|
|
45
|
+
* <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name.
|
|
46
|
+
* 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>.
|
|
47
|
+
* Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p>
|
|
48
|
+
* </li>
|
|
49
|
+
* <li>
|
|
50
|
+
* <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name.
|
|
51
|
+
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p>
|
|
52
|
+
* </li>
|
|
53
|
+
* </ul>
|
|
35
54
|
* </li>
|
|
36
55
|
* </ul>
|
|
37
56
|
* <p>For more information about the Amazon Redshift Data API and CLI usage examples, see
|
|
@@ -26,13 +26,32 @@ export interface ListTablesCommandOutput extends ListTablesResponse, __MetadataB
|
|
|
26
26
|
* following combinations of request parameters: </p>
|
|
27
27
|
* <ul>
|
|
28
28
|
* <li>
|
|
29
|
-
* <p>Secrets Manager - when connecting to a cluster,
|
|
30
|
-
*
|
|
29
|
+
* <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret
|
|
30
|
+
* stored in Secrets Manager which has <code>username</code> and <code>password</code>.
|
|
31
|
+
* The specified secret contains credentials
|
|
32
|
+
* to connect to the <code>database</code> you specify.
|
|
33
|
+
* When you are connecting to a cluster, you also supply the database name,
|
|
34
|
+
* If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret.
|
|
35
|
+
* When you are connecting to a serverless workgroup, you also supply the database name.</p>
|
|
31
36
|
* </li>
|
|
32
37
|
* <li>
|
|
33
|
-
* <p>Temporary credentials - when connecting to
|
|
34
|
-
*
|
|
35
|
-
*
|
|
38
|
+
* <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p>
|
|
39
|
+
* <ul>
|
|
40
|
+
* <li>
|
|
41
|
+
* <p>When connecting to a serverless workgroup, specify the workgroup name and database name.
|
|
42
|
+
* 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>.
|
|
43
|
+
* Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required.</p>
|
|
44
|
+
* </li>
|
|
45
|
+
* <li>
|
|
46
|
+
* <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name.
|
|
47
|
+
* 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>.
|
|
48
|
+
* Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p>
|
|
49
|
+
* </li>
|
|
50
|
+
* <li>
|
|
51
|
+
* <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name.
|
|
52
|
+
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p>
|
|
53
|
+
* </li>
|
|
54
|
+
* </ul>
|
|
36
55
|
* </li>
|
|
37
56
|
* </ul>
|
|
38
57
|
* <p>For more information about the Amazon Redshift Data API and CLI usage examples, see
|
|
@@ -51,7 +51,7 @@ export interface BatchExecuteStatementInput {
|
|
|
51
51
|
*/
|
|
52
52
|
SecretArn?: string;
|
|
53
53
|
/**
|
|
54
|
-
* <p>The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials. </p>
|
|
54
|
+
* <p>The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials. </p>
|
|
55
55
|
*/
|
|
56
56
|
DbUser?: string;
|
|
57
57
|
/**
|
|
@@ -491,7 +491,7 @@ export interface DescribeTableRequest {
|
|
|
491
491
|
*/
|
|
492
492
|
SecretArn?: string;
|
|
493
493
|
/**
|
|
494
|
-
* <p>The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials. </p>
|
|
494
|
+
* <p>The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials. </p>
|
|
495
495
|
*/
|
|
496
496
|
DbUser?: string;
|
|
497
497
|
/**
|
|
@@ -580,7 +580,7 @@ export interface ExecuteStatementInput {
|
|
|
580
580
|
*/
|
|
581
581
|
SecretArn?: string;
|
|
582
582
|
/**
|
|
583
|
-
* <p>The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials. </p>
|
|
583
|
+
* <p>The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials. </p>
|
|
584
584
|
*/
|
|
585
585
|
DbUser?: string;
|
|
586
586
|
/**
|
|
@@ -797,7 +797,7 @@ export interface ListDatabasesRequest {
|
|
|
797
797
|
*/
|
|
798
798
|
SecretArn?: string;
|
|
799
799
|
/**
|
|
800
|
-
* <p>The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials. </p>
|
|
800
|
+
* <p>The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials. </p>
|
|
801
801
|
*/
|
|
802
802
|
DbUser?: string;
|
|
803
803
|
/**
|
|
@@ -840,7 +840,7 @@ export interface ListSchemasRequest {
|
|
|
840
840
|
*/
|
|
841
841
|
SecretArn?: string;
|
|
842
842
|
/**
|
|
843
|
-
* <p>The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials. </p>
|
|
843
|
+
* <p>The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials. </p>
|
|
844
844
|
*/
|
|
845
845
|
DbUser?: string;
|
|
846
846
|
/**
|
|
@@ -1012,7 +1012,7 @@ export interface ListTablesRequest {
|
|
|
1012
1012
|
*/
|
|
1013
1013
|
SecretArn?: string;
|
|
1014
1014
|
/**
|
|
1015
|
-
* <p>The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials. </p>
|
|
1015
|
+
* <p>The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials. </p>
|
|
1016
1016
|
*/
|
|
1017
1017
|
DbUser?: string;
|
|
1018
1018
|
/**
|