Skip to content

Commit c2a5cf1

Browse files
author
awstools
committed
docs(client-redshift-data): Update documentation of API descriptions as needed in support of temporary credentials with IAM identity.
1 parent 500f7df commit c2a5cf1

File tree

9 files changed

+392
-114
lines changed

9 files changed

+392
-114
lines changed

Diff for: ‎clients/client-redshift-data/src/RedshiftData.ts

+144-30
Large diffs are not rendered by default.

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

+24-5
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,32 @@ export interface BatchExecuteStatementCommandOutput extends BatchExecuteStatemen
3838
* method, use one of the following combinations of request parameters: </p>
3939
* <ul>
4040
* <li>
41-
* <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.
42-
* When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name. </p>
41+
* <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret
42+
* stored in Secrets Manager which has <code>username</code> and <code>password</code>.
43+
* The specified secret contains credentials
44+
* to connect to the <code>database</code> you specify.
45+
* When you are connecting to a cluster, you also supply the database name,
46+
* If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret.
47+
* When you are connecting to a serverless workgroup, you also supply the database name.</p>
4348
* </li>
4449
* <li>
45-
* <p>Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name.
46-
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.
47-
* 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>
50+
* <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p>
51+
* <ul>
52+
* <li>
53+
* <p>When connecting to a serverless workgroup, specify the workgroup name and 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-serverless:GetCredentials</code> operation is required.</p>
56+
* </li>
57+
* <li>
58+
* <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name.
59+
* 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>.
60+
* Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p>
61+
* </li>
62+
* <li>
63+
* <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name.
64+
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p>
65+
* </li>
66+
* </ul>
4867
* </li>
4968
* </ul>
5069
* <p>For more information about the Amazon Redshift Data API and CLI usage examples, see

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

+24-5
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,32 @@ export interface DescribeTableCommandOutput extends DescribeTableResponse, __Met
3939
* following combinations of request parameters: </p>
4040
* <ul>
4141
* <li>
42-
* <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.
43-
* When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name. </p>
42+
* <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret
43+
* stored in Secrets Manager which has <code>username</code> and <code>password</code>.
44+
* The specified secret contains credentials
45+
* to connect to the <code>database</code> you specify.
46+
* When you are connecting to a cluster, you also supply the database name,
47+
* If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret.
48+
* When you are connecting to a serverless workgroup, you also supply the database name.</p>
4449
* </li>
4550
* <li>
46-
* <p>Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name.
47-
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.
48-
* 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>
51+
* <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p>
52+
* <ul>
53+
* <li>
54+
* <p>When connecting to a serverless workgroup, specify the workgroup name and 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-serverless:GetCredentials</code> operation is required.</p>
57+
* </li>
58+
* <li>
59+
* <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name.
60+
* 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>.
61+
* Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p>
62+
* </li>
63+
* <li>
64+
* <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name.
65+
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p>
66+
* </li>
67+
* </ul>
4968
* </li>
5069
* </ul>
5170
* <p>For more information about the Amazon Redshift Data API and CLI usage examples, see

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

+24-5
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,32 @@ export interface ExecuteStatementCommandOutput extends ExecuteStatementOutput, _
3838
* method, use one of the following combinations of request parameters: </p>
3939
* <ul>
4040
* <li>
41-
* <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.
42-
* When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name. </p>
41+
* <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret
42+
* stored in Secrets Manager which has <code>username</code> and <code>password</code>.
43+
* The specified secret contains credentials
44+
* to connect to the <code>database</code> you specify.
45+
* When you are connecting to a cluster, you also supply the database name,
46+
* If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret.
47+
* When you are connecting to a serverless workgroup, you also supply the database name.</p>
4348
* </li>
4449
* <li>
45-
* <p>Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name.
46-
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.
47-
* 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>
50+
* <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p>
51+
* <ul>
52+
* <li>
53+
* <p>When connecting to a serverless workgroup, specify the workgroup name and 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-serverless:GetCredentials</code> operation is required.</p>
56+
* </li>
57+
* <li>
58+
* <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name.
59+
* 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>.
60+
* Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p>
61+
* </li>
62+
* <li>
63+
* <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name.
64+
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p>
65+
* </li>
66+
* </ul>
4867
* </li>
4968
* </ul>
5069
* <p>For more information about the Amazon Redshift Data API and CLI usage examples, see

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

+24-5
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,32 @@ export interface ListDatabasesCommandOutput extends ListDatabasesResponse, __Met
3838
* following combinations of request parameters: </p>
3939
* <ul>
4040
* <li>
41-
* <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.
42-
* When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name. </p>
41+
* <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret
42+
* stored in Secrets Manager which has <code>username</code> and <code>password</code>.
43+
* The specified secret contains credentials
44+
* to connect to the <code>database</code> you specify.
45+
* When you are connecting to a cluster, you also supply the database name,
46+
* If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret.
47+
* When you are connecting to a serverless workgroup, you also supply the database name.</p>
4348
* </li>
4449
* <li>
45-
* <p>Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name.
46-
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.
47-
* 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>
50+
* <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p>
51+
* <ul>
52+
* <li>
53+
* <p>When connecting to a serverless workgroup, specify the workgroup name and 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-serverless:GetCredentials</code> operation is required.</p>
56+
* </li>
57+
* <li>
58+
* <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name.
59+
* 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>.
60+
* Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p>
61+
* </li>
62+
* <li>
63+
* <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name.
64+
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p>
65+
* </li>
66+
* </ul>
4867
* </li>
4968
* </ul>
5069
* <p>For more information about the Amazon Redshift Data API and CLI usage examples, see

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

+24-5
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,32 @@ export interface ListSchemasCommandOutput extends ListSchemasResponse, __Metadat
3838
* following combinations of request parameters: </p>
3939
* <ul>
4040
* <li>
41-
* <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.
42-
* When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name. </p>
41+
* <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret
42+
* stored in Secrets Manager which has <code>username</code> and <code>password</code>.
43+
* The specified secret contains credentials
44+
* to connect to the <code>database</code> you specify.
45+
* When you are connecting to a cluster, you also supply the database name,
46+
* If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret.
47+
* When you are connecting to a serverless workgroup, you also supply the database name.</p>
4348
* </li>
4449
* <li>
45-
* <p>Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name.
46-
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.
47-
* 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>
50+
* <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p>
51+
* <ul>
52+
* <li>
53+
* <p>When connecting to a serverless workgroup, specify the workgroup name and 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-serverless:GetCredentials</code> operation is required.</p>
56+
* </li>
57+
* <li>
58+
* <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name.
59+
* 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>.
60+
* Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p>
61+
* </li>
62+
* <li>
63+
* <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name.
64+
* Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p>
65+
* </li>
66+
* </ul>
4867
* </li>
4968
* </ul>
5069
* <p>For more information about the Amazon Redshift Data API and CLI usage examples, see

0 commit comments

Comments
 (0)