API Neptune Lainnya - Amazon Neptune

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

API Neptune Lainnya

Tindakan:

Struktur:

AddTagsToResource (tindakan)

        Nama AWS CLI untuk API ini adalah:. add-tags-to-resource

Menambahkan tag metadata ke sumber daya Amazon Neptune. Tag ini juga dapat digunakan dengan alokasi biaya pelaporan untuk melacak biaya yang terkait dengan sumber daya Amazon Neptune, atau digunakan dalam pernyataan Kondisi dalam kebijakan IAM untuk Amazon Neptune.

Permintaan

  • ResourceName(dalam CLI:--resource-name) - Diperlukan: String, tipe: string (string yang dikodekan UTF-8).

    Sumber daya Amazon Neptune tempat tag ditambahkan. Nilai ini adalah sebuah Amazon Resource Name (ARN). Untuk informasi tentang membuat ARN, lihat Membangun Amazon Resource Name (ARN).

  • Tags(dalam CLI:--tags) - Diperlukan: Sebuah array objek. Tanda

    Tag yang akan ditetapkan ke sumber daya Amazon Neptune.

Response
  • Tidak ada parameter Respons.

ListTagsForResource (tindakan)

        Nama AWS CLI untuk API ini adalah:. list-tags-for-resource

Mencantumkan semua tanda pada sumber daya Amazon Neptune.

Permintaan

  • Filters(dalam CLI:--filters) — Sebuah array objek. Filter

    Parameter ini saat ini tidak didukung.

  • ResourceName(dalam CLI:--resource-name) - Diperlukan: String, tipe: string (string yang dikodekan UTF-8).

    Sumber daya Amazon Neptune dengan tag untuk dicantumkan. Nilai ini adalah sebuah Amazon Resource Name (ARN). Untuk informasi tentang membuat ARN, lihat Membangun Amazon Resource Name (ARN).

Respon

  • TagList – Susunan objek Tanda.

    Daftar tag yang dikembalikan oleh ListTagsForResource operasi.

RemoveTagsFromResource (tindakan)

        Nama AWS CLI untuk API ini adalah:. remove-tags-from-resource

Menghapus tanda metadata dari sumber daya Amazon Neptune.

Permintaan

  • ResourceName(dalam CLI:--resource-name) - Diperlukan: String, tipe: string (string yang dikodekan UTF-8).

    Sumber daya Amazon Neptune tempat tag dihapus. Nilai ini adalah sebuah Amazon Resource Name (ARN). Untuk informasi tentang membuat ARN, lihat Membangun Amazon Resource Name (ARN).

  • TagKeys(dalam CLI:--tag-keys) - Diperlukan: String, tipe: string (string yang dikodekan UTF-8).

    Kunci tag (nama) dari tag yang akan dihapus.

Response
  • Tidak ada parameter Respons.

ApplyPendingMaintenanceAction (tindakan)

        Nama AWS CLI untuk API ini adalah:. apply-pending-maintenance-action

Menerapkan tindakan pemeliharaan tertunda ke sumber daya (misalnya, ke instans DB).

Permintaan

  • ApplyAction(dalam CLI:--apply-action) - Diperlukan: String, tipe: string (string yang dikodekan UTF-8).

    Tindakan pemeliharaan tertunda untuk diterapkan ke sumber daya ini.

    Nilai valid: system-update, db-upgrade

  • OptInType(dalam CLI:--opt-in-type) - Diperlukan: String, tipe: string (string yang dikodekan UTF-8).

    Nilai yang menentukan jenis permintaan opt-in atau membatalkan permintaan opt-in. Permintaan opt-in dari jenis immediate tidak dapat dibatalkan.

    Nilai yang valid:

    • immediate - Terapkan tindakan pemeliharaan segera.

    • next-maintenance - Terapkan tindakan pemeliharaan selama jendela pemeliharaan berikutnya untuk sumber daya.

    • undo-opt-in - Batalkan permintaan opt-in next-maintenance apa pun yang ada.

  • ResourceIdentifier(dalam CLI:--resource-identifier) - Diperlukan: String, tipe: string (string yang dikodekan UTF-8).

    Amazon Resource Name (ARN) dari sumber daya tempat tindakan pemeliharaan tertunda diterapkan. Untuk informasi tentang membuat ARN, lihat Membangun Amazon Resource Name (ARN).

Respon

Menjelaskan tindakan pemeliharaan tertunda untuk sumber daya.

  • PendingMaintenanceActionDetails – Susunan objek PendingMaintenanceAction.

    Daftar yang menyediakan detail tentang tindakan pemeliharaan yang tertunda untuk sumber daya.

  • ResourceIdentifier— String, tipe: string (string yang dikodekan UTF-8).

    ARN dari sumber daya yang memiliki tindakan pemeliharaan tertunda.

DescribePendingMaintenanceActions (tindakan)

        Nama AWS CLI untuk API ini adalah:. describe-pending-maintenance-actions

Mengembalikan daftar sumber daya (misalnya, instans DB) yang memiliki setidaknya satu tindakan pemeliharaan tertunda.

Permintaan

  • Filters(dalam CLI:--filters) — Sebuah array objek. Filter

    Filter yang menentukan satu sumber daya atau lebih untuk mengembalikan tindakan pemeliharaan tertunda.

    Filter yang didukung:

    • db-cluster-id - Menerima pengidentifikasi klaster DB dan Amazon Resource Name (ARN) klaster DB. Daftar hasil mencakup hanya tindakan pemeliharaan yang tertunda untuk klaster DB yang diidentifikasi oleh ARN ini.

    • db-instance-id - Menerima pengidentifikasi instans DB dan ARN instans DB. Daftar hasil mencakup hanya tindakan pemeliharaan yang tertunda untuk instans DB yang diidentifikasi oleh ARN ini.

  • Marker(dalam CLI:--marker) — String, tipe: string (string yang dikodekan UTF-8).

    Token pagination opsional yang disediakan oleh permintaan DescribePendingMaintenanceActions sebelumnya. Jika parameter ini ditentukan, respons hanya menyertakan catatan di luar penanda, hingga jumlah catatn ditentukan oleh MaxRecords.

  • MaxRecords(dalam CLI:--max-records) — sebuah IntegerOptional, dari tipe: integer (integer 32-bit yang ditandatangani).

    Jumlah maksimum catatan yang akan dikembalikan dalam respons. Jika lebih banyak catatan ada daripada nilai MaxRecords yang ditentukan, token pagination (pemberian nomor halaman) yang disebut penanda disertakan dalam respons sehingga hasil yang tersisa dapat diambil.

    Default: 100

    Kendala: Minimal 20, maksimum 100.

  • ResourceIdentifier(dalam CLI:--resource-identifier) — String, tipe: string (string yang dikodekan UTF-8).

    ARN dari sumber daya untuk mengembalikan tindakan pemeliharaan yang tertunda.

Respon

  • Marker— String, tipe: string (string yang dikodekan UTF-8).

    Token pagination opsional yang disediakan oleh permintaan DescribePendingMaintenanceActions sebelumnya. Jika parameter ini ditentukan, respons hanya menyertakan catatan di luar penanda, hingga jumlah catatn ditentukan oleh MaxRecords.

  • PendingMaintenanceActions – Susunan objek ResourcePendingMaintenanceActions.

    Daftar tindakan pemeliharaan yang tertunda untuk sumber daya.

DescribedB EngineVersions (tindakan)

        Nama AWS CLI untuk API ini adalah:. describe-db-engine-versions

Mengembalikan daftar dari mesin DB yang tersedia.

Permintaan

  • DBParameterGroupFamily(dalam CLI:--db-parameter-group-family) — String, tipe: string (string yang dikodekan UTF-8).

    Nama keluarga grup parameter DB tertentu yang dikembalikan detailnya.

    Batasan:

    • Jika disediakan, harus cocok dengan DB yang adaParameterGroupFamily.

  • DefaultOnly(dalam CLI:--default-only) — Boolean, dari tipe: boolean (nilai Boolean (benar atau salah)).

    Menunjukkan bahwa hanya versi default dari mesin tertentu atau mesin dan kombinasi versi utama dikembalikan.

  • Engine(dalam CLI:--engine) — String, tipe: string (string yang dikodekan UTF-8).

    Mesin basis data untuk mengembalikan.

  • EngineVersion(dalam CLI:--engine-version) — String, tipe: string (string yang dikodekan UTF-8).

    Versi mesin basis data untuk mengembalikan.

    Contoh: 5.1.49

  • Filters(dalam CLI:--filters) — Sebuah array objek. Filter

    Saat ini tidak didukung.

  • ListSupportedCharacterSets(dalam CLI:--list-supported-character-sets) — a BooleanOptional, dari tipe: boolean (nilai Boolean (benar atau salah)).

    Jika parameter ini ditentukan dan mesin yang diminta mendukung parameter CharacterSetName untuk CreateDBInstance, responsnya mencakup daftar set karakter yang didukung untuk setiap versi mesin.

  • ListSupportedTimezones(dalam CLI:--list-supported-timezones) — a BooleanOptional, dari tipe: boolean (nilai Boolean (benar atau salah)).

    Jika parameter ini ditentukan dan mesin yang diminta mendukung parameter TimeZone untuk CreateDBInstance, responsnya mencakup daftar zona waktu yang didukung untuk setiap versi mesin.

  • Marker(dalam CLI:--marker) — String, tipe: string (string yang dikodekan UTF-8).

    Token pagination opsional yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respon hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan MaxRecords.

  • MaxRecords(dalam CLI:--max-records) — sebuah IntegerOptional, dari tipe: integer (integer 32-bit yang ditandatangani).

    Jumlah maksimum catatan yang akan dikembalikan dalam respons. Jika tersedia lebih banyak daripada nilai MaxRecords, token pagination (pemberian nomor halaman) yang disebut penanda disertakan dalam respons sehingga hasil berikut dapat diambil.

    Default: 100

    Kendala: Minimal 20, maksimum 100.

Respon

  • DBEngineVersions – Susunan objek DB EngineVersion.

    Daftar Elemen DBEngineVersion.

  • Marker— String, tipe: string (string yang dikodekan UTF-8).

    Token pagination opsional yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respon hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan MaxRecords.

Struktur:

DB EngineVersion (struktur)

Tipe data ini digunakan sebagai elemen respons dalam tindakan DescribedB EngineVersions (tindakan).

Bidang
  • DBEngineDescription— Ini adalah String, tipe: string (string yang dikodekan UTF-8).

    Deskripsi mesin basis data.

  • DBEngineVersionDescription— Ini adalah String, tipe: string (string yang dikodekan UTF-8).

    Deskripsi versi mesin basis data.

  • DBParameterGroupFamily— Ini adalah String, tipe: string (string yang dikodekan UTF-8).

    Nama famili grup parameter DB untuk mesin basis data.

  • Engine— Ini adalah String, tipe: string (string yang dikodekan UTF-8).

    Nama mesin basis data.

  • EngineVersion— Ini adalah String, tipe: string (string yang dikodekan UTF-8).

    Nomor versi mesin basis data.

  • ExportableLogTypes— Ini adalah String, tipe: string (string yang dikodekan UTF-8).

    Jenis log yang dimiliki mesin database untuk diekspor ke CloudWatch Log.

  • SupportedTimezones— Ini adalah Array Zona waktu objek.

    Daftar zona waktu didukung oleh mesin ini untuk parameter Timezone dari tindakanCreateDBInstance.

  • SupportsGlobalDatabases— Ini adalah Boolean, dari tipe: boolean (nilai Boolean (benar atau salah)).

    Nilai yang menunjukkan apakah Anda dapat menggunakan database global Aurora dengan versi mesin DB tertentu.

  • SupportsLogExportsToCloudwatchLogs— Ini adalah Boolean, dari tipe: boolean (nilai Boolean (benar atau salah)).

    Nilai yang menunjukkan apakah versi engine mendukung ekspor jenis log yang ditentukan oleh ExportableLogTypes ke CloudWatch Log.

  • SupportsReadReplica— Ini adalah Boolean, dari tipe: boolean (nilai Boolean (benar atau salah)).

    Menunjukkan apakah versi mesin basis data mendukung replika baca.

  • ValidUpgradeTarget— Ini adalah Array UpgradeTarget objek.

    Daftar versi mesin yang dapat ditingkatkan untuk versi mesin basis data ini.

EngineDefaults (struktur)

Berisi hasil pemanggilan yang berhasil dari tindakan DescribeEngineDefaultParameters(tindakan).

Bidang
  • DBParameterGroupFamily— Ini adalah String, tipe: string (string yang dikodekan UTF-8).

    Menentukan nama keluarga grup parameter DB yang diterapkan parameter default mesin.

  • Marker— Ini adalah String, tipe: string (string yang dikodekan UTF-8).

    Token pagination opsional yang disediakan oleh EngineDefaults permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan MaxRecords.

  • Parameters— Ini adalah Array Parameter objek.

    Berisi daftar parameter default mesin.

EngineDefaults digunakan sebagai elemen respons untuk:

PendingMaintenanceAction (struktur)

Menyediakan informasi tentang tindakan pemeliharaan yang tertunda untuk sumber daya.

Bidang
  • Action— Ini adalah String, tipe: string (string yang dikodekan UTF-8).

    Jenis tindakan pemeliharaan tertunda yang tersedia untuk sumber daya.

  • AutoAppliedAfterDate— Ini adalah TStamp, dari jenis: timestamp (titik waktu, umumnya didefinisikan sebagai offset dari tengah malam 1970-01-01).

    Tanggal jendela pemeliharaan saat tindakan diterapkan. Tindakan pemeliharaan diterapkan ke sumber daya selama jendela pemeliharaan pertama setelah tanggal ini. Jika tanggal ini ditentukan, semua permintaan opt-in next-maintenance diabaikan.

  • CurrentApplyDate— Ini adalah TStamp, dari jenis: timestamp (titik waktu, umumnya didefinisikan sebagai offset dari tengah malam 1970-01-01).

    Tanggal efektif ketika tindakan pemeliharaan tertunda diterapkan ke sumber daya. Tanggal ini mempertimbangkan permintaan opt-in yang diterima dari API ApplyPendingMaintenanceAction (tindakan),AutoAppliedAfterDate, dan ForcedApplyDate. Nilai ini kosong jika permintaan opt-in belum diterima dan tidak ada yang ditetapkan sebagai AutoAppliedAfterDate atau ForcedApplyDate.

  • Description— Ini adalah String, tipe: string (string yang dikodekan UTF-8).

    Deskripsi yang memberikan detail lebih lanjut tentang tindakan pemeliharaan.

  • ForcedApplyDate— Ini adalah TStamp, dari jenis: timestamp (titik waktu, umumnya didefinisikan sebagai offset dari tengah malam 1970-01-01).

    Tanggal ketika tindakan pemeliharaan diterapkan secara otomatis. Tindakan pemeliharaan diterapkan ke sumber daya pada tanggal ini terlepas dari jendela pemeliharaan untuk sumber daya. Jika tanggal ini ditentukan, semua permintaan opt-in immediate diabaikan.

  • OptInStatus— Ini adalah String, tipe: string (string yang dikodekan UTF-8).

    Menunjukkan jenis permintaan opt-in yang telah diterima untuk sumber daya.

ResourcePendingMaintenanceActions (struktur)

Menjelaskan tindakan pemeliharaan tertunda untuk sumber daya.

Bidang
  • PendingMaintenanceActionDetails— Ini adalah Array PendingMaintenanceAction objek.

    Daftar yang menyediakan detail tentang tindakan pemeliharaan yang tertunda untuk sumber daya.

  • ResourceIdentifier— Ini adalah String, tipe: string (string yang dikodekan UTF-8).

    ARN dari sumber daya yang memiliki tindakan pemeliharaan tertunda.

ResourcePendingMaintenanceActions digunakan sebagai elemen respons untuk:

UpgradeTarget (struktur)

Versi mesin basis data yang dapat ditingkatkan instans DB.

Bidang
  • AutoUpgrade— Ini adalah Boolean, dari tipe: boolean (nilai Boolean (benar atau salah)).

    Nilai yang menunjukkan apakah versi target diterapkan ke instance DB sumber apa pun yang telah AutoMinorVersionUpgrade disetel ke true.

  • Description— Ini adalah String, tipe: string (string yang dikodekan UTF-8).

    Versi mesin basis data yang dapat ditingkatkan instans DB.

  • Engine— Ini adalah String, tipe: string (string yang dikodekan UTF-8).

    Nama mesin basis data target peningkatan.

  • EngineVersion— Ini adalah String, tipe: string (string yang dikodekan UTF-8).

    Nomor versi mesin basis data target peningkatan.

  • IsMajorVersionUpgrade— Ini adalah Boolean, dari tipe: boolean (nilai Boolean (benar atau salah)).

    Nilai yang menunjukkan apakah mesin basis data ditingkatkan ke versi major.

  • SupportsGlobalDatabases— Ini adalah BooleanOptional, dari tipe: boolean (nilai Boolean (benar atau salah)).

    Nilai yang menunjukkan apakah Anda dapat menggunakan database global Neptunus dengan versi mesin target.

Tag (Struktur)

Metadata yang ditetapkan ke sumber daya Amazon Neptune yang terdiri dari pasangan nilai kunci.

Bidang
  • Key— Ini adalah String, tipe: string (string yang dikodekan UTF-8).

    Kunci adalah nama tag yang diperlukan. Nilai string dapat mulai dari 1 hingga 128 karakter Unicode dan tidak boleh diawali dengan aws: atau rds:. String tersebut hanya dapat berisi rangkaian huruf Unicode, angka, spasi, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").

  • Value— Ini adalah String, tipe: string (string yang dikodekan UTF-8).

    Nilai adalah nilai tag opsional. Nilai string dapat mulai dari 1 hingga 256 karakter Unicode dan tidak boleh diawali dengan aws: atau rds:. String tersebut hanya dapat berisi rangkaian huruf Unicode, angka, spasi, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").