aws-sdk-redshiftdataapiservice 1.25.0 → 1.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 407a8551dba3493cc7c1c0b87ea941f9b753e113b3c7ca50b437a16722f00802
-  data.tar.gz: 99cff936cfcbb2859fd0c0b94b673ae20e786241e7f023ef53688215cbc12c78
+  metadata.gz: 0ca8632f1a1d0e3bd3818ad9701960c2bff8a77f7a95214604e3962123d6954e
+  data.tar.gz: d804ad2bc64d21cfdc351db5a0c03029953d18faa9878bbb9ad15e0345217d6a
 SHA512:
-  metadata.gz: 44474a4cb727c2e21067cd7d4680417ec6ac4f6468f1de536547c61aa8b23304f3c1d6ba46c363630468a524ee67bc7abd29709995df277d8558d0b0b407ab82
-  data.tar.gz: 85986998c5a1dbaab77edf5a848d79e2cacee795e49d913cb6dfed1a32464b70bc80b741812bad4db1bb22a4c5698894607869b30e508061c9e93a6be691661e
+  metadata.gz: 36ec285ec86c7aafc399ef98ddc078f99c0bcb13bdae94ecb49282ec22a5a331c1ef23ec45276ce54b478c7d3cc362932add2bbed6b9fb2251b622a18230a800
+  data.tar.gz: df312a43821cd6bea4e7a2512ef48dc87de9edc976afc964005e40d71700003525f6e95fccc5b935de91a8e12e16aaba8ef9a99aa43128c31223df139edd114f

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.26.0 (2023-04-07)
+------------------
+
+* Feature - Update documentation of API descriptions as needed in support of temporary credentials with IAM identity.
+
 1.25.0 (2023-03-09)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.25.0
+1.26.0

data/lib/aws-sdk-redshiftdataapiservice/client.rb

@@ -383,18 +383,35 @@ module Aws::RedshiftDataAPIService
     # authorization method, use one of the following combinations of request
     # parameters:
     #
-    # * 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. When
-    #   connecting to a serverless workgroup, specify the Amazon Resource
-    #   Name (ARN) of the secret and the database name.
-    #
-    # * Temporary credentials - when connecting to a cluster, specify the
-    #   cluster identifier, the database name, and the database user name.
-    #   Also, permission to call the `redshift:GetClusterCredentials`
-    #   operation is required. When connecting to a serverless workgroup,
-    #   specify the workgroup name and database name. Also, permission to
-    #   call the `redshift-serverless:GetCredentials` operation is required.
+    # * Secrets Manager - when connecting to a cluster, provide the
+    #   `secret-arn` of a secret stored in Secrets Manager which has
+    #   `username` and `password`. The specified secret contains credentials
+    #   to connect to the `database` you specify. When you are connecting to
+    #   a cluster, you also supply the database name, If you provide a
+    #   cluster identifier (`dbClusterIdentifier`), it must match the
+    #   cluster identifier stored in the secret. When you are connecting to
+    #   a serverless workgroup, you also supply the database name.
+    #
+    # * Temporary credentials - when connecting to your data warehouse,
+    #   choose one of the following options:
+    #
+    #   * 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, `arn:iam::123456789012:user:foo` has
+    #     the database user name `IAM:foo`. Also, permission to call the
+    #     `redshift-serverless:GetCredentials` operation is required.
+    #
+    #   * 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,
+    #     `arn:iam::123456789012:user:foo` has the database user name
+    #     `IAM:foo`. Also, permission to call the
+    #     `redshift:GetClusterCredentialsWithIAM` operation is required.
+    #
+    #   * 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 `redshift:GetClusterCredentials`
+    #     operation is required.
     #
     # For more information about the Amazon Redshift Data API and CLI usage
     # examples, see [Using the Amazon Redshift Data API][1] in the *Amazon
