IoTTwinMaker.Client.batch_put_property_values(**kwargs)¶Sets values for multiple time series properties.
See also: AWS API Documentation
Request Syntax
response = client.batch_put_property_values(
workspaceId='string',
entries=[
{
'entityPropertyReference': {
'componentName': 'string',
'externalIdProperty': {
'string': 'string'
},
'entityId': 'string',
'propertyName': 'string'
},
'propertyValues': [
{
'timestamp': datetime(2015, 1, 1),
'value': {
'booleanValue': True|False,
'doubleValue': 123.0,
'integerValue': 123,
'longValue': 123,
'stringValue': 'string',
'listValue': [
{'... recursive ...'},
],
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetEntityId': 'string',
'targetComponentName': 'string'
},
'expression': 'string'
},
'time': 'string'
},
]
},
]
)
[REQUIRED]
The ID of the workspace that contains the properties to set.
[REQUIRED]
An object that maps strings to the property value entries to set. Each string in the mapping must be unique to this object.
An object that specifies information about time series property values. This object is used and consumed by the BatchPutPropertyValues action.
An object that contains information about the entity that has the property.
The name of the component.
A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.
The ID of the entity.
The name of the property.
A list of objects that specify time series property values.
An object that contains information about a value for a time series property.
The timestamp of a value for a time series property.
An object that specifies a value for a time series property.
A Boolean value.
A double value.
An integer value.
A long value.
A string value.
A list of multiple values.
An object that specifies a value for a property.
An object that maps strings to multiple DataValue objects.
An object that specifies a value for a property.
A value that relates a component to another component.
The ID of the target entity associated with this relationship value.
The name of the target component associated with the relationship value.
An expression that produces the value.
ISO8601 DateTime of a value for a time series property.
The time for when the property value was recorded in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.SSSSSSSSS][Z/±HH:mm] .
Required sub-fields : YYYY-MM-DDThh:mm:ss and [Z/±HH:mm]
dict
Response Syntax
{
'errorEntries': [
{
'errors': [
{
'errorCode': 'string',
'errorMessage': 'string',
'entry': {
'entityPropertyReference': {
'componentName': 'string',
'externalIdProperty': {
'string': 'string'
},
'entityId': 'string',
'propertyName': 'string'
},
'propertyValues': [
{
'timestamp': datetime(2015, 1, 1),
'value': {
'booleanValue': True|False,
'doubleValue': 123.0,
'integerValue': 123,
'longValue': 123,
'stringValue': 'string',
'listValue': [
{'... recursive ...'},
],
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetEntityId': 'string',
'targetComponentName': 'string'
},
'expression': 'string'
},
'time': 'string'
},
]
}
},
]
},
]
}
Response Structure
(dict) --
errorEntries (list) --
Entries that caused errors in the batch put operation.
(dict) --
An object that contains information about errors returned by the BatchPutProperty action.
errors (list) --
A list of objects that contain information about errors returned by the BatchPutProperty action.
(dict) --
An error returned by the BatchPutProperty action.
errorCode (string) --
The error code.
errorMessage (string) --
The error message.
entry (dict) --
An object that contains information about errors returned by the BatchPutProperty action.
entityPropertyReference (dict) --
An object that contains information about the entity that has the property.
componentName (string) --
The name of the component.
externalIdProperty (dict) --
A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.
entityId (string) --
The ID of the entity.
propertyName (string) --
The name of the property.
propertyValues (list) --
A list of objects that specify time series property values.
(dict) --
An object that contains information about a value for a time series property.
timestamp (datetime) --
The timestamp of a value for a time series property.
value (dict) --
An object that specifies a value for a time series property.
booleanValue (boolean) --
A Boolean value.
doubleValue (float) --
A double value.
integerValue (integer) --
An integer value.
longValue (integer) --
A long value.
stringValue (string) --
A string value.
listValue (list) --
A list of multiple values.
(dict) --
An object that specifies a value for a property.
mapValue (dict) --
An object that maps strings to multiple DataValue objects.
(string) --
(dict) --
An object that specifies a value for a property.
relationshipValue (dict) --
A value that relates a component to another component.
targetEntityId (string) --
The ID of the target entity associated with this relationship value.
targetComponentName (string) --
The name of the target component associated with the relationship value.
expression (string) --
An expression that produces the value.
time (string) --
ISO8601 DateTime of a value for a time series property.
The time for when the property value was recorded in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.SSSSSSSSS][Z/±HH:mm] .
Required sub-fields : YYYY-MM-DDThh:mm:ss and [Z/±HH:mm]
Exceptions
IoTTwinMaker.Client.exceptions.InternalServerExceptionIoTTwinMaker.Client.exceptions.ResourceNotFoundExceptionIoTTwinMaker.Client.exceptions.ThrottlingExceptionIoTTwinMaker.Client.exceptions.ValidationException