IAmazonSecretsManager.RestoreSecret Method (RestoreSecretRequest)

Cancels the scheduled deletion of a secret by removing the DeletedDate time stamp. You can access a secret again after it has been restored.

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:RestoreSecret. 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 RestoreSecretAsync.

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

Syntax

public abstract RestoreSecretResponse RestoreSecret(
         RestoreSecretRequest request
)

Parameters

request: Type: Amazon.SecretsManager.Model.RestoreSecretRequest

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

Return Value

Type: RestoreSecretResponse

The response from the RestoreSecret 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.
InvalidRequestException	A parameter value is not valid for the current state of the resource. Possible causes: The secret is scheduled for deletion. You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call. The secret is managed by another service, and you must use that service to update it. For more information, see Secrets managed by other Amazon Web Services services.
ResourceNotFoundException	Secrets Manager can't find the resource that you asked for.

Examples

The following example shows how to restore a secret that you previously scheduled for deletion.

To restore a previously deleted secret


var client = new AmazonSecretsManagerClient();
var response = client.RestoreSecret(new RestoreSecretRequest 
{
    SecretId = "MyTestDatabaseSecret"
});

string arn = response.ARN;
string name = response.Name;

Version Information

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

IAmazonSecretsManager.RestoreSecret (RestoreSecretRequest)

Method