Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . backup ]



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

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.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--recovery-point-arn <value>
--metadata <value>
--iam-role-arn <value>
[--idempotency-token <value>]
[--resource-type <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--recovery-point-arn (string)

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 (map)

A set of metadata key-value pairs. Lists the metadata that the recovery point was created with.

Shorthand Syntax:


JSON Syntax:

{"string": "string"

--iam-role-arn (string)

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 .

--idempotency-token (string)

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.

--resource-type (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


RestoreJobId -> (string)

Uniquely identifies the job that restores a recovery point.