Skip to content

Commit e92c230

Browse files
author
awstools
committed
feat(client-redshift-data): This release adds a new --workgroup-name field to operations that connect to an endpoint. Customers can now execute queries against their serverless workgroups.
1 parent e655014 commit e92c230

File tree

12 files changed

+156
-38
lines changed

12 files changed

+156
-38
lines changed

‎clients/client-redshift-data/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ AWS SDK for JavaScript RedshiftData Client for Node.js, Browser and React Native
1111

1212
<p>You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You
1313
can run SQL statements, which are committed if the statement succeeds. </p>
14-
<p>For more information about the Amazon Redshift Data API, see
14+
<p>For more information about the Amazon Redshift Data API and CLI usage examples, see
1515
<a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the
1616
<i>Amazon Redshift Cluster Management Guide</i>. </p>
1717

‎clients/client-redshift-data/src/RedshiftData.ts

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ import { RedshiftDataClient } from "./RedshiftDataClient";
4848
/**
4949
* <p>You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You
5050
* can run SQL statements, which are committed if the statement succeeds. </p>
51-
* <p>For more information about the Amazon Redshift Data API, see
51+
* <p>For more information about the Amazon Redshift Data API and CLI usage examples, see
5252
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the
5353
* <i>Amazon Redshift Cluster Management Guide</i>. </p>
5454
*/
@@ -61,12 +61,12 @@ export class RedshiftData extends RedshiftDataClient {
6161
* <ul>
6262
* <li>
6363
* <p>Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.
64-
* When connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name. </p>
64+
* When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name. </p>
6565
* </li>
6666
* <li>
6767
* <p>Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name.
6868
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.
69-
* When connecting to a serverless endpoint, specify the database name. </p>
69+
* When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required. </p>
7070
* </li>
7171
* </ul>
7272
*/
@@ -174,12 +174,12 @@ export class RedshiftData extends RedshiftDataClient {
174174
* <ul>
175175
* <li>
176176
* <p>Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.
177-
* When connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name. </p>
177+
* When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name. </p>
178178
* </li>
179179
* <li>
180180
* <p>Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name.
181181
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.
182-
* When connecting to a serverless endpoint, specify the database name. </p>
182+
* When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required. </p>
183183
* </li>
184184
* </ul>
185185
*/
@@ -220,12 +220,12 @@ export class RedshiftData extends RedshiftDataClient {
220220
* <ul>
221221
* <li>
222222
* <p>Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.
223-
* When connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name. </p>
223+
* When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name. </p>
224224
* </li>
225225
* <li>
226226
* <p>Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name.
227227
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.
228-
* When connecting to a serverless endpoint, specify the database name. </p>
228+
* When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required. </p>
229229
* </li>
230230
* </ul>
231231
*/
@@ -299,12 +299,12 @@ export class RedshiftData extends RedshiftDataClient {
299299
* <ul>
300300
* <li>
301301
* <p>Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.
302-
* When connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name. </p>
302+
* When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name. </p>
303303
* </li>
304304
* <li>
305305
* <p>Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name.
306306
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.
307-
* When connecting to a serverless endpoint, specify the database name. </p>
307+
* When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required. </p>
308308
* </li>
309309
* </ul>
310310
*/
@@ -345,12 +345,12 @@ export class RedshiftData extends RedshiftDataClient {
345345
* <ul>
346346
* <li>
347347
* <p>Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.
348-
* When connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name. </p>
348+
* When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name. </p>
349349
* </li>
350350
* <li>
351351
* <p>Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name.
352352
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.
353-
* When connecting to a serverless endpoint, specify the database name. </p>
353+
* When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required. </p>
354354
* </li>
355355
* </ul>
356356
*/
@@ -419,12 +419,12 @@ export class RedshiftData extends RedshiftDataClient {
419419
* <ul>
420420
* <li>
421421
* <p>Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.
422-
* When connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name. </p>
422+
* When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name. </p>
423423
* </li>
424424
* <li>
425425
* <p>Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name.
426426
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.
427-
* When connecting to a serverless endpoint, specify the database name. </p>
427+
* When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required. </p>
428428
* </li>
429429
* </ul>
430430
*/

‎clients/client-redshift-data/src/RedshiftDataClient.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,7 @@ export interface RedshiftDataClientResolvedConfig extends RedshiftDataClientReso
248248
/**
249249
* <p>You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You
250250
* can run SQL statements, which are committed if the statement succeeds. </p>
251-
* <p>For more information about the Amazon Redshift Data API, see
251+
* <p>For more information about the Amazon Redshift Data API and CLI usage examples, see
252252
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the
253253
* <i>Amazon Redshift Cluster Management Guide</i>. </p>
254254
*/

‎clients/client-redshift-data/src/commands/BatchExecuteStatementCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@ export interface BatchExecuteStatementCommandOutput extends BatchExecuteStatemen
3030
* <ul>
3131
* <li>
3232
* <p>Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.
33-
* When connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name. </p>
33+
* When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name. </p>
3434
* </li>
3535
* <li>
3636
* <p>Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name.
3737
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.
38-
* When connecting to a serverless endpoint, specify the database name. </p>
38+
* When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required. </p>
3939
* </li>
4040
* </ul>
4141
* @example

‎clients/client-redshift-data/src/commands/DescribeTableCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,12 @@ export interface DescribeTableCommandOutput extends DescribeTableResponse, __Met
3131
* <ul>
3232
* <li>
3333
* <p>Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.
34-
* When connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name. </p>
34+
* When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name. </p>
3535
* </li>
3636
* <li>
3737
* <p>Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name.
3838
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.
39-
* When connecting to a serverless endpoint, specify the database name. </p>
39+
* When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required. </p>
4040
* </li>
4141
* </ul>
4242
* @example

‎clients/client-redshift-data/src/commands/ExecuteStatementCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@ export interface ExecuteStatementCommandOutput extends ExecuteStatementOutput, _
3030
* <ul>
3131
* <li>
3232
* <p>Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.
33-
* When connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name. </p>
33+
* When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name. </p>
3434
* </li>
3535
* <li>
3636
* <p>Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name.
3737
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.
38-
* When connecting to a serverless endpoint, specify the database name. </p>
38+
* When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required. </p>
3939
* </li>
4040
* </ul>
4141
* @example

‎clients/client-redshift-data/src/commands/ListDatabasesCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@ export interface ListDatabasesCommandOutput extends ListDatabasesResponse, __Met
3030
* <ul>
3131
* <li>
3232
* <p>Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.
33-
* When connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name. </p>
33+
* When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name. </p>
3434
* </li>
3535
* <li>
3636
* <p>Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name.
3737
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.
38-
* When connecting to a serverless endpoint, specify the database name. </p>
38+
* When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required. </p>
3939
* </li>
4040
* </ul>
4141
* @example

‎clients/client-redshift-data/src/commands/ListSchemasCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@ export interface ListSchemasCommandOutput extends ListSchemasResponse, __Metadat
3030
* <ul>
3131
* <li>
3232
* <p>Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.
33-
* When connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name. </p>
33+
* When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name. </p>
3434
* </li>
3535
* <li>
3636
* <p>Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name.
3737
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.
38-
* When connecting to a serverless endpoint, specify the database name. </p>
38+
* When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required. </p>
3939
* </li>
4040
* </ul>
4141
* @example

‎clients/client-redshift-data/src/commands/ListTablesCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,12 @@ export interface ListTablesCommandOutput extends ListTablesResponse, __MetadataB
3131
* <ul>
3232
* <li>
3333
* <p>Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.
34-
* When connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name. </p>
34+
* When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name. </p>
3535
* </li>
3636
* <li>
3737
* <p>Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name.
3838
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.
39-
* When connecting to a serverless endpoint, specify the database name. </p>
39+
* When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required. </p>
4040
* </li>
4141
* </ul>
4242
* @example

0 commit comments

Comments
 (0)