Table of Contents

Class GetSecretValueRequest

Namespace
Amazon.SecretsManager.Model
Assembly
AWSSDK.SecretsManager.dll

Container for the parameters to the GetSecretValue operation. Retrieves the contents of the encrypted fields 

SecretString
or 
SecretBinary
from the specified version of a secret, whichever contains content.

Minimum permissions

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

  • secretsmanager:GetSecretValue

  • kms:Decrypt - required only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager.

Related operations

  • To create a new version of the secret with different encrypted information, use PutSecretValue.

  • To retrieve the non-encrypted details for the secret, use DescribeSecret. 

public class GetSecretValueRequest : AmazonSecretsManagerRequest
Inheritance
GetSecretValueRequest

Constructors

GetSecretValueRequest() 

public GetSecretValueRequest()

Properties

SecretId

Gets and sets the property SecretId.

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

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. 

public string SecretId { get; set; }

Property Value

string

VersionId

Gets and sets the property VersionId.

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 version with the 
VersionStage
value of 
AWSCURRENT
.

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

public string VersionId { get; set; }

Property Value

string

VersionStage

Gets and sets the property VersionStage.

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 use this parameter then don't specify 

VersionId
. 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
. 
public string VersionStage { get; set; }

Property Value

string