backup_describe_backup_job: Returns backup job details for the specified BackupJobId

Description Usage Arguments Value Request syntax

View source: R/backup_operations.R

Description

Returns backup job details for the specified BackupJobId.

Usage

1

Arguments

BackupJobId

[required] Uniquely identifies a request to AWS Backup to back up a resource.

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
list(
  AccountId = "string",
  BackupJobId = "string",
  BackupVaultName = "string",
  BackupVaultArn = "string",
  RecoveryPointArn = "string",
  ResourceArn = "string",
  CreationDate = as.POSIXct(
    "2015-01-01"
  ),
  CompletionDate = as.POSIXct(
    "2015-01-01"
  ),
  State = "CREATED"|"PENDING"|"RUNNING"|"ABORTING"|"ABORTED"|"COMPLETED"|"FAILED"|"EXPIRED",
  StatusMessage = "string",
  PercentDone = "string",
  BackupSizeInBytes = 123,
  IamRoleArn = "string",
  CreatedBy = list(
    BackupPlanId = "string",
    BackupPlanArn = "string",
    BackupPlanVersion = "string",
    BackupRuleId = "string"
  ),
  ResourceType = "string",
  BytesTransferred = 123,
  ExpectedCompletionDate = as.POSIXct(
    "2015-01-01"
  ),
  StartBy = as.POSIXct(
    "2015-01-01"
  ),
  BackupOptions = list(
    "string"
  ),
  BackupType = "string"
)

Request syntax

1
2
3
svc$describe_backup_job(
  BackupJobId = "string"
)

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