Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

describe_backup_policy

describe_backup_policy(**kwargs)

Returns the backup policy for the specified EFS file system.

See also: AWS API Documentation

Request Syntax

response = client.describe_backup_policy(
    FileSystemId='string'
)
Parameters
FileSystemId (string) --

[REQUIRED]

Specifies which EFS file system to retrieve the BackupPolicy for.

Return type
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

  • EFS.Client.exceptions.BadRequest
  • EFS.Client.exceptions.FileSystemNotFound
  • EFS.Client.exceptions.InternalServerError
  • EFS.Client.exceptions.PolicyNotFound
  • EFS.Client.exceptions.ValidationException