List Restore Jobs

backup_list_restore_jobs

R Documentation

Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process¶

Description¶

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

Usage¶

backup_list_restore_jobs(NextToken, MaxResults, ByAccountId,
  ByResourceType, ByCreatedBefore, ByCreatedAfter, ByStatus,
  ByCompleteBefore, ByCompleteAfter, ByRestoreTestingPlanArn)

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.

ByResourceType

Include this parameter to return only restore jobs for the specified resources:

Aurora for Amazon Aurora
CloudFormation for CloudFormation
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
RDS for Amazon Relational Database Service
Redshift for Amazon Redshift
S3 for Amazon Simple Storage Service (Amazon S3)
⁠SAP HANA on Amazon EC2⁠ for SAP HANA databases on Amazon Elastic Compute Cloud instances
⁠Storage Gateway⁠ for Storage Gateway
Timestream for Amazon Timestream
VirtualMachine for VMware virtual machines

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.

ByCompleteBefore

Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).

ByCompleteAfter

Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

ByRestoreTestingPlanArn

This returns only restore testing jobs that match the specified resource Amazon Resource Name (ARN).

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(
  NextToken = "string",
  MaxResults = 123,
  ByAccountId = "string",
  ByResourceType = "string",
  ByCreatedBefore = as.POSIXct(
    "2015-01-01"
  ),
  ByCreatedAfter = as.POSIXct(
    "2015-01-01"
  ),
  ByStatus = "PENDING"|"RUNNING"|"COMPLETED"|"ABORTED"|"FAILED",
  ByCompleteBefore = as.POSIXct(
    "2015-01-01"
  ),
  ByCompleteAfter = as.POSIXct(
    "2015-01-01"
  ),
  ByRestoreTestingPlanArn = "string"
)