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. # StartBackupJob Démarre une tâche de sauvegarde à la demande pour la ressource spécifiée. ## Syntaxe de la demande ``` PUT /backup-jobs HTTP/1.1 Content-type: application/json { "BackupOptions": { "string" : "string" }, "BackupVaultName": "string", "CompleteWindowMinutes": number, "IamRoleArn": "string", "IdempotencyToken": "string", "Index": "string", "Lifecycle": { "DeleteAfterDays": number, "DeleteAfterEvent": "string", "MoveToColdStorageAfterDays": number, "OptInToArchiveForSupportedResources": boolean }, "LogicallyAirGappedBackupVaultArn": "string", "RecoveryPointTags": { "string" : "string" }, "ResourceArn": "string", "StartWindowMinutes": number } ``` ## 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. ** [BackupOptions](#API_StartBackupJob_RequestSyntax) ** L'option de sauvegarde pour une ressource sélectionnée. Cette option est uniquement disponible pour les tâches de sauvegarde Windows Volume Shadow Copy Service (VSS). Valeurs valides : définissez sur `"WindowsVSS":"enabled"` pour activer l'option de sauvegarde `WindowsVSS` et créer une sauvegarde Windows VSS. Définissez sur `"WindowsVSS""disabled"` pour créer une sauvegarde régulière. L'option `WindowsVSS` n'est pas activée par défaut. Type : mappage chaîne/chaîne Modèle de clé :`^[a-zA-Z0-9\-\_\.]{1,50}$` Modèle de valeur : `^[a-zA-Z0-9\-\_\.]{1,50}$` Obligatoire : non ** [BackupVaultName](#API_StartBackupJob_RequestSyntax) ** Le nom d'un conteneur logique où les sauvegardes sont stockées. Les coffres-forts de sauvegarde sont identifiés par des noms spécifiques pour le compte utilisé pour les créer et la région AWS dans laquelle ils sont créés. Type : Chaîne Modèle : `^[a-zA-Z0-9\-\_]{2,50}$` Obligatoire : oui ** [CompleteWindowMinutes](#API_StartBackupJob_RequestSyntax) ** Valeur en minutes pendant laquelle une sauvegarde démarrée avec succès doit se terminer, faute de quoi AWS Backup annule la tâche. Cette valeur est facultative. Cette valeur commence le compte à rebours à partir du moment auquel la sauvegarde a été planifiée. Cela n'ajoute pas de temps supplémentaire pour `StartWindowMinutes`, ni si la sauvegarde a démarré plus tard que prévu. Comme `StartWindowMinutes`, ce paramètre a une valeur maximale de 100 ans (52 560 000 minutes). Type : Long Obligatoire : non ** [IamRoleArn](#API_StartBackupJob_RequestSyntax) ** Spécifie l'ARN du rôle IAM utilisé pour créer le point de récupération cible ; par exemple, `arn:aws:iam::123456789012:role/S3Access`. Type : Chaîne Obligatoire : oui ** [IdempotencyToken](#API_StartBackupJob_RequestSyntax) ** Chaîne choisie par le client que vous pouvez utiliser pour faire la distinction entre des appels par ailleurs identiques à `StartBackupJob`. 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 ** [Index](#API_StartBackupJob_RequestSyntax) ** Incluez ce paramètre pour activer la création d'index si votre tâche de sauvegarde possède un type de ressource qui prend en charge les index de sauvegarde. Les types de ressources qui prennent en charge les index de sauvegarde sont les suivants : + `EBS` pour Amazon Elastic Block Store + `S3`pour Amazon Simple Storage Service (Amazon S3) L'index peut avoir 1 des 2 valeurs possibles, `ENABLED` soit`DISABLED`. Pour créer un index de sauvegarde pour un point de `ACTIVE` restauration éligible qui ne possède pas encore d'index de sauvegarde, définissez la valeur sur`ENABLED`. Pour supprimer un index de sauvegarde, définissez la valeur sur`DISABLED`. Type : Chaîne Valeurs valides : `ENABLED | DISABLED` Obligatoire : non ** [Lifecycle](#API_StartBackupJob_RequestSyntax) ** Le cycle de vie définit le moment où une ressource protégée est transférée vers le stockage à froid et sa date d'expiration. AWS Backup fera automatiquement la transition et expirera les sauvegardes en fonction du cycle de vie que vous définissez. Les sauvegardes transférées vers une chambre froide doivent être stockées dans une chambre froide pendant au moins 90 jours. Par conséquent, le paramètre « rétention » doit être supérieur de 90 jours au paramètre « nombre de jours avant transfert vers stockage à froid ». Le paramètre « nombre de jours avant transfert vers stockage à froid » ne peut pas être modifié après le transfert d’une sauvegarde vers un stockage à froid. Les types de ressources pouvant passer au stockage à froid sont répertoriés dans le tableau [Disponibilité des fonctionnalités par ressource](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource). AWS Backup ignore cette expression pour les autres types de ressources. Ce paramètre a une valeur maximale de 100 ans (36 500 jours). Type : objet [Lifecycle](API_Lifecycle.md) Obligatoire : non ** [LogicallyAirGappedBackupVaultArn](#API_StartBackupJob_RequestSyntax) ** L'ARN d'un coffre-fort à espacement logique. L'ARN doit appartenir au même compte et à la même région. Si elles sont fournies, les ressources entièrement gérées prises en charge sont sauvegardées directement dans un coffre-fort à espacement logique, tandis que les autres ressources prises en charge créent un instantané temporaire (facturable) dans le coffre-fort de sauvegarde, puis le copient dans un coffre-fort à espacement logique. Les ressources non prises en charge ne sont sauvegardées que dans le coffre de sauvegarde spécifié. Type : chaîne Obligatoire : non ** [RecoveryPointTags](#API_StartBackupJob_RequestSyntax) ** Les balises à attribuer aux ressources. Type : mappage chaîne/chaîne Obligatoire : non ** [ResourceArn](#API_StartBackupJob_RequestSyntax) ** Un Amazon Resource Name (ARN) qui identifie de façon unique une ressource. Le format de l'ARN dépend du type de ressource. Type : Chaîne Obligatoire : oui ** [StartWindowMinutes](#API_StartBackupJob_RequestSyntax) ** Valeur en minutes après la planification d'une sauvegarde avant qu'une tâche soit annulée si elle ne démarre pas correctement. Cette valeur est facultative et elle est de 8 heures par défaut. Si cette valeur est incluse, elle doit être d'au moins 60 minutes pour éviter les erreurs. Ce paramètre a une valeur maximale de 100 ans (52 560 000 minutes). Pendant la fenêtre de démarrage, le statut de la tâche de sauvegarde reste `CREATED` jusqu'à ce qu'elle ait démarré ou jusqu'à ce que le délai de la fenêtre de démarrage soit écoulé. Si, dans la fenêtre de démarrage, time AWS Backup reçoit une erreur autorisant une nouvelle tentative de la tâche, elle AWS Backup réessaiera automatiquement de recommencer la tâche au moins toutes les 10 minutes jusqu'à ce que la sauvegarde commence avec succès (le statut de la tâche passe à`RUNNING`) ou jusqu'à ce que le statut de la tâche passe à `EXPIRED` (ce qui devrait se produire une fois la fenêtre de démarrage terminée). Type : Long Obligatoire : non ## Syntaxe de la réponse ``` HTTP/1.1 200 Content-type: application/json { "BackupJobId": "string", "CreationDate": number, "IsParent": boolean, "RecoveryPointArn": "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. ** [BackupJobId](#API_StartBackupJob_ResponseSyntax) ** Identifie de manière unique une demande AWS Backup de sauvegarde d'une ressource. Type : Chaîne ** [CreationDate](#API_StartBackupJob_ResponseSyntax) ** Date et heure de création d'une tâche de sauvegarde, au format Unix et au format UTC (temps universel coordonné). La valeur de `CreationDate` est précise en millisecondes. Par exemple, la valeur 1516925490,087 représente le vendredi 26 janvier 2018 à 00 h 11 m 30,087 s. Type : Timestamp ** [IsParent](#API_StartBackupJob_ResponseSyntax) ** Il s'agit d'une valeur booléenne renvoyée indiquant qu'il s'agit d'une tâche de sauvegarde parent (composite). Type : Boolean ** [RecoveryPointArn](#API_StartBackupJob_ResponseSyntax) ** *Remarque : ce champ n'est renvoyé que pour les ressources Amazon EFS et Advanced DynamoDB.* 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 ## Erreurs Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Types d'erreurs courants](CommonErrors.md). ** InvalidParameterValueException ** Indique une erreur avec la valeur d'un paramètre. Par exemple, la valeur est hors de portée. ** Context ** ** Type ** 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. ** Context ** ** Type ** Code d’état HTTP : 400 ** LimitExceededException ** Une limite de la demande a été dépassée ; par exemple, le nombre maximum d'éléments autorisés dans une demande. ** Context ** ** Type ** Code d’état HTTP : 400 ** MissingParameterValueException ** Indique qu'un paramètre obligatoire est manquant. ** Context ** ** Type ** Code d’état HTTP : 400 ** ResourceNotFoundException ** Aucune ressource requise pour l'action n'existe. ** Context ** ** Type ** Code d’état HTTP : 400 ** ServiceUnavailableException ** La demande a échoué en raison d'une défaillance temporaire du serveur. ** Context ** ** Type ** Code d’état HTTP : 500 ## Voir aussi Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit : + [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/StartBackupJob) + [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/StartBackupJob) + [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/StartBackupJob) + [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/StartBackupJob) + [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/StartBackupJob) + [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/StartBackupJob) + [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/StartBackupJob) + [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/StartBackupJob) + [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/StartBackupJob) + [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/StartBackupJob)