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. # UpdateLedger Met à jour les propriétés d'un registre. ## Syntaxe de la demande ``` PATCH /ledgers/name HTTP/1.1 Content-type: application/json { "DeletionProtection": boolean, "KmsKey": "string" } ``` ## Paramètres de demande URI La demande utilise les paramètres URI suivants. ** [name](#API_UpdateLedger_RequestSyntax) ** Nom du registre. Contraintes de longueur : longueur minimum de 1. Longueur maximale de 32. Modèle : `(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$` Obligatoire : oui ## Corps de la demande Cette demande accepte les données suivantes au format JSON. ** [DeletionProtection](#API_UpdateLedger_RequestSyntax) ** Spécifie si le registre est protégé contre la suppression par un utilisateur. À défaut de définition lors de la création du registre, cette fonctionnalité est activée (`true`) par défaut. Si la protection contre la suppression est activée, vous devez commencer par la désactiver avant de pouvoir supprimer le registre. Vous pouvez la désactiver en appelant l'opération `UpdateLedger` pour définir ce paramètre sur `false`. Type : booléen Obligatoire : non ** [KmsKey](#API_UpdateLedger_RequestSyntax) ** La clé in AWS Key Management Service (AWS KMS) à utiliser pour le chiffrement des données au repos dans le registre. Pour plus d'informations, veuillez consulter la rubrique [Chiffrement au repos](https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html) dans le *Guide du développeur Amazon QLDB*. Utilisez l'une des options suivantes pour spécifier ce paramètre : + `AWS_OWNED_KMS_KEY`: utilisez une AWS KMS clé détenue et gérée par AWS vous. + **Non défini** : n'apportez aucune modification à la clé KMS du registre. + **Une clé KMS symétrique gérée par le client valide** : utilisez la clé KMS de chiffrement symétrique spécifiée dans votre compte que vous créez, possédez et gérez. Amazon QLDB ne prend pas en charge les clés asymétriques. Pour plus d'informations, consultez la section [Utilisation de clés symétriques et asymétriques](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) dans le manuel du * AWS Key Management Service développeur*. Pour spécifier une clé KMS gérée par le client, utilisez son ID de clé, son Amazon Resource Name (ARN), son nom d'alias ou son ARN d'alias. Lorsque vous utilisez un nom d'alias, préfixez-le avec `"alias/"`. Pour spécifier une clé dans un autre Compte AWS, vous devez utiliser l'ARN de la clé ou l'alias ARN. Par exemple : + ID de clé : `1234abcd-12ab-34cd-56ef-1234567890ab` + ARN de clé : `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab` + Nom d'alias : `alias/ExampleAlias` + ARN d'alias : `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias` Pour plus d'informations, consultez la section [Identifiants clés (KeyId)](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id) dans le *guide du AWS Key Management Service développeur*. Type : String Contraintes de longueur : longueur maximale de 1600. Obligatoire : non ## Syntaxe de la réponse ``` HTTP/1.1 200 Content-type: application/json { "Arn": "string", "CreationDateTime": number, "DeletionProtection": boolean, "EncryptionDescription": { "EncryptionStatus": "string", "InaccessibleKmsKeyDateTime": number, "KmsKeyArn": "string" }, "Name": "string", "State": "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. ** [Arn](#API_UpdateLedger_ResponseSyntax) ** Le nom de ressource Amazon (ARN) du registre. Type : String Contraintes de longueur : longueur minimale de 20. Longueur maximale de 1600. ** [CreationDateTime](#API_UpdateLedger_ResponseSyntax) ** Date et heure, au format epoch time, auxquelles le registre a été créé. (Le format Epoch est le nombre de secondes écoulées depuis 00h00 le 1er janvier 1970 UTC.) Type : Timestamp ** [DeletionProtection](#API_UpdateLedger_ResponseSyntax) ** Spécifie si le registre est protégé contre la suppression par un utilisateur. À défaut de définition lors de la création du registre, cette fonctionnalité est activée (`true`) par défaut. Si la protection contre la suppression est activée, vous devez commencer par la désactiver avant de pouvoir supprimer le registre. Vous pouvez la désactiver en appelant l'opération `UpdateLedger` pour définir ce paramètre sur `false`. Type : booléen ** [EncryptionDescription](#API_UpdateLedger_ResponseSyntax) ** Informations sur le chiffrement des données au repos dans le registre. Cela inclut l'état actuel, la AWS KMS clé et le moment où la clé est devenue inaccessible (en cas d'erreur). Type : objet [LedgerEncryptionDescription](API_LedgerEncryptionDescription.md) ** [Name](#API_UpdateLedger_ResponseSyntax) ** Nom du registre. Type : String Contraintes de longueur : longueur minimum de 1. Longueur maximale de 32. Modèle : `(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$` ** [State](#API_UpdateLedger_ResponseSyntax) ** État actuel du registre. Type : String Valeurs valides : `CREATING | ACTIVE | DELETING | DELETED` ## Erreurs Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md). ** InvalidParameterException ** Un ou plusieurs paramètres de la demande ne sont pas valides. Code d’état HTTP : 400 ** ResourceNotFoundException ** La ressource spécifiée n’existe pas. Code d’état HTTP : 404 ## consultez aussi Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit : + [Interface de ligne de commande AWS](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/UpdateLedger) + [AWS SDK pour .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/UpdateLedger) + [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/UpdateLedger) + [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/UpdateLedger) + [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/UpdateLedger) + [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/UpdateLedger) + [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/UpdateLedger) + [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/UpdateLedger) + [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/UpdateLedger) + [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/UpdateLedger)