AmazonSecretsManagerClient.DescribeSecret Method (DescribeSecretRequest)

Retrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager only returns fields that have a value in the response.

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

Required permissions: secretsmanager:DescribeSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to DescribeSecretAsync.

Namespace: Amazon.SecretsManager
Assembly: AWSSDK.SecretsManager.dll
Version: 3.x.y.z

Syntax

public virtual DescribeSecretResponse DescribeSecret(
         DescribeSecretRequest request
)

Parameters

request: Type: Amazon.SecretsManager.Model.DescribeSecretRequest

Container for the necessary parameters to execute the DescribeSecret service method.

Return Value

Type: DescribeSecretResponse

The response from the DescribeSecret service method, as returned by SecretsManager.

Exceptions

Exception	Condition
InternalServiceErrorException	An error occurred on the server side.
InvalidParameterException	The parameter name or value is invalid.
ResourceNotFoundException	Secrets Manager can't find the resource that you asked for.

Examples

The following example shows how to get the details about a secret.

To retrieve the details of a secret


var client = new AmazonSecretsManagerClient();
var response = client.DescribeSecret(new DescribeSecretRequest 
{
    SecretId = "MyTestDatabaseSecret"
});

string arn = response.ARN;
string description = response.Description;
string kmsKeyId = response.KmsKeyId;
DateTime lastAccessedDate = response.LastAccessedDate;
DateTime lastChangedDate = response.LastChangedDate;
DateTime lastRotatedDate = response.LastRotatedDate;
string name = response.Name;
DateTime nextRotationDate = response.NextRotationDate;
bool rotationEnabled = response.RotationEnabled;
string rotationLambdaARN = response.RotationLambdaARN;
RotationRulesType rotationRules = response.RotationRules;
List<Tag> tags = response.Tags;
Dictionary<string, List<string>> versionIdsToStages = response.VersionIdsToStages;

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

AmazonSecretsManagerClient.DescribeSecret (DescribeSecretRequest)

Method