Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
CreateEntity
Menciptakan entitas.
Minta Sintaks
POST /workspaces/workspaceId
/entities HTTP/1.1
Content-type: application/json
{
"components": {
"string
" : {
"componentTypeId": "string
",
"description": "string
",
"properties": {
"string
" : {
"definition": {
"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
},
"updateType": "string
",
"value": {
"booleanValue": boolean
,
"doubleValue": number
,
"expression": "string
",
"integerValue": number
,
"listValue": [
"DataValue"
],
"longValue": number
,
"mapValue": {
"string
" : "DataValue"
},
"relationshipValue": {
"targetComponentName": "string
",
"targetEntityId": "string
"
},
"stringValue": "string
"
}
}
},
"propertyGroups": {
"string
" : {
"groupType": "string
",
"propertyNames": [ "string
" ],
"updateType": "string
"
}
}
}
},
"compositeComponents": {
"string
" : {
"description": "string
",
"properties": {
"string
" : {
"definition": {
"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
},
"updateType": "string
",
"value": {
"booleanValue": boolean
,
"doubleValue": number
,
"expression": "string
",
"integerValue": number
,
"listValue": [
"DataValue"
],
"longValue": number
,
"mapValue": {
"string
" : "DataValue"
},
"relationshipValue": {
"targetComponentName": "string
",
"targetEntityId": "string
"
},
"stringValue": "string
"
}
}
},
"propertyGroups": {
"string
" : {
"groupType": "string
",
"propertyNames": [ "string
" ],
"updateType": "string
"
}
}
}
},
"description": "string
",
"entityId": "string
",
"entityName": "string
",
"parentEntityId": "string
",
"tags": {
"string
" : "string
"
}
}
Parameter Permintaan URI
Permintaan menggunakan parameter URI berikut.
- workspaceId
-
ID ruang kerja yang berisi entitas.
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.
- components
-
Objek yang memetakan string ke komponen dalam entitas. Setiap string dalam pemetaan harus unik untuk objek ini.
Jenis: String ke peta ComponentRequest objek
Batasan Panjang Kunci: Panjang minimum 1. Panjang maksimum 256.
Pola Kunci:
[a-zA-Z_\-0-9]+
Wajib: Tidak
- compositeComponents
-
Ini adalah objek yang memetakan string ke
compositeComponent
pembaruan dalam permintaan. Setiap kunci peta mewakilicomponentPath
daricompositeComponent
.Jenis: String ke peta CompositeComponentRequest objek
Batasan Panjang Kunci: Panjang minimum 1. Panjang maksimum 2048.
Pola Kunci:
[a-zA-Z_\-0-9/]+
Wajib: Tidak
- description
-
Deskripsi entitas.
Jenis: String
Batasan Panjang: Panjang minimum sebesar 0. Panjang maksimum 2048.
Pola:
.*
Wajib: Tidak
- entityId
-
ID entitas.
Jenis: String
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: Tidak
- entityName
-
Nama entitas.
Jenis: String
Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.
Pola:
[^\u0000-\u001F\u007F]+
Wajib: Ya
- parentEntityId
-
ID entitas induk entitas.
Jenis: String
Batasan Panjang: Panjang minimum 1. Panjang maksimum 128.
Pola:
\$ROOT|^[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: Tidak
-
Metadata yang dapat Anda gunakan untuk mengelola entitas.
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,
"entityId": "string",
"state": "string"
}
Elemen Respons
Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.
Layanan mengembalikan data berikut dalam format JSON.
- arn
-
ARN entitas.
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
- entityId
-
ID entitas.
Jenis: String
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]+
- state
-
Keadaan entitas saat ini.
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: