Skip to content

Describe Restore Job

backup_describe_restore_job R Documentation

Returns metadata associated with a restore job that is specified by a job ID

Description

Returns metadata associated with a restore job that is specified by a job ID.

Usage

backup_describe_restore_job(RestoreJobId)

Arguments

RestoreJobId

[required] Uniquely identifies the job that restores a recovery point.

Value

A list with the following syntax:

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"
)

Request syntax

svc$describe_restore_job(
  RestoreJobId = "string"
)