本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
UpdateLedger
更新分類帳上的屬性。
請求語法
PATCH /ledgers/name
HTTP/1.1
Content-type: application/json
{
"DeletionProtection": boolean
,
"KmsKey": "string
"
}
URI 請求參數
請求會使用下列 URI 參數。
- name
-
分類帳的名稱。
長度限制:長度下限為 1。長度上限為 32。
模式:
(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$
必要:是
請求主體
請求接受採用 JSON 格式的下列資料。
- DeletionProtection
-
指定是否要保護分類帳,不讓任何使用者刪除。如果在建立分類帳時未定義,則預設會啟用此功能 (
true
)。如果已啟用刪除保護,則必須先停用該功能才能刪除分類帳。您可以呼叫
UpdateLedger
操作將此參數設定為false
以停用該功能。類型:布林值
必要:否
- KmsKey
-
AWS Key Management Service (AWS KMS) 中的密鑰用於分類帳中靜態數據的加密。如需詳細資訊,請參閱《Amazon QLDB 開發人員指南》中的靜態加密。
使用以下其中一個選項來指定此參數:
-
AWS_OWNED_KMS_KEY
:使用代表您擁有和管理 AWS 的 AWS KMS 密鑰。 -
未定義:不變更分類帳的 KMS 金鑰。
-
有效的對稱客戶受管 KMS 金鑰:使用在您帳戶中建立、擁有和管理的指定對稱加密 KMS 金鑰。
Amazon QLDB 不支援非對稱金鑰。如需詳細資訊,請參閱 AWS Key Management Service 開發人員指南中的使用對稱和非對稱金鑰。
若要指定客戶受管 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)。
類型:字串
長度限制:最大長度為 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
-
分類帳的 Amazon 資源名稱(ARN)。
類型:字串
長度限制︰長度下限為 20。長度上限為 1600。
- CreationDateTime
-
建立分類帳時的日期和時間 (以紀元時間格式表示)。(紀元時間格式是自世界標準時間 1970 年 1 月 1 日上午 12:00:00 以來經過的秒數。)
類型:Timestamp
- DeletionProtection
-
指定是否要保護分類帳,不讓任何使用者刪除。如果在建立分類帳時未定義,則預設會啟用此功能 (
true
)。如果已啟用刪除保護,則必須先停用該功能才能刪除分類帳。您可以呼叫
UpdateLedger
操作將此參數設定為false
以停用該功能。類型:布林值
- EncryptionDescription
-
有關分類帳中靜態數據加密的信息。這包括當前狀態, AWS KMS 密鑰以及密鑰無法訪問的時間(在發生錯誤的情況下)。
- Name
-
分類帳的名稱。
類型:字串
長度限制:長度下限為 1。長度上限為 32。
模式:
(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$
- State
-
分類帳的目前狀態。
類型:字串
有效值:
CREATING | ACTIVE | DELETING | DELETED
錯誤
如需所有動作常見錯誤的資訊,請參閱常見錯誤。
- InvalidParameterException
-
請求中的一個或多個參數無效。
HTTP 狀態碼:400
- ResourceNotFoundException
-
指定的資源不存在。
HTTP 狀態碼:404
另請參閱
如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊,請參閱下列內容: