aws-sdk-secretsmanager 1.62.0 → 1.65.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b1db95d58a296965e3e67e29dda7bddae3029b9828a0bf4016a951825d5fa61
-  data.tar.gz: 4ce3047b908c3134c8ae717ad79790d1877e17a9ebf1ce42414692c2e1869d5f
+  metadata.gz: 55454322928dc33ba5dbd7fde31a3d863eccff4c56eb542668f51ae0b08f16f7
+  data.tar.gz: 8726157c51744c29b479d30782973a74a00fb486408b696c4e5bbb1a70ac7a93
 SHA512:
-  metadata.gz: 345690087bb756e8218ead0897f15495268eb02da24ea0e79fd5b7f6ebeab68e3c4af91509c240f12dcd53d4527270fe3bccbef8cc7b7db998cf10ce023a2e58
-  data.tar.gz: f8a195852f3adc1ad281a8143d46cbef53e0da62c21fc8804223964afb7df176d93fd806e23ad380047415ad05c6ea5f845d93c2066db74b3ede0a03566ce913
+  metadata.gz: a3ce58ec66c49f185e64a1cdde6f9bec89c261df7eec2dc3a71d3bf5d9b1fdfee4852fa63be43635921f0a8702814c46868ba831d400bb124aa3cc4f19463e07
+  data.tar.gz: 16cbab9304366563b8e9222ea70d917b8649ec4be9fedb85159671d2f531b6c0dc38074ca40351bf7a9508283986fa50743ccdbc94cbd96dcf062387d667e6b0

data/CHANGELOG.md

@@ -1,6 +1,21 @@
 Unreleased Changes
 ------------------
 
+1.65.0 (2022-08-17)
+------------------
+
+* Feature - Documentation updates for Secrets Manager.
+
+1.64.0 (2022-06-16)
+------------------
+
+* Feature - Documentation updates for Secrets Manager
+
+1.63.0 (2022-06-16)
+------------------
+
+* Feature - Documentation updates for Secrets Manager
+
 1.62.0 (2022-05-25)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.62.0
+1.65.0

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

@@ -553,7 +553,9 @@ module Aws::SecretsManager
     #
     # @option params [String] :kms_key_id
     #   The ARN, key ID, or alias of the KMS key that Secrets Manager uses to
-    #   encrypt the secret value in the secret.
+    #   encrypt the secret value in the secret. An alias is always prefixed by
+    #   `alias/`, for example `alias/aws/secretsmanager`. For more
+    #   information, see [About aliases][1].
     #
     #   To use a KMS key in a different account, use the key ARN or the alias
     #   ARN.
@@ -568,6 +570,10 @@ module Aws::SecretsManager
     #   to encrypt the secret, and you must create and use a customer managed
     #   KMS key.
     #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html
+    #
     # @option params [String, StringIO, File] :secret_binary
     #   The binary data to encrypt and store in the new version of the secret.
     #   We recommend that you store your binary data in a file and then pass
@@ -1218,18 +1224,23 @@ module Aws::SecretsManager
     # caching. Caching secrets improves speed and reduces your costs. For
     # more information, see [Cache secrets for your applications][1].
     #
+    # To retrieve the previous version of a secret, use `VersionStage` and
+    # specify AWSPREVIOUS. To revert to the previous version of a secret,
+    # call [UpdateSecretVersionStage][2].
+    #
     # <b>Required permissions: </b> `secretsmanager:GetSecretValue`. If the
     # secret is encrypted using a customer-managed key instead of the Amazon
     # Web Services managed key `aws/secretsmanager`, then you also need
     # `kms:Decrypt` permissions for that key. For more information, see [
-    # IAM policy actions for Secrets Manager][2] and [Authentication and
-    # access control in Secrets Manager][3].
+    # IAM policy actions for Secrets Manager][3] and [Authentication and
+    # access control in Secrets Manager][4].
     #
     #
     #
     # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieving-secrets.html
-    # [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
-    # [3]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
+    # [2]: https://docs.aws.amazon.com/cli/latest/reference/secretsmanager/update-secret-version-stage.html
+    # [3]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
+    # [4]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
     #
     # @option params [required, String] :secret_id
     #   The ARN or name of the secret to retrieve.
@@ -1448,6 +1459,10 @@ module Aws::SecretsManager
     # Services account, not including secrets that are marked for deletion.
     # To see secrets marked for deletion, use the Secrets Manager console.
     #
+    # ListSecrets is eventually consistent, however it might not reflect
+    # changes from the last five minutes. To get the latest information for
+    # a specific secret, use DescribeSecret.
+    #
     # To list the versions of a secret, use ListSecretVersionIds.
     #
     # To get the secret value from `SecretString` or `SecretBinary`, call
@@ -1685,9 +1700,9 @@ module Aws::SecretsManager
     # the staging label `AWSPREVIOUS` to the version that `AWSCURRENT` was
     # removed from.
     #
-    # This operation is idempotent. If a version with a `VersionId` with the
-    # same value as the `ClientRequestToken` parameter already exists, and
-    # you specify the same secret data, the operation succeeds but does
+    # This operation is idempotent. If you call this operation with a
+    # `ClientRequestToken` that matches an existing version's VersionId,
+    # and you specify the same secret data, the operation succeeds but does
     # nothing. However, if the secret data is different, then the operation
     # fails because you can't modify an existing version; you can only
     # create new ones.
@@ -2446,25 +2461,12 @@ module Aws::SecretsManager
     # version, Secrets Manager automatically attaches the staging label
     # `AWSCURRENT` to the new version.
     #
-    # If you call this operation with a `VersionId` that matches an existing
-    # version's `ClientRequestToken`, the operation results in an error.
+    # If you call this operation with a `ClientRequestToken` that matches an
+    # existing version's `VersionId`, the operation results in an error.
     # You can't modify an existing version, you can only create a new
     # version. To remove a version, remove all staging labels from it. See
     # UpdateSecretVersionStage.
     #
-    # If you don't specify an KMS encryption key, Secrets Manager uses the
-    # Amazon Web Services managed key `aws/secretsmanager`. If this key
-    # doesn't already exist in your account, then Secrets Manager creates
-    # it for you automatically. All users and roles in the Amazon Web
-    # Services account automatically have access to use
-    # `aws/secretsmanager`. Creating `aws/secretsmanager` can result in a
-    # one-time significant delay in returning the result.
-    #
-    # If the secret is in a different Amazon Web Services account from the
-    # credentials calling the API, then you can't use `aws/secretsmanager`
-    # to encrypt the secret, and you must create and use a customer managed
-    # key.
-    #
     # <b>Required permissions: </b> `secretsmanager:UpdateSecret`. For more
     # information, see [ IAM policy actions for Secrets Manager][1] and
     # [Authentication and access control in Secrets Manager][2]. If you use
@@ -2514,11 +2516,23 @@ module Aws::SecretsManager
     #
     # @option params [String] :kms_key_id
     #   The ARN, key ID, or alias of the KMS key that Secrets Manager uses to
-    #   encrypt new secret versions as well as any existing versions the
+    #   encrypt new secret versions as well as any existing versions with the
     #   staging labels `AWSCURRENT`, `AWSPENDING`, or `AWSPREVIOUS`. For more
     #   information about versions and staging labels, see [Concepts:
     #   Version][1].
     #
+    #   A key alias is always prefixed by `alias/`, for example
+    #   `alias/aws/secretsmanager`. For more information, see [About
+    #   aliases][2].
+    #
+    #   If you set this to an empty string, Secrets Manager uses the Amazon
+    #   Web Services managed key `aws/secretsmanager`. If this key doesn't
+    #   already exist in your account, then Secrets Manager creates it for you
+    #   automatically. All users and roles in the Amazon Web Services account
+    #   automatically have access to use `aws/secretsmanager`. Creating
+    #   `aws/secretsmanager` can result in a one-time significant delay in
+    #   returning the result.
+    #
     #   You can only use the Amazon Web Services managed key
     #   `aws/secretsmanager` if you call this operation using credentials from
     #   the same Amazon Web Services account that owns the secret. If the
@@ -2530,6 +2544,7 @@ module Aws::SecretsManager
     #
     #
     #   [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version
+    #   [2]: https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html
     #
     # @option params [String, StringIO, File] :secret_binary
     #   The binary data to encrypt and store in the new version of the secret.
@@ -2875,7 +2890,7 @@ module Aws::SecretsManager
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-secretsmanager'
-      context[:gem_version] = '1.62.0'
+      context[:gem_version] = '1.65.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -152,7 +152,9 @@ module Aws::SecretsManager
     #
     # @!attribute [rw] kms_key_id
     #   The ARN, key ID, or alias of the KMS key that Secrets Manager uses
-    #   to encrypt the secret value in the secret.
+    #   to encrypt the secret value in the secret. An alias is always
+    #   prefixed by `alias/`, for example `alias/aws/secretsmanager`. For
+    #   more information, see [About aliases][1].
     #
     #   To use a KMS key in a different account, use the key ARN or the
     #   alias ARN.
@@ -166,6 +168,10 @@ module Aws::SecretsManager
     #   credentials calling the API, then you can't use
     #   `aws/secretsmanager` to encrypt the secret, and you must create and
     #   use a customer managed KMS key.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html
     #   @return [String]
     #
     # @!attribute [rw] secret_binary
@@ -489,9 +495,10 @@ module Aws::SecretsManager
     #   @return [String]
     #
     # @!attribute [rw] kms_key_id
-    #   The ARN of the KMS key that Secrets Manager uses to encrypt the
-    #   secret value. If the secret is encrypted with the Amazon Web
-    #   Services managed key `aws/secretsmanager`, this field is omitted.
+    #   The key ID or alias ARN of the KMS key that Secrets Manager uses to
+    #   encrypt the secret value. If the secret is encrypted with the Amazon
+    #   Web Services managed key `aws/secretsmanager`, this field is
+    #   omitted. Secrets created using the console use an KMS key ID.
     #   @return [String]
     #
     # @!attribute [rw] rotation_enabled
@@ -525,9 +532,8 @@ module Aws::SecretsManager
     #   @return [Time]
     #
     # @!attribute [rw] last_accessed_date
-    #   The last date that the secret value was retrieved. This value does
-    #   not include the time. This field is omitted if the secret has never
-    #   been retrieved.
+    #   The date that the secret was last accessed in the Region. This field
+    #   is omitted if the secret has never been retrieved in the Region.
     #   @return [Time]
     #
     # @!attribute [rw] deleted_date
@@ -578,7 +584,13 @@ module Aws::SecretsManager
     #   @return [Hash<String,Array<String>>]
     #
     # @!attribute [rw] owning_service
-    #   The name of the service that created this secret.
+    #   The ID of the service that created this secret. For more
+    #   information, see [Secrets managed by other Amazon Web Services
+    #   services][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html
     #   @return [String]
     #
     # @!attribute [rw] created_date
@@ -1003,6 +1015,14 @@ module Aws::SecretsManager
     #   a Lambda function ARN configured and you didn't include such an ARN
     #   as a parameter in this call.
     #
+    # * The secret is managed by another service, and you must use that
+    #   service to update it. For more information, see [Secrets managed by
+    #   other Amazon Web Services services][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html
+    #
     # @!attribute [rw] message
     #   @return [String]
     #
@@ -1580,7 +1600,8 @@ module Aws::SecretsManager
     #   @return [String]
     #
     # @!attribute [rw] last_accessed_date
-    #   The date that you last accessed the secret in the Region.
+    #   The date that the secret was last accessed in the Region. This field
+    #   is omitted if the secret has never been retrieved in the Region.
     #   @return [Time]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/ReplicationStatusType AWS API Documentation
@@ -1912,9 +1933,8 @@ module Aws::SecretsManager
     #   @return [Time]
     #
     # @!attribute [rw] last_accessed_date
-    #   The last date that this secret was accessed. This value is truncated
-    #   to midnight of the date and therefore shows only the date, not the
-    #   time.
+    #   The date that the secret was last accessed in the Region. This field
+    #   is omitted if the secret has never been retrieved in the Region.
     #   @return [Time]
     #
     # @!attribute [rw] deleted_date
@@ -2229,11 +2249,23 @@ module Aws::SecretsManager
     #
     # @!attribute [rw] kms_key_id
     #   The ARN, key ID, or alias of the KMS key that Secrets Manager uses
-    #   to encrypt new secret versions as well as any existing versions the
-    #   staging labels `AWSCURRENT`, `AWSPENDING`, or `AWSPREVIOUS`. For
+    #   to encrypt new secret versions as well as any existing versions with
+    #   the staging labels `AWSCURRENT`, `AWSPENDING`, or `AWSPREVIOUS`. For
     #   more information about versions and staging labels, see [Concepts:
     #   Version][1].
     #
+    #   A key alias is always prefixed by `alias/`, for example
+    #   `alias/aws/secretsmanager`. For more information, see [About
+    #   aliases][2].
+    #
+    #   If you set this to an empty string, Secrets Manager uses the Amazon
+    #   Web Services managed key `aws/secretsmanager`. If this key doesn't
+    #   already exist in your account, then Secrets Manager creates it for
+    #   you automatically. All users and roles in the Amazon Web Services
+    #   account automatically have access to use `aws/secretsmanager`.
+    #   Creating `aws/secretsmanager` can result in a one-time significant
+    #   delay in returning the result.
+    #
     #   You can only use the Amazon Web Services managed key
     #   `aws/secretsmanager` if you call this operation using credentials
     #   from the same Amazon Web Services account that owns the secret. If
@@ -2245,6 +2277,7 @@ module Aws::SecretsManager
     #
     #
     #   [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version
+    #   [2]: https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html
     #   @return [String]
     #
     # @!attribute [rw] secret_binary

data/lib/aws-sdk-secretsmanager.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-secretsmanager/customizations'
 # @!group service
 module Aws::SecretsManager
 
-  GEM_VERSION = '1.62.0'
+  GEM_VERSION = '1.65.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-secretsmanager
 version: !ruby/object:Gem::Version
-  version: 1.62.0
+  version: 1.65.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-25 00:00:00.000000000 Z
+date: 2022-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core