本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# UpdateLedger


更新總帳上的屬性。

## 請求語法


```
PATCH /ledgers/name HTTP/1.1
Content-type: application/json

{
   "DeletionProtection": boolean,
   "KmsKey": "string"
}
```

## URI 請求參數


請求會使用下列 URI 參數。

 ** [name](#API_UpdateLedger_RequestSyntax) **   <a name="qldb-UpdateLedger-request-uri-Name"></a>
分類帳的名稱。  
長度限制：長度下限為 1。長度上限為 32。  
模式：`(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$`  
必要：是

## 請求主體


請求接受採用 JSON 格式的下列資料。

 ** [DeletionProtection](#API_UpdateLedger_RequestSyntax) **   <a name="qldb-UpdateLedger-request-DeletionProtection"></a>
指定是否要保護分類帳，不讓任何使用者刪除。如果在建立分類帳時未定義，則預設會啟用此功能 (`true`)。  
如果已啟用刪除保護，則必須先停用該功能才能刪除分類帳。您可以呼叫 `UpdateLedger` 操作將此參數設定為 `false` 以停用該功能。  
類型：布林值  
必要：否

 ** [KmsKey](#API_UpdateLedger_RequestSyntax) **   <a name="qldb-UpdateLedger-request-KmsKey"></a>
用於在總帳中加密靜態資料的 in 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 金鑰，您可使用其金鑰 ID、Amazon Resource Name (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) **   <a name="qldb-UpdateLedger-response-Arn"></a>
總帳的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制︰長度下限為 20。長度上限為 1600。

 ** [CreationDateTime](#API_UpdateLedger_ResponseSyntax) **   <a name="qldb-UpdateLedger-response-CreationDateTime"></a>
建立總帳時的日期和時間，以 epoch 時間格式顯示。(Epoch 時間格式是自 1970 年 1 月 1 日上午 12：00：00 UTC 以來經過的秒數。)  
類型：Timestamp

 ** [DeletionProtection](#API_UpdateLedger_ResponseSyntax) **   <a name="qldb-UpdateLedger-response-DeletionProtection"></a>
指定是否要保護分類帳，不讓任何使用者刪除。如果在建立分類帳時未定義，則預設會啟用此功能 (`true`)。  
如果已啟用刪除保護，則必須先停用該功能才能刪除分類帳。您可以呼叫 `UpdateLedger` 操作將此參數設定為 `false` 以停用該功能。  
類型：布林值

 ** [EncryptionDescription](#API_UpdateLedger_ResponseSyntax) **   <a name="qldb-UpdateLedger-response-EncryptionDescription"></a>
有關分類帳中靜態資料加密的資訊。這包括目前狀態、 AWS KMS 金鑰，以及金鑰何時變得無法存取 （發生錯誤時）。  
類型：[LedgerEncryptionDescription](API_LedgerEncryptionDescription.md) 物件

 ** [Name](#API_UpdateLedger_ResponseSyntax) **   <a name="qldb-UpdateLedger-response-Name"></a>
分類帳的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 32。  
模式：`(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$`

 ** [State](#API_UpdateLedger_ResponseSyntax) **   <a name="qldb-UpdateLedger-response-State"></a>
總帳的目前狀態。  
類型：字串  
有效值:`CREATING | ACTIVE | DELETING | DELETED` 

## 錯誤


如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** InvalidParameterException **   
請求中的一或多個參數無效。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
指定的資源不存在。  
HTTP 狀態碼：404

## 另請參閱


如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列介面](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/UpdateLedger) 
+  [AWS 適用於 .NET 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/UpdateLedger) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/UpdateLedger) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/UpdateLedger) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/UpdateLedger) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/UpdateLedger) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/UpdateLedger) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/UpdateLedger) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/UpdateLedger) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/UpdateLedger)