AWS Backup
Developer Guide

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

UpdateBackupPlan

Replaces the body of a saved backup plan identified by its backupPlanId with the input document in JSON format. The new version is uniquely identified by a VersionId.

Request Syntax

POST /backup/plans/backupPlanId HTTP/1.1 Content-type: application/json { "BackupPlan": { "BackupPlanName": "string", "Rules": [ { "CompletionWindowMinutes": number, "Lifecycle": { "DeleteAfterDays": number, "MoveToColdStorageAfterDays": number }, "RecoveryPointTags": { "string" : "string" }, "RuleName": "string", "ScheduleExpression": "string", "StartWindowMinutes": number, "TargetBackupVaultName": "string" } ] } }

URI Request Parameters

The request requires the following URI parameters.

backupPlanId

Uniquely identifies a backup plan.

Request Body

The request accepts the following data in JSON format.

BackupPlan

Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

Type: BackupPlanInput object

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "BackupPlanArn": "string", "BackupPlanId": "string", "CreationDate": number, "VersionId": "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.

BackupPlanArn

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

Type: String

BackupPlanId

Uniquely identifies a backup plan.

Type: String

CreationDate

The date and time a backup plan is updated, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Type: Timestamp

VersionId

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version Ids cannot be edited.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterValueException

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

HTTP Status Code: 400

MissingParameterValueException

Indicates that a required parameter is missing.

HTTP Status Code: 400

ResourceNotFoundException

A resource that is required for the action doesn't exist.

HTTP Status Code: 400

ServiceUnavailableException

The request failed due to a temporary failure of the server.

HTTP Status Code: 500

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: