backup_get_backup_plan: Returns BackupPlan details for the specified BackupPlanId

Description Usage Arguments Value Request syntax

View source: R/backup_operations.R

Description

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

Usage

1
backup_get_backup_plan(BackupPlanId, VersionId)

Arguments

BackupPlanId

[required] Uniquely identifies a backup plan.

VersionId

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

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
list(
  BackupPlan = list(
    BackupPlanName = "string",
    Rules = list(
      list(
        RuleName = "string",
        TargetBackupVaultName = "string",
        ScheduleExpression = "string",
        StartWindowMinutes = 123,
        CompletionWindowMinutes = 123,
        Lifecycle = list(
          MoveToColdStorageAfterDays = 123,
          DeleteAfterDays = 123
        ),
        RecoveryPointTags = list(
          "string"
        ),
        RuleId = "string",
        CopyActions = list(
          list(
            Lifecycle = list(
              MoveToColdStorageAfterDays = 123,
              DeleteAfterDays = 123
            ),
            DestinationBackupVaultArn = "string"
          )
        )
      )
    ),
    AdvancedBackupSettings = list(
      list(
        ResourceType = "string",
        BackupOptions = list(
          "string"
        )
      )
    )
  ),
  BackupPlanId = "string",
  BackupPlanArn = "string",
  VersionId = "string",
  CreatorRequestId = "string",
  CreationDate = as.POSIXct(
    "2015-01-01"
  ),
  DeletionDate = as.POSIXct(
    "2015-01-01"
  ),
  LastExecutionDate = as.POSIXct(
    "2015-01-01"
  ),
  AdvancedBackupSettings = list(
    list(
      ResourceType = "string",
      BackupOptions = list(
        "string"
      )
    )
  )
)

Request syntax

1
2
3
4
svc$get_backup_plan(
  BackupPlanId = "string",
  VersionId = "string"
)

paws.storage documentation built on Aug. 23, 2021, 1:06 a.m.