lib/aws-sdk-secretsmanager/client.rb in aws-sdk-secretsmanager-1.15.0 vs lib/aws-sdk-secretsmanager/client.rb in aws-sdk-secretsmanager-1.16.0

- old
+ new

@@ -239,10 +239,25 @@ # @option params [required, String] :secret_id # Specifies the secret for which you want to cancel a rotation request. # You can specify either the Amazon Resource Name (ARN) or the friendly # name of the secret. # + # <note markdown="1"> If you specify an ARN, we generally recommend that you specify a + # complete ARN. You can specify a partial ARN too—for example, if you + # don’t include the final hyphen and six random characters that Secrets + # Manager adds at the end of the ARN when you created the secret. A + # partial ARN match can work as long as it uniquely matches only one + # secret. However, if your secret has a name that ends in a hyphen + # followed by six characters (before Secrets Manager adds the hyphen and + # six characters to the ARN) and you try to use that as a partial ARN, + # then those characters cause Secrets Manager to assume that you’re + # specifying a complete ARN. This confusion can cause unexpected + # results. To avoid this situation, we recommend that you don’t create + # secret names that end with a hyphen followed by six characters. + # + # </note> + # # @return [Types::CancelRotateSecretResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CancelRotateSecretResponse#arn #arn} => String # * {Types::CancelRotateSecretResponse#name #name} => String # * {Types::CancelRotateSecretResponse#version_id #version_id} => String @@ -370,10 +385,18 @@ # Specifies the friendly name of the new secret. # # The secret name must be ASCII letters, digits, or the following # characters : /\_+=.@- # + # <note markdown="1"> Don't end your secret name with a hyphen followed by six characters. + # If you do so, you risk confusion and unexpected results when searching + # for a secret by partial ARN. This is because Secrets Manager + # automatically adds a hyphen and six random characters at the end of + # the ARN. + # + # </note> + # # @option params [String] :client_request_token # (Optional) If you include `SecretString` or `SecretBinary`, then an # initial version is created as part of the secret, and this parameter # specifies a unique identifier for the new version. # @@ -614,10 +637,25 @@ # @option params [required, String] :secret_id # Specifies the secret that you want to delete the attached # resource-based policy for. You can specify either the Amazon Resource # Name (ARN) or the friendly name of the secret. # + # <note markdown="1"> If you specify an ARN, we generally recommend that you specify a + # complete ARN. You can specify a partial ARN too—for example, if you + # don’t include the final hyphen and six random characters that Secrets + # Manager adds at the end of the ARN when you created the secret. A + # partial ARN match can work as long as it uniquely matches only one + # secret. However, if your secret has a name that ends in a hyphen + # followed by six characters (before Secrets Manager adds the hyphen and + # six characters to the ARN) and you try to use that as a partial ARN, + # then those characters cause Secrets Manager to assume that you’re + # specifying a complete ARN. This confusion can cause unexpected + # results. To avoid this situation, we recommend that you don’t create + # secret names that end with a hyphen followed by six characters. + # + # </note> + # # @return [Types::DeleteResourcePolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DeleteResourcePolicyResponse#arn #arn} => String # * {Types::DeleteResourcePolicyResponse#name #name} => String # @@ -702,10 +740,25 @@ # # @option params [required, String] :secret_id # Specifies the secret that you want to delete. You can specify either # the Amazon Resource Name (ARN) or the friendly name of the secret. # + # <note markdown="1"> If you specify an ARN, we generally recommend that you specify a + # complete ARN. You can specify a partial ARN too—for example, if you + # don’t include the final hyphen and six random characters that Secrets + # Manager adds at the end of the ARN when you created the secret. A + # partial ARN match can work as long as it uniquely matches only one + # secret. However, if your secret has a name that ends in a hyphen + # followed by six characters (before Secrets Manager adds the hyphen and + # six characters to the ARN) and you try to use that as a partial ARN, + # then those characters cause Secrets Manager to assume that you’re + # specifying a complete ARN. This confusion can cause unexpected + # results. To avoid this situation, we recommend that you don’t create + # secret names that end with a hyphen followed by six characters. + # + # </note> + # # @option params [Integer] :recovery_window_in_days # (Optional) Specifies the number of days that Secrets Manager waits # before it can delete the secret. You can't use both this parameter # and the `ForceDeleteWithoutRecovery` parameter in the same API call. # @@ -803,10 +856,25 @@ # @option params [required, String] :secret_id # The identifier of the secret whose details you want to retrieve. You # can specify either the Amazon Resource Name (ARN) or the friendly name # of the secret. # + # <note markdown="1"> If you specify an ARN, we generally recommend that you specify a + # complete ARN. You can specify a partial ARN too—for example, if you + # don’t include the final hyphen and six random characters that Secrets + # Manager adds at the end of the ARN when you created the secret. A + # partial ARN match can work as long as it uniquely matches only one + # secret. However, if your secret has a name that ends in a hyphen + # followed by six characters (before Secrets Manager adds the hyphen and + # six characters to the ARN) and you try to use that as a partial ARN, + # then those characters cause Secrets Manager to assume that you’re + # specifying a complete ARN. This confusion can cause unexpected + # results. To avoid this situation, we recommend that you don’t create + # secret names that end with a hyphen followed by six characters. + # + # </note> + # # @return [Types::DescribeSecretResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeSecretResponse#arn #arn} => String # * {Types::DescribeSecretResponse#name #name} => String # * {Types::DescribeSecretResponse#description #description} => String @@ -1033,10 +1101,25 @@ # @option params [required, String] :secret_id # Specifies the secret that you want to retrieve the attached # resource-based policy for. You can specify either the Amazon Resource # Name (ARN) or the friendly name of the secret. # + # <note markdown="1"> If you specify an ARN, we generally recommend that you specify a + # complete ARN. You can specify a partial ARN too—for example, if you + # don’t include the final hyphen and six random characters that Secrets + # Manager adds at the end of the ARN when you created the secret. A + # partial ARN match can work as long as it uniquely matches only one + # secret. However, if your secret has a name that ends in a hyphen + # followed by six characters (before Secrets Manager adds the hyphen and + # six characters to the ARN) and you try to use that as a partial ARN, + # then those characters cause Secrets Manager to assume that you’re + # specifying a complete ARN. This confusion can cause unexpected + # results. To avoid this situation, we recommend that you don’t create + # secret names that end with a hyphen followed by six characters. + # + # </note> + # # @return [Types::GetResourcePolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetResourcePolicyResponse#arn #arn} => String # * {Types::GetResourcePolicyResponse#name #name} => String # * {Types::GetResourcePolicyResponse#resource_policy #resource_policy} => String @@ -1103,10 +1186,25 @@ # @option params [required, String] :secret_id # Specifies the secret containing the version that you want to retrieve. # You can specify either the Amazon Resource Name (ARN) or the friendly # name of the secret. # + # <note markdown="1"> If you specify an ARN, we generally recommend that you specify a + # complete ARN. You can specify a partial ARN too—for example, if you + # don’t include the final hyphen and six random characters that Secrets + # Manager adds at the end of the ARN when you created the secret. A + # partial ARN match can work as long as it uniquely matches only one + # secret. However, if your secret has a name that ends in a hyphen + # followed by six characters (before Secrets Manager adds the hyphen and + # six characters to the ARN) and you try to use that as a partial ARN, + # then those characters cause Secrets Manager to assume that you’re + # specifying a complete ARN. This confusion can cause unexpected + # results. To avoid this situation, we recommend that you don’t create + # secret names that end with a hyphen followed by six characters. + # + # </note> + # # @option params [String] :version_id # Specifies the unique identifier of the version of the secret that you # want to retrieve. If you specify this parameter then don't specify # `VersionStage`. If you don't specify either a `VersionStage` or # `VersionId` then the default is to perform the operation on the @@ -1222,10 +1320,25 @@ # @option params [required, String] :secret_id # The identifier for the secret containing the versions you want to # list. You can specify either the Amazon Resource Name (ARN) or the # friendly name of the secret. # + # <note markdown="1"> If you specify an ARN, we generally recommend that you specify a + # complete ARN. You can specify a partial ARN too—for example, if you + # don’t include the final hyphen and six random characters that Secrets + # Manager adds at the end of the ARN when you created the secret. A + # partial ARN match can work as long as it uniquely matches only one + # secret. However, if your secret has a name that ends in a hyphen + # followed by six characters (before Secrets Manager adds the hyphen and + # six characters to the ARN) and you try to use that as a partial ARN, + # then those characters cause Secrets Manager to assume that you’re + # specifying a complete ARN. This confusion can cause unexpected + # results. To avoid this situation, we recommend that you don’t create + # secret names that end with a hyphen followed by six characters. + # + # </note> + # # @option params [Integer] :max_results # (Optional) Limits the number of results that you want to include in # the response. If you don't include this parameter, it defaults to a # value that's specific to the operation. If additional items exist # beyond the maximum you specify, the `NextToken` response element is @@ -1487,10 +1600,25 @@ # # @option params [required, String] :secret_id # Specifies the secret that you want to attach the resource-based policy # to. You can specify either the ARN or the friendly name of the secret. # + # <note markdown="1"> If you specify an ARN, we generally recommend that you specify a + # complete ARN. You can specify a partial ARN too—for example, if you + # don’t include the final hyphen and six random characters that Secrets + # Manager adds at the end of the ARN when you created the secret. A + # partial ARN match can work as long as it uniquely matches only one + # secret. However, if your secret has a name that ends in a hyphen + # followed by six characters (before Secrets Manager adds the hyphen and + # six characters to the ARN) and you try to use that as a partial ARN, + # then those characters cause Secrets Manager to assume that you’re + # specifying a complete ARN. This confusion can cause unexpected + # results. To avoid this situation, we recommend that you don’t create + # secret names that end with a hyphen followed by six characters. + # + # </note> + # # @option params [required, String] :resource_policy # A JSON-formatted string that's constructed according to the grammar # and syntax for an AWS resource-based policy. The policy in the string # identifies who can access or manage this secret and its versions. For # information on how to format a JSON parameter for the various command @@ -1626,10 +1754,25 @@ # @option params [required, String] :secret_id # Specifies the secret to which you want to add a new version. You can # specify either the Amazon Resource Name (ARN) or the friendly name of # the secret. The secret must already exist. # + # <note markdown="1"> If you specify an ARN, we generally recommend that you specify a + # complete ARN. You can specify a partial ARN too—for example, if you + # don’t include the final hyphen and six random characters that Secrets + # Manager adds at the end of the ARN when you created the secret. A + # partial ARN match can work as long as it uniquely matches only one + # secret. However, if your secret has a name that ends in a hyphen + # followed by six characters (before Secrets Manager adds the hyphen and + # six characters to the ARN) and you try to use that as a partial ARN, + # then those characters cause Secrets Manager to assume that you’re + # specifying a complete ARN. This confusion can cause unexpected + # results. To avoid this situation, we recommend that you don’t create + # secret names that end with a hyphen followed by six characters. + # + # </note> + # # @option params [String] :client_request_token # (Optional) Specifies a unique identifier for the new version of the # secret. # # <note markdown="1"> If you use the AWS CLI or one of the AWS SDK to call this operation, @@ -1804,10 +1947,25 @@ # @option params [required, String] :secret_id # Specifies the secret that you want to restore from a previously # scheduled deletion. You can specify either the Amazon Resource Name # (ARN) or the friendly name of the secret. # + # <note markdown="1"> If you specify an ARN, we generally recommend that you specify a + # complete ARN. You can specify a partial ARN too—for example, if you + # don’t include the final hyphen and six random characters that Secrets + # Manager adds at the end of the ARN when you created the secret. A + # partial ARN match can work as long as it uniquely matches only one + # secret. However, if your secret has a name that ends in a hyphen + # followed by six characters (before Secrets Manager adds the hyphen and + # six characters to the ARN) and you try to use that as a partial ARN, + # then those characters cause Secrets Manager to assume that you’re + # specifying a complete ARN. This confusion can cause unexpected + # results. To avoid this situation, we recommend that you don’t create + # secret names that end with a hyphen followed by six characters. + # + # </note> + # # @return [Types::RestoreSecretResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::RestoreSecretResponse#arn #arn} => String # * {Types::RestoreSecretResponse#name #name} => String # @@ -1913,10 +2071,25 @@ # # @option params [required, String] :secret_id # Specifies the secret that you want to rotate. You can specify either # the Amazon Resource Name (ARN) or the friendly name of the secret. # + # <note markdown="1"> If you specify an ARN, we generally recommend that you specify a + # complete ARN. You can specify a partial ARN too—for example, if you + # don’t include the final hyphen and six random characters that Secrets + # Manager adds at the end of the ARN when you created the secret. A + # partial ARN match can work as long as it uniquely matches only one + # secret. However, if your secret has a name that ends in a hyphen + # followed by six characters (before Secrets Manager adds the hyphen and + # six characters to the ARN) and you try to use that as a partial ARN, + # then those characters cause Secrets Manager to assume that you’re + # specifying a complete ARN. This confusion can cause unexpected + # results. To avoid this situation, we recommend that you don’t create + # secret names that end with a hyphen followed by six characters. + # + # </note> + # # @option params [String] :client_request_token # (Optional) Specifies a unique identifier for the new version of the # secret that helps ensure idempotency. # # If you use the AWS CLI or one of the AWS SDK to call this operation, @@ -2033,10 +2206,25 @@ # @option params [required, String] :secret_id # The identifier for the secret that you want to attach tags to. You can # specify either the Amazon Resource Name (ARN) or the friendly name of # the secret. # + # <note markdown="1"> If you specify an ARN, we generally recommend that you specify a + # complete ARN. You can specify a partial ARN too—for example, if you + # don’t include the final hyphen and six random characters that Secrets + # Manager adds at the end of the ARN when you created the secret. A + # partial ARN match can work as long as it uniquely matches only one + # secret. However, if your secret has a name that ends in a hyphen + # followed by six characters (before Secrets Manager adds the hyphen and + # six characters to the ARN) and you try to use that as a partial ARN, + # then those characters cause Secrets Manager to assume that you’re + # specifying a complete ARN. This confusion can cause unexpected + # results. To avoid this situation, we recommend that you don’t create + # secret names that end with a hyphen followed by six characters. + # + # </note> + # # @option params [required, Array<Types::Tag>] :tags # The tags to attach to the secret. Each element in the list consists of # a `Key` and a `Value`. # # This parameter to the API requires a JSON text string argument. For @@ -2120,10 +2308,25 @@ # @option params [required, String] :secret_id # The identifier for the secret that you want to remove tags from. You # can specify either the Amazon Resource Name (ARN) or the friendly name # of the secret. # + # <note markdown="1"> If you specify an ARN, we generally recommend that you specify a + # complete ARN. You can specify a partial ARN too—for example, if you + # don’t include the final hyphen and six random characters that Secrets + # Manager adds at the end of the ARN when you created the secret. A + # partial ARN match can work as long as it uniquely matches only one + # secret. However, if your secret has a name that ends in a hyphen + # followed by six characters (before Secrets Manager adds the hyphen and + # six characters to the ARN) and you try to use that as a partial ARN, + # then those characters cause Secrets Manager to assume that you’re + # specifying a complete ARN. This confusion can cause unexpected + # results. To avoid this situation, we recommend that you don’t create + # secret names that end with a hyphen followed by six characters. + # + # </note> + # # @option params [required, Array<String>] :tag_keys # A list of tag key names to remove from the secret. You don't specify # the value. Both the key and its associated value are removed. # # This parameter to the API requires a JSON text string argument. For @@ -2244,10 +2447,25 @@ # @option params [required, String] :secret_id # Specifies the secret that you want to modify or to which you want to # add a new version. You can specify either the Amazon Resource Name # (ARN) or the friendly name of the secret. # + # <note markdown="1"> If you specify an ARN, we generally recommend that you specify a + # complete ARN. You can specify a partial ARN too—for example, if you + # don’t include the final hyphen and six random characters that Secrets + # Manager adds at the end of the ARN when you created the secret. A + # partial ARN match can work as long as it uniquely matches only one + # secret. However, if your secret has a name that ends in a hyphen + # followed by six characters (before Secrets Manager adds the hyphen and + # six characters to the ARN) and you try to use that as a partial ARN, + # then those characters cause Secrets Manager to assume that you’re + # specifying a complete ARN. This confusion can cause unexpected + # results. To avoid this situation, we recommend that you don’t create + # secret names that end with a hyphen followed by six characters. + # + # </note> + # # @option params [String] :client_request_token # (Optional) If you want to add a new version to the secret, this # parameter specifies a unique identifier for the new version that helps # ensure idempotency. # @@ -2481,10 +2699,25 @@ # @option params [required, String] :secret_id # Specifies the secret with the version whose list of staging labels you # want to modify. You can specify either the Amazon Resource Name (ARN) # or the friendly name of the secret. # + # <note markdown="1"> If you specify an ARN, we generally recommend that you specify a + # complete ARN. You can specify a partial ARN too—for example, if you + # don’t include the final hyphen and six random characters that Secrets + # Manager adds at the end of the ARN when you created the secret. A + # partial ARN match can work as long as it uniquely matches only one + # secret. However, if your secret has a name that ends in a hyphen + # followed by six characters (before Secrets Manager adds the hyphen and + # six characters to the ARN) and you try to use that as a partial ARN, + # then those characters cause Secrets Manager to assume that you’re + # specifying a complete ARN. This confusion can cause unexpected + # results. To avoid this situation, we recommend that you don’t create + # secret names that end with a hyphen followed by six characters. + # + # </note> + # # @option params [required, String] :version_stage # The list of staging labels to add to this version. # # @option params [String] :remove_from_version_id # Specifies the secret version ID of the version that the staging labels @@ -2598,10 +2831,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-secretsmanager' - context[:gem_version] = '1.15.0' + context[:gem_version] = '1.16.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated