secretsmanager_get_secret_value: Retrieves the contents of the encrypted fields SecretString...

View source: R/secretsmanager_operations.R

secretsmanager_get_secret_valueR Documentation

Retrieves the contents of the encrypted fields SecretString or SecretBinary from the specified version of a secret, whichever contains content

Description

Retrieves the contents of the encrypted fields SecretString or SecretBinary from the specified version of a secret, whichever contains content.

See https://www.paws-r-sdk.com/docs/secretsmanager_get_secret_value/ for full documentation.

Usage

secretsmanager_get_secret_value(
  SecretId,
  VersionId = NULL,
  VersionStage = NULL
)

Arguments

SecretId

[required] The ARN or name of the secret to retrieve. To retrieve a secret from another account, you must use an ARN.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

VersionId

The unique identifier of the version of the secret to retrieve. If you include both this parameter and VersionStage, the two parameters must refer to the same secret version. If you don't specify either a VersionStage or VersionId, then Secrets Manager returns the AWSCURRENT version.

This value is typically a UUID-type value with 32 hexadecimal digits.

VersionStage

The staging label of the version of the secret to retrieve.

Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and VersionId, the two parameters must refer to the same secret version. If you don't specify either a VersionStage or VersionId, Secrets Manager returns the AWSCURRENT version.


paws.security.identity documentation built on Sept. 12, 2024, 6:30 a.m.