CreateLegalHold - 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.

CreateLegalHold

Crée un blocage légal sur un point de récupération (sauvegarde). Une conservation légale est une restriction associée à la modification ou à la suppression d'une sauvegarde jusqu'à ce qu'un utilisateur autorisé annule la conservation légale. Toute action visant à supprimer ou dissocier un point de récupération échouera avec une erreur si une ou plusieurs conservations légales actives se trouvent sur le point de récupération.

Syntaxe de la requête

POST /legal-holds/ HTTP/1.1 Content-type: application/json { "Description": "string", "IdempotencyToken": "string", "RecoveryPointSelection": { "DateRange": { "FromDate": number, "ToDate": number }, "ResourceIdentifiers": [ "string" ], "VaultNames": [ "string" ] }, "Tags": { "string" : "string" }, "Title": "string" }

URIParamètres de demande

La demande n'utilise aucun URI paramètre.

Corps de la requête

La demande accepte les données suivantes au JSON format suivant.

Description

Description de la détention légale.

Type : String

Obligatoire : oui

IdempotencyToken

Il s'agit d'une chaîne choisie par l'utilisateur utilisée pour faire la distinction entre des appels par ailleurs identiques. 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

RecoveryPointSelection

Les critères d'attribution d'un ensemble de ressources, tels que les types de ressources ou les coffres-forts de sauvegarde.

Type : objet RecoveryPointSelection

Obligatoire : non

Tags

Balises facultatives à inclure. Une balise est une paire clé-valeur que vous pouvez utiliser pour gérer, filtrer et rechercher vos ressources. Les caractères autorisés incluent UTF -8 lettres, chiffres, espaces et les caractères suivants : + - =. _ : /.

Type : mappage chaîne/chaîne

Obligatoire : non

Title

Titre de la retenue légale.

Type : String

Obligatoire : oui

Syntaxe de la réponse

HTTP/1.1 200 Content-type: application/json { "CreationDate": number, "Description": "string", "LegalHoldArn": "string", "LegalHoldId": "string", "RecoveryPointSelection": { "DateRange": { "FromDate": number, "ToDate": number }, "ResourceIdentifiers": [ "string" ], "VaultNames": [ "string" ] }, "Status": "string", "Title": "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 sous JSON forme formatée par le service.

CreationDate

Heure à laquelle la mise en attente légale a été créée.

Type : Timestamp

Description

Description de la détention légale.

Type : String

LegalHoldArn

Le nom de ressource Amazon (ARN) de la conservation légale.

Type : String

LegalHoldId

L'identifiant de la retenue légale.

Type : String

RecoveryPointSelection

Les critères à attribuer à un ensemble de ressources, tels que les types de ressources ou les coffres-forts de sauvegarde.

Type : objet RecoveryPointSelection

Status

Le statut de la suspension légale.

Type : String

Valeurs valides : CREATING | ACTIVE | CANCELING | CANCELED

Title

Titre de la retenue légale.

Type : String

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.

HTTPCode de statut : 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.

HTTPCode de statut : 400

MissingParameterValueException

Indique qu'un paramètre obligatoire est manquant.

HTTPCode de statut : 400

ServiceUnavailableException

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

HTTPCode de statut : 500

consultez aussi

Pour plus d'informations sur son utilisation API dans l'une des langues spécifiques AWS SDKs, consultez ce qui suit :