Registri skema - AWS Glue
 —  tipe data  —RegistryIdRegistryListItemMetadataInfoOtherMetadataValueListItemSchemaListItemSchemaVersionListItemMetadataKeyValuePairSchemaVersionErrorItemErrorDetailsSchemaVersionNumberSchemaId —  operasi  —CreateRegistry (create_registry)CreateSchema (create_schema)GetSchema (get_skema)ListSchemaVersions (list_schema_versions)GetSchemaVersion (get_schema_version)GetSchemaVersionsDiff (get_schema_versions_diff)ListRegistries (list_registries)ListSchemas (daftar_skema)RegisterSchemaVersion (register_schema_version)UpdateSchema (update_schema)CheckSchemaVersionValidity (check_schema_version_validity)UpdateRegistry (update_registry)GetSchemaByDefinition (get_schema_by_definition)GetRegistry (get_registry)PutSchemaVersionMetadata (put_schema_version_metadata)QuerySchemaVersionMetadata (query_schema_version_metadata)RemoveSchemaVersionMetadata (hapus_schema_version_metadata)DeleteRegistry (delete_registry)DeleteSchema (delete_schema)DeleteSchemaVersions (delete_schema_versions)

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

Registri skema

API registri Skema menjelaskan tipe data dan API yang terkait dengan bekerja dengan skema di. AWS Glue

Jenis data

RegistryId struktur

Pembungkus struktur yang mungkin berisi nama registri dan Amazon Resource Name (ARN).

Bidang

  • RegistryName — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan Custom string pattern #18.

    Nama registri. Digunakan hanya untuk pencarian. Salah satu dari RegistryArn atau RegistryName harus disediakan.

  • RegistryArn — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 10240 byte, yang cocok dengan Custom string pattern #22.

    Arn dari registri yang akan diperbarui. Salah satu dari RegistryArn atau RegistryName harus disediakan.

RegistryListItem struktur

Struktur yang berisi detail untuk sebuah registri.

Bidang

  • RegistryName — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan Custom string pattern #18.

    Nama registri.

  • RegistryArn — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 10240 byte, yang cocok dengan Custom string pattern #22.

    Amazon Resource Name (ARN) registri.

  • Description — String deskripsi, dengan panjang tidak lebih dari 2048 byte, yang cocok dengan URI address multi-line string pattern.

    Sebuah deskripsi registri.

  • Status – String UTF-8 (nilai yang valid: AVAILABLE | DELETING).

    Status registri.

  • CreatedTime – String UTF-8.

    Registri data telah dibuat.

  • UpdatedTime – String UTF-8.

    Tanggal saat registri diperbarui.

MetadataInfo struktur

Struktur yang berisi informasi metadata untuk sebuah versi skema.

Bidang

  • MetadataValue — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 256 byte, yang cocok dengan Custom string pattern #33.

    Nilai yang sesuai kunci metadata.

  • CreatedTime – String UTF-8.

    Waktu saat entri dibuat.

  • OtherMetadataValueList – Susunan objek OtherMetadataValueListItem.

    Metadata lainnya yang merupakan milik dari kunci metadata yang sama.

OtherMetadataValueListItem struktur

Struktur yang berisi metadata lain untuk sebuah versi skema yang merupakan milik dari kunci metadata yang sama.

Bidang

  • MetadataValue — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 256 byte, yang cocok dengan Custom string pattern #33.

    Nilai yang sesuai kunci metadata untuk metadata lainnya yang merupakan milik dari kunci metadata yang sama.

  • CreatedTime – String UTF-8.

    Waktu saat entri dibuat.

SchemaListItem struktur

Sebuah objek yang berisi detail minimal untuk sebuah skema.

Bidang

  • RegistryName — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan Custom string pattern #18.

    Nama registri tempat skema berada.

  • SchemaName — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan Custom string pattern #18.

    Nama skema.

  • SchemaArn — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 10240 byte, yang cocok dengan Custom string pattern #22.

    Amazon Resource Name (ARN) untuk skema.

  • Description — String deskripsi, dengan panjang tidak lebih dari 2048 byte, yang cocok dengan URI address multi-line string pattern.

    Sebuah deskripsi untuk skema.

  • SchemaStatus – String UTF-8 (nilai yang valid: AVAILABLE | PENDING | DELETING).

    Status skema.

  • CreatedTime – String UTF-8.

    Tanggal dan waktu saat sebuah skema dibuat.

  • UpdatedTime – String UTF-8.

    Tanggal dan waktu saat sebuah skema diperbarui.

SchemaVersionListItem struktur

Sebuah objek yang berisi detail tentang sebuah versi skema.

Bidang

  • SchemaArn — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 10240 byte, yang cocok dengan Custom string pattern #22.

    Amazon Resource Name (ARN) dari skema.

  • SchemaVersionId — String UTF-8, sepanjang tidak kurang dari 36 atau lebih dari 36 byte, yang cocok dengan Custom string pattern #17.

    Pengenal unik dari versi skema.

  • VersionNumber — Nomor (bilangan bulat), tidak kurang dari 1 atau lebih dari 100000.

    Nomor versi dari skema.

  • Status – String UTF-8 (nilai yang valid: AVAILABLE | PENDING | FAILURE | DELETING).

    Status versi skema.

  • CreatedTime – String UTF-8.

    Tanggal dan waktu saat versi skema dibuat.

MetadataKeyValuePair struktur

Sebuah Struktur yang berisi pasangan nilai kunci untuk metadata.

Bidang

  • MetadataKey — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 128 byte, yang cocok dengan Custom string pattern #33.

    Sebuah kunci metadata.

  • MetadataValue — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 256 byte, yang cocok dengan Custom string pattern #33.

    Sebuah nilai yang sesuai kunci metadata.

SchemaVersionErrorItem struktur

Sebuah objek yang berisi detail kesalahan untuk sebuah pada sebuah versi skema.

Bidang

  • VersionNumber — Nomor (bilangan bulat), tidak kurang dari 1 atau lebih dari 100000.

    Nomor versi dari skema.

  • ErrorDetails — Sebuah objek ErrorDetails.

    Detail kesalahan untuk versi skema.

ErrorDetails struktur

Sebuah objek yang berisi detail kesalahan.

Bidang

  • ErrorCode – String UTF-8.

    Kode kesalahan untuk sebuah kesalahan.

  • ErrorMessage – String UTF-8.

    Pesan kesalahan untuk sebuah kesalahan.

SchemaVersionNumber struktur

Sebuah struktur yang berisi informasi skema.

Bidang

  • LatestVersion – Boolean.

    Versi terbaru yang tersedia untuk skema.

  • VersionNumber — Nomor (bilangan bulat), tidak kurang dari 1 atau lebih dari 100000.

    Nomor versi dari skema.

SchemaId struktur

ID unik skema dalam registri AWS Glue skema.

Bidang

  • SchemaArn — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 10240 byte, yang cocok dengan Custom string pattern #22.

    Amazon Resource Name (ARN) dari skema. Salah satu dari SchemaArn atau SchemaName harus disediakan.

  • SchemaName — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan Custom string pattern #18.

    Nama skema. Salah satu dari SchemaArn atau SchemaName harus disediakan.

  • RegistryName — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan Custom string pattern #18.

    Nama registri skema yang berisi skema.

Operasi

CreateRegistry tindakan (Python: create_registry)

Menciptakan sebuah registri baru yang dapat digunakan untuk menyimpan sekumpulan skema.

Permintaan

  • RegistryName — Wajib: String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan Custom string pattern #18.

    Nama registri yang akan dibuat dengan panjang maksimal 255 karakter, dan mungkin hanya berisi huruf, angka, tanda hubung, garis bawah, tanda dolar, atau tanda hash. Tanpa spasi.

  • Description — String deskripsi, dengan panjang tidak lebih dari 2048 byte, yang cocok dengan URI address multi-line string pattern.

    Sebuah deskripsi registri. Jika deskripsi tidak tersedia, maka tidak akan ada nilai default untuk ini.

  • Tags — Sebuah rangkaian peta pasangan nilai kunci, tidak lebih dari 50 pasang.

    Masing-masing kunci adalah sebuah string UTF-8, dengan panjang tidak kurang dari 1 atau lebih dari 128 byte.

    Masing-masing kunci adalah sebuah string UTF-8, dengan panjang tidak lebih dari 256 byte.

    AWS tag yang berisi pasangan nilai kunci dan dapat dicari berdasarkan konsol, baris perintah, atau API.

Respons

  • RegistryArn — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 10240 byte, yang cocok dengan Custom string pattern #22.

    Amazon Resource Name (ARN) dari registri yang baru saja dibuat.

  • RegistryName — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan Custom string pattern #18.

    Nama registri.

  • Description — String deskripsi, dengan panjang tidak lebih dari 2048 byte, yang cocok dengan URI address multi-line string pattern.

    Sebuah deskripsi registri.

  • Tags — Sebuah rangkaian peta pasangan nilai kunci, tidak lebih dari 50 pasang.

    Masing-masing kunci adalah sebuah string UTF-8, dengan panjang tidak kurang dari 1 atau lebih dari 128 byte.

    Masing-masing kunci adalah sebuah string UTF-8, dengan panjang tidak lebih dari 256 byte.

    Tag untuk registri.

Kesalahan

  • InvalidInputException

  • AccessDeniedException

  • AlreadyExistsException

  • ResourceNumberLimitExceededException

  • ConcurrentModificationException

  • InternalServiceException

CreateSchema tindakan (Python: create_schema)

Menciptakan sebuah set skema baru dan mendaftar definisi skema. Mengembalikan kesalahan jika set skema sudah ada tanpa benar-benar mendaftarkan versi.

Ketika set skema dibuat, pos pemeriksaan versi akan diatur ke versi pertama. Mode kompatibilitas "DINONAKTIFKAN" membatasi versi skema tambahan agar tidak ditambahkan setelah versi skema pertama. Untuk semua mode kompatibilitas lainnya, validasi pengaturan kompatibilitas akan diterapkan hanya dari versi kedua dan seterusnya ketika API RegisterSchemaVersion digunakan.

Ketika API ini dipanggil tanpa RegistryId, hal ini akan membuat entri untuk sebuah "default-registry" dalam tabel basis data registri, jika tidak sudah ada.

