Skip to content

Start Restore Job

backup_start_restore_job R Documentation

Recovers the saved resource identified by an Amazon Resource Name (ARN)

Description

Recovers the saved resource identified by an Amazon Resource Name (ARN).

Usage

backup_start_restore_job(RecoveryPointArn, Metadata, IamRoleArn,
  IdempotencyToken, ResourceType, CopySourceTagsToRestoredResource)

Arguments

RecoveryPointArn

[required] An ARN that uniquely identifies a recovery point; for example, ⁠arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45⁠.

Metadata

[required] A set of metadata key-value pairs.

You can get configuration metadata about a resource at the time it was backed up by calling get_recovery_point_restore_metadata. However, values in addition to those provided by get_recovery_point_restore_metadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.

For more information about the metadata for each resource, see the following:

IamRoleArn

The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: ⁠arn:aws:iam::123456789012:role/S3Access⁠.

IdempotencyToken

A customer-chosen string that you can use to distinguish between otherwise identical calls to start_restore_job. Retrying a successful request with the same idempotency token results in a success message with no action taken.

ResourceType

Starts a job to restore a recovery point for one of the following resources:

  • Aurora - Amazon Aurora

  • DocumentDB - Amazon DocumentDB

  • CloudFormation - CloudFormation

  • DynamoDB - Amazon DynamoDB

  • EBS - Amazon Elastic Block Store

  • EC2 - Amazon Elastic Compute Cloud

  • EFS - Amazon Elastic File System

  • FSx - Amazon FSx

  • Neptune - Amazon Neptune

  • RDS - Amazon Relational Database Service

  • Redshift - Amazon Redshift

  • ⁠Storage Gateway⁠ - Storage Gateway

  • S3 - Amazon Simple Storage Service

  • Timestream - Amazon Timestream

  • VirtualMachine - Virtual machines

CopySourceTagsToRestoredResource

This is an optional parameter. If this equals True, tags included in the backup will be copied to the restored resource.

This can only be applied to backups created through Backup.

Value

A list with the following syntax: 

list(
  RestoreJobId = "string"
)

Request syntax

svc$start_restore_job(
  RecoveryPointArn = "string",
  Metadata = list(
    "string"
  ),
  IamRoleArn = "string",
  IdempotencyToken = "string",
  ResourceType = "string",
  CopySourceTagsToRestoredResource = TRUE|FALSE
)