PUT

/2015-02-01/file-systems/{FileSystemId}/backup-policy

http://elasticfilesystem.{region}.amazonaws.com/2015-02-01/file-systems/{FileSystemId}/backup-policy

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

Access Token Required: API Key

Path Parameters

FileSystemIdstringrequired

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

Body Params

BackupPolicyobjectrequired

The backup policy for the file system used to create automatic daily backups. If status has a value of <code>ENABLED</code>, the file system is being automatically backed up. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#automatic-backups">Automatic backups</a>.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'http://elasticfilesystem.{region}.amazonaws.com/2015-02-01/file-systems/{FileSystemId}/backup-policy' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

PUT