@@ -422,7 +439,8 @@ module Aws::RedshiftDataAPIService
     #
     # @option params [String] :db_user
     #   The database user name. This parameter is required when connecting to
-    #   a cluster and authenticating using temporary credentials.
+    #   a cluster as a database user and authenticating using temporary
+    #   credentials.
     #
     # @option params [String] :secret_arn
     #   The name or ARN of the secret that enables access to the database.
@@ -629,18 +647,35 @@ module Aws::RedshiftDataAPIService
     # page through the column list. Depending on the authorization method,
     # use one of the following combinations of request parameters:
     #
-    # * 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. When
-    #   connecting to a serverless workgroup, specify the Amazon Resource
-    #   Name (ARN) of the secret and the database name.
-    #
-    # * Temporary credentials - when connecting to a cluster, specify the
-    #   cluster identifier, the database name, and the database user name.
-    #   Also, permission to call the `redshift:GetClusterCredentials`
-    #   operation is required. When connecting to a serverless workgroup,
-    #   specify the workgroup name and database name. Also, permission to
-    #   call the `redshift-serverless:GetCredentials` operation is required.
+    # * Secrets Manager - when connecting to a cluster, provide the
+    #   `secret-arn` of a secret stored in Secrets Manager which has
+    #   `username` and `password`. The specified secret contains credentials
+    #   to connect to the `database` you specify. When you are connecting to
+    #   a cluster, you also supply the database name, If you provide a
+    #   cluster identifier (`dbClusterIdentifier`), it must match the
+    #   cluster identifier stored in the secret. When you are connecting to
+    #   a serverless workgroup, you also supply the database name.
+    #
+    # * Temporary credentials - when connecting to your data warehouse,
+    #   choose one of the following options:
+    #
+    #   * 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, `arn:iam::123456789012:user:foo` has
+    #     the database user name `IAM:foo`. Also, permission to call the
+    #     `redshift-serverless:GetCredentials` operation is required.
+    #
+    #   * 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,
+    #     `arn:iam::123456789012:user:foo` has the database user name
+    #     `IAM:foo`. Also, permission to call the
+    #     `redshift:GetClusterCredentialsWithIAM` operation is required.
+    #
+    #   * 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 `redshift:GetClusterCredentials`
+    #     operation is required.
     #
     # For more information about the Amazon Redshift Data API and CLI usage
     # examples, see [Using the Amazon Redshift Data API][1] in the *Amazon
@@ -666,7 +701,8 @@ module Aws::RedshiftDataAPIService
     #
     # @option params [String] :db_user
     #   The database user name. This parameter is required when connecting to
-    #   a cluster and authenticating using temporary credentials.
+    #   a cluster as a database user and authenticating using temporary
+    #   credentials.
     #
     # @option params [Integer] :max_results
     #   The maximum number of tables to return in the response. If more tables
@@ -755,18 +791,35 @@ module Aws::RedshiftDataAPIService
     # statement. Depending on the authorization method, use one of the
     # following combinations of request parameters:
     #
-    # * 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. When
-    #   connecting to a serverless workgroup, specify the Amazon Resource
-    #   Name (ARN) of the secret and the database name.
-    #
-    # * Temporary credentials - when connecting to a cluster, specify the
-    #   cluster identifier, the database name, and the database user name.
-    #   Also, permission to call the `redshift:GetClusterCredentials`
-    #   operation is required. When connecting to a serverless workgroup,
-    #   specify the workgroup name and database name. Also, permission to
-    #   call the `redshift-serverless:GetCredentials` operation is required.
+    # * Secrets Manager - when connecting to a cluster, provide the
+    #   `secret-arn` of a secret stored in Secrets Manager which has
+    #   `username` and `password`. The specified secret contains credentials
+    #   to connect to the `database` you specify. When you are connecting to
+    #   a cluster, you also supply the database name, If you provide a
+    #   cluster identifier (`dbClusterIdentifier`), it must match the
+    #   cluster identifier stored in the secret. When you are connecting to
+    #   a serverless workgroup, you also supply the database name.
+    #
+    # * Temporary credentials - when connecting to your data warehouse,
+    #   choose one of the following options:
+    #
+    #   * 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, `arn:iam::123456789012:user:foo` has
+    #     the database user name `IAM:foo`. Also, permission to call the
+    #     `redshift-serverless:GetCredentials` operation is required.
+    #
+    #   * 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,
+    #     `arn:iam::123456789012:user:foo` has the database user name
+    #     `IAM:foo`. Also, permission to call the
+    #     `redshift:GetClusterCredentialsWithIAM` operation is required.
+    #
+    #   * 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 `redshift:GetClusterCredentials`
+    #     operation is required.
     #
     # For more information about the Amazon Redshift Data API and CLI usage
     # examples, see [Using the Amazon Redshift Data API][1] in the *Amazon
