paws.storage (version 0.1.0)

backup_start_restore_job: 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)

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. Lists the metadata that the recovery point was created with.

IamRoleArn

[required] The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

IdempotencyToken

A customer chosen string that can be used to distinguish between calls to StartRestoreJob. Idempotency tokens time out after one hour. Therefore, if you call StartRestoreJob multiple times with the same idempotency token within one hour, AWS Backup recognizes that you are requesting only one restore job and initiates only one. If you change the idempotency token for each call, AWS Backup recognizes that you are requesting to start multiple restores.

ResourceType

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

  • EBS for Amazon Elastic Block Store

  • SGW for AWS Storage Gateway

  • RDS for Amazon Relational Database Service

  • DDB for Amazon DynamoDB

  • EFS for Amazon Elastic File System

Request syntax

svc$start_restore_job(
  RecoveryPointArn = "string",
  Metadata = list(
    "string"
  ),
  IamRoleArn = "string",
  IdempotencyToken = "string",
  ResourceType = "string"
)

Details

If the resource ARN is included in the request, then the last complete backup of that resource is recovered. If the ARN of a recovery point is supplied, then that recovery point is restored.