View a markdown version of this page

ListComponentTypes - AWS IoT TwinMaker

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

ListComponentTypes

Daftar semua jenis komponen di ruang kerja.

Minta Sintaks

POST /workspaces/workspaceId/component-types-list HTTP/1.1 Content-type: application/json { "filters": [ { ... } ], "maxResults": number, "nextToken": "string" }

Parameter Permintaan URI

Permintaan menggunakan parameter URI berikut.

workspaceId

ID ruang kerja.

Batasan Panjang: Panjang minimum 1. Panjang maksimum 128.

Pola: [a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+

Wajib: Ya

Isi Permintaan

Permintaan menerima data berikut dalam format JSON.

filters

Daftar objek yang memfilter permintaan.

Tipe: Array objek ListComponentTypesFilter

Wajib: Tidak

maxResults

Jumlah maksimum hasil untuk kembali pada satu waktu. Default-nya adalah 25.

Rentang yang Valid: Nilai minimum 1. Nilai maksimum 250.

Jenis: Integer

Rentang yang Valid: Nilai minimum 0. Nilai maksimum 200.

Wajib: Tidak

nextToken

String yang menentukan halaman berikutnya dari hasil.

Tipe: String

Batasan Panjang: Panjang minimum 0. Panjang maksimum 17880.

Pola: .*

Diperlukan: Tidak

Sintaksis Respons

HTTP/1.1 200 Content-type: application/json { "componentTypeSummaries": [ { "arn": "string", "componentTypeId": "string", "componentTypeName": "string", "creationDateTime": number, "description": "string", "status": { "error": { "code": "string", "message": "string" }, "state": "string" }, "updateDateTime": number } ], "maxResults": number, "nextToken": "string", "workspaceId": "string" }

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

componentTypeSummaries

Daftar objek yang berisi informasi tentang jenis komponen.

Tipe: Array objek ComponentTypeSummary

maxResults

Menentukan jumlah maksimum hasil untuk ditampilkan.

Jenis: Integer

Rentang yang Valid: Nilai minimum 0. Nilai maksimum 200.

nextToken

String yang menentukan halaman berikutnya dari hasil.

Tipe: String

Batasan Panjang: Panjang minimum 0. Panjang maksimum 17880.

Pola: .*

workspaceId

ID ruang kerja.

Tipe: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 128.

Pola: [a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+

Kesalahan

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

AccessDeniedException

Akses ditolak.

Kode Status HTTP: 403

InternalServerException

Terjadi kesalahan tak terduga.

Kode Status HTTP: 500

ThrottlingException

Tarif melebihi batas.

Kode Status HTTP: 429

ValidationException

Gagal

Kode Status HTTP: 400

Lihat Juga

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