Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

# UpdateLedger
<a name="API_UpdateLedger"></a>

Memperbarui properti pada buku besar.

## Minta Sintaks
<a name="API_UpdateLedger_RequestSyntax"></a>

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

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

## Parameter Permintaan URI
<a name="API_UpdateLedger_RequestParameters"></a>

Permintaan menggunakan parameter URI berikut.

 ** [name](#API_UpdateLedger_RequestSyntax) **   <a name="qldb-UpdateLedger-request-uri-Name"></a>
Nama buku besar.  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 32.  
Pola: `(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$`   
Wajib: Ya

## Isi Permintaan
<a name="API_UpdateLedger_RequestBody"></a>

Permintaan menerima data berikut dalam format JSON.

 ** [DeletionProtection](#API_UpdateLedger_RequestSyntax) **   <a name="qldb-UpdateLedger-request-DeletionProtection"></a>
Menentukan apakah buku besar dilindungi dari dihapus oleh setiap pengguna. Jika tidak ditentukan selama pembuatan buku besar, fitur ini diaktifkan (`true`) secara default.  
Jika perlindungan penghapusan diaktifkan, Anda harus menonaktifkannya terlebih dahulu sebelum dapat menghapus buku besar. Anda dapat menonaktifkannya dengan memanggil `UpdateLedger` operasi untuk mengatur parameter ini`false`.  
Tipe: Boolean  
Wajib: Tidak

 ** [KmsKey](#API_UpdateLedger_RequestSyntax) **   <a name="qldb-UpdateLedger-request-KmsKey"></a>
Kunci in AWS Key Management Service (AWS KMS) yang akan digunakan untuk enkripsi data saat istirahat di buku besar. Untuk informasi selengkapnya, lihat [Enkripsi saat istirahat](https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html) di Panduan Pengembang *QLDB Amazon*.  
Gunakan salah satu opsi berikut untuk menentukan parameter ini:  
+  `AWS_OWNED_KMS_KEY`: Gunakan AWS KMS kunci yang dimiliki dan dikelola oleh AWS atas nama Anda.
+  **Undefined**: Jangan membuat perubahan pada kunci KMS buku besar.
+  Kunci KMS **terkelola pelanggan simetris yang valid: Gunakan kunci KMS** enkripsi simetris yang ditentukan di akun yang Anda buat, miliki, dan kelola.

  Amazon QLDB tidak mendukung kunci asimetris. Untuk informasi selengkapnya, lihat [Menggunakan kunci simetris dan asimetris](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) di Panduan * AWS Key Management Service Pengembang*.
Untuk menentukan kunci KMS yang dikelola pelanggan, Anda dapat menggunakan ID kunci, Nama Sumber Daya Amazon (ARN), nama alias, atau alias ARN. Saat menggunakan nama alias, awali dengan. `"alias/"` Untuk menentukan kunci yang berbeda Akun AWS, Anda harus menggunakan kunci ARN atau alias ARN.  
Misalnya:  
+ ID Kunci: `1234abcd-12ab-34cd-56ef-1234567890ab` 
+ ARN kunci: `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab` 
+ Nama alias: `alias/ExampleAlias` 
+ Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias` 
Untuk informasi selengkapnya, lihat [Pengidentifikasi kunci (KeyId)](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id) di *Panduan AWS Key Management Service Pengembang*.  
Tipe: String  
Kendala Panjang: Panjang maksimum 1600.  
Wajib: Tidak

## Sintaksis Respons
<a name="API_UpdateLedger_ResponseSyntax"></a>

```
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"
}
```

## Elemen Respons
<a name="API_UpdateLedger_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [Arn](#API_UpdateLedger_ResponseSyntax) **   <a name="qldb-UpdateLedger-response-Arn"></a>
Nama Sumber Daya Amazon (ARN) untuk buku besar.  
Tipe: String  
Batasan Panjang: Panjang minimum 20. Panjang maksimum 1600.

 ** [CreationDateTime](#API_UpdateLedger_ResponseSyntax) **   <a name="qldb-UpdateLedger-response-CreationDateTime"></a>
Tanggal dan waktu, dalam format waktu epoch, saat buku besar dibuat. (Format waktu zaman adalah jumlah detik yang berlalu sejak 12:00:00 1 Januari 1970 UTC.)  
Tipe: Timestamp

 ** [DeletionProtection](#API_UpdateLedger_ResponseSyntax) **   <a name="qldb-UpdateLedger-response-DeletionProtection"></a>
Menentukan apakah buku besar dilindungi dari dihapus oleh setiap pengguna. Jika tidak ditentukan selama pembuatan buku besar, fitur ini diaktifkan (`true`) secara default.  
Jika perlindungan penghapusan diaktifkan, Anda harus menonaktifkannya terlebih dahulu sebelum dapat menghapus buku besar. Anda dapat menonaktifkannya dengan memanggil `UpdateLedger` operasi untuk mengatur parameter ini`false`.  
Jenis: Boolean

 ** [EncryptionDescription](#API_UpdateLedger_ResponseSyntax) **   <a name="qldb-UpdateLedger-response-EncryptionDescription"></a>
Informasi tentang enkripsi data saat istirahat di buku besar. Ini termasuk status saat ini, AWS KMS kunci, dan ketika kunci menjadi tidak dapat diakses (dalam kasus kesalahan).  
Tipe: Objek [LedgerEncryptionDescription](API_LedgerEncryptionDescription.md)

 ** [Name](#API_UpdateLedger_ResponseSyntax) **   <a name="qldb-UpdateLedger-response-Name"></a>
Nama buku besar.  
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 32.  
Pola: `(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$` 

 ** [State](#API_UpdateLedger_ResponseSyntax) **   <a name="qldb-UpdateLedger-response-State"></a>
Status buku besar saat ini.  
Tipe: String  
Nilai yang Valid: `CREATING | ACTIVE | DELETING | DELETED` 

## Kesalahan
<a name="API_UpdateLedger_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** InvalidParameterException **   
Satu atau beberapa parameter dalam permintaan tidak valid.  
Kode Status HTTP: 400

 ** ResourceNotFoundException **   
Sumber daya yang ditentukan tidak ada.  
Kode Status HTTP: 404

## Lihat Juga
<a name="API_UpdateLedger_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah](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 untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/UpdateLedger) 
+  [AWS SDK para 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 untuk 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)