AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the DescribeSecret operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SecretsManager.AmazonSecretsManagerRequest
      Amazon.SecretsManager.Model.DescribeSecretRequest

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

Syntax

C#
public class DescribeSecretRequest : AmazonSecretsManagerRequest
         IAmazonWebServiceRequest

The DescribeSecretRequest type exposes the following members

Constructors

NameDescription
Public Method DescribeSecretRequest()

Properties

NameTypeDescription
Public Property SecretId System.String

Gets and sets the property SecretId.

The ARN or name of the secret.

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

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 Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5