StreamJournalToKinesis - Database Buku Besar Amazon Quantum (AmazonQLDB)
Minta SintaksParameter Permintaan URIIsi PermintaanSintaksis ResponsElemen ResponsKesalahanLihat Juga

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

StreamJournalToKinesis

Membuat aliran jurnal untuk buku besar Amazon QLDB tertentu. Pengaliran menangkap setiap revisi dokumen yang dilakukan ke jurnal buku besar dan mengirimkan data ke sumber daya Amazon Kinesis Data Streams yang ditentukan.

Minta Sintaks

POST /ledgers/name/journal-kinesis-streams HTTP/1.1
Content-type: application/json

{
   "ExclusiveEndTime": number,
   "InclusiveStartTime": number,
   "KinesisConfiguration": { 
      "AggregationEnabled": boolean,
      "StreamArn": "string"
   },
   "RoleArn": "string",
   "StreamName": "string",
   "Tags": { 
      "string" : "string" 
   }
}

Parameter Permintaan URI

Permintaan menggunakan parameter URI berikut.

name

Nama buku besar.

Batasan Panjang: Panjang minimum 1. Panjang maksimum 32.

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

Wajib: Ya

Isi Permintaan

Permintaan menerima data berikut dalam format JSON.

ExclusiveEndTime

Tanggal dan waktu eksklusif yang menentukan kapan pengaliran berakhir. Jika Anda tidak menentukan parameter ini, pengaliran berjalan tanpa batas waktu hingga Anda membatalkannya.

ExclusiveEndTime harus berada dalam format tanggal dan waktu ISO 8601 dan dalam Waktu Terkoordinasi Universal (UTC). Misalnya: 2019-06-13T21:36:34Z.

Tipe: Timestamp

Wajib: Tidak

InclusiveStartTime

Tanggal dan waktu mulai inklusif untuk memulai data jurnal streaming. Parameter ini harus berada dalam format tanggal dan waktu ISO 8601 dan dalam Waktu Terkoordinasi Universal (UTC). Misalnya: 2019-06-13T21:36:34Z.

InclusiveStartTime tidak bisa untuk masa depan dan harus sebelum ExclusiveEndTime.

Jika Anda menyediakan InclusiveStartTime yang ada sebelum CreationDateTime buku besar, QLDB secara efektif men-default ke CreationDateTime buku besar.

Tipe: Timestamp

Wajib: Ya

KinesisConfiguration

Pengaturan konfigurasi tujuan Kinesis Data Streams untuk permintaan pengaliran Anda.

Tipe: Objek KinesisConfiguration

Wajib: Ya

RoleArn

Amazon Resource Name (ARN) dari IAM role yang memberikan QLDB izin untuk pengaliran jurnal untuk menulis catatan data ke sumber daya Kinesis Data Streams.

Untuk meneruskan peran ke QLDB saat meminta aliran jurnal, Anda harus memiliki izin untuk melakukan iam:PassRole tindakan pada sumber daya peran IAM. Ini diperlukan untuk semua permintaan aliran jurnal.

Jenis: String

Batasan Panjang: Panjang minimum 20. Panjang maksimum 1600.

Wajib: Ya

StreamName

Nama yang ingin Anda tetapkan ke pengaliran jurnal QLDB. Nama yang ditentukan pengguna dapat membantu mengidentifikasi dan menunjukkan tujuan pengaliran.

Nama pengaliran Anda harus unik di antara pengaliran aktif lainnya untuk buku besar yang ditentukan. Nama pengaliran memiliki batasan penamaan yang sama dengan nama buku besar, sebagaimana ditentukan di Kuota di Amazon QLDB di Panduan Developer Amazon QLDB.

Jenis: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 32.

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

Wajib: Ya

Tags

Pasangan kunci-nilai untuk ditambahkan sebagai tag ke aliran yang ingin Anda buat. Kunci tag peka huruf besar dan kecil. Nilai tag peka huruf besar/kecil dan bisa null.

Tipe: Peta string ke string

Entri Peta: Jumlah minimum 0 item. Jumlah maksimum 200 item.

Batasan Panjang Kunci: Panjang minimum 1. Panjang maksimum 128.

Batasan Panjang Nilai: Panjang minimum 0. Panjang maksimum 256.

Wajib: Tidak

Sintaksis Respons

HTTP/1.1 200
Content-type: application/json

{
   "StreamId": "string"
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

StreamId

UUID (diwakili dalam teks yang disandikan Base62) yang diberikan QLDB ke setiap aliran jurnal QLDB.

Jenis: String

Kendala Panjang: Panjang tetap 22.

Pola: ^[A-Za-z-0-9]+$

Kesalahan

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat Kesalahan Umum.

InvalidParameterException

Satu atau beberapa parameter dalam permintaan tidak valid.

Kode Status HTTP: 400

ResourceNotFoundException

Sumber daya yang ditentukan tidak ada.

Kode Status HTTP: 404

ResourcePreconditionNotMetException

Operasi gagal karena kondisi tidak terpenuhi sebelumnya.

Kode Status HTTP: 412

Lihat Juga

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu AWS SDK khusus bahasa, lihat berikut ini: