lib/aws-sdk-secretsmanager/client.rb in aws-sdk-secretsmanager-1.8.0 vs lib/aws-sdk-secretsmanager/client.rb in aws-sdk-secretsmanager-1.9.0
- old
+ new
@@ -348,11 +348,11 @@
#
# @option params [required, String] :name
# Specifies the friendly name of the new secret.
#
# The secret name must be ASCII letters, digits, or the following
- # characters : /\_+=,.@-
+ # characters : /\_+=.@-
#
# @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.
@@ -569,11 +569,12 @@
def create_secret(params = {}, options = {})
req = build_request(:create_secret, params)
req.send_request(options)
end
- # Deletes the resource-based policy currently attached to the secret.
+ # Deletes the resource-based permission policy that's attached to the
+ # secret.
#
# **Minimum permissions**
#
# To run this command, you must have the following permissions:
#
@@ -583,19 +584,19 @@
#
# **Related operations**
#
# * To attach a resource policy to a secret, use PutResourcePolicy.
#
- # * To retrieve the current resource-based policy that is attached to a
+ # * To retrieve the current resource-based policy that's attached to a
# secret, use GetResourcePolicy.
#
# * To list all of the currently available secrets, use ListSecrets.
#
# @option params [required, String] :secret_id
- # Specifies the secret for which you want to delete the attached
- # resource-based policy. You can specify either the Amazon Resource Name
- # (ARN) or the friendly name of the secret.
+ # 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.
#
# @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
@@ -942,14 +943,15 @@
def get_random_password(params = {}, options = {})
req = build_request(:get_random_password, params)
req.send_request(options)
end
- # Retrieves the JSON text of the resource-based policy attached to the
- # specified secret. The JSON request string input and response output
- # are shown formatted with whitespace and line breaks for better
- # readability. Submit your input as a single line JSON string.
+ # Retrieves the JSON text of the resource-based policy document that's
+ # attached to the specified secret. The JSON request string input and
+ # response output are shown formatted with white space and line breaks
+ # for better readability. Submit your input as a single line JSON
+ # string.
#
# **Minimum permissions**
#
# To run this command, you must have the following permissions:
#
@@ -959,19 +961,19 @@
#
# **Related operations**
#
# * To attach a resource policy to a secret, use PutResourcePolicy.
#
- # * To delete the resource-based policy that is attached to a secret,
+ # * To delete the resource-based policy that's attached to a secret,
# use DeleteResourcePolicy.
#
# * To list all of the currently available secrets, use ListSecrets.
#
# @option params [required, String] :secret_id
- # Specifies the secret for which you want to retrieve the attached
- # resource-based policy. You can specify either the Amazon Resource Name
- # (ARN) or the friendly name of the secret.
+ # 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.
#
# @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
@@ -1368,16 +1370,17 @@
def list_secrets(params = {}, options = {})
req = build_request(:list_secrets, params)
req.send_request(options)
end
- # Attaches the contents of the specified resource-based policy to a
- # secret. A resource-based policy is optional. Alternatively, you can
- # use IAM user-based policies that specify the secret's ARN in the
- # policy statement's `Resources` element. You can also use a
- # combination of both identity- an resource-based policies. The affected
- # users and roles receive the permissions permitted by all of the
+ # Attaches the contents of the specified resource-based permission
+ # policy to a secret. A resource-based policy is optional.
+ # Alternatively, you can use IAM identity-based policies that specify
+ # the secret's Amazon Resource Name (ARN) in the policy statement's
+ # `Resources` element. You can also use a combination of both
+ # identity-based and resource-based policies. The affected users and
+ # roles receive the permissions that are permitted by all of the
# relevant policies. For more information, see [Using Resource-Based
# Policies for AWS Secrets Manager][1]. For the complete description of
# the AWS policy syntax and grammar, see [IAM JSON Policy Reference][2]
# in the *IAM User Guide*.
#
@@ -1389,31 +1392,30 @@
#
# ^
#
# **Related operations**
#
- # * To retrieve the resource policy attached to a secret, use
+ # * To retrieve the resource policy that's attached to a secret, use
# GetResourcePolicy.
#
- # * To delete the resource-based policy that is attached to a secret,
+ # * To delete the resource-based policy that's attached to a secret,
# use DeleteResourcePolicy.
#
# * To list all of the currently available secrets, use ListSecrets.
#
#
#
# [1]: http://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-based-policies.html
# [2]: http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html
#
# @option params [required, String] :secret_id
- # Specifies the secret to which you want to attach the resource-based
- # policy. You can specify either the Amazon Resource Name (ARN) or the
- # friendly name of the secret.
+ # 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.
#
# @option params [required, String] :resource_policy
- # A JSON-formatted string constructed according to the grammar and
- # syntax for an AWS resource-based policy. The policy in the string
+ # 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
# line tool environments, see [Using JSON for Parameters][1] in the *AWS
# CLI User Guide*.
#
@@ -2509,10 +2511,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-secretsmanager'
- context[:gem_version] = '1.8.0'
+ context[:gem_version] = '1.9.0'
Seahorse::Client::Request.new(handlers, context)
end
# @api private
# @deprecated