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

ExportJournalToS3

Mengekspor konten jurnal dalam rentang tanggal dan waktu dari buku besar ke bucket Amazon Simple Storage Service (Amazon S3) tertentu. Pekerjaan ekspor jurnal dapat menulis objek data baik dalam teks atau representasi biner format Amazon Ion, atau dalam format teks JSON Lines.

Jika buku besar dengan yang diberikan Name tidak ada, maka lemparResourceNotFoundException.

Jika buku besar dengan yang Name diberikan dalam CREATING status, maka lemparResourcePreconditionNotMetException.

Anda dapat memulai hingga dua permintaan ekspor jurnal bersamaan untuk setiap buku besar. Di luar batas ini, permintaan ekspor jurnal melemparLimitExceededException.

Minta Sintaks

POST /ledgers/name/journal-s3-exports HTTP/1.1
Content-type: application/json

{
   "ExclusiveEndTime": number,
   "InclusiveStartTime": number,
   "OutputFormat": "string",
   "RoleArn": "string",
   "S3ExportConfiguration": { 
      "Bucket": "string",
      "EncryptionConfiguration": { 
         "KmsKeyArn": "string",
         "ObjectEncryptionType": "string"
      },
      "Prefix": "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 akhir eksklusif untuk berbagai konten jurnal untuk diekspor.

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

ExclusiveEndTimeHarus kurang dari atau sama dengan tanggal dan waktu UTC saat ini.

Tipe: Timestamp

Wajib: Ya

InclusiveStartTime

Tanggal dan waktu mulai inklusif untuk berbagai konten jurnal untuk diekspor.

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

InclusiveStartTimeHarus sebelumnyaExclusiveEndTime.

Jika Anda memberikan InclusiveStartTime yang sebelum buku besarCreationDateTime, Amazon QLDB mendefaultkannya ke buku besar. CreationDateTime

Tipe: Timestamp

Wajib: Ya

OutputFormat

Format output dari data jurnal yang diekspor. Pekerjaan ekspor jurnal dapat menulis objek data baik dalam teks atau representasi biner format Amazon Ion, atau dalam format teks JSON Lines.

Default: ION_TEXT

Dalam format JSON Lines, setiap blok jurnal dalam objek data yang diekspor adalah objek JSON yang valid yang dibatasi oleh baris baru. Anda dapat menggunakan format ini untuk mengintegrasikan ekspor JSON secara langsung dengan alat analitik seperti Amazon Athena AWS Glue dan karena layanan ini dapat mengurai JSON yang dibatasi baris baru secara otomatis.

Jenis: String

Nilai yang Valid: ION_BINARY | ION_TEXT | JSON

Wajib: Tidak

RoleArn

Nama Sumber Daya Amazon (ARN) dari peran IAM yang memberikan izin QLDB untuk pekerjaan ekspor jurnal untuk melakukan hal berikut:

  • Tulis objek ke dalam ember Amazon S3 Anda.

  • (Opsional) Gunakan kunci terkelola pelanggan Anda di AWS Key Management Service (AWS KMS) untuk enkripsi sisi server dari data yang Anda ekspor.

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

Jenis: String

Batasan Panjang: Panjang minimum 20. Panjang maksimum 1600.

Wajib: Ya

S3ExportConfiguration

Pengaturan konfigurasi tujuan bucket Amazon S3 untuk permintaan ekspor Anda.

Tipe: Objek S3ExportConfiguration

Wajib: Ya

Sintaksis Respons

HTTP/1.1 200
Content-type: application/json

{
   "ExportId": "string"
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

ExportId

UUID (diwakili dalam teks yang disandikan Base62) yang diberikan QLDB untuk setiap pekerjaan ekspor jurnal.

Untuk menjelaskan permintaan ekspor Anda dan memeriksa status pekerjaan, Anda dapat menggunakan ExportId untuk meneleponDescribeJournalS3Export.

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.

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: