Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.
# AWS IoT TwinMaker connettori dati
I connettori devono accedere al data store sottostante per risolvere le interrogazioni inviate e restituire risultati o errori.
Per informazioni sui connettori disponibili, le relative interfacce di richiesta e le relative interfacce di risposta, consulta i seguenti argomenti.
Per ulteriori informazioni sulle proprietà utilizzate nelle interfacce dei connettori, consulta l'[GetPropertyValueHistory](https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_GetPropertyValueHistory.html)azione API.
**Nota**
Alcuni connettori dispongono di due campi timestamp nelle interfacce di richiesta e risposta per le proprietà dell'ora di inizio e dell'ora di fine. Entrambi `startDateTime` `endDateTime` utilizzano un numero lungo per rappresentare epoch second, che non è più supportato. Per mantenere la compatibilità con le versioni precedenti, inviamo comunque un valore di timestamp a quel campo, ma consigliamo di utilizzare `endTime` campi `startTime` e coerenti con il formato di timestamp della nostra API.
**Topics**
+ [Connettore di inizializzazione dello schema](#SchemaInitializer-connector)
+ [DataReaderByEntity](#DataReaderByEntity-connector)
+ [DataReaderByComponentType](#DataReaderByComponentType-connector)
+ [DataReader](#DataReader-connector)
+ [AttributePropertyValueReaderByEntity](#AttributePropertyValueReaderByEntity-connector)
+ [DataWriter](#DataWriter-connector)
+ [Esempi](#examples-connector)
## Connettore di inizializzazione dello schema
È possibile utilizzare l'inizializzatore dello schema nel ciclo di vita del tipo di componente o dell'entità per recuperare il tipo di componente o le proprietà del componente dall'origine dati sottostante. L'inizializzatore dello schema importa automaticamente il tipo di componente o le proprietà del componente senza richiamare esplicitamente un'azione API per la configurazione. `properties`
### SchemaInitializer interfaccia di richiesta
```
{
"workspaceId": "string",
"entityId": "string",
"componentName": "string",
"properties": {
// property name as key,
// value is of type PropertyRequest
"string": "PropertyRequest"
}
}
```
**Nota**
La mappa delle proprietà in questa interfaccia di richiesta è una`PropertyRequest`. Per ulteriori informazioni, consulta [PropertyRequest](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_PropertyRequest.html).
### SchemaInitializer interfaccia di risposta
```
{
"properties": {
// property name as key,
// value is of type PropertyResponse
"string": "PropertyResponse"
}
}
```
**Nota**
La mappa delle proprietà in questa interfaccia di richiesta è una`PropertyResponse`. Per ulteriori informazioni, consulta [PropertyResponse](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_PropertyResponse.html).
## DataReaderByEntity
DataReaderByEntity è un connettore del piano dati utilizzato per ottenere i valori delle serie temporali delle proprietà in un singolo componente.
Per informazioni sui tipi di proprietà, sulla sintassi e sul formato di questo connettore, vedi l'azione [GetPropertyValueHistory](https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_GetPropertyValueHistory.html)API.
### DataReaderByEntity interfaccia di richiesta
```
{
"startDateTime": long, // In epoch sec, deprecated
"startTime": "string", // ISO-8601 timestamp format
"endDateTime": long, // In epoch sec, deprecated
"endTime": "string", // ISO-8601 timestamp format
"properties": {
// A map of properties as in the get-entity API response
// property name as key,
// value is of type [PropertyResponse](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_PropertyResponse.html)
"string": "PropertyResponse"
},
"workspaceId": "string",
"selectedProperties": List:"string",
"propertyFilters": List:PropertyFilter,
"entityId": "string",
"componentName": "string",
"componentTypeId": "string",
"interpolation": InterpolationParameters,
"nextToken": "string",
"maxResults": int,
"orderByTime": "string"
}
```
### DataReaderByEntity interfaccia di risposta
```
{
"propertyValues": [
{
"entityPropertyReference": EntityPropertyReference, // The same as [EntityPropertyReference](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_EntityPropertyReference.html)
"values": [
{
"timestamp": long, // Epoch sec, deprecated
"time": "string", // ISO-8601 timestamp format
"value": DataValue // The same as [DataValue](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_DataValue.html)
}
]
}
],
"nextToken": "string"
}
```
## DataReaderByComponentType
Per ottenere i valori delle serie temporali delle proprietà comuni che provengono dallo stesso tipo di componente, utilizzate il connettore DataReaderByEntity del piano dati. Ad esempio, se definisci proprietà di serie temporali nel tipo di componente e hai più componenti che utilizzano quel tipo di componente, puoi interrogare tali proprietà su tutti i componenti in un determinato intervallo di tempo. Un caso d'uso comune è quando si desidera interrogare lo stato di allarme di più componenti per una visione globale delle entità.
Per informazioni sui tipi di proprietà, sulla sintassi e sul formato di questo connettore, consulta l'azione [GetPropertyValueHistory](https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_GetPropertyValueHistory.html)API.
### DataReaderByComponentType interfaccia di richiesta
```
{
"startDateTime": long, // In epoch sec, deprecated
"startTime": "string", // ISO-8601 timestamp format
"endDateTime": long, // In epoch sec, deprecated
"endTime": "string", // ISO-8601 timestamp format
"properties": { // A map of properties as in the get-entity API response
// property name as key,
// value is of type [PropertyResponse](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_PropertyResponse.html)
"string": "PropertyResponse"
},
"workspaceId": "string",
"selectedProperties": List:"string",
"propertyFilters": List:PropertyFilter,
"componentTypeId": "string",
"interpolation": InterpolationParameters,
"nextToken": "string",
"maxResults": int,
"orderByTime": "string"
}
```
### DataReaderByComponentType interfaccia di risposta
```
{
"propertyValues": [
{
"entityPropertyReference": EntityPropertyReference, // The same as [EntityPropertyReference](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_EntityPropertyReference.html)
"entityId": "string",
"componentName": "string",
"values": [
{
"timestamp": long, // Epoch sec, deprecated
"time": "string", // ISO-8601 timestamp format
"value": DataValue // The same as [DataValue](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_DataValue.html)
}
]
}
],
"nextToken": "string"
}
```
## DataReader
DataReader è un connettore data plane in grado di gestire sia le maiuscole che le minuscole DataReaderByEntity e le minuscole DataReaderByComponentType.
Per informazioni sui tipi di proprietà, sulla sintassi e sul formato di questo connettore, consulta l'azione [GetPropertyValueHistory](https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_GetPropertyValueHistory.html)API.
### DataReader interfaccia di richiesta
`EntityId` e `componentName` sono facoltativi.
```
{
"startDateTime": long, // In epoch sec, deprecated
"startTime": "string", // ISO-8601 timestamp format
"endDateTime": long, // In epoch sec, deprecated
"endTime": "string", // ISO-8601 timestamp format
"properties": { // A map of properties as in the get-entity API response
// property name as key,
// value is of type PropertyRequest
"string": "PropertyRequest"
},
"workspaceId": "string",
"selectedProperties": List:"string",
"propertyFilters": List:PropertyFilter,
"entityId": "string",
"componentName": "string",
"componentTypeId": "string",
"interpolation": InterpolationParameters,
"nextToken": "string",
"maxResults": int,
"orderByTime": "string"
}
```
### DataReader interfaccia di risposta
```
{
"propertyValues": [
{
"entityPropertyReference": EntityPropertyReference, // The same as [EntityPropertyReference](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_EntityPropertyReference.html)
"values": [
{
"timestamp": long, // Epoch sec, deprecated
"time": "string", // ISO-8601 timestamp format
"value": DataValue // The same as [DataValue](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_DataValue.html)
}
]
}
],
"nextToken": "string"
}
```
## AttributePropertyValueReaderByEntity
AttributePropertyValueReaderByEntity è un connettore del piano dati che è possibile utilizzare per recuperare il valore delle proprietà statiche in una singola entità.
Per informazioni sui tipi di proprietà, sulla sintassi e sul formato di questo connettore, consulta l'azione [ GetPropertyValue](https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_GetPropertyValue.html)API.
### AttributePropertyValueReaderByEntity interfaccia di richiesta
```
{
"properties": {
// property name as key,
// value is of type [PropertyResponse](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_PropertyResponse.html)
"string": "PropertyResponse"
}
"workspaceId": "string",
"entityId": "string",
"componentName": "string",
"selectedProperties": List:"string",
}
```
### AttributePropertyValueReaderByEntity interfaccia di risposta
```
{
"propertyValues": {
"string": { // property name as key
"propertyReference": EntityPropertyReference, // The same as [EntityPropertyReference](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_EntityPropertyReference.html)
"propertyValue": DataValue // The same as [DataValue](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_DataValue.html)
}
}
```
## DataWriter
DataWriter è un connettore del piano dati che è possibile utilizzare per riscrivere i punti dati di serie temporali nell'archivio dati sottostante per le proprietà di un singolo componente.
Per informazioni sui tipi di proprietà, sulla sintassi e sul formato di questo connettore, consulta l'azione [BatchPutPropertyValues](https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_BatchPutPropertyValues.html)API.
### DataWriter interfaccia di richiesta
```
{
"workspaceId": "string",
"properties": {
// entity id as key
"String": {
// property name as key,
// value is of type [PropertyResponse](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_PropertyResponse.html)
"string": PropertyResponse
}
},
"entries": [
{
"entryId": "string",
"entityPropertyReference": EntityPropertyReference, // The same as [EntityPropertyReference](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_EntityPropertyReference.html)
"propertyValues": [
{
"timestamp": long, // Epoch sec, deprecated
"time": "string", // ISO-8601 timestamp format
"value": DataValue // The same as [DataValue](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_DataValue.html)
}
]
}
]
}
```
### DataWriter interfaccia di risposta
```
{
"errorEntries": [
{
"errors": List:BatchPutPropertyError // The value is a list of type [BatchPutPropertyError](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_BatchPutPropertyError.html)
}
]
}
```
## Esempi
I seguenti esempi JSON sono esempi di sintassi di risposta e richiesta per più connettori.
+ **SchemaInitializer**:
Gli esempi seguenti mostrano l'inizializzatore dello schema nel ciclo di vita di un tipo di componente.
**Richiesta:**
```
{
"workspaceId": "myWorkspace",
"properties": {
"modelId": {
"definition": {
"dataType": { "type": "STRING" },
"isExternalId": true,
"isFinal": true,
"isImported": false,
"isInherited": false,
"isRequiredInEntity": true,
"isStoredExternally": false,
"isTimeSeries": false,
"defaultValue": {
"stringValue": "myModelId"
}
},
"value": {
"stringValue": "myModelId"
}
},
"tableName": {
"definition": {
"dataType": { "type": "STRING" },
"isExternalId": false,
"isFinal": false,
"isImported": false,
"isInherited": false,
"isRequiredInEntity": false,
"isStoredExternally": false,
"isTimeSeries": false,
"defaultValue": {
"stringValue": "myTableName"
}
},
"value": {
"stringValue": "myTableName"
}
}
}
}
```
**Risposta:**
```
{
"properties": {
"myProperty1": {
"definition": {
"dataType": {
"type": "DOUBLE",
"unitOfMeasure": "%"
},
"configuration": {
"myProperty1Id": "idValue"
},
"isTimeSeries": true
}
},
"myProperty2": {
"definition": {
"dataType": { "type": "STRING" },
"isTimeSeries": false,
"defaultValue": {
"stringValue": "property2Value"
}
}
}
}
}
```
+ **Inizializzatore dello schema** nel ciclo di vita dell'entità:
**Richiesta:**
```
{
"workspaceId": "myWorkspace",
"entityId": "myEntity",
"componentName": "myComponent",
"properties": {
"assetId": {
"definition": {
"dataType": { "type": "STRING" },
"isExternalId": true,
"isFinal": true,
"isImported": false,
"isInherited": false,
"isRequiredInEntity": true,
"isStoredExternally": false,
"isTimeSeries": false
},
"value": {
"stringValue": "myAssetId"
}
},
"tableName": {
"definition": {
"dataType": { "type": "STRING" },
"isExternalId": false,
"isFinal": false,
"isImported": false,
"isInherited": false,
"isRequiredInEntity": false,
"isStoredExternally": false,
"isTimeSeries": false
},
"value": {
"stringValue": "myTableName"
}
}
}
}
```
**Risposta:**
```
{
"properties": {
"myProperty1": {
"definition": {
"dataType": {
"type": "DOUBLE",
"unitOfMeasure": "%"
},
"configuration": {
"myProperty1Id": "idValue"
},
"isTimeSeries": true
}
},
"myProperty2": {
"definition": {
"dataType": { "type": "STRING" },
"isTimeSeries": false
},
"value": {
"stringValue": "property2Value"
}
}
}
}
```
+ **DataReaderByEntity e DataReader**:
**Richiesta:**
```
{
"workspaceId": "myWorkspace",
"entityId": "myEntity",
"componentName": "myComponent",
"selectedProperties": [
"Temperature",
"Pressure"
],
"startTime": "2022-04-07T04:04:42Z",
"endTime": "2022-04-07T04:04:45Z",
"maxResults": 4,
"orderByTime": "ASCENDING",
"properties": {
"assetId": {
"definition": {
"dataType": { "type": "STRING" },
"isExternalId": true,
"isFinal": true,
"isImported": false,
"isInherited": false,
"isRequiredInEntity": true,
"isStoredExternally": false,
"isTimeSeries": false
},
"value": {
"stringValue": "myAssetId"
}
},
"Temperature": {
"definition": {
"configuration": {
"temperatureId": "xyz123"
},
"dataType": {
"type": "DOUBLE",
"unitOfMeasure": "DEGC"
},
"isExternalId": false,
"isFinal": false,
"isImported": true,
"isInherited": false,
"isRequiredInEntity": false,
"isStoredExternally": false,
"isTimeSeries": true
}
},
"Pressure": {
"definition": {
"configuration": {
"pressureId": "xyz456"
},
"dataType": {
"type": "DOUBLE",
"unitOfMeasure": "MPA"
},
"isExternalId": false,
"isFinal": false,
"isImported": true,
"isInherited": false,
"isRequiredInEntity": false,
"isStoredExternally": false,
"isTimeSeries": true
}
}
}
}
```
**Risposta:**
```
{
"propertyValues": [
{
"entityPropertyReference": {
"entityId": "myEntity",
"componentName": "myComponent",
"propertyName": "Temperature"
},
"values": [
{
"time": "2022-04-07T04:04:42Z",
"value": {
"doubleValue": 588.168
}
},
{
"time": "2022-04-07T04:04:43Z",
"value": {
"doubleValue": 592.4224
}
}
]
}
],
"nextToken": "qwertyuiop"
}
```
+ **AttributePropertyValueReaderByEntity**:
**Richiesta:**
```
{
"workspaceId": "myWorkspace",
"entityId": "myEntity",
"componentName": "myComponent",
"selectedProperties": [
"manufacturer",
],
"properties": {
"assetId": {
"definition": {
"dataType": { "type": "STRING" },
"isExternalId": true,
"isFinal": true,
"isImported": false,
"isInherited": false,
"isRequiredInEntity": true,
"isStoredExternally": false,
"isTimeSeries": false
},
"value": {
"stringValue": "myAssetId"
}
},
"manufacturer": {
"definition": {
"dataType": { "type": "STRING" },
"configuration": {
"manufacturerPropId": "M001"
},
"isExternalId": false,
"isFinal": false,
"isImported": false,
"isInherited": false,
"isRequiredInEntity": false,
"isStoredExternally": true,
"isTimeSeries": false
}
}
}
}
```
**Risposta:**
```
{
"propertyValues": {
"manufacturer": {
"propertyReference": {
"propertyName": "manufacturer",
"entityId": "myEntity",
"componentName": "myComponent"
},
"propertyValue": {
"stringValue": "Amazon"
}
}
}
}
```
+ **DataWriter**:
**Richiesta:**
```
{
"workspaceId": "myWorkspaceId",
"properties": {
"myEntity": {
"Temperature": {
"definition": {
"configuration": {
"temperatureId": "xyz123"
},
"dataType": {
"type": "DOUBLE",
"unitOfMeasure": "DEGC"
},
"isExternalId": false,
"isFinal": false,
"isImported": true,
"isInherited": false,
"isRequiredInEntity": false,
"isStoredExternally": false,
"isTimeSeries": true
}
}
}
},
"entries": [
{
"entryId": "myEntity",
"entityPropertyReference": {
"entityId": "myEntity",
"componentName": "myComponent",
"propertyName": "Temperature"
},
"propertyValues": [
{
"timestamp": 1626201120,
"value": {
"doubleValue": 95.6958
}
},
{
"timestamp": 1626201132,
"value": {
"doubleValue": 80.6959
}
}
]
}
]
}
```
**Risposta:**
```
{
"errorEntries": [
{
"errors": [
{
"errorCode": "409",
"errorMessage": "Conflict value at same timestamp",
"entry": {
"entryId": "myEntity",
"entityPropertyReference": {
"entityId": "myEntity",
"componentName": "myComponent",
"propertyName": "Temperature"
},
"propertyValues": [
"time": "2022-04-07T04:04:42Z",
"value": {
"doubleValue": 95.6958
}
]
}
}
]
}
]
}
```