Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

StartRestoreJob

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

Request Syntax


PUT /restore-jobs HTTP/1.1
Content-type: application/json

{
   "CopySourceTagsToRestoredResource": boolean,
   "IamRoleArn": "string",
   "IdempotencyToken": "string",
   "Metadata": { 
      "string" : "string" 
   },
   "RecoveryPointArn": "string",
   "ResourceType": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

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 AWS Backup.

Type: Boolean

Required: No

IamRoleArn

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

Type: String

Required: No

IdempotencyToken

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

Type: String

Required: No

Metadata

A set of metadata key-value pairs.

You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata 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:

Type: String to string map

Required: Yes

RecoveryPointArn

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

Type: String

Required: Yes

ResourceType

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

Aurora - Amazon Aurora
DocumentDB - Amazon DocumentDB
CloudFormation - AWS 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 - AWS Storage Gateway
S3 - Amazon Simple Storage Service
Timestream - Amazon Timestream
VirtualMachine - Virtual machines

Type: String

Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "RestoreJobId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

RestoreJobId

Uniquely identifies the job that restores a recovery point.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterValueException

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

HTTP Status Code: 400

InvalidRequestException

Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.

HTTP Status Code: 400

MissingParameterValueException

Indicates that a required parameter is missing.

HTTP Status Code: 400

ResourceNotFoundException

A resource that is required for the action doesn't exist.

HTTP Status Code: 400

ServiceUnavailableException

The request failed due to a temporary failure of the server.

HTTP Status Code: 500