:doc:`EFS <../../efs>` / Client / describe_backup_policy

**********************
describe_backup_policy
**********************



.. py:method:: EFS.Client.describe_backup_policy(**kwargs)

  

  Returns the backup policy for the specified EFS file system.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeBackupPolicy>`_  


  **Request Syntax**
  ::

    response = client.describe_backup_policy(
        FileSystemId='string'
    )
    
  :type FileSystemId: string
  :param FileSystemId: **[REQUIRED]** 

    Specifies which EFS file system for which to retrieve the ``BackupPolicy``.

    

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

    
    ::

      {
          'BackupPolicy': {
              'Status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **BackupPolicy** *(dict) --* 

        Describes the file system's backup policy, indicating whether automatic backups are turned on or off.

        
        

        - **Status** *(string) --* 

          Describes the status of the file system's backup policy.

           

          
          * ``ENABLED`` – EFS is automatically backing up the file system.
           
          * ``ENABLING`` – EFS is turning on automatic backups for the file system.
           
          * ``DISABLED`` – Automatic back ups are turned off for the file system.
           
          * ``DISABLING`` – EFS is turning off automatic backups for the file system.
          

          
    
  
  **Exceptions**
  
  *   :py:class:`EFS.Client.exceptions.BadRequest`

  
  *   :py:class:`EFS.Client.exceptions.FileSystemNotFound`

  
  *   :py:class:`EFS.Client.exceptions.InternalServerError`

  
  *   :py:class:`EFS.Client.exceptions.PolicyNotFound`

  
  *   :py:class:`EFS.Client.exceptions.ValidationException`

  