Minta Sintaks Parameter Permintaan URI Isi Permintaan Sintaks Respons Elemen Respons Kesalahan Lihat Juga

DescribeLedger

Mengembalikan informasi tentang buku besar, termasuk statusnya, mode izin, enkripsi pada pengaturan istirahat, dan kapan dibuat.

Minta Sintaks


GET /ledgers/name HTTP/1.1

Parameter Permintaan URI

Permintaan menggunakan parameter URI berikut.

name

Nama buku besar yang ingin Anda gambarkan.

Batasan Panjang: Panjang minimum 1. Panjang maksimum 32.

Pola: (?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$

Wajib: Ya

Isi Permintaan

Permintaan tidak memiliki isi permintaan.

Sintaks Respons


HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "CreationDateTime": number,
   "DeletionProtection": boolean,
   "EncryptionDescription": { 
      "EncryptionStatus": "string",
      "InaccessibleKmsKeyDateTime": number,
      "KmsKeyArn": "string"
   },
   "Name": "string",
   "PermissionsMode": "string",
   "State": "string"
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

Arn

Nama Sumber Daya Amazon (ARN) untuk buku besar.

Jenis: String

Batasan Panjang: Panjang minimum 20. Panjang maksimum 1600.

CreationDateTime

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

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 inifalse.

Jenis: Boolean

EncryptionDescription

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). Jika parameter ini tidak terdefinisi, buku besar menggunakan kunci KMS yang AWS dimiliki untuk enkripsi.

Tipe: Objek LedgerEncryptionDescription

Name