Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . backup ]



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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--backup-plan-template-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--backup-plan-template-id (string)

Uniquely identifies a stored backup plan template.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


To get an existing backup plan from a template

The following get-backup-plan-from-template example gets an existing backup plan from a template that specifies a daily backup with a 35 day retention.

aws backup get-backup-plan-from-template \
    --backup-plan-template-id "87c0c1ef-254d-4180-8fef-2e76a2c38aaa"


    "BackupPlanDocument": {
        "Rules": [
                "RuleName": "DailyBackups",
                "ScheduleExpression": "cron(0 5 ? * * *)",
                "StartWindowMinutes": 480,
                "Lifecycle": {
                    "DeleteAfterDays": 35

For more information, see Creating a Backup Plan in the AWS Backup Developer Guide.


BackupPlanDocument -> (structure)

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

BackupPlanName -> (string)

The display name of a backup plan.

Rules -> (list)

An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.


Specifies a scheduled task used to back up a selection of resources.

RuleName -> (string)

An optional display name for a backup rule.

TargetBackupVaultName -> (string)

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

ScheduleExpression -> (string)

A CRON expression specifying when AWS Backup initiates a backup job.

StartWindowMinutes -> (long)

An optional value that specifies a period of time in minutes after a backup is scheduled before a job is canceled if it doesn't start successfully.

CompletionWindowMinutes -> (long)

A value in minutes after a backup job is successfully started before it must be completed or it is canceled by AWS Backup. This value is optional.

Lifecycle -> (structure)

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

MoveToColdStorageAfterDays -> (long)

Specifies the number of days after creation that a recovery point is moved to cold storage.

DeleteAfterDays -> (long)

Specifies the number of days after creation that a recovery point is deleted. Must be greater than MoveToColdStorageAfterDays .

RecoveryPointTags -> (map)

An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.

key -> (string)

value -> (string)

RuleId -> (string)

Uniquely identifies a rule that is used to schedule the backup of a selection of resources.