Updates the file system's backup policy. Use this action to start or stop automatic backups of the file system.
Request Syntax
PUT /2015-02-01/file-systems/FileSystemId/backup-policy HTTP/1.1
Content-type: application/json
{
"BackupPolicy": {
"Status": "string"
}
}URI Request Parameters
The request uses the following URI parameters.
- FileSystemId
-
Specifies which EFS file system to update the backup policy for.
Length Constraints: Maximum length of 128.
Pattern:
^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$Required: Yes
Request Body
The request accepts the following data in JSON format.
- BackupPolicy
-
The backup policy included in the
PutBackupPolicyrequest.Type: BackupPolicy object
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"BackupPolicy": {
"Status": "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- BackupPolicy
-
Describes the file system's backup policy, indicating whether automatic backups are turned on or off.
Type: BackupPolicy object
Errors
- BadRequest
-
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
HTTP Status Code: 400
- FileSystemNotFound
-
Returned if the specified
FileSystemIdvalue doesn't exist in the requester's AWS account.HTTP Status Code: 404
- IncorrectFileSystemLifeCycleState
-
Returned if the file system's lifecycle state is not "available".
HTTP Status Code: 409
- InternalServerError
-
Returned if an error occurred on the server side.
HTTP Status Code: 500
- ValidationException
-
Returned if the AWS Backup service is not available in the AWS Region in which the request was made.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
