StartRestoreJob - AWS Backup

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

StartRestoreJob

Récupère la ressource enregistrée identifiée par un Amazon Resource Name (ARN).

Syntaxe de la demande

PUT /restore-jobs HTTP/1.1 Content-type: application/json { "CopySourceTagsToRestoredResource": boolean, "IamRoleArn": "string", "IdempotencyToken": "string", "Metadata": { "string" : "string" }, "RecoveryPointArn": "string", "ResourceType": "string" }

Paramètres de demande URI

La demande n’utilise pas de paramètres URI.

Corps de la demande

Cette demande accepte les données suivantes au format JSON.

CopySourceTagsToRestoredResource

Ce paramètre est facultatif. S'il est égal à True, les balises incluses dans la sauvegarde seront copiées sur la ressource restaurée.

Cela ne peut être appliqué qu'aux sauvegardes créées via AWS Backup.

Type : booléen

Obligatoire : non

IamRoleArn

Le nom de ressource Amazon (ARN) du rôle IAM AWS Backup utilisé pour créer la ressource cible ; par exemple :arn:aws:iam::123456789012:role/S3Access.

Type : chaîne

Obligatoire : non

IdempotencyToken

Chaîne choisie par le client que vous pouvez utiliser pour faire la distinction entre des appels par ailleurs identiques à StartRestoreJob. Toute nouvelle tentative d'une demande réussie avec le même jeton d'idempotence entraîne un message de réussite sans qu'aucune action ne soit entreprise.

Type : chaîne

Obligatoire : non

Metadata

Un ensemble de paires clé-valeur de métadonnées.

Vous pouvez obtenir les métadonnées de configuration relatives à une ressource au moment de sa sauvegarde en appelant GetRecoveryPointRestoreMetadata. Cependant, des valeurs autres que celles fournies par GetRecoveryPointRestoreMetadata peuvent être nécessaires pour restaurer une ressource. Par exemple, vous devrez peut-être fournir un nouveau nom de ressource si l'original existe déjà.

Pour plus d'informations sur les métadonnées de chaque ressource, consultez les rubriques suivantes :

Type : mappage chaîne/chaîne

Obligatoire : oui

RecoveryPointArn

Un ARN qui identifie de façon unique un point de récupération ; par exemple, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Type : chaîne

Obligatoire : oui

ResourceType

Démarre une tâche visant à restaurer un point de récupération pour l'une des ressources suivantes :

  • Aurora- Amazon Aurora

  • DocumentDB- Amazon DocumentDB

  • CloudFormation - AWS CloudFormation

  • DynamoDB- Amazon DynamoDB

  • EBS- Boutique Amazon Elastic Block

  • 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- Machines virtuelles

Type : chaîne

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

Obligatoire : non

Syntaxe de la réponse

HTTP/1.1 200 Content-type: application/json { "RestoreJobId": "string" }

Eléments de réponse

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

RestoreJobId

Identifie de manière unique la tâche qui restaure un point de récupération.

Type : chaîne

Erreurs

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.

InvalidParameterValueException

Indique une erreur avec la valeur d'un paramètre. Par exemple, la valeur est hors de portée.

Code d’état HTTP : 400

InvalidRequestException

Indique une erreur dans la saisie de la demande. Par exemple, un paramètre n'est pas du bon type.

Code d’état HTTP : 400

MissingParameterValueException

Indique qu'un paramètre obligatoire est manquant.

Code d’état HTTP : 400

ResourceNotFoundException

Aucune ressource requise pour l'action n'existe.

Code d’état HTTP : 400

ServiceUnavailableException

La demande a échoué en raison d'une défaillance temporaire du serveur.

Code d’état HTTP : 500

consultez aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des AWS SDK spécifiques au langage, consultez les pages suivantes :