StartRestoreJob - AWS Backup
Sintaxe da SolicitaçãoParâmetros da solicitação de URICorpo da SolicitaçãoSintaxe da RespostaElementos de RespostaErrosConsulte também

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

StartRestoreJob

Recupera o recurso salvo identificado por um Nome do recurso da Amazon (ARN).

Sintaxe da Solicitação

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

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

Parâmetros da solicitação de URI

A solicitação não usa nenhum parâmetro de URI.

Corpo da Solicitação

A solicitação aceita os dados a seguir no formato JSON.

CopySourceTagsToRestoredResource

Esse parâmetro é opcional. Se isso for igual a True, as tags incluídas no backup serão copiadas para o recurso restaurado.

Isso só pode ser aplicado aos backups criados por meio do AWS Backup.

Tipo: booliano

Obrigatório: Não

IamRoleArn

O nome do recurso da Amazon (ARN) do perfil do IAM que o AWS Backup usa para criar o recurso de destino. Por exemplo: arn:aws:iam::123456789012:role/S3Access.

Tipo: string

Obrigatório: Não

IdempotencyToken

Uma string escolhida pelo cliente que você pode usar para distinguir entre chamadas idênticas para StartRestoreJob. Tentar novamente uma solicitação com êxito com o mesmo token de idempotência resultará em uma mensagem de êxito sem nenhuma ação tomada.

Tipo: string

Obrigatório: Não

Metadata

Um conjunto de pares de chave/valor de metadados.

É possível obter metadados de configuração sobre um recurso no momento em que o backup foi feito por meio de uma chamada a GetRecoveryPointRestoreMetadata. No entanto, valores além dos fornecidos por GetRecoveryPointRestoreMetadata podem ser necessários para restaurar um recurso. Por exemplo, talvez seja necessário fornecer um novo nome de recurso caso o original já exista.

Para obter mais informações sobre os metadados para cada recurso, consulte:

Tipo: mapa de string para string

Obrigatório: Sim

RecoveryPointArn

Um ARN que identifica de forma exclusiva um ponto de recuperação. Por exemplo, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Tipo: string

Obrigatório: Sim

ResourceType

Inicia um trabalho para restaurar um ponto de recuperação para um dos seguintes recursos:

  • 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: Máquinas virtuais

Tipo: string

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

Obrigatório: Não

Sintaxe da Resposta

HTTP/1.1 200
Content-type: application/json

{
   "RestoreJobId": "string"
}

Elementos de Resposta

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

RestoreJobId

Identifica de forma exclusiva o trabalho que restaura um ponto de recuperação.

Tipo: string

Erros

Para obter informações sobre os erros comuns a todas as ações, consulte Erros comuns.

InvalidParameterValueException

Indica que há algo errado com o valor de um parâmetro. Por exemplo, o valor está fora do intervalo.

Código de Status HTTP: 400

InvalidRequestException

Indica que há algo errado com a entrada da solicitação. Por exemplo, um parâmetro é do tipo errado.

Código de Status HTTP: 400

MissingParameterValueException

Indica que um parâmetro necessário está ausente.

Código de Status HTTP: 400

ResourceNotFoundException

Um recurso necessário para a ação não existe.

Código de Status HTTP: 400

ServiceUnavailableException

Houve falha na solicitação devido a um erro temporário do servidor.

Código de Status HTTP: 500

Consulte também

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: