backup_list_restore_jobs: Returns a list of jobs that AWS Backup initiated to restore a...

Description Usage Arguments Value Request syntax

View source: R/backup_operations.R

Description

Returns a list of jobs that AWS Backup initiated to restore a saved resource, including metadata about the recovery process.

Usage

1
2
backup_list_restore_jobs(NextToken, MaxResults, ByAccountId,
  ByCreatedBefore, ByCreatedAfter, ByStatus)

Arguments

NextToken

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

MaxResults

The maximum number of items to be returned.

ByAccountId

The account ID to list the jobs from. Returns only restore jobs associated with the specified account ID.

ByCreatedBefore

Returns only restore jobs that were created before the specified date.

ByCreatedAfter

Returns only restore jobs that were created after the specified date.

ByStatus

Returns only restore jobs associated with the specified job status.

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
list(
  RestoreJobs = list(
    list(
      AccountId = "string",
      RestoreJobId = "string",
      RecoveryPointArn = "string",
      CreationDate = as.POSIXct(
        "2015-01-01"
      ),
      CompletionDate = as.POSIXct(
        "2015-01-01"
      ),
      Status = "PENDING"|"RUNNING"|"COMPLETED"|"ABORTED"|"FAILED",
      StatusMessage = "string",
      PercentDone = "string",
      BackupSizeInBytes = 123,
      IamRoleArn = "string",
      ExpectedCompletionTimeMinutes = 123,
      CreatedResourceArn = "string",
      ResourceType = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
svc$list_restore_jobs(
  NextToken = "string",
  MaxResults = 123,
  ByAccountId = "string",
  ByCreatedBefore = as.POSIXct(
    "2015-01-01"
  ),
  ByCreatedAfter = as.POSIXct(
    "2015-01-01"
  ),
  ByStatus = "PENDING"|"RUNNING"|"COMPLETED"|"ABORTED"|"FAILED"
)

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