ListWorlds - AWS RoboMaker
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.

ListWorlds

Daftar dunia.

Minta Sintaks

POST /listWorlds HTTP/1.1
Content-type: application/json

{
   "filters": [ 
      { 
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "string"
}

Parameter Permintaan URI

Permintaan tidak menggunakan parameter URI apa pun.

Isi Permintaan

Permintaan menerima data berikut dalam format JSON.

filters

Filter opsional untuk membatasi hasil. Anda dapat menggunakanstatus.

Tipe: Array objek Filter

Anggota Array: Jumlah tetap 1 item.

Wajib: Tidak

maxResults

Ketika parameter ini digunakan, ListWorlds hanya mengembalikan maxResults hasil dalam satu halaman bersama dengan elemen nextToken respon. Hasil yang tersisa dari permintaan awal dapat dilihat dengan mengirimkan ListWorlds permintaan lain dengan nextToken nilai yang dikembalikan. Nilai ini bisa antara 1 dan 100. Jika parameter ini tidak digunakan, maka ListWorlds mengembalikan hingga 100 hasil dan nextToken nilai jika berlaku.

Tipe: Integer

Wajib: Tidak

nextToken

Jika permintaan paginasi sebelumnya tidak mengembalikan semua hasil yang tersisa, nilai nextToken parameter objek respons disetel ke token. Untuk mengambil set hasil berikutnya, panggil ListWorlds lagi dan tetapkan token itu ke parameter objek permintaannextToken. Jika tidak ada hasil yang tersisa, NextToken parameter objek respon sebelumnya diatur ke null.

Jenis: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 2048.

Pola: [a-zA-Z0-9_.\-\/+=]*

Diperlukan: Tidak

Sintaksis Respons

HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "worldSummaries": [ 
      { 
         "arn": "string",
         "createdAt": number,
         "generationJob": "string",
         "template": "string"
      }
   ]
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

nextToken

Jika permintaan paginasi sebelumnya tidak mengembalikan semua hasil yang tersisa, nilai nextToken parameter objek respons disetel ke token. Untuk mengambil set hasil berikutnya, panggil ListWorlds lagi dan tetapkan token itu ke parameter objek permintaannextToken. Jika tidak ada hasil yang tersisa, NextToken parameter objek respon sebelumnya diatur ke null.

Jenis: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 2048.

Pola: [a-zA-Z0-9_.\-\/+=]*

worldSummaries

Ringkasan informasi untuk dunia.

Tipe: Array objek WorldSummary

Kesalahan

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

InternalServerException

AWS RoboMaker mengalami masalah layanan. Coba lagi panggilan Anda.

Kode Status HTTP: 500

InvalidParameterException

Parameter yang ditentukan dalam permintaan tidak valid, tidak didukung, atau tidak dapat digunakan. Pesan yang dikembalikan memberikan penjelasan tentang nilai kesalahan.

Kode Status HTTP: 400

ThrottlingException

RoboMaker AWS untuk sementara tidak dapat memproses permintaan. Coba lagi panggilan Anda.

Kode Status HTTP: 400

Lihat Juga

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