secretsmanager_get_resource_policy: Retrieves the JSON text of the resource-based policy document...

Description Usage Arguments Details Request syntax Examples

View source: R/secretsmanager_operations.R

Description

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.

Usage

1

Arguments

SecretId

[required] 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.

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.

Details

Minimum permissions

To run this command, you must have the following permissions:

Related operations

Request syntax

1
2
3
svc$get_resource_policy(
  SecretId = "string"
)

Examples

1
2
3
4
5
# The following example shows how to retrieve the resource-based policy
# that is attached to a secret.
svc$get_resource_policy(
  SecretId = "MyTestDatabaseSecret"
)

paws.security.identity documentation built on Oct. 30, 2019, 11:26 a.m.