翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # UpdateLedger 台帳のプロパティを更新します。 ## リクエストの構文 ``` PATCH /ledgers/name HTTP/1.1 Content-type: application/json { "DeletionProtection": boolean, "KmsKey": "string" } ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [name](#API_UpdateLedger_RequestSyntax) ** 台帳の名前。 長さの制限：最小長 1、最大長は 32 です。 パターン: `(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$` 必須: はい ## リクエストボディ リクエストは以下の JSON 形式のデータを受け入れます。 ** [DeletionProtection](#API_UpdateLedger_RequestSyntax) ** 台帳がユーザーによって削除されないように保護されるかどうかを指定します。台帳の作成時に指定しない場合、この機能はデフォルトで有効 `true` になります。 削除保護が有効になっている場合は、台帳を削除する前に、まず無効にする必要があります。無効にするには、`UpdateLedger` オペレーションを呼び出してパラメータを `false` に設定します。 型: ブール値 必須: いいえ ** [KmsKey](#API_UpdateLedger_RequestSyntax) ** 台帳内の保管中のデータの暗号化に使用する AWS Key Management Service （AWS KMS) のキー。詳細については、*Amazon QLDB デベロッパーガイド*の[保管時の暗号化](https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html)を参照してください。 次のオプションのいずれかを使用して、このパラメータを指定します。 + `AWS_OWNED_KMS_KEY`: ユーザーに代わって によって所有および管理 AWS されている AWS KMS キーを使用します。 + **未定義**: 台帳の KMS キーは変更されません。 + **有効な対称カスタマーマネージド KMS キー**: 作成、所有、管理しているアカウントで指定した対称暗号 KMS キーを使用します。 Amazon QLDB は非対称キーをサポートしていません。詳細については、「 * AWS Key Management Service デベロッパーガイド*」の[「対称キーと非対称キーの使用](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html)」を参照してください。 カスタマーマネージド KMS キーを指定するには、その KMS キー ID、Amazon リソースネーム (ARN)、エイリアス名、またはエイリアス ARN を使用します。エイリアス名を使用する場合は、`"alias/"` をプレフィックスします。別の でキーを指定するには AWS アカウント、キー ARN またはエイリアス ARN を使用する必要があります。 例： + キー ID: `1234abcd-12ab-34cd-56ef-1234567890ab` + キー ARN: `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab` + エイリアス名: `alias/ExampleAlias` + エイリアス ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias` 詳細については、「 * AWS Key Management Service デベロッパーガイド*」の[「キー識別子 (KeyId)](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id)」を参照してください。 タイプ: 文字列 長さの制限: 最大長は 1600 必須: いいえ ## レスポンスの構文 ``` 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" } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [Arn](#API_UpdateLedger_ResponseSyntax) ** 台帳の Amazon リソースネーム (ARN)。 タイプ: 文字列 長さの制限: 最小長は 20 です。最大長は 1600 です。 ** [CreationDateTime](#API_UpdateLedger_ResponseSyntax) ** 台帳が作成された日時 (エポック時刻形式)。(エポック時間形式は 1970 年 1 月 1 日 12:00:00 AM UTC からの経過秒数です。) タイプ: タイムスタンプ ** [DeletionProtection](#API_UpdateLedger_ResponseSyntax) ** 台帳がユーザーによって削除されないように保護されるかどうかを指定します。台帳の作成時に指定しない場合、この機能はデフォルトで有効 `true` になります。 削除保護が有効になっている場合は、台帳を削除する前に、まず無効にする必要があります。無効にするには、`UpdateLedger` オペレーションを呼び出してパラメータを `false` に設定します。 型: ブール値 ** [EncryptionDescription](#API_UpdateLedger_ResponseSyntax) ** 台帳の保管中のデータの暗号化に関する情報。これには、現在のステータス、 AWS KMS キー、キーにアクセスできなくなった日時 (エラーの場合) が含まれます。 型: [LedgerEncryptionDescription](API_LedgerEncryptionDescription.md) オブジェクト ** [Name](#API_UpdateLedger_ResponseSyntax) ** 台帳の名前。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 32 です。 パターン: `(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$` ** [State](#API_UpdateLedger_ResponseSyntax) ** 台帳の現在のステータス。 型: 文字列 有効な値：`CREATING | ACTIVE | DELETING | DELETED` ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** InvalidParameterException ** リクエスト内の 1 つ以上のパラメータが有効ではありません。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** 指定されたリソースは存在しません。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/UpdateLedger) + [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/UpdateLedger) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/UpdateLedger) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/UpdateLedger) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/UpdateLedger) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/UpdateLedger) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/UpdateLedger) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/UpdateLedger) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/UpdateLedger) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/UpdateLedger)