@@ -794,7 +847,8 @@ module Aws::RedshiftDataAPIService
     #
     # @option params [String] :db_user
     #   The database user name. This parameter is required when connecting to
-    #   a cluster and authenticating using temporary credentials.
+    #   a cluster as a database user and authenticating using temporary
+    #   credentials.
     #
     # @option params [Array<Types::SqlParameter>] :parameters
     #   The parameters for the SQL statement.
@@ -952,18 +1006,35 @@ module Aws::RedshiftDataAPIService
     # the database list. Depending on the authorization method, use one of
     # the following combinations of request parameters:
     #
-    # * 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. When
-    #   connecting to a serverless workgroup, specify the Amazon Resource
-    #   Name (ARN) of the secret and the database name.
-    #
-    # * Temporary credentials - when connecting to a cluster, specify the
-    #   cluster identifier, the database name, and the database user name.
-    #   Also, permission to call the `redshift:GetClusterCredentials`
-    #   operation is required. When connecting to a serverless workgroup,
-    #   specify the workgroup name and database name. Also, permission to
-    #   call the `redshift-serverless:GetCredentials` operation is required.
+    # * Secrets Manager - when connecting to a cluster, provide the
+    #   `secret-arn` of a secret stored in Secrets Manager which has
+    #   `username` and `password`. The specified secret contains credentials
+    #   to connect to the `database` you specify. When you are connecting to
+    #   a cluster, you also supply the database name, If you provide a
+    #   cluster identifier (`dbClusterIdentifier`), it must match the
+    #   cluster identifier stored in the secret. When you are connecting to
+    #   a serverless workgroup, you also supply the database name.
+    #
+    # * Temporary credentials - when connecting to your data warehouse,
+    #   choose one of the following options:
+    #
+    #   * 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, `arn:iam::123456789012:user:foo` has
+    #     the database user name `IAM:foo`. Also, permission to call the
+    #     `redshift-serverless:GetCredentials` operation is required.
+    #
+    #   * 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,
+    #     `arn:iam::123456789012:user:foo` has the database user name
+    #     `IAM:foo`. Also, permission to call the
+    #     `redshift:GetClusterCredentialsWithIAM` operation is required.
+    #
+    #   * 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 `redshift:GetClusterCredentials`
+    #     operation is required.
     #
     # For more information about the Amazon Redshift Data API and CLI usage
     # examples, see [Using the Amazon Redshift Data API][1] in the *Amazon
@@ -984,7 +1055,8 @@ module Aws::RedshiftDataAPIService
     #
     # @option params [String] :db_user
     #   The database user name. This parameter is required when connecting to
-    #   a cluster and authenticating using temporary credentials.
+    #   a cluster as a database user and authenticating using temporary
+    #   credentials.
     #
     # @option params [Integer] :max_results
     #   The maximum number of databases to return in the response. If more
@@ -1046,18 +1118,35 @@ module Aws::RedshiftDataAPIService
     # the schema list. Depending on the authorization method, use one of the
     # following combinations of request parameters:
     #
-    # * 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. When
-    #   connecting to a serverless workgroup, specify the Amazon Resource
-    #   Name (ARN) of the secret and the database name.
-    #
-    # * Temporary credentials - when connecting to a cluster, specify the
-    #   cluster identifier, the database name, and the database user name.
-    #   Also, permission to call the `redshift:GetClusterCredentials`
-    #   operation is required. When connecting to a serverless workgroup,
-    #   specify the workgroup name and database name. Also, permission to
-    #   call the `redshift-serverless:GetCredentials` operation is required.
+    # * Secrets Manager - when connecting to a cluster, provide the
+    #   `secret-arn` of a secret stored in Secrets Manager which has
+    #   `username` and `password`. The specified secret contains credentials
+    #   to connect to the `database` you specify. When you are connecting to
+    #   a cluster, you also supply the database name, If you provide a
+    #   cluster identifier (`dbClusterIdentifier`), it must match the
+    #   cluster identifier stored in the secret. When you are connecting to
+    #   a serverless workgroup, you also supply the database name.
+    #
+    # * Temporary credentials - when connecting to your data warehouse,
+    #   choose one of the following options:
+    #
+    #   * 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, `arn:iam::123456789012:user:foo` has
+    #     the database user name `IAM:foo`. Also, permission to call the
+    #     `redshift-serverless:GetCredentials` operation is required.
+    #
+    #   * 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,
+    #     `arn:iam::123456789012:user:foo` has the database user name
+    #     `IAM:foo`. Also, permission to call the
+    #     `redshift:GetClusterCredentialsWithIAM` operation is required.
+    #
+    #   * 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 `redshift:GetClusterCredentials`
+    #     operation is required.
     #
     # For more information about the Amazon Redshift Data API and CLI usage
     # examples, see [Using the Amazon Redshift Data API][1] in the *Amazon
@@ -1083,7 +1172,8 @@ module Aws::RedshiftDataAPIService
     #
     # @option params [String] :db_user
     #   The database user name. This parameter is required when connecting to
-    #   a cluster and authenticating using temporary credentials.
+    #   a cluster as a database user and authenticating using temporary
+    #   credentials.
     #
     # @option params [Integer] :max_results
     #   The maximum number of schemas to return in the response. If more
@@ -1257,18 +1347,35 @@ module Aws::RedshiftDataAPIService
     # Depending on the authorization method, use one of the following
     # combinations of request parameters:
     #
-    # * 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. When
-    #   connecting to a serverless workgroup, specify the Amazon Resource
-    #   Name (ARN) of the secret and the database name.
-    #
-    # * Temporary credentials - when connecting to a cluster, specify the
-    #   cluster identifier, the database name, and the database user name.
-    #   Also, permission to call the `redshift:GetClusterCredentials`
-    #   operation is required. When connecting to a serverless workgroup,
-    #   specify the workgroup name and database name. Also, permission to
-    #   call the `redshift-serverless:GetCredentials` operation is required.
+    # * Secrets Manager - when connecting to a cluster, provide the
+    #   `secret-arn` of a secret stored in Secrets Manager which has
+    #   `username` and `password`. The specified secret contains credentials
+    #   to connect to the `database` you specify. When you are connecting to
+    #   a cluster, you also supply the database name, If you provide a
+    #   cluster identifier (`dbClusterIdentifier`), it must match the
+    #   cluster identifier stored in the secret. When you are connecting to
+    #   a serverless workgroup, you also supply the database name.
+    #
+    # * Temporary credentials - when connecting to your data warehouse,
+    #   choose one of the following options:
+    #
+    #   * 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, `arn:iam::123456789012:user:foo` has
+    #     the database user name `IAM:foo`. Also, permission to call the
+    #     `redshift-serverless:GetCredentials` operation is required.
+    #
+    #   * 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,
+    #     `arn:iam::123456789012:user:foo` has the database user name
+    #     `IAM:foo`. Also, permission to call the
+    #     `redshift:GetClusterCredentialsWithIAM` operation is required.
+    #
+    #   * 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 `redshift:GetClusterCredentials`
+    #     operation is required.
     #
     # For more information about the Amazon Redshift Data API and CLI usage
     # examples, see [Using the Amazon Redshift Data API][1] in the *Amazon
