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.

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:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDescribeSecret and EndDescribeSecret.

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

Syntax

C#
public virtual Task<DescribeSecretResponse> DescribeSecretAsync(
         DescribeSecretRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.SecretsManager.Model.DescribeSecretRequest

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

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


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

Exceptions

ExceptionCondition
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.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also