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

# ListComponents
<a name="API_ListComponents"></a>

API ini mencantumkan komponen entitas.

## Minta Sintaks
<a name="API_ListComponents_RequestSyntax"></a>

```
POST /workspaces/workspaceId/entities/entityId/components-list HTTP/1.1
Content-type: application/json

{
   "componentPath": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

## Parameter Permintaan URI
<a name="API_ListComponents_RequestParameters"></a>

Permintaan menggunakan parameter URI berikut.

 ** [entityId](#API_ListComponents_RequestSyntax) **   <a name="tm-ListComponents-request-uri-entityId"></a>
ID untuk entitas yang metadatanya (komponen/properti) dikembalikan oleh operasi.  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 128.  
Pola: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\-0-9.:]*[a-zA-Z0-9]+`   
Wajib: Ya

 ** [workspaceId](#API_ListComponents_RequestSyntax) **   <a name="tm-ListComponents-request-uri-workspaceId"></a>
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
<a name="API_ListComponents_RequestBody"></a>

Permintaan menerima data berikut dalam format JSON.

 ** [componentPath](#API_ListComponents_RequestSyntax) **   <a name="tm-ListComponents-request-componentPath"></a>
String ini menentukan jalur ke komponen komposit, mulai dari komponen tingkat atas.  
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 2048.  
Pola: `[a-zA-Z_\-0-9/]+`   
Wajib: Tidak

 ** [maxResults](#API_ListComponents_RequestSyntax) **   <a name="tm-ListComponents-request-maxResults"></a>
Jumlah maksimum hasil yang dikembalikan pada satu waktu. Default-nya adalah 25.  
Jenis: Integer  
Rentang yang Valid: Nilai minimum 0. Nilai maksimum 200.  
Wajib: Tidak

 ** [nextToken](#API_ListComponents_RequestSyntax) **   <a name="tm-ListComponents-request-nextToken"></a>
String yang menentukan halaman berikutnya dari hasil.  
Tipe: String  
Batasan Panjang: Panjang minimum 0. Panjang maksimum 17880.  
Pola: `.*`   
Diperlukan: Tidak

## Sintaksis Respons
<a name="API_ListComponents_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "componentSummaries": [ 
      { 
         "componentName": "string",
         "componentPath": "string",
         "componentTypeId": "string",
         "definedIn": "string",
         "description": "string",
         "propertyGroups": { 
            "string" : { 
               "groupType": "string",
               "isInherited": boolean,
               "propertyNames": [ "string" ]
            }
         },
         "status": { 
            "error": { 
               "code": "string",
               "message": "string"
            },
            "state": "string"
         },
         "syncSource": "string"
      }
   ],
   "nextToken": "string"
}
```

## Elemen Respons
<a name="API_ListComponents_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [componentSummaries](#API_ListComponents_ResponseSyntax) **   <a name="tm-ListComponents-response-componentSummaries"></a>
Daftar objek yang berisi informasi tentang komponen.  
Tipe: Array objek [ComponentSummary](API_ComponentSummary.md)

 ** [nextToken](#API_ListComponents_ResponseSyntax) **   <a name="tm-ListComponents-response-nextToken"></a>
String yang menentukan halaman berikutnya dari hasil komponen.  
Tipe: String  
Batasan Panjang: Panjang minimum 0. Panjang maksimum 17880.  
Pola: `.*` 

## Kesalahan
<a name="API_ListComponents_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Jenis Kesalahan Umum](CommonErrors.md).

 ** AccessDeniedException **   
Akses ditolak.  
Kode Status HTTP: 403

 ** InternalServerException **   
Terjadi kesalahan tak terduga.  
Kode Status HTTP: 500

 ** ResourceNotFoundException **   
Sumber daya tidak ditemukan.  
Kode Status HTTP: 404

 ** ThrottlingException **   
Tarif melebihi batas.  
Kode Status HTTP: 429

 ** ValidationException **   
Gagal  
Kode Status HTTP: 400

## Lihat Juga
<a name="API_ListComponents_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/iottwinmaker-2021-11-29/ListComponents) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iottwinmaker-2021-11-29/ListComponents) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iottwinmaker-2021-11-29/ListComponents) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iottwinmaker-2021-11-29/ListComponents) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iottwinmaker-2021-11-29/ListComponents) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iottwinmaker-2021-11-29/ListComponents) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iottwinmaker-2021-11-29/ListComponents) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iottwinmaker-2021-11-29/ListComponents) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/iottwinmaker-2021-11-29/ListComponents) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iottwinmaker-2021-11-29/ListComponents)