2022/04/12 - AWS IoT TwinMaker - 5 updated api methods
Changes This release adds the following new features: 1) ListEntities API now supports search using ExternalId. 2) BatchPutPropertyValue and GetPropertyValueHistory API now allows users to represent time in sub-second level precisions.
{'entries': {'propertyValues': {'time': 'string'}}}
Response {'errorEntries': {'errors': {'entry': {'propertyValues': {'time': 'string'}}}}}
Sets values for multiple time series properties.
See also: AWS API Documentation
Request Syntax
client.batch_put_property_values(
entries=[
{
'entityPropertyReference': {
'componentName': 'string',
'entityId': 'string',
'externalIdProperty': {
'string': 'string'
},
'propertyName': 'string'
},
'propertyValues': [
{
'time': 'string',
'timestamp': datetime(2015, 1, 1),
'value': {
'booleanValue': True|False,
'doubleValue': 123.0,
'expression': 'string',
'integerValue': 123,
'listValue': [
{'... recursive ...'},
],
'longValue': 123,
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetComponentName': 'string',
'targetEntityId': 'string'
},
'stringValue': 'string'
}
},
]
},
],
workspaceId='string'
)
list
[REQUIRED]
An object that maps strings to the property value entries to set. Each string in the mapping must be unique to this object.
(dict) --
An object that specifies information about time series property values.
entityPropertyReference (dict) -- [REQUIRED]
An object that contains information about the entity that has the property.
componentName (string) --
The name of the component.
entityId (string) --
The ID of the entity.
externalIdProperty (dict) --
A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.
(string) --
(string) --
propertyName (string) -- [REQUIRED]
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.
time (string) --
Timestamp represented in ISO 8601 format
timestamp (datetime) --
The timestamp of a value for a time series property.
value (dict) -- [REQUIRED]
An object that specifies a value for a time series property.
booleanValue (boolean) --
A Boolean value.
doubleValue (float) --
A double value.
expression (string) --
An expression that produces the value.
integerValue (integer) --
An integer value.
listValue (list) --
A list of multiple values.
(dict) --
An object that specifies a value for a property.
longValue (integer) --
A long value.
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.
targetComponentName (string) --
The name of the target component associated with the relationship value.
targetEntityId (string) --
The ID of the target entity associated with this relationship value.
stringValue (string) --
A string value.
string
[REQUIRED]
The ID of the workspace that contains the properties to set.
dict
Response Syntax
{
'errorEntries': [
{
'errors': [
{
'entry': {
'entityPropertyReference': {
'componentName': 'string',
'entityId': 'string',
'externalIdProperty': {
'string': 'string'
},
'propertyName': 'string'
},
'propertyValues': [
{
'time': 'string',
'timestamp': datetime(2015, 1, 1),
'value': {
'booleanValue': True|False,
'doubleValue': 123.0,
'expression': 'string',
'integerValue': 123,
'listValue': [
{'... recursive ...'},
],
'longValue': 123,
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetComponentName': 'string',
'targetEntityId': 'string'
},
'stringValue': 'string'
}
},
]
},
'errorCode': 'string',
'errorMessage': '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.
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.
entityId (string) --
The ID of the entity.
externalIdProperty (dict) --
A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.
(string) --
(string) --
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.
time (string) --
Timestamp represented in ISO 8601 format
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.
expression (string) --
An expression that produces the value.
integerValue (integer) --
An integer value.
listValue (list) --
A list of multiple values.
(dict) --
An object that specifies a value for a property.
longValue (integer) --
A long value.
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.
targetComponentName (string) --
The name of the target component associated with the relationship value.
targetEntityId (string) --
The ID of the target entity associated with this relationship value.
stringValue (string) --
A string value.
errorCode (string) --
The error code.
errorMessage (string) --
The error message.
{'components': {'properties': {'updateType': {'CREATE'}}}}
Creates an entity.
See also: AWS API Documentation
Request Syntax
client.create_entity(
components={
'string': {
'componentTypeId': 'string',
'description': 'string',
'properties': {
'string': {
'definition': {
'configuration': {
'string': 'string'
},
'dataType': {
'allowedValues': [
{
'booleanValue': True|False,
'doubleValue': 123.0,
'expression': 'string',
'integerValue': 123,
'listValue': {'... recursive ...'},
'longValue': 123,
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetComponentName': 'string',
'targetEntityId': 'string'
},
'stringValue': 'string'
},
],
'nestedType': {'... recursive ...'},
'relationship': {
'relationshipType': 'string',
'targetComponentTypeId': 'string'
},
'type': 'RELATIONSHIP'|'STRING'|'LONG'|'BOOLEAN'|'INTEGER'|'DOUBLE'|'LIST'|'MAP',
'unitOfMeasure': 'string'
},
'defaultValue': {
'booleanValue': True|False,
'doubleValue': 123.0,
'expression': 'string',
'integerValue': 123,
'listValue': [
{'... recursive ...'},
],
'longValue': 123,
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetComponentName': 'string',
'targetEntityId': 'string'
},
'stringValue': 'string'
},
'isExternalId': True|False,
'isRequiredInEntity': True|False,
'isStoredExternally': True|False,
'isTimeSeries': True|False
},
'updateType': 'UPDATE'|'DELETE'|'CREATE',
'value': {
'booleanValue': True|False,
'doubleValue': 123.0,
'expression': 'string',
'integerValue': 123,
'listValue': [
{'... recursive ...'},
],
'longValue': 123,
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetComponentName': 'string',
'targetEntityId': 'string'
},
'stringValue': 'string'
}
}
}
}
},
description='string',
entityId='string',
entityName='string',
parentEntityId='string',
tags={
'string': 'string'
},
workspaceId='string'
)
dict
An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.
(string) --
(dict) --
An object that sets information about a component type create or update request.
componentTypeId (string) --
The ID of the component type.
description (string) --
The description of the component request.
properties (dict) --
An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.
(string) --
(dict) --
An object that sets information about a property.
definition (dict) --
An object that specifies information about a property.
configuration (dict) --
A mapping that specifies configuration information about the property. Use this field to specify information that you read from and write to an external source.
(string) --
(string) --
dataType (dict) --
An object that contains information about the data type.
allowedValues (list) --
The allowed values for this data type.
(dict) --
An object that specifies a value for a property.
booleanValue (boolean) --
A Boolean value.
doubleValue (float) --
A double value.
expression (string) --
An expression that produces the value.
integerValue (integer) --
An integer value.
listValue (list) --
A list of multiple values.
longValue (integer) --
A long value.
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.
targetComponentName (string) --
The name of the target component associated with the relationship value.
targetEntityId (string) --
The ID of the target entity associated with this relationship value.
stringValue (string) --
A string value.
nestedType (dict) --
The nested type in the data type.
relationship (dict) --
A relationship that associates a component with another component.
relationshipType (string) --
The type of the relationship.
targetComponentTypeId (string) --
The ID of the target component type associated with this relationship.
type (string) -- [REQUIRED]
The underlying type of the data type.
unitOfMeasure (string) --
The unit of measure used in this data type.
defaultValue (dict) --
An object that contains the default value.
booleanValue (boolean) --
A Boolean value.
doubleValue (float) --
A double value.
expression (string) --
An expression that produces the value.
integerValue (integer) --
An integer value.
listValue (list) --
A list of multiple values.
(dict) --
An object that specifies a value for a property.
longValue (integer) --
A long value.
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.
targetComponentName (string) --
The name of the target component associated with the relationship value.
targetEntityId (string) --
The ID of the target entity associated with this relationship value.
stringValue (string) --
A string value.
isExternalId (boolean) --
A Boolean value that specifies whether the property ID comes from an external data store.
isRequiredInEntity (boolean) --
A Boolean value that specifies whether the property is required.
isStoredExternally (boolean) --
A Boolean value that specifies whether the property is stored externally.
isTimeSeries (boolean) --
A Boolean value that specifies whether the property consists of time series data.
updateType (string) --
The update type of the update property request.
value (dict) --
The value of the property.
booleanValue (boolean) --
A Boolean value.
doubleValue (float) --
A double value.
expression (string) --
An expression that produces the value.
integerValue (integer) --
An integer value.
listValue (list) --
A list of multiple values.
(dict) --
An object that specifies a value for a property.
longValue (integer) --
A long value.
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.
targetComponentName (string) --
The name of the target component associated with the relationship value.
targetEntityId (string) --
The ID of the target entity associated with this relationship value.
stringValue (string) --
A string value.
string
The description of the entity.
string
The ID of the entity.
string
[REQUIRED]
The name of the entity.
string
The ID of the entity's parent entity.
dict
Metadata that you can use to manage the entity.
(string) --
(string) --
string
[REQUIRED]
The ID of the workspace that contains the entity.
dict
Response Syntax
{
'arn': 'string',
'creationDateTime': datetime(2015, 1, 1),
'entityId': 'string',
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR'
}
Response Structure
(dict) --
arn (string) --
The ARN of the entity.
creationDateTime (datetime) --
The date and time when the entity was created.
entityId (string) --
The ID of the entity.
state (string) --
The current state of the entity.
{'endTime': 'string', 'startTime': 'string'}
Response {'propertyValues': {'values': {'time': 'string'}}}
Retrieves information about the history of a time series property value for a component, component type, entity, or workspace.
You must specify a value for workspaceId . For entity-specific queries, specify values for componentName and entityId . For cross-entity quries, specify a value for componentTypeId .
See also: AWS API Documentation
Request Syntax
client.get_property_value_history(
componentName='string',
componentTypeId='string',
endDateTime=datetime(2015, 1, 1),
endTime='string',
entityId='string',
interpolation={
'interpolationType': 'LINEAR',
'intervalInSeconds': 123
},
maxResults=123,
nextToken='string',
orderByTime='ASCENDING'|'DESCENDING',
propertyFilters=[
{
'operator': 'string',
'propertyName': 'string',
'value': {
'booleanValue': True|False,
'doubleValue': 123.0,
'expression': 'string',
'integerValue': 123,
'listValue': [
{'... recursive ...'},
],
'longValue': 123,
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetComponentName': 'string',
'targetEntityId': 'string'
},
'stringValue': 'string'
}
},
],
selectedProperties=[
'string',
],
startDateTime=datetime(2015, 1, 1),
startTime='string',
workspaceId='string'
)
string
The name of the component.
string
The ID of the component type.
datetime
The date and time of the latest property value to return.
string
Timestamp represented in ISO 8601 format
string
The ID of the entity.
dict
An object that specifies the interpolation type and the interval over which to interpolate data.
interpolationType (string) --
The interpolation type.
intervalInSeconds (integer) --
The interpolation time interval in seconds.
integer
The maximum number of results to return.
string
The string that specifies the next page of results.
string
The time direction to use in the result order.
list
A list of objects that filter the property value history request.
(dict) --
An object that filters items returned by a property request.
operator (string) --
The operator associated with this property filter.
propertyName (string) --
The property name associated with this property filter.
value (dict) --
The value associated with this property filter.
booleanValue (boolean) --
A Boolean value.
doubleValue (float) --
A double value.
expression (string) --
An expression that produces the value.
integerValue (integer) --
An integer value.
listValue (list) --
A list of multiple values.
(dict) --
An object that specifies a value for a property.
longValue (integer) --
A long value.
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.
targetComponentName (string) --
The name of the target component associated with the relationship value.
targetEntityId (string) --
The ID of the target entity associated with this relationship value.
stringValue (string) --
A string value.
list
[REQUIRED]
A list of properties whose value histories the request retrieves.
(string) --
datetime
The date and time of the earliest property value to return.
string
Timestamp represented in ISO 8601 format
string
[REQUIRED]
The ID of the workspace.
dict
Response Syntax
{
'nextToken': 'string',
'propertyValues': [
{
'entityPropertyReference': {
'componentName': 'string',
'entityId': 'string',
'externalIdProperty': {
'string': 'string'
},
'propertyName': 'string'
},
'values': [
{
'time': 'string',
'timestamp': datetime(2015, 1, 1),
'value': {
'booleanValue': True|False,
'doubleValue': 123.0,
'expression': 'string',
'integerValue': 123,
'listValue': [
{'... recursive ...'},
],
'longValue': 123,
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetComponentName': 'string',
'targetEntityId': 'string'
},
'stringValue': 'string'
}
},
]
},
]
}
Response Structure
(dict) --
nextToken (string) --
The string that specifies the next page of results.
propertyValues (list) --
An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.
(dict) --
The history of values for a time series property.
entityPropertyReference (dict) --
An object that uniquely identifies an entity property.
componentName (string) --
The name of the component.
entityId (string) --
The ID of the entity.
externalIdProperty (dict) --
A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.
(string) --
(string) --
propertyName (string) --
The name of the property.
values (list) --
A list of objects that contain information about the values in the history of a time series property.
(dict) --
An object that contains information about a value for a time series property.
time (string) --
Timestamp represented in ISO 8601 format
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.
expression (string) --
An expression that produces the value.
integerValue (integer) --
An integer value.
listValue (list) --
A list of multiple values.
(dict) --
An object that specifies a value for a property.
longValue (integer) --
A long value.
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.
targetComponentName (string) --
The name of the target component associated with the relationship value.
targetEntityId (string) --
The ID of the target entity associated with this relationship value.
stringValue (string) --
A string value.
{'filters': {'externalId': 'string'}}
Lists all entities in a workspace.
See also: AWS API Documentation
Request Syntax
client.list_entities(
filters=[
{
'componentTypeId': 'string',
'externalId': 'string',
'parentEntityId': 'string'
},
],
maxResults=123,
nextToken='string',
workspaceId='string'
)
list
A list of objects that filter the request.
(dict) --
An object that filters items in a list of entities.
componentTypeId (string) --
The ID of the component type in the entities in the list.
externalId (string) --
The external-Id property of a component. The external-Id property is the primary key of an external storage system.
parentEntityId (string) --
The parent of the entities in the list.
integer
The maximum number of results to display.
string
The string that specifies the next page of results.
string
[REQUIRED]
The ID of the workspace.
dict
Response Syntax
{
'entitySummaries': [
{
'arn': 'string',
'creationDateTime': datetime(2015, 1, 1),
'description': 'string',
'entityId': 'string',
'entityName': 'string',
'hasChildEntities': True|False,
'parentEntityId': 'string',
'status': {
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string'
},
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR'
},
'updateDateTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
entitySummaries (list) --
A list of objects that contain information about the entities.
(dict) --
An object that contains information about an entity.
arn (string) --
The ARN of the entity.
creationDateTime (datetime) --
The date and time when the entity was created.
description (string) --
The description of the entity.
entityId (string) --
The ID of the entity.
entityName (string) --
The name of the entity.
hasChildEntities (boolean) --
A Boolean value that specifies whether the entity has child entities or not.
parentEntityId (string) --
The ID of the parent entity.
status (dict) --
The current status of the entity.
error (dict) --
The error message.
code (string) --
The error code.
message (string) --
The error message.
state (string) --
The current state of the entity, component, component type, or workspace.
updateDateTime (datetime) --
The last date and time when the entity was updated.
nextToken (string) --
The string that specifies the next page of results.
{'componentUpdates': {'propertyUpdates': {'updateType': {'CREATE'}}}}
Updates an entity.
See also: AWS API Documentation
Request Syntax
client.update_entity(
componentUpdates={
'string': {
'componentTypeId': 'string',
'description': 'string',
'propertyUpdates': {
'string': {
'definition': {
'configuration': {
'string': 'string'
},
'dataType': {
'allowedValues': [
{
'booleanValue': True|False,
'doubleValue': 123.0,
'expression': 'string',
'integerValue': 123,
'listValue': {'... recursive ...'},
'longValue': 123,
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetComponentName': 'string',
'targetEntityId': 'string'
},
'stringValue': 'string'
},
],
'nestedType': {'... recursive ...'},
'relationship': {
'relationshipType': 'string',
'targetComponentTypeId': 'string'
},
'type': 'RELATIONSHIP'|'STRING'|'LONG'|'BOOLEAN'|'INTEGER'|'DOUBLE'|'LIST'|'MAP',
'unitOfMeasure': 'string'
},
'defaultValue': {
'booleanValue': True|False,
'doubleValue': 123.0,
'expression': 'string',
'integerValue': 123,
'listValue': [
{'... recursive ...'},
],
'longValue': 123,
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetComponentName': 'string',
'targetEntityId': 'string'
},
'stringValue': 'string'
},
'isExternalId': True|False,
'isRequiredInEntity': True|False,
'isStoredExternally': True|False,
'isTimeSeries': True|False
},
'updateType': 'UPDATE'|'DELETE'|'CREATE',
'value': {
'booleanValue': True|False,
'doubleValue': 123.0,
'expression': 'string',
'integerValue': 123,
'listValue': [
{'... recursive ...'},
],
'longValue': 123,
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetComponentName': 'string',
'targetEntityId': 'string'
},
'stringValue': 'string'
}
}
},
'updateType': 'CREATE'|'UPDATE'|'DELETE'
}
},
description='string',
entityId='string',
entityName='string',
parentEntityUpdate={
'parentEntityId': 'string',
'updateType': 'UPDATE'|'DELETE'
},
workspaceId='string'
)
dict
An object that maps strings to the component updates in the request. Each string in the mapping must be unique to this object.
(string) --
(dict) --
The component update request.
componentTypeId (string) --
The ID of the component type.
description (string) --
The description of the component type.
propertyUpdates (dict) --
An object that maps strings to the properties to set in the component type update. Each string in the mapping must be unique to this object.
(string) --
(dict) --
An object that sets information about a property.
definition (dict) --
An object that specifies information about a property.
configuration (dict) --
A mapping that specifies configuration information about the property. Use this field to specify information that you read from and write to an external source.
(string) --
(string) --
dataType (dict) --
An object that contains information about the data type.
allowedValues (list) --
The allowed values for this data type.
(dict) --
An object that specifies a value for a property.
booleanValue (boolean) --
A Boolean value.
doubleValue (float) --
A double value.
expression (string) --
An expression that produces the value.
integerValue (integer) --
An integer value.
listValue (list) --
A list of multiple values.
longValue (integer) --
A long value.
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.
targetComponentName (string) --
The name of the target component associated with the relationship value.
targetEntityId (string) --
The ID of the target entity associated with this relationship value.
stringValue (string) --
A string value.
nestedType (dict) --
The nested type in the data type.
relationship (dict) --
A relationship that associates a component with another component.
relationshipType (string) --
The type of the relationship.
targetComponentTypeId (string) --
The ID of the target component type associated with this relationship.
type (string) -- [REQUIRED]
The underlying type of the data type.
unitOfMeasure (string) --
The unit of measure used in this data type.
defaultValue (dict) --
An object that contains the default value.
booleanValue (boolean) --
A Boolean value.
doubleValue (float) --
A double value.
expression (string) --
An expression that produces the value.
integerValue (integer) --
An integer value.
listValue (list) --
A list of multiple values.
(dict) --
An object that specifies a value for a property.
longValue (integer) --
A long value.
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.
targetComponentName (string) --
The name of the target component associated with the relationship value.
targetEntityId (string) --
The ID of the target entity associated with this relationship value.
stringValue (string) --
A string value.
isExternalId (boolean) --
A Boolean value that specifies whether the property ID comes from an external data store.
isRequiredInEntity (boolean) --
A Boolean value that specifies whether the property is required.
isStoredExternally (boolean) --
A Boolean value that specifies whether the property is stored externally.
isTimeSeries (boolean) --
A Boolean value that specifies whether the property consists of time series data.
updateType (string) --
The update type of the update property request.
value (dict) --
The value of the property.
booleanValue (boolean) --
A Boolean value.
doubleValue (float) --
A double value.
expression (string) --
An expression that produces the value.
integerValue (integer) --
An integer value.
listValue (list) --
A list of multiple values.
(dict) --
An object that specifies a value for a property.
longValue (integer) --
A long value.
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.
targetComponentName (string) --
The name of the target component associated with the relationship value.
targetEntityId (string) --
The ID of the target entity associated with this relationship value.
stringValue (string) --
A string value.
updateType (string) --
The update type of the component update request.
string
The description of the entity.
string
[REQUIRED]
The ID of the entity.
string
The name of the entity.
dict
An object that describes the update request for a parent entity.
parentEntityId (string) --
The ID of the parent entity.
updateType (string) -- [REQUIRED]
The type of the update.
string
[REQUIRED]
The ID of the workspace that contains the entity.
dict
Response Syntax
{
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR',
'updateDateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
state (string) --
The current state of the entity update.
updateDateTime (datetime) --
The date and time when the entity was last updated.