Skip to content

List Restore Jobs by Protected Resource

backup_list_restore_jobs_by_protected_resource R Documentation

This returns restore jobs that contain the specified protected resource

Description

This returns restore jobs that contain the specified protected resource.

You must include ResourceArn. You can optionally include NextToken, ByStatus, MaxResults, ByRecoveryPointCreationDateAfter , and ByRecoveryPointCreationDateBefore.

Usage

backup_list_restore_jobs_by_protected_resource(ResourceArn, ByStatus,
  ByRecoveryPointCreationDateAfter, ByRecoveryPointCreationDateBefore,
  NextToken, MaxResults)

Arguments

ResourceArn

[required] Returns only restore jobs that match the specified resource Amazon Resource Name (ARN).

ByStatus

Returns only restore jobs associated with the specified job status.

ByRecoveryPointCreationDateAfter

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

ByRecoveryPointCreationDateBefore

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

NextToken

The next item following a partial list of returned items. For example, if a request ismade 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.

Value

A list with the following syntax: 

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",
      RecoveryPointCreationDate = as.POSIXct(
        "2015-01-01"
      ),
      CreatedBy = list(
        RestoreTestingPlanArn = "string"
      ),
      ValidationStatus = "FAILED"|"SUCCESSFUL"|"TIMED_OUT"|"VALIDATING",
      ValidationStatusMessage = "string",
      DeletionStatus = "DELETING"|"FAILED"|"SUCCESSFUL",
      DeletionStatusMessage = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_restore_jobs_by_protected_resource(
  ResourceArn = "string",
  ByStatus = "PENDING"|"RUNNING"|"COMPLETED"|"ABORTED"|"FAILED",
  ByRecoveryPointCreationDateAfter = as.POSIXct(
    "2015-01-01"
  ),
  ByRecoveryPointCreationDateBefore = as.POSIXct(
    "2015-01-01"
  ),
  NextToken = "string",
  MaxResults = 123
)