Permintaan

  • RegistryId — Sebuah objek RegistryId.

    Ini adalah sebuah bentuk pembungkus berisi bidang identitas registri. Jika ini tidak tersedia, maka registri default akan digunakan. Format ARN untuk hal tersebut adalah: arn:aws:glue:us-east-2:<customer id>:registry/default-registry:random-5-letter-id.

  • SchemaName — Wajib: String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan Custom string pattern #18.

    Nama skema yang akan dibuat dengan panjang maksimal 255 karakter, dan mungkin hanya berisi huruf, angka, tanda hubung, garis bawah, tanda dolar, atau tanda hash. Tanpa spasi.

  • DataFormat – Wajib: String UTF-8 (nilai yang valid: AVRO | JSON | PROTOBUF).

    Format data dari definisi skema. Saat iniAVRO, JSON dan PROTOBUF didukung.

  • Compatibility – String UTF-8 (nilai yang valid: NONE | DISABLED | BACKWARD | BACKWARD_ALL | FORWARD | FORWARD_ALL | FULL | FULL_ALL).

    Mode kompatibilitas skema. Nilai yang mungkin adalah:

    • NONE: Tidak ada mode kompatibilitas yang berlaku. Anda dapat menggunakan pilihan ini dalam skenario pengembangan atau jika Anda tidak tahu mode kompatibilitas yang ingin Anda terapkan untuk skema. Setiap versi baru yang ditambahkan akan diterima tanpa menjalani pemeriksaan kompatibilitas terlebih dahulu.

    • DISABLED: Pilihan kompatibilitas ini mencegah versioning untuk skema tertentu. Anda dapat menggunakan pilihan ini untuk mencegah dilakukannya versioning masa depan pada sebuah skema.

    • MUNDUR: Pilihan kompatibilitas ini dianjurkan karena memungkinkan penerima data untuk membaca versi skema saat ini dan versi skema sebelumnya. Ini berarti bahwa misalnya, versi skema baru tidak dapat membuang bidang data atau mengubah jenis bidang ini, sehingga tidak dapat dibaca oleh pembaca menggunakan versi sebelumnya.

    • MUNDUR_SEMUA: Pilihan kompatibilitas ini memungkinkan penerima data untuk membaca versi skema saat ini dan versi skema sebelumnya. Anda dapat menggunakan pilihan ini ketika Anda harus menghapus bidang atau menambahkan bidang opsional, dan memeriksa kompatibilitas terhadap semua versi skema sebelumnya.

    • MAJU: Pilihan kompatibilitas ini memungkinkan penerima data untuk membaca kedua versi skema saat ini dan versi skema berikutnya, tetapi tidak selalu versi yang lebih baru. Anda dapat menggunakan pilihan ini ketika Anda harus menambahkan bidang atau menghapus bidang opsional, tetapi hanya memeriksa kompatibilitas terhadap semua versi skema sebelumnya.

    • MAJU_SEMUA: Pilihan kompatibilitas ini memungkinkan penerima data untuk membaca skema yang ditulis oleh produsen dari setiap skema terdaftar baru. Anda dapat menggunakan pilihan ini ketika Anda harus menambahkan bidang atau menghapus bidang opsional, dan memeriksa kompatibilitas terhadap semua versi skema sebelumnya.

    • PENUH: Pilihan kompatibilitas ini memungkinkan penerima data untuk membaca data yang ditulis oleh produsen menggunakan versi skema sebelumnya atau berikutnya, tetapi tidak harus selalau versi sebelumnya atau versi setelahnya. Anda dapat menggunakan pilihan ini ketika Anda harus menambahkan atau menghapus bidang opsional, tetapi hanya memeriksa kompatibilitas terhadap versi skema sebelumnya.

    • PENUH_SEMUA: Pilihan kompatibilitas ini memungkinkan penerima data untuk membaca data yang ditulis oleh produsen menggunakan semua versi skema sebelumnya. Anda dapat menggunakan pilihan ini ketika Anda harus menambahkan atau menghapus bidang opsional, dan memeriksa kompatibilitas terhadap semua versi skema sebelumnya.

  • Description — String deskripsi, dengan panjang tidak lebih dari 2048 byte, yang cocok dengan URI address multi-line string pattern.

    Sebuah deskripsi opsional dari skema. Jika deskripsi tidak tersedia, maka tidak akan ada nilai default otomatis untuk ini.

  • Tags — Sebuah rangkaian peta pasangan nilai kunci, tidak lebih dari 50 pasang.

    Masing-masing kunci adalah sebuah string UTF-8, dengan panjang tidak kurang dari 1 atau lebih dari 128 byte.

    Masing-masing kunci adalah sebuah string UTF-8, dengan panjang tidak lebih dari 256 byte.

    AWS tag yang berisi pasangan nilai kunci dan dapat dicari berdasarkan konsol, baris perintah, atau API. Jika ditentukan, ikuti AWS tags-on-create polanya.

  • SchemaDefinition — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 170000 byte, yang cocok dengan Custom string pattern #32.

    Definisi skema menggunakan pengaturan DataFormat untuk SchemaName.

Respons

  • RegistryName — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan Custom string pattern #18.

    Nama registri.

  • RegistryArn — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 10240 byte, yang cocok dengan Custom string pattern #22.

    Amazon Resource Name (ARN) registri.

  • SchemaName — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan Custom string pattern #18.

    Nama skema.

  • SchemaArn — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 10240 byte, yang cocok dengan Custom string pattern #22.

    Amazon Resource Name (ARN) dari skema.

  • Description — String deskripsi, dengan panjang tidak lebih dari 2048 byte, yang cocok dengan URI address multi-line string pattern.

    Sebuah deskripsi skema jika ditentukan saat dibuat.

  • DataFormat – String UTF-8 (nilai yang valid: AVRO | JSON | PROTOBUF).

    Format data dari definisi skema. Saat iniAVRO, JSON dan PROTOBUF didukung.

  • Compatibility – String UTF-8 (nilai yang valid: NONE | DISABLED | BACKWARD | BACKWARD_ALL | FORWARD | FORWARD_ALL | FULL | FULL_ALL).

    Mode kompatibilitas skema.

  • SchemaCheckpoint — Nomor (bilangan bulat), tidak kurang dari 1 atau lebih dari 100000.

    Nomor versi pos pemeriksaan (terakhir kali mode kompatibilitas diubah).

  • LatestSchemaVersion — Nomor (bilangan bulat), tidak kurang dari 1 atau lebih dari 100000.

    Versi terbaru dari skema yang dikaitkan dengan definisi skema yang dikembalikan.

  • NextSchemaVersion — Nomor (bilangan bulat), tidak kurang dari 1 atau lebih dari 100000.

    Versi berikutnya dari skema yang dikaitkan dengan definisi skema yang dikembalikan.

  • SchemaStatus – String UTF-8 (nilai yang valid: AVAILABLE | PENDING | DELETING).

    Status skema.

  • Tags — Sebuah rangkaian peta pasangan nilai kunci, tidak lebih dari 50 pasang.

    Masing-masing kunci adalah sebuah string UTF-8, dengan panjang tidak kurang dari 1 atau lebih dari 128 byte.

    Masing-masing kunci adalah sebuah string UTF-8, dengan panjang tidak lebih dari 256 byte.

    Tag untuk skema.

  • SchemaVersionId — String UTF-8, sepanjang tidak kurang dari 36 atau lebih dari 36 byte, yang cocok dengan Custom string pattern #17.

    Pengenal unik dari versi skema yang pertama.

  • SchemaVersionStatus – String UTF-8 (nilai yang valid: AVAILABLE | PENDING | FAILURE | DELETING).

    Status versi skema pertama yang dibuat.

Kesalahan

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • AlreadyExistsException

  • ResourceNumberLimitExceededException

  • ConcurrentModificationException

  • InternalServiceException

GetSchema tindakan (Python: get_schema)

Menjelaskan skema yang ditentukan secara detail.

