Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetBackupPlanFromTemplate

Returns the template specified by its templateId as a backup plan.

Request Syntax


GET /backup/template/plans/templateId/toPlan HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

templateId

Uniquely identifies a stored backup plan template.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "BackupPlanDocument": { 
      "AdvancedBackupSettings": [ 
         { 
            "BackupOptions": { 
               "string" : "string" 
            },
            "ResourceType": "string"
         }
      ],
      "BackupPlanName": "string",
      "Rules": [ 
         { 
            "CompletionWindowMinutes": number,
            "CopyActions": [ 
               { 
                  "DestinationBackupVaultArn": "string",
                  "Lifecycle": { 
                     "DeleteAfterDays": number,
                     "MoveToColdStorageAfterDays": number,
                     "OptInToArchiveForSupportedResources": boolean
                  }
               }
            ],
            "EnableContinuousBackup": boolean,
            "Lifecycle": { 
               "DeleteAfterDays": number,
               "MoveToColdStorageAfterDays": number,
               "OptInToArchiveForSupportedResources": boolean
            },
            "RecoveryPointTags": { 
               "string" : "string" 
            },
            "RuleId": "string",
            "RuleName": "string",
            "ScheduleExpression": "string",
            "ScheduleExpressionTimezone": "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.

BackupPlanDocument

Returns the body of a backup plan based on the target template, including the name, rules, and backup vault of the plan.

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

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