Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
CreateComponentType
Menciptakan tipe komponen.
Minta Sintaks
POST /workspaces/workspaceId/component-types/componentTypeId HTTP/1.1
Content-type: application/json
{
"componentTypeName": "string",
"compositeComponentTypes": {
"string" : {
"componentTypeId": "string"
}
},
"description": "string",
"extendsFrom": [ "string" ],
"functions": {
"string" : {
"implementedBy": {
"isNative": boolean,
"lambda": {
"arn": "string"
}
},
"requiredProperties": [ "string" ],
"scope": "string"
}
},
"isSingleton": boolean,
"propertyDefinitions": {
"string" : {
"configuration": {
"string" : "string"
},
"dataType": {
"allowedValues": [
{
"booleanValue": boolean,
"doubleValue": number,
"expression": "string",
"integerValue": number,
"listValue": [
"DataValue"
],
"longValue": number,
"mapValue": {
"string" : "DataValue"
},
"relationshipValue": {
"targetComponentName": "string",
"targetEntityId": "string"
},
"stringValue": "string"
}
],
"nestedType": "DataType",
"relationship": {
"relationshipType": "string",
"targetComponentTypeId": "string"
},
"type": "string",
"unitOfMeasure": "string"
},
"defaultValue": {
"booleanValue": boolean,
"doubleValue": number,
"expression": "string",
"integerValue": number,
"listValue": [
"DataValue"
],
"longValue": number,
"mapValue": {
"string" : "DataValue"
},
"relationshipValue": {
"targetComponentName": "string",
"targetEntityId": "string"
},
"stringValue": "string"
},
"displayName": "string",
"isExternalId": boolean,
"isRequiredInEntity": boolean,
"isStoredExternally": boolean,
"isTimeSeries": boolean
}
},
"propertyGroups": {
"string" : {
"groupType": "string",
"propertyNames": [ "string" ]
}
},
"tags": {
"string" : "string"
}
}Parameter Permintaan URI
Permintaan menggunakan parameter URI berikut.
- componentTypeId
-
ID dari jenis komponen.
Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.
Pola:
[a-zA-Z_\.\-0-9:]+Diperlukan: Ya
- workspaceId
-
ID ruang kerja yang berisi tipe komponen.
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.
- componentTypeName
-
Nama ramah untuk tipe komponen.
Jenis: String
Batasan Panjang: Panjang minimum 0. Panjang maksimum 256.
Pola:
.*[^\u0000-\u001F\u007F]*.*Diperlukan: Tidak
- compositeComponentTypes
-
Ini adalah objek yang memetakan string ke
compositeComponentTypesdari.componentTypeCompositeComponentTypedireferensikan olehcomponentTypeId.Jenis: String ke peta CompositeComponentTypeRequest objek
Batasan Panjang Kunci: Panjang minimum 1. Panjang maksimum 256.
Pola Kunci:
[a-zA-Z_\-0-9]+Diperlukan: Tidak
- description
-
Deskripsi jenis komponen.
Jenis: String
Batasan Panjang: Panjang minimum sebesar 0. Panjang maksimum 2048.
Pola:
.*Diperlukan: Tidak
- extendsFrom
-
Menentukan jenis komponen induk untuk memperpanjang.
Tipe: Array string
Panjang Batasan: Panjang minimum 1. Panjang maksimum 256.
Pola:
[a-zA-Z_\.\-0-9:]+Diperlukan: Tidak
- functions
-
Objek yang memetakan string ke fungsi dalam tipe komponen. Setiap string dalam pemetaan harus unik untuk objek ini.
Jenis: String ke peta FunctionRequest objek
Batasan Panjang Kunci: Panjang minimum 1. Panjang maksimum 256.
Pola Kunci:
[a-zA-Z_\-0-9]+Diperlukan: Tidak
- isSingleton
-
Nilai Boolean yang menentukan apakah suatu entitas dapat memiliki lebih dari satu komponen jenis ini.
Tipe: Boolean
Wajib: Tidak
- propertyDefinitions
-
Objek yang memetakan string ke definisi properti dalam tipe komponen. Setiap string dalam pemetaan harus unik untuk objek ini.
Jenis: String ke peta PropertyDefinitionRequest objek
Batasan Panjang Kunci: Panjang minimum 1. Panjang maksimum 256.
Pola Kunci:
[a-zA-Z_\-0-9]+Diperlukan: Tidak
- propertyGroups
-
Jenis: String ke peta PropertyGroupRequest objek
Batasan Panjang Kunci: Panjang minimum 1. Panjang maksimum 256.
Pola Kunci:
[a-zA-Z_\-0-9]+Diperlukan: Tidak
-
Metadata yang dapat Anda gunakan untuk mengelola jenis komponen.
Tipe: Peta string ke string
Entri Peta: Jumlah minimum 0 item. Jumlah maksimum 50 item.
Batasan Panjang Kunci: Panjang minimum 1. Panjang maksimum 128.
Pola Kunci:
([\p{L}\p{Z}\p{N}_.:/=+\-@]*)Batasan Panjang Nilai: Panjang minimum 1. Panjang maksimum 256.
Pola nilai:
.*Wajib: Tidak
Sintaksis Respons
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"creationDateTime": number,
"state": "string"
}Elemen Respons
Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.
Layanan mengembalikan data berikut dalam format JSON.
- arn
-
ARN dari tipe komponen.
Jenis: String
Batasan Panjang: Panjang minimum 20. Panjang maksimum 2048.
Pola:
arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\/a-zA-Z0-9_\-\.:]+ - creationDateTime
-
Tanggal dan waktu ketika entitas dibuat.
Tipe: Timestamp
- state
-
Keadaan saat ini dari tipe komponen.
Jenis: String
Nilai yang Valid:
CREATING | UPDATING | DELETING | ACTIVE | ERROR
Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat Kesalahan Umum.
- AccessDeniedException
-
Akses ditolak.
Kode Status HTTP: 403
- ConflictException
-
Konflik terjadi.
Kode Status HTTP: 409
- InternalServerException
-
Terjadi kesalahan tak terduga.
Kode Status HTTP: 500
- ServiceQuotaExceededException
-
Kuota layanan terlampaui.
Kode Status HTTP: 402
- ThrottlingException
-
Tarif melebihi batas.
Kode Status HTTP: 429
- ValidationException
-
Failed
Kode Status HTTP: 400
Lihat Juga
Untuk informasi selengkapnya tentang penggunaan API ini di salah satu AWS SDK khusus bahasa, lihat berikut ini:
