:doc:`SecretsManager <../../secretsmanager>` / Client / restore_secret

**************
restore_secret
**************



.. py:method:: SecretsManager.Client.restore_secret(**kwargs)

  

  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 <https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html>`__.

   

  **Required permissions:** ``secretsmanager:RestoreSecret``. For more information, see `IAM policy actions for Secrets Manager <https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions>`__ and `Authentication and access control in Secrets Manager <https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html>`__.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/RestoreSecret>`_  


  **Request Syntax**
  ::

    response = client.restore_secret(
        SecretId='string'
    )
    
  :type SecretId: string
  :param SecretId: **[REQUIRED]** 

    The ARN or name of the secret to restore.

     

    For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See `Finding a secret from a partial ARN <https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen>`__.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'ARN': 'string',
          'Name': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ARN** *(string) --* 

        The ARN of the secret that was restored.

        
      

      - **Name** *(string) --* 

        The name of the secret that was restored.

        
  
  **Exceptions**
  
  *   :py:class:`SecretsManager.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`SecretsManager.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`SecretsManager.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`SecretsManager.Client.exceptions.InternalServiceError`

  

  **Examples**

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

    response = client.restore_secret(
        SecretId='MyTestDatabaseSecret',
    )
    
    print(response)

  
  Expected Output:
  ::

    {
        'ARN': 'arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3',
        'Name': 'MyTestDatabaseSecret',
        'ResponseMetadata': {
            '...': '...',
        },
    }

  