@@ -1294,7 +1401,8 @@ module Aws::RedshiftDataAPIService
     #
     # @option params [String] :db_user
     #   The database user name. This parameter is required when connecting to
-    #   a cluster and authenticating using temporary credentials.
+    #   a cluster as a database user and authenticating using temporary
+    #   credentials.
     #
     # @option params [Integer] :max_results
     #   The maximum number of tables to return in the response. If more tables
@@ -1388,7 +1496,7 @@ module Aws::RedshiftDataAPIService
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-redshiftdataapiservice'
-      context[:gem_version] = '1.25.0'
+      context[:gem_version] = '1.26.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-redshiftdataapiservice/types.rb

@@ -63,7 +63,8 @@ module Aws::RedshiftDataAPIService
     #
     # @!attribute [rw] db_user
     #   The database user name. This parameter is required when connecting
-    #   to a cluster and authenticating using temporary credentials.
+    #   to a cluster as a database user and authenticating using temporary
+    #   credentials.
     #   @return [String]
     #
     # @!attribute [rw] secret_arn
@@ -446,7 +447,8 @@ module Aws::RedshiftDataAPIService
     #
     # @!attribute [rw] db_user
     #   The database user name. This parameter is required when connecting
-    #   to a cluster and authenticating using temporary credentials.
+    #   to a cluster as a database user and authenticating using temporary
+    #   credentials.
     #   @return [String]
     #
     # @!attribute [rw] max_results
@@ -574,7 +576,8 @@ module Aws::RedshiftDataAPIService
     #
     # @!attribute [rw] db_user
     #   The database user name. This parameter is required when connecting
-    #   to a cluster and authenticating using temporary credentials.
+    #   to a cluster as a database user and authenticating using temporary
+    #   credentials.
     #   @return [String]
     #
     # @!attribute [rw] parameters
@@ -812,7 +815,8 @@ module Aws::RedshiftDataAPIService
     #
     # @!attribute [rw] db_user
     #   The database user name. This parameter is required when connecting
-    #   to a cluster and authenticating using temporary credentials.
+    #   to a cluster as a database user and authenticating using temporary
+    #   credentials.
     #   @return [String]
     #
     # @!attribute [rw] max_results
@@ -898,7 +902,8 @@ module Aws::RedshiftDataAPIService
     #
     # @!attribute [rw] db_user
     #   The database user name. This parameter is required when connecting
-    #   to a cluster and authenticating using temporary credentials.
+    #   to a cluster as a database user and authenticating using temporary
+    #   credentials.
     #   @return [String]
     #
     # @!attribute [rw] max_results
@@ -1079,7 +1084,8 @@ module Aws::RedshiftDataAPIService
     #
     # @!attribute [rw] db_user
     #   The database user name. This parameter is required when connecting
-    #   to a cluster and authenticating using temporary credentials.
+    #   to a cluster as a database user and authenticating using temporary
+    #   credentials.
     #   @return [String]
     #
     # @!attribute [rw] max_results

data/lib/aws-sdk-redshiftdataapiservice.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-redshiftdataapiservice/customizations'
 # @!group service
 module Aws::RedshiftDataAPIService
 
-  GEM_VERSION = '1.25.0'
+  GEM_VERSION = '1.26.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-redshiftdataapiservice
 version: !ruby/object:Gem::Version
-  version: 1.25.0
+  version: 1.26.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-09 00:00:00.000000000 Z
+date: 2023-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core