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.

GetBackupPlanFromJSON

Returns a valid JSON document specifying a backup plan or an error.

Request Syntax

POST /backup/template/json/toPlan HTTP/1.1 Content-type: application/json { "BackupPlanTemplateJson": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

BackupPlanTemplateJson

A customer-supplied backup plan document in JSON format.

Type: String

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "BackupPlan": { "BackupPlanName": "string", "Rules": [ { "CompletionWindowMinutes": number, "Lifecycle": { "DeleteAfterDays": number, "MoveToColdStorageAfterDays": number }, "RecoveryPointTags": { "string" : "string" }, "RuleId": "string", "RuleName": "string", "ScheduleExpression": "string", "StartWindowMinutes": number, "TargetBackupVaultName": "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.

BackupPlan

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

Type: BackupPlan object

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

InvalidRequestException

Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.

HTTP Status Code: 400

LimitExceededException

A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.

HTTP Status Code: 400

MissingParameterValueException

Indicates that a required parameter is missing.

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: