class Aws::SecretsManager::Types::GetSecretValueRequest

@note When making an API call, you may pass GetSecretValueRequest

data as a hash:

    {
      secret_id: "SecretIdType", # required
      version_id: "SecretVersionIdType",
      version_stage: "SecretVersionStageType",
    }

@!attribute [rw] 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 ending with a hyphen followed by six
characters.

 If you specify an incomplete ARN without the random suffix, and
instead provide the 'friendly name', you *must* not include the
random suffix. If you do include the random suffix added by Secrets
Manager, you receive either a *ResourceNotFoundException* or an
*AccessDeniedException* error, depending on your permissions.

 </note>
@return [String]

@!attribute [rw] version_id

Specifies the unique identifier of the version of the secret that
you want to retrieve. If you specify 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 the default is to perform the operation on the
version with the `VersionStage` value of `AWSCURRENT`.

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

[1]: https://wikipedia.org/wiki/Universally_unique_identifier
@return [String]

@!attribute [rw] version_stage

Specifies the secret version that you want to retrieve by the
staging label attached to the version.

Staging labels are used to keep track of different versions during
the rotation process. If you specify 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`, then the default is to perform the operation on the
version with the `VersionStage` value of `AWSCURRENT`.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/GetSecretValueRequest AWS API Documentation

Constants

SENSITIVE