EFS / Client / put_backup_policy

put_backup_policy#

EFS.Client.put_backup_policy(**kwargs)#

Updates the file system’s backup policy. Use this action to start or stop automatic backups of the file system.

See also: AWS API Documentation

Request Syntax

response = client.put_backup_policy(
    FileSystemId='string',
    BackupPolicy={
        'Status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'
    }
)
Parameters:

  • FileSystemId (string) –

    [REQUIRED]

    Specifies which EFS file system to update the backup policy for.

  • BackupPolicy (dict) –

    [REQUIRED]

    The backup policy included in the PutBackupPolicy request.

    • Status (string) – [REQUIRED]

      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.

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

  • EFS.Client.exceptions.InternalServerError

  • EFS.Client.exceptions.ValidationException