Permintaan

  • SchemaId — Wajib: Sebuah objek SchemaId.

    Ini adalah sebuah struktur pembungkus berisi bidang identitas skema. Strukturnya berisi:

    • SchemaId$SchemaArn: Nama Sumber Daya Amazon (ARN) dari skema. Baik SchemaArn, atau SchemaName dan RegistryName harus disediakan.

    • SchemaId$SchemaName: Nama skema. Baik SchemaArn, atau SchemaName dan RegistryName harus disediakan.

Respons

  • RegistryName — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan Custom string pattern #18.

    Nama registri.

  • RegistryArn — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 10240 byte, yang cocok dengan Custom string pattern #22.

    Amazon Resource Name (ARN) registri.

  • SchemaName — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan Custom string pattern #18.

    Nama skema.

  • SchemaArn — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 10240 byte, yang cocok dengan Custom string pattern #22.

    Amazon Resource Name (ARN) dari skema.

  • Description — String deskripsi, dengan panjang tidak lebih dari 2048 byte, yang cocok dengan URI address multi-line string pattern.

    Sebuah deskripsi skema jika ditentukan saat dibuat

  • DataFormat – String UTF-8 (nilai yang valid: AVRO | JSON | PROTOBUF).

    Format data dari definisi skema. Saat iniAVRO, JSON dan PROTOBUF didukung.

  • Compatibility – String UTF-8 (nilai yang valid: NONE | DISABLED | BACKWARD | BACKWARD_ALL | FORWARD | FORWARD_ALL | FULL | FULL_ALL).

    Mode kompatibilitas skema.

  • SchemaCheckpoint — Nomor (bilangan bulat), tidak kurang dari 1 atau lebih dari 100000.

    Nomor versi pos pemeriksaan (terakhir kali mode kompatibilitas diubah).

  • LatestSchemaVersion — Nomor (bilangan bulat), tidak kurang dari 1 atau lebih dari 100000.

    Versi terbaru dari skema yang dikaitkan dengan definisi skema yang dikembalikan.

  • NextSchemaVersion — Nomor (bilangan bulat), tidak kurang dari 1 atau lebih dari 100000.

    Versi berikutnya dari skema yang dikaitkan dengan definisi skema yang dikembalikan.

  • SchemaStatus – String UTF-8 (nilai yang valid: AVAILABLE | PENDING | DELETING).

    Status skema.

  • CreatedTime – String UTF-8.

    Tanggal dan waktu saat sebuah skema dibuat.

  • UpdatedTime – String UTF-8.

    Tanggal dan waktu saat sebuah skema diperbarui.

Kesalahan

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

ListSchemaVersions tindakan (Python: list_schema_versions)

Mengembalikan daftar versi skema yang telah Anda buat, dengan informasi yang minimal. Versi skema dengan status Dihapus tidak akan disertakan dalam hasil. Hasil kosong akan dikembalikan jika tidak ada versi skema yang tersedia.

Permintaan

  • SchemaId — Wajib: Sebuah objek SchemaId.

    Ini adalah sebuah struktur pembungkus berisi bidang identitas skema. Strukturnya berisi:

    • SchemaId$SchemaArn: Nama Sumber Daya Amazon (ARN) dari skema. Baik SchemaArn, atau SchemaName dan RegistryName harus disediakan.

    • SchemaId$SchemaName: Nama skema. Baik SchemaArn, atau SchemaName dan RegistryName harus disediakan.

  • MaxResults — Nomor (bilangan bulat), tidak kurang dari 1 atau lebih dari 100.

    Jumlah maksimum hasil yang diperlukan untuk setiap halaman. Jika nilai tidak diberikan, maka diatur ke nilai default 25 per halaman.

  • NextToken – String UTF-8.

    Sebuah token kelanjutan, jika ini adalah panggilan kelanjutan.

Respons

  • Schemas – Susunan objek SchemaVersionListItem.

    Susunan objek SchemaVersionList yang berisi detail dari setiap versi skema.

  • NextToken – String UTF-8.

    Sebuah token kelanjutan untuk pemberian nomor halaman untuk daftar token yang ditampilkan, dikembalikan jika segmen saat ini dari daftar tersebut bukan yang terakhir.

Kesalahan

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

GetSchemaVersion tindakan (Python: get_schema_version)

Mendapatkan skema yang ditentukan oleh ID uniknya yang ditetapkan ketika versi skema dibuat atau didaftarkan. Versi skema dengan status Dihapus tidak akan disertakan dalam hasil.

Permintaan

  • SchemaId — Sebuah objek SchemaId.

    Ini adalah sebuah struktur pembungkus berisi bidang identitas skema. Strukturnya berisi:

    • SchemaId$SchemaArn: Nama Sumber Daya Amazon (ARN) dari skema. Baik SchemaArn, atau SchemaName dan RegistryName harus disediakan.

    • SchemaId$SchemaName: Nama skema. Baik SchemaArn, atau SchemaName dan RegistryName harus disediakan.

  • SchemaVersionId — String UTF-8, sepanjang tidak kurang dari 36 atau lebih dari 36 byte, yang cocok dengan Custom string pattern #17.

    SchemaVersionId dari versi skema. Kolom ini diperlukan untuk mengambil berdasarkan ID skema. Baik ini atau pembungkus SchemaId harus disediakan.

  • SchemaVersionNumber — Sebuah objek SchemaVersionNumber.

    Nomor versi dari skema.

Respons

  • SchemaVersionId — String UTF-8, sepanjang tidak kurang dari 36 atau lebih dari 36 byte, yang cocok dengan Custom string pattern #17.

    SchemaVersionId dari versi skema.

  • SchemaDefinition — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 170000 byte, yang cocok dengan Custom string pattern #32.

    Definisi skema untuk ID skema.

  • DataFormat – String UTF-8 (nilai yang valid: AVRO | JSON | PROTOBUF).

    Format data dari definisi skema. Saat iniAVRO, JSON dan PROTOBUF didukung.

  • SchemaArn — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 10240 byte, yang cocok dengan Custom string pattern #22.

    Amazon Resource Name (ARN) dari skema.

  • VersionNumber — Nomor (bilangan bulat), tidak kurang dari 1 atau lebih dari 100000.

    Nomor versi dari skema.

  • Status – String UTF-8 (nilai yang valid: AVAILABLE | PENDING | FAILURE | DELETING).

    Status versi skema.

  • CreatedTime – String UTF-8.

    Tanggal dan waktu saat versi skema dibuat.

Kesalahan

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

GetSchemaVersionsDiff tindakan (Python: get_schema_versions_diff)

Mengambil perbedaan versi skema dalam jenis perbedaan yang ditentukan antara dua versi skema yang disimpan di Registri Skema.

API ini memungkinkan Anda untuk membandingkan dua versi skema antara dua definisi skema berdasarkan pada skema yang sama.

Permintaan

  • SchemaId — Wajib: Sebuah objek SchemaId.

    Ini adalah sebuah struktur pembungkus berisi bidang identitas skema. Strukturnya berisi:

    • SchemaId$SchemaArn: Nama Sumber Daya Amazon (ARN) dari skema. Salah satu dari SchemaArn atau SchemaName harus disediakan.

    • SchemaId$SchemaName: Nama skema. Salah satu dari SchemaArn atau SchemaName harus disediakan.

  • FirstSchemaVersionNumber — Wajib: Sebuah objek SchemaVersionNumber.

    Versi skema yang pertama dari dua versi skema yang akan dibandingkan.

  • SecondSchemaVersionNumber — Wajib: Sebuah objek SchemaVersionNumber.

    Versi skema yang kedua dari dua versi skema yang akan dibandingkan.

  • SchemaDiffType – Wajib: String UTF-8 (nilai yang valid: SYNTAX_DIFF).

    Mengacu pada SYNTAX_DIFF, yang merupakan tipe perbedaan yang didukung saat ini.

Respons

  • Diff — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 340000 byte, yang cocok dengan Custom string pattern #32.

    Perbedaan antara skema sebagai string dalam JsonPatch format.

Kesalahan

  • InvalidInputException

  • EntityNotFoundException

  • AccessDeniedException

  • InternalServiceException

ListRegistries tindakan (Python: list_registries)

Mengembalikan sebuah daftar registri yang telah Anda buat, dengan informasi registri yang minimal. Registri yang sedang dalam status Deleting tidak akan dimasukkan dalam hasil. Hasil kosong akan dikembalikan jika tidak ada registri yang tersedia.

Permintaan

  • MaxResults — Nomor (bilangan bulat), tidak kurang dari 1 atau lebih dari 100.

    Jumlah maksimum hasil yang diperlukan untuk setiap halaman. Jika nilai tidak diberikan, maka diatur ke nilai default 25 per halaman.

  • NextToken – String UTF-8.

    Sebuah token kelanjutan, jika ini adalah panggilan kelanjutan.

Respons

  • Registries – Susunan objek RegistryListItem.

    Susunan objek RegistryDetailedListItem yang berisi detail minimal dari setiap registri.

  • NextToken – String UTF-8.

    Sebuah token kelanjutan untuk pemberian nomor halaman untuk daftar token yang ditampilkan, dikembalikan jika segmen saat ini dari daftar tersebut bukan yang terakhir.

Kesalahan

  • InvalidInputException

  • AccessDeniedException

  • InternalServiceException

ListSchemas tindakan (Python: list_schemas)

Mengembalikan sebuah daftar skema dengan detail yang minimal. Skema dengan status Menghapus tidak akan disertakan dalam hasil. Hasil kosong akan dikembalikan jika tidak ada skema yang tersedia.

Saat RegistryId tidak disediakan, semua skema di seluruh registri akan menjadi bagian dari respons API.

Permintaan

  • RegistryId — Sebuah objek RegistryId.

    Pembungkus struktur yang mungkin berisi nama registri dan Amazon Resource Name (ARN).

  • MaxResults — Nomor (bilangan bulat), tidak kurang dari 1 atau lebih dari 100.

    Jumlah maksimum hasil yang diperlukan untuk setiap halaman. Jika nilai tidak diberikan, maka diatur ke nilai default 25 per halaman.

  • NextToken – String UTF-8.

    Sebuah token kelanjutan, jika ini adalah panggilan kelanjutan.

Respons

  • Schemas – Susunan objek SchemaListItem.

    Susunan objek SchemaListItem yang berisi detail dari setiap skema.

  • NextToken – String UTF-8.

    Sebuah token kelanjutan untuk pemberian nomor halaman untuk daftar token yang ditampilkan, dikembalikan jika segmen saat ini dari daftar tersebut bukan yang terakhir.

Kesalahan

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

RegisterSchemaVersion tindakan (Python: register_schema_version)

Menambahkan sebuah versi baru untuk skema yang ada. Mengembalikan sebuah kesalahan jika skema versi baru tidak memenuhi persyaratan kompatibilitas set skema. API ini tidak akan membuat set skema baru dan akan mengembalikan kesalahan 404 jika set skema belum ada di Registri Skema.

Jika ini adalah definisi skema pertama yang akan terdaftar di Registri Skema, maka API ini akan menyimpan versi skema dan mengembalikan segera. Jika tidak, panggilan ini memiliki potensi untuk berjalan lebih lama daripada operasi lain karena mode kompatibilitas. Anda dapat memanggil API GetSchemaVersion dengan SchemaVersionId untuk memeriksa mode kompatibilitas.

Jika definisi skema yang sama sudah disimpan dalam Registri Skema sebagai sebuah versi, maka ID skema dari skema yang ada akan dikembalikan ke pemanggil.

Permintaan

  • SchemaId — Wajib: Sebuah objek SchemaId.

    Ini adalah sebuah struktur pembungkus berisi bidang identitas skema. Strukturnya berisi:

    • SchemaId$SchemaArn: Nama Sumber Daya Amazon (ARN) dari skema. Baik SchemaArn, atau SchemaName dan RegistryName harus disediakan.

    • SchemaId$SchemaName: Nama skema. Baik SchemaArn, atau SchemaName dan RegistryName harus disediakan.

  • SchemaDefinition — Wajib: String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 170000 byte, yang cocok dengan Custom string pattern #32.

    Definisi skema menggunakan pengaturan DataFormat untuk SchemaName.

Respons

  • SchemaVersionId — String UTF-8, sepanjang tidak kurang dari 36 atau lebih dari 36 byte, yang cocok dengan Custom string pattern #17.

    ID unik yang mewakili versi skema ini.

  • VersionNumber — Nomor (bilangan bulat), tidak kurang dari 1 atau lebih dari 100000.

    Versi skema ini (untuk aliran sinkronisasi saja, jika ini adalah versi pertama).

  • Status – String UTF-8 (nilai yang valid: AVAILABLE | PENDING | FAILURE | DELETING).

    Status versi skema.

Kesalahan

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • ResourceNumberLimitExceededException

  • ConcurrentModificationException

  • InternalServiceException

UpdateSchema tindakan (Python: update_schema)

Memperbarui deskripsi, pengaturan kompatibilitas, atau versi pos pemeriksaan untuk sebuah set skema.

Untuk memperbarui pengaturan kompatibilitas, panggilan tidak akan memvalidasi kompatibilitas untuk seluruh rangkaian versi skema dengan pengaturan kompatibilitas baru. Jika nilai untuk Compatibility disediakan, maka VersionNumber (pos pemeriksaan) juga diperlukan. API akan memvalidasi konsistensi nomor versi pos pemeriksaan.

Jika nilai untuk VersionNumber (pos pemeriksaan) disediakan, maka Compatibility bersifat opsional dan ini dapat digunakan untuk mengatur/me-reset pos pemeriksaan untuk skema tersebut.

Pembaruan ini akan terjadi hanya jika skema dalam status TERSEDIA.

Permintaan

  • SchemaId — Wajib: Sebuah objek SchemaId.

    Ini adalah sebuah struktur pembungkus berisi bidang identitas skema. Strukturnya berisi:

    • SchemaId$SchemaArn: Nama Sumber Daya Amazon (ARN) dari skema. Salah satu dari SchemaArn atau SchemaName harus disediakan.

    • SchemaId$SchemaName: Nama skema. Salah satu dari SchemaArn atau SchemaName harus disediakan.

  • SchemaVersionNumber — Sebuah objek SchemaVersionNumber.

    Nomor versi yang diperlukan untuk melakukan pemeriksaan. Salah satu dari VersionNumber atau Compatibility harus disediakan.

  • Compatibility – String UTF-8 (nilai yang valid: NONE | DISABLED | BACKWARD | BACKWARD_ALL | FORWARD | FORWARD_ALL | FULL | FULL_ALL).

    Pengaturan kompatibilitas baru untuk skema.

  • Description — String deskripsi, dengan panjang tidak lebih dari 2048 byte, yang cocok dengan URI address multi-line string pattern.

    Deskripsi baru untuk skema.

Respons

  • SchemaArn — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 10240 byte, yang cocok dengan Custom string pattern #22.

    Amazon Resource Name (ARN) dari skema.

  • SchemaName — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan Custom string pattern #18.

    Nama skema.

  • RegistryName — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan Custom string pattern #18.

    Nama registri yang berisi skema.

Kesalahan

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • ConcurrentModificationException

  • InternalServiceException

CheckSchemaVersionValidity tindakan (Python: check_schema_version_validity)

Memvalidasi skema yang disediakan. Panggilan ini tidak memiliki efek samping, ia hanya memvalidasi dengan menggunakan skema yang disediakan dengan menggunakan DataFormat sebagai formatnya. Karena tidak mengambil nama set skema, maka tidak ada pemeriksaan kompatibilitas yang dilakukan.

Permintaan

  • DataFormat – Wajib: String UTF-8 (nilai yang valid: AVRO | JSON | PROTOBUF).

    Format data dari definisi skema. Saat iniAVRO, JSON dan PROTOBUF didukung.

  • SchemaDefinition — Wajib: String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 170000 byte, yang cocok dengan Custom string pattern #32.

    Definisi skema yang harus divalidasi.

Respons

  • Valid – Boolean.

    Mengembalikan BETUL, jika skema ini valid, dan mengembalikan SALAH, jika skema tidak valid.

  • Error — String UTF-8, dengan panjang tidak kurang dari 1 atau lebih dari 5000 byte.

    Pesan kesalahan kegagalan validasi.

Kesalahan

  • InvalidInputException

  • AccessDeniedException

  • InternalServiceException

UpdateRegistry tindakan (Python: update_registry)

Memperbarui registri yang ada yang digunakan untuk menyimpan koleksi skema. Properti yang diperbarui berhubungan dengan registri, dan tidak mengubah salah satu skema dalam registri tersebut.

Permintaan

  • RegistryId — Wajib: Sebuah objek RegistryId.

    Ini adalah sebuah struktur pembungkus yang mungkin berisi nama registri dan Amazon Resource Name (ARN).

  • Description — Wajib: String deskripsi, dengan panjang tidak lebih dari 2048 byte, yang cocok dengan URI address multi-line string pattern.

    Sebuah deskripsi registri. Jika deskripsi tidak tersedia, maka bidang ini tidak akan diperbarui.

Respons

  • RegistryName — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan Custom string pattern #18.

    Nama registri yang diperbarui.

  • RegistryArn — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 10240 byte, yang cocok dengan Custom string pattern #22.

    Amazon Resource Name (ARN) dari registri yang diperbarui.

Kesalahan

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • ConcurrentModificationException

  • InternalServiceException

GetSchemaByDefinition tindakan (Python: get_schema_by_definition)

Mengambil sebuah skema berdasarkan SchemaDefinition. Definisi skema dikirim ke Registri Skema, di-kanonikalisasi, dan di-hash. Jika hash cocok dalam lingkup SchemaName atau ARN (atau registri default, jika tidak disediakan), maka metadata dari skema tersebut dikembalikan. Jika tidak, 404 atau NotFound kesalahan dikembalikan. Versi skema dengan status Deleted tidak akan disertakan dalam hasil.

Permintaan

  • SchemaId — Wajib: Sebuah objek SchemaId.

    Ini adalah sebuah struktur pembungkus berisi bidang identitas skema. Strukturnya berisi:

    • SchemaId$SchemaArn: Nama Sumber Daya Amazon (ARN) dari skema. Salah satu dari SchemaArn atau SchemaName harus disediakan.

    • SchemaId$SchemaName: Nama skema. Salah satu dari SchemaArn atau SchemaName harus disediakan.

  • SchemaDefinition — Wajib: String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 170000 byte, yang cocok dengan Custom string pattern #32.

    Definisi skema yang diwajibkan detail skema untuknya.

Respons

  • SchemaVersionId — String UTF-8, sepanjang tidak kurang dari 36 atau lebih dari 36 byte, yang cocok dengan Custom string pattern #17.

    ID skema dari versi skema.

  • SchemaArn — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 10240 byte, yang cocok dengan Custom string pattern #22.

    Amazon Resource Name (ARN) dari skema.

  • DataFormat – String UTF-8 (nilai yang valid: AVRO | JSON | PROTOBUF).

    Format data dari definisi skema. Saat iniAVRO, JSON dan PROTOBUF didukung.

  • Status – String UTF-8 (nilai yang valid: AVAILABLE | PENDING | FAILURE | DELETING).

    Status versi skema.

  • CreatedTime – String UTF-8.

    Tanggal dan waktu saat sebuah skema dibuat.

Kesalahan

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

GetRegistry tindakan (Python: get_registry)

Menjelaskan registri yang ditentukan secara detail.

Permintaan

  • RegistryId — Wajib: Sebuah objek RegistryId.

    Ini adalah sebuah struktur pembungkus yang mungkin berisi nama registri dan Amazon Resource Name (ARN).

Respons

  • RegistryName — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan Custom string pattern #18.

    Nama registri.

  • RegistryArn — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 10240 byte, yang cocok dengan Custom string pattern #22.

    Amazon Resource Name (ARN) registri.

  • Description — String deskripsi, dengan panjang tidak lebih dari 2048 byte, yang cocok dengan URI address multi-line string pattern.

    Sebuah deskripsi registri.

  • Status – String UTF-8 (nilai yang valid: AVAILABLE | DELETING).

    Status registri.

  • CreatedTime – String UTF-8.

    Tanggal dan waktu saat registri dibuat.

  • UpdatedTime – String UTF-8.

    Tanggal dan waktu saat registri diperbarui.

Kesalahan

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

PutSchemaVersionMetadata tindakan (Python: put_schema_version_metadata)

Menempatkan pasangan nilai kunci metadata untuk ID versi skema yang ditentukan. Maksimal 10 pasangan nilai kunci akan diizinkan untuk setiap versi skema. Mereka dapat ditambahkan lebih dari satu atau beberapa panggilan.

Permintaan

  • SchemaId — Sebuah objek SchemaId.

    ID unik untuk skema.

  • SchemaVersionNumber — Sebuah objek SchemaVersionNumber.

    Nomor versi dari skema.

  • SchemaVersionId — String UTF-8, sepanjang tidak kurang dari 36 atau lebih dari 36 byte, yang cocok dengan Custom string pattern #17.

    ID versi unik dari versi skema.

  • MetadataKeyValue — Wajib: Sebuah objek MetadataKeyValuePair.

    Nilai yang sesuai kunci metadata.

Respons

  • SchemaArn — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 10240 byte, yang cocok dengan Custom string pattern #22.

    Amazon Resource Name (ARN) untuk skema.

  • SchemaName — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan Custom string pattern #18.

    Nama untuk skema.

  • RegistryName — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan Custom string pattern #18.

    Nama untuk registri.

  • LatestVersion – Boolean.

    Skema versi terbaru.

  • VersionNumber — Nomor (bilangan bulat), tidak kurang dari 1 atau lebih dari 100000.

    Nomor versi dari skema.

  • SchemaVersionId — String UTF-8, sepanjang tidak kurang dari 36 atau lebih dari 36 byte, yang cocok dengan Custom string pattern #17.

    ID versi unik dari versi skema.

  • MetadataKey — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 128 byte, yang cocok dengan Custom string pattern #33.

    Kunci metadata.

  • MetadataValue — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 256 byte, yang cocok dengan Custom string pattern #33.

    Nilai dari kunci metadata.

Kesalahan

  • InvalidInputException

  • AccessDeniedException

  • AlreadyExistsException

  • EntityNotFoundException

  • ResourceNumberLimitExceededException

QuerySchemaVersionMetadata tindakan (Python: query_schema_version_metadata)

Kueri untuk informasi metadata versi skema.

Permintaan

  • SchemaId — Sebuah objek SchemaId.

    Sebuah struktur pembungkus yang mungkin berisi nama skema dan Amazon Resource Name (ARN).

  • SchemaVersionNumber — Sebuah objek SchemaVersionNumber.

    Nomor versi dari skema.

  • SchemaVersionId — String UTF-8, sepanjang tidak kurang dari 36 atau lebih dari 36 byte, yang cocok dengan Custom string pattern #17.

    ID versi unik dari versi skema.

  • MetadataList – Susunan objek MetadataKeyValuePair.

    Mencari pasangan nilai kunci untuk metadata, jika mereka tidak disediakan, maka semua informasi metadata akan diambil.

  • MaxResults — Nomor (bilangan bulat), tidak kurang dari 1 atau lebih dari 50.

    Jumlah maksimum hasil yang diperlukan untuk setiap halaman. Jika nilai tidak diberikan, maka diatur ke nilai default 25 per halaman.

  • NextToken – String UTF-8.

    Sebuah token kelanjutan, jika ini adalah panggilan kelanjutan.

Respons

  • MetadataInfoMap – Susunan peta pasangan nilai kunci.

    Masing-masing kunci adalah sebuah string UTF-8, dengan panjang tidak kurang dari 1 atau lebih dari 128 byte, yang cocok dengan Custom string pattern #33.

    Setiap nilai adalah sebuah objek MetadataInfo A.

    Sebuah peta kunci metadata dan nilai-nilai yang dikaitkan.

  • SchemaVersionId — String UTF-8, sepanjang tidak kurang dari 36 atau lebih dari 36 byte, yang cocok dengan Custom string pattern #17.

    ID versi unik dari versi skema.

  • NextToken – String UTF-8.

    Sebuah token kelanjutan untuk pemberian nomor halaman untuk daftar token yang ditampilkan, dikembalikan jika segmen saat ini dari daftar tersebut bukan yang terakhir.

Kesalahan

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

RemoveSchemaVersionMetadata tindakan (Python: remove_schema_version_metadata)

Menghapus sebuah pasangan nilai kunci dari metadata versi skema untuk ID versi skema yang ditentukan.

Permintaan

  • SchemaId — Sebuah objek SchemaId.

    Sebuah struktur pembungkus yang mungkin berisi nama skema dan Amazon Resource Name (ARN).

  • SchemaVersionNumber — Sebuah objek SchemaVersionNumber.

    Nomor versi dari skema.

  • SchemaVersionId — String UTF-8, sepanjang tidak kurang dari 36 atau lebih dari 36 byte, yang cocok dengan Custom string pattern #17.

    ID versi unik dari versi skema.

  • MetadataKeyValue — Wajib: Sebuah objek MetadataKeyValuePair.

    Nilai dari kunci metadata.

Respons

  • SchemaArn — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 10240 byte, yang cocok dengan Custom string pattern #22.

    Amazon Resource Name (ARN) dari skema.

  • SchemaName — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan Custom string pattern #18.

    Nama skema.

  • RegistryName — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan Custom string pattern #18.

    Nama registri.

  • LatestVersion – Boolean.

    Skema versi terbaru.

  • VersionNumber — Nomor (bilangan bulat), tidak kurang dari 1 atau lebih dari 100000.

    Nomor versi dari skema.

  • SchemaVersionId — String UTF-8, sepanjang tidak kurang dari 36 atau lebih dari 36 byte, yang cocok dengan Custom string pattern #17.

    ID versi untuk versi skema.

  • MetadataKey — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 128 byte, yang cocok dengan Custom string pattern #33.

    Kunci metadata.

  • MetadataValue — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 256 byte, yang cocok dengan Custom string pattern #33.

    Nilai dari kunci metadata.

Kesalahan

  • InvalidInputException

  • AccessDeniedException

  • EntityNotFoundException

DeleteRegistry tindakan (Python: delete_registry)

Menghapus registri secara keseluruhan termasuk skema dan semua versinya. Untuk mendapatkan status operasi hapus, Anda dapat memanggil API GetRegistry setelah panggilan asinkron. Menghapus registri akan menonaktifkan semua operasi online untuk registri seperti API UpdateRegistry, CreateSchema, UpdateSchema, dan RegisterSchemaVersion.

Permintaan

  • RegistryId — Wajib: Sebuah objek RegistryId.

    Ini adalah sebuah struktur pembungkus yang mungkin berisi nama registri dan Amazon Resource Name (ARN).

Respons

  • RegistryName — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan Custom string pattern #18.

    Nama registri yang sedang dihapus.

  • RegistryArn — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 10240 byte, yang cocok dengan Custom string pattern #22.

    Amazon Resource Name (ARN) dari registri yang sedang dihapus.

  • Status – String UTF-8 (nilai yang valid: AVAILABLE | DELETING).

    Status registri. Sebuah operasi yang sukses akan mengembalikan status Deleting.

Kesalahan

  • InvalidInputException

  • EntityNotFoundException

  • AccessDeniedException

  • ConcurrentModificationException

DeleteSchema tindakan (Python: delete_schema)

Menghapus seluruh set skema, termasuk set skema dan semua versinya. Untuk mendapatkan status operasi hapus, Anda dapat memanggil API GetSchema setelah panggilan asinkron. Menghapus sebuah registri akan menonaktifkan semua operasi online untuk skema, seperti API GetSchemaByDefinition, dan RegisterSchemaVersion.

Permintaan

  • SchemaId — Wajib: Sebuah objek SchemaId.

    Ini adalah sebuah struktur pembungkus yang mungkin berisi nama skema dan Amazon Resource Name (ARN).

Respons

  • SchemaArn — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 10240 byte, yang cocok dengan Custom string pattern #22.

    Amazon Resource Name (ARN) dari skema yang sedang dihapus.

  • SchemaName — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan Custom string pattern #18.

    Nama dari skema yang sedang dihapus.

  • Status – String UTF-8 (nilai yang valid: AVAILABLE | PENDING | DELETING).

    Status skema.

Kesalahan

  • InvalidInputException

  • EntityNotFoundException

  • AccessDeniedException

  • ConcurrentModificationException

DeleteSchemaVersions tindakan (Python: delete_schema_versions)

Menghapus versi skema yang ditentukan. Nomor versi atau rentang versi mungkin disediakan. Jika modus kompatibilitas melarang menghapus sebuah versi yang diperlukan, seperti BACKWARDS_FULL, maka kesalahan akan dikembalikan. Memanggil API GetSchemaVersions setelah panggilan ini akan mencantumkan status versi yang dihapus.

Ketika rentang nomor versi berisi versi yang diperiksa, maka API akan mengembalikan konflik 409 dan tidak akan melanjutkan dengan penghapusan. Anda harus menghapus pos pemeriksaan terlebih dahulu menggunakan API DeleteSchemaCheckpoint sebelum menggunakan API ini.

Anda tidak dapat menggunakan API DeleteSchemaVersions untuk menghapus versi skema pertama dalam set skema tersebut. Versi skema pertama hanya dapat dihapus oleh API DeleteSchema. Operasi ini juga akan menghapus SchemaVersionMetadata yang dilampirkan pada versi skema. Hapus paksa akan diberlakukan pada basis data.

Jika modus kompatibilitas melarang menghapus sebuah versi yang diperlukan, seperti BACKWARDS_FULL, maka kesalahan akan dikembalikan.

Permintaan

  • SchemaId — Wajib: Sebuah objek SchemaId.

    Ini adalah sebuah struktur pembungkus yang mungkin berisi nama skema dan Amazon Resource Name (ARN).

  • Versions — Wajib: String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 100000 byte, yang cocok dengan Custom string pattern #34.

    Rentang versi dapat diberikan, mungkin dalam format:

    • nomor versi tunggal, 5

    • rentang, 5-8: menghapus versi 5, 6, 7, 8

Respons

  • SchemaVersionErrors – Susunan objek SchemaVersionErrorItem.

    Sebuah daftar objek SchemaVersionErrorItem, masing-masing berisi kesalahan dan versi skema.

Kesalahan

  • InvalidInputException

  • EntityNotFoundException

  • AccessDeniedException

  • ConcurrentModificationException