GetBackupPlan - Amazon Backup
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

GetBackupPlan

Returns BackupPlan details for the specified BackupPlanId. The details are the body of a backup plan in JSON format, in addition to plan metadata.

Request Syntax

GET /backup/plans/backupPlanId/?versionId=VersionId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

backupPlanId

Uniquely identifies a backup plan.

Required: Yes

VersionId

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "AdvancedBackupSettings": [ { "BackupOptions": { "string" : "string" }, "ResourceType": "string" } ], "BackupPlan": { "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" } ] }, "BackupPlanArn": "string", "BackupPlanId": "string", "CreationDate": number, "CreatorRequestId": "string", "DeletionDate": number, "LastExecutionDate": number, "VersionId": "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.

AdvancedBackupSettings

Contains a list of BackupOptions for each resource type. The list is populated only if the advanced option is set for the backup plan.

Type: Array of AdvancedBackupSetting objects

BackupPlan

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

Type: BackupPlan object

BackupPlanArn

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

Type: String

BackupPlanId

Uniquely identifies a backup plan.

Type: String

CreationDate

The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Type: Timestamp

CreatorRequestId

A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.

Type: String

DeletionDate

The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Type: Timestamp

LastExecutionDate

The last time this backup plan was run. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Type: Timestamp

VersionId

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

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 Amazon SDKs, see the following: