CmdID / aws / aws backup

aws backup get-backup-plan

Returns BackupPlan details for the specified BackupPlanId. AWS CLI reference

1 example 3 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

To get the details of a backup plan

The following get-backup-plan example displays the details of the specified backup plan.

aws backup get-backup-plan --backup-plan-id "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"Identify

--backup-plan-idUniquely identifies a backup plan.

Its output

{
    "BackupPlan": {
        "BackupPlanName": "Example-Backup-Plan",
        "Rules": [
            {
                "RuleName": "DailyBackups",
                "TargetBackupVaultName": "Default",
                "ScheduleExpression": "cron(0 5 ? * * *)",
                "StartWindowMinutes": 480,
                "CompletionWindowMinutes": 10080,
                "Lifecycle": {
                    "DeleteAfterDays": 35
                },
                "RuleId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
            }
        ]
    },
    "BackupPlanId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "BackupPlanArn": "arn:aws:backup:us-west-2:123456789012:backup-plan:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "VersionId": "NjQ2ZTZkODktMGVhNy00MmQ0LWE4YjktZTkwNTQ3OTkyYTcw",
    "CreationDate": 1568926091.57
}

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

Options

3 in the AWS CLI reference

--backup-plan-idUniquely identifies a backup plan.

--max-scheduled-runs-previewNumber of future scheduled backup runs to preview.

--version-idUnique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long.