AWS Backup
Developer Guide

ExportBackupPlanTemplate

Returns the backup plan that is specified by the plan ID as a backup template.

Request Syntax

GET /backup/plans/backupPlanId/toTemplate/ HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

backupPlanId

Uniquely identifies a backup plan.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "BackupPlanTemplateJson": "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.

BackupPlanTemplateJson

The body of a backup plan template in JSON format.

Note

This is a signed JSON document that cannot be modified before being passed to GetBackupPlanFromJSON.

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: