Backup / Client / start_restore_job

start_restore_job#

Backup.Client.start_restore_job(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.start_restore_job(
    RecoveryPointArn='string',
    Metadata={
        'string': 'string'
    },
    IamRoleArn='string',
    IdempotencyToken='string',
    ResourceType='string',
    CopySourceTagsToRestoredResource=True|False
)
Parameters:

  • RecoveryPointArn (string) –

    [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 (dict) –

    [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 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:

    • (string) –

      • (string) –

  • IamRoleArn (string) – 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 (string) – 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.

  • ResourceType (string) –

    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 (boolean) –

    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.

Return type:

dict

Returns:

Response Syntax

{
    'RestoreJobId': 'string'
}

Response Structure

  • (dict) –

    • RestoreJobId (string) –

      Uniquely identifies the job that restores a recovery point.

Exceptions