2022/12/08 - AWS IoT TwinMaker - 5 new 8 updated api methods
Changes This release adds the following new features: 1) New APIs for managing a continuous sync of assets and asset models from AWS IoT SiteWise. 2) Support user friendly names for component types (ComponentTypeName) and properties (DisplayName).
Delete the SyncJob.
See also: AWS API Documentation
Request Syntax
client.delete_sync_job(
workspaceId='string',
syncSource='string'
)
string
[REQUIRED]
The workspace Id.
string
[REQUIRED]
The sync source.
Note
Currently the only supported syncSoucre is SITEWISE .
dict
Response Syntax
{
'state': 'CREATING'|'INITIALIZING'|'ACTIVE'|'DELETING'|'ERROR'
}
Response Structure
(dict) --
state (string) --
The SyncJob response state.
Gets the SyncJob.
See also: AWS API Documentation
Request Syntax
client.get_sync_job(
syncSource='string',
workspaceId='string'
)
string
[REQUIRED]
The sync soucre.
Note
Currently the only supported syncSoucre is SITEWISE .
string
The workspace Id.
dict
Response Syntax
{
'arn': 'string',
'workspaceId': 'string',
'syncSource': 'string',
'syncRole': 'string',
'status': {
'state': 'CREATING'|'INITIALIZING'|'ACTIVE'|'DELETING'|'ERROR',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR',
'message': 'string'
}
},
'creationDateTime': datetime(2015, 1, 1),
'updateDateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
arn (string) --
The sync job ARN.
workspaceId (string) --
The ID of the workspace that contains the sync job.
syncSource (string) --
The sync soucre.
Note
Currently the only supported syncSoucre is SITEWISE .
syncRole (string) --
The sync IAM role.
status (dict) --
The SyncJob response status.
state (string) --
The SyncJob status state.
error (dict) --
The SyncJob error.
code (string) --
The error code.
message (string) --
The error message.
creationDateTime (datetime) --
The creation date and time.
updateDateTime (datetime) --
The update date and time.
This action creates a SyncJob.
See also: AWS API Documentation
Request Syntax
client.create_sync_job(
workspaceId='string',
syncSource='string',
syncRole='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
The workspace Id.
string
[REQUIRED]
The sync source.
Note
Currently the only supported syncSoucre is SITEWISE .
string
[REQUIRED]
The SyncJob IAM role. This IAM role is used by the sync job to read from the syncSource, and create, update or delete the corresponding resources.
dict
The SyncJob tags.
(string) --
(string) --
dict
Response Syntax
{
'arn': 'string',
'creationDateTime': datetime(2015, 1, 1),
'state': 'CREATING'|'INITIALIZING'|'ACTIVE'|'DELETING'|'ERROR'
}
Response Structure
(dict) --
arn (string) --
The SyncJob ARN.
creationDateTime (datetime) --
The date and time for the SyncJob creation.
state (string) --
The SyncJob response state.
List all SyncJobs.
See also: AWS API Documentation
Request Syntax
client.list_sync_jobs(
workspaceId='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The ID of the workspace that contains the sync job.
integer
The maximum number of results to return at one time. The default is 50.
Valid Range: Minimum value of 0. Maximum value of 200.
string
The string that specifies the next page of results.
dict
Response Syntax
{
'syncJobSummaries': [
{
'arn': 'string',
'workspaceId': 'string',
'syncSource': 'string',
'status': {
'state': 'CREATING'|'INITIALIZING'|'ACTIVE'|'DELETING'|'ERROR',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR',
'message': 'string'
}
},
'creationDateTime': datetime(2015, 1, 1),
'updateDateTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
syncJobSummaries (list) --
The listed SyncJob summaries.
(dict) --
The SyncJob summary.
arn (string) --
The SyncJob summary ARN.
workspaceId (string) --
The ID of the workspace that contains the sync job.
syncSource (string) --
The sync source.
status (dict) --
The SyncJob summaries status.
state (string) --
The SyncJob status state.
error (dict) --
The SyncJob error.
code (string) --
The error code.
message (string) --
The error message.
creationDateTime (datetime) --
The creation date and time.
updateDateTime (datetime) --
The update date and time.
nextToken (string) --
The string that specifies the next page of results.
Lists the sync resources.
See also: AWS API Documentation
Request Syntax
client.list_sync_resources(
workspaceId='string',
syncSource='string',
filters=[
{
'state': 'INITIALIZING'|'PROCESSING'|'DELETED'|'IN_SYNC'|'ERROR',
'resourceType': 'ENTITY'|'COMPONENT_TYPE',
'resourceId': 'string',
'externalId': 'string'
},
],
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The ID of the workspace that contains the sync job.
string
[REQUIRED]
The sync soucre.
Note
Currently the only supported syncSoucre is SITEWISE .
list
A list of objects that filter the request.
(dict) --
The sync resource filter.
state (string) --
The sync resource filter's state.
resourceType (string) --
The sync resource filter resoucre type
resourceId (string) --
The sync resource filter resource Id.
externalId (string) --
The external Id.
integer
The maximum number of results to return at one time. The default is 50.
Valid Range: Minimum value of 0. Maximum value of 200.
string
The string that specifies the next page of results.
dict
Response Syntax
{
'syncResources': [
{
'resourceType': 'ENTITY'|'COMPONENT_TYPE',
'externalId': 'string',
'resourceId': 'string',
'status': {
'state': 'INITIALIZING'|'PROCESSING'|'DELETED'|'IN_SYNC'|'ERROR',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR',
'message': 'string'
}
},
'updateDateTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
syncResources (list) --
The sync resources.
(dict) --
The sync resource summary.
resourceType (string) --
The resource type.
externalId (string) --
The external Id.
resourceId (string) --
The resource Id.
status (dict) --
The sync resource summary status.
state (string) --
The sync resource status state.
error (dict) --
The status error.
code (string) --
The error code.
message (string) --
The error message.
updateDateTime (datetime) --
The update date and time.
nextToken (string) --
The string that specifies the next page of results.
{'componentTypeName': 'string',
'propertyDefinitions': {'displayName': 'string'}}
Creates a component type.
See also: AWS API Documentation
Request Syntax
client.create_component_type(
workspaceId='string',
isSingleton=True|False,
componentTypeId='string',
description='string',
propertyDefinitions={
'string': {
'dataType': {
'type': 'RELATIONSHIP'|'STRING'|'LONG'|'BOOLEAN'|'INTEGER'|'DOUBLE'|'LIST'|'MAP',
'nestedType': {'... recursive ...'},
'allowedValues': [
{
'booleanValue': True|False,
'doubleValue': 123.0,
'integerValue': 123,
'longValue': 123,
'stringValue': 'string',
'listValue': {'... recursive ...'},
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetEntityId': 'string',
'targetComponentName': 'string'
},
'expression': 'string'
},
],
'unitOfMeasure': 'string',
'relationship': {
'targetComponentTypeId': 'string',
'relationshipType': 'string'
}
},
'isRequiredInEntity': True|False,
'isExternalId': True|False,
'isStoredExternally': True|False,
'isTimeSeries': True|False,
'defaultValue': {
'booleanValue': True|False,
'doubleValue': 123.0,
'integerValue': 123,
'longValue': 123,
'stringValue': 'string',
'listValue': [
{'... recursive ...'},
],
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetEntityId': 'string',
'targetComponentName': 'string'
},
'expression': 'string'
},
'configuration': {
'string': 'string'
},
'displayName': 'string'
}
},
extendsFrom=[
'string',
],
functions={
'string': {
'requiredProperties': [
'string',
],
'scope': 'ENTITY'|'WORKSPACE',
'implementedBy': {
'lambda': {
'arn': 'string'
},
'isNative': True|False
}
}
},
tags={
'string': 'string'
},
propertyGroups={
'string': {
'groupType': 'TABULAR',
'propertyNames': [
'string',
]
}
},
componentTypeName='string'
)
string
[REQUIRED]
The ID of the workspace that contains the component type.
boolean
A Boolean value that specifies whether an entity can have more than one component of this type.
string
[REQUIRED]
The ID of the component type.
string
The description of the component type.
dict
An object that maps strings to the property definitions 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.
dataType (dict) --
An object that contains information about the data type.
type (string) -- [REQUIRED]
The underlying type of the data type.
nestedType (dict) --
The nested type in 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.
integerValue (integer) --
An integer value.
longValue (integer) --
A long value.
stringValue (string) --
A string value.
listValue (list) --
A list of multiple values.
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.
unitOfMeasure (string) --
The unit of measure used in this data type.
relationship (dict) --
A relationship that associates a component with another component.
targetComponentTypeId (string) --
The ID of the target component type associated with this relationship.
relationshipType (string) --
The type of the relationship.
isRequiredInEntity (boolean) --
A Boolean value that specifies whether the property is required.
isExternalId (boolean) --
A Boolean value that specifies whether the property ID comes from an external data store.
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.
defaultValue (dict) --
An object that contains the default value.
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.
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) --
displayName (string) --
A friendly name for the property.
list
Specifies the parent component type to extend.
(string) --
dict
An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.
(string) --
(dict) --
The function request body.
requiredProperties (list) --
The required properties of the function.
(string) --
scope (string) --
The scope of the function.
implementedBy (dict) --
The data connector.
lambda (dict) --
The Lambda function associated with this data connector.
arn (string) -- [REQUIRED]
The ARN of the Lambda function.
isNative (boolean) --
A Boolean value that specifies whether the data connector is native to IoT TwinMaker.
dict
Metadata that you can use to manage the component type.
(string) --
(string) --
dict
(string) --
(dict) --
groupType (string) --
The group type.
propertyNames (list) --
The names of properties.
(string) --
string
A friendly name for the component type.
dict
Response Syntax
{
'arn': 'string',
'creationDateTime': datetime(2015, 1, 1),
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR'
}
Response Structure
(dict) --
arn (string) --
The ARN of the component type.
creationDateTime (datetime) --
The date and time when the entity was created.
state (string) --
The current state of the component type.
{'components': {'properties': {'definition': {'displayName': 'string'}}}}
Creates an entity.
See also: AWS API Documentation
Request Syntax
client.create_entity(
workspaceId='string',
entityId='string',
entityName='string',
description='string',
components={
'string': {
'description': 'string',
'componentTypeId': 'string',
'properties': {
'string': {
'definition': {
'dataType': {
'type': 'RELATIONSHIP'|'STRING'|'LONG'|'BOOLEAN'|'INTEGER'|'DOUBLE'|'LIST'|'MAP',
'nestedType': {'... recursive ...'},
'allowedValues': [
{
'booleanValue': True|False,
'doubleValue': 123.0,
'integerValue': 123,
'longValue': 123,
'stringValue': 'string',
'listValue': {'... recursive ...'},
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetEntityId': 'string',
'targetComponentName': 'string'
},
'expression': 'string'
},
],
'unitOfMeasure': 'string',
'relationship': {
'targetComponentTypeId': 'string',
'relationshipType': 'string'
}
},
'isRequiredInEntity': True|False,
'isExternalId': True|False,
'isStoredExternally': True|False,
'isTimeSeries': True|False,
'defaultValue': {
'booleanValue': True|False,
'doubleValue': 123.0,
'integerValue': 123,
'longValue': 123,
'stringValue': 'string',
'listValue': [
{'... recursive ...'},
],
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetEntityId': 'string',
'targetComponentName': 'string'
},
'expression': 'string'
},
'configuration': {
'string': 'string'
},
'displayName': 'string'
},
'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'
},
'updateType': 'UPDATE'|'DELETE'|'CREATE'
}
},
'propertyGroups': {
'string': {
'groupType': 'TABULAR',
'propertyNames': [
'string',
],
'updateType': 'UPDATE'|'DELETE'|'CREATE'
}
}
}
},
parentEntityId='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
The ID of the workspace that contains the entity.
string
The ID of the entity.
string
[REQUIRED]
The name of the entity.
string
The description of the entity.
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.
description (string) --
The description of the component request.
componentTypeId (string) --
The ID of the component type.
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.
dataType (dict) --
An object that contains information about the data type.
type (string) -- [REQUIRED]
The underlying type of the data type.
nestedType (dict) --
The nested type in 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.
integerValue (integer) --
An integer value.
longValue (integer) --
A long value.
stringValue (string) --
A string value.
listValue (list) --
A list of multiple values.
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.
unitOfMeasure (string) --
The unit of measure used in this data type.
relationship (dict) --
A relationship that associates a component with another component.
targetComponentTypeId (string) --
The ID of the target component type associated with this relationship.
relationshipType (string) --
The type of the relationship.
isRequiredInEntity (boolean) --
A Boolean value that specifies whether the property is required.
isExternalId (boolean) --
A Boolean value that specifies whether the property ID comes from an external data store.
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.
defaultValue (dict) --
An object that contains the default value.
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.
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) --
displayName (string) --
A friendly name for the property.
value (dict) --
The value of the 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.
updateType (string) --
The update type of the update property request.
propertyGroups (dict) --
The property groups.
(string) --
(dict) --
groupType (string) --
The group type.
propertyNames (list) --
The property names.
(string) --
updateType (string) --
The update type.
string
The ID of the entity's parent entity.
dict
Metadata that you can use to manage the entity.
(string) --
(string) --
dict
Response Syntax
{
'entityId': 'string',
'arn': 'string',
'creationDateTime': datetime(2015, 1, 1),
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR'
}
Response Structure
(dict) --
entityId (string) --
The ID of the entity.
arn (string) --
The ARN of the entity.
creationDateTime (datetime) --
The date and time when the entity was created.
state (string) --
The current state of the entity.
{'componentTypeName': 'string',
'propertyDefinitions': {'displayName': 'string'},
'status': {'error': {'code': {'SYNC_CREATING_ERROR',
'SYNC_INITIALIZING_ERROR',
'SYNC_PROCESSING_ERROR'}}},
'syncSource': 'string'}
Retrieves information about a component type.
See also: AWS API Documentation
Request Syntax
client.get_component_type(
workspaceId='string',
componentTypeId='string'
)
string
[REQUIRED]
The ID of the workspace that contains the component type.
string
[REQUIRED]
The ID of the component type.
dict
Response Syntax
{
'workspaceId': 'string',
'isSingleton': True|False,
'componentTypeId': 'string',
'description': 'string',
'propertyDefinitions': {
'string': {
'dataType': {
'type': 'RELATIONSHIP'|'STRING'|'LONG'|'BOOLEAN'|'INTEGER'|'DOUBLE'|'LIST'|'MAP',
'nestedType': {'... recursive ...'},
'allowedValues': [
{
'booleanValue': True|False,
'doubleValue': 123.0,
'integerValue': 123,
'longValue': 123,
'stringValue': 'string',
'listValue': {'... recursive ...'},
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetEntityId': 'string',
'targetComponentName': 'string'
},
'expression': 'string'
},
],
'unitOfMeasure': 'string',
'relationship': {
'targetComponentTypeId': 'string',
'relationshipType': 'string'
}
},
'isTimeSeries': True|False,
'isRequiredInEntity': True|False,
'isExternalId': True|False,
'isStoredExternally': True|False,
'isImported': True|False,
'isFinal': True|False,
'isInherited': True|False,
'defaultValue': {
'booleanValue': True|False,
'doubleValue': 123.0,
'integerValue': 123,
'longValue': 123,
'stringValue': 'string',
'listValue': [
{'... recursive ...'},
],
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetEntityId': 'string',
'targetComponentName': 'string'
},
'expression': 'string'
},
'configuration': {
'string': 'string'
},
'displayName': 'string'
}
},
'extendsFrom': [
'string',
],
'functions': {
'string': {
'requiredProperties': [
'string',
],
'scope': 'ENTITY'|'WORKSPACE',
'implementedBy': {
'lambda': {
'arn': 'string'
},
'isNative': True|False
},
'isInherited': True|False
}
},
'creationDateTime': datetime(2015, 1, 1),
'updateDateTime': datetime(2015, 1, 1),
'arn': 'string',
'isAbstract': True|False,
'isSchemaInitialized': True|False,
'status': {
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR',
'message': 'string'
}
},
'propertyGroups': {
'string': {
'groupType': 'TABULAR',
'propertyNames': [
'string',
],
'isInherited': True|False
}
},
'syncSource': 'string',
'componentTypeName': 'string'
}
Response Structure
(dict) --
workspaceId (string) --
The ID of the workspace that contains the component type.
isSingleton (boolean) --
A Boolean value that specifies whether an entity can have more than one component of this type.
componentTypeId (string) --
The ID of the component type.
description (string) --
The description of the component type.
propertyDefinitions (dict) --
An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.
(string) --
(dict) --
An object that contains response data from a property definition request.
dataType (dict) --
An object that contains information about the data type.
type (string) --
The underlying type of the data type.
nestedType (dict) --
The nested type in 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.
integerValue (integer) --
An integer value.
longValue (integer) --
A long value.
stringValue (string) --
A string value.
listValue (list) --
A list of multiple values.
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.
unitOfMeasure (string) --
The unit of measure used in this data type.
relationship (dict) --
A relationship that associates a component with another component.
targetComponentTypeId (string) --
The ID of the target component type associated with this relationship.
relationshipType (string) --
The type of the relationship.
isTimeSeries (boolean) --
A Boolean value that specifies whether the property consists of time series data.
isRequiredInEntity (boolean) --
A Boolean value that specifies whether the property is required in an entity.
isExternalId (boolean) --
A Boolean value that specifies whether the property ID comes from an external data store.
isStoredExternally (boolean) --
A Boolean value that specifies whether the property is stored externally.
isImported (boolean) --
A Boolean value that specifies whether the property definition is imported from an external data store.
isFinal (boolean) --
A Boolean value that specifies whether the property definition can be updated.
isInherited (boolean) --
A Boolean value that specifies whether the property definition is inherited from a parent entity.
defaultValue (dict) --
An object that contains the default value.
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.
configuration (dict) --
A mapping that specifies configuration information about the property.
(string) --
(string) --
displayName (string) --
A friendly name for the property.
extendsFrom (list) --
The name of the parent component type that this component type extends.
(string) --
functions (dict) --
An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.
(string) --
(dict) --
The function response.
requiredProperties (list) --
The required properties of the function.
(string) --
scope (string) --
The scope of the function.
implementedBy (dict) --
The data connector.
lambda (dict) --
The Lambda function associated with this data connector.
arn (string) --
The ARN of the Lambda function.
isNative (boolean) --
A Boolean value that specifies whether the data connector is native to IoT TwinMaker.
isInherited (boolean) --
Indicates whether this function is inherited.
creationDateTime (datetime) --
The date and time when the component type was created.
updateDateTime (datetime) --
The date and time when the component was last updated.
arn (string) --
The ARN of the component type.
isAbstract (boolean) --
A Boolean value that specifies whether the component type is abstract.
isSchemaInitialized (boolean) --
A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.
status (dict) --
The current status of the component type.
state (string) --
The current state of the entity, component, component type, or workspace.
error (dict) --
The error message.
code (string) --
The error code.
message (string) --
The error message.
propertyGroups (dict) --
The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
(string) --
(dict) --
The property group response
groupType (string) --
The group types.
propertyNames (list) --
The names of properties.
(string) --
isInherited (boolean) --
A Boolean value that specifies whether the property group is inherited from a parent entity
syncSource (string) --
The syncSource of the sync job, if this entity was created by a sync job.
componentTypeName (string) --
The component type name.
{'components': {'properties': {'definition': {'displayName': 'string'}},
'status': {'error': {'code': {'SYNC_CREATING_ERROR',
'SYNC_INITIALIZING_ERROR',
'SYNC_PROCESSING_ERROR'}}},
'syncSource': 'string'},
'status': {'error': {'code': {'SYNC_CREATING_ERROR',
'SYNC_INITIALIZING_ERROR',
'SYNC_PROCESSING_ERROR'}}},
'syncSource': 'string'}
Retrieves information about an entity.
See also: AWS API Documentation
Request Syntax
client.get_entity(
workspaceId='string',
entityId='string'
)
string
[REQUIRED]
The ID of the workspace.
string
[REQUIRED]
The ID of the entity.
dict
Response Syntax
{
'entityId': 'string',
'entityName': 'string',
'arn': 'string',
'status': {
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR',
'message': 'string'
}
},
'workspaceId': 'string',
'description': 'string',
'components': {
'string': {
'componentName': 'string',
'description': 'string',
'componentTypeId': 'string',
'status': {
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR',
'message': 'string'
}
},
'definedIn': 'string',
'properties': {
'string': {
'definition': {
'dataType': {
'type': 'RELATIONSHIP'|'STRING'|'LONG'|'BOOLEAN'|'INTEGER'|'DOUBLE'|'LIST'|'MAP',
'nestedType': {'... recursive ...'},
'allowedValues': [
{
'booleanValue': True|False,
'doubleValue': 123.0,
'integerValue': 123,
'longValue': 123,
'stringValue': 'string',
'listValue': {'... recursive ...'},
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetEntityId': 'string',
'targetComponentName': 'string'
},
'expression': 'string'
},
],
'unitOfMeasure': 'string',
'relationship': {
'targetComponentTypeId': 'string',
'relationshipType': 'string'
}
},
'isTimeSeries': True|False,
'isRequiredInEntity': True|False,
'isExternalId': True|False,
'isStoredExternally': True|False,
'isImported': True|False,
'isFinal': True|False,
'isInherited': True|False,
'defaultValue': {
'booleanValue': True|False,
'doubleValue': 123.0,
'integerValue': 123,
'longValue': 123,
'stringValue': 'string',
'listValue': [
{'... recursive ...'},
],
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetEntityId': 'string',
'targetComponentName': 'string'
},
'expression': 'string'
},
'configuration': {
'string': 'string'
},
'displayName': 'string'
},
'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'
}
}
},
'propertyGroups': {
'string': {
'groupType': 'TABULAR',
'propertyNames': [
'string',
],
'isInherited': True|False
}
},
'syncSource': 'string'
}
},
'parentEntityId': 'string',
'hasChildEntities': True|False,
'creationDateTime': datetime(2015, 1, 1),
'updateDateTime': datetime(2015, 1, 1),
'syncSource': 'string'
}
Response Structure
(dict) --
entityId (string) --
The ID of the entity.
entityName (string) --
The name of the entity.
arn (string) --
The ARN of the entity.
status (dict) --
The current status of the entity.
state (string) --
The current state of the entity, component, component type, or workspace.
error (dict) --
The error message.
code (string) --
The error code.
message (string) --
The error message.
workspaceId (string) --
The ID of the workspace.
description (string) --
The description of the entity.
components (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 returns information about a component type create or update request.
componentName (string) --
The name of the component.
description (string) --
The description of the component type.
componentTypeId (string) --
The ID of the component type.
status (dict) --
The status of the component type.
state (string) --
The current state of the entity, component, component type, or workspace.
error (dict) --
The error message.
code (string) --
The error code.
message (string) --
The error message.
definedIn (string) --
The name of the property definition set in the 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 contains information about a property response.
definition (dict) --
An object that specifies information about a property.
dataType (dict) --
An object that contains information about the data type.
type (string) --
The underlying type of the data type.
nestedType (dict) --
The nested type in 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.
integerValue (integer) --
An integer value.
longValue (integer) --
A long value.
stringValue (string) --
A string value.
listValue (list) --
A list of multiple values.
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.
unitOfMeasure (string) --
The unit of measure used in this data type.
relationship (dict) --
A relationship that associates a component with another component.
targetComponentTypeId (string) --
The ID of the target component type associated with this relationship.
relationshipType (string) --
The type of the relationship.
isTimeSeries (boolean) --
A Boolean value that specifies whether the property consists of time series data.
isRequiredInEntity (boolean) --
A Boolean value that specifies whether the property is required in an entity.
isExternalId (boolean) --
A Boolean value that specifies whether the property ID comes from an external data store.
isStoredExternally (boolean) --
A Boolean value that specifies whether the property is stored externally.
isImported (boolean) --
A Boolean value that specifies whether the property definition is imported from an external data store.
isFinal (boolean) --
A Boolean value that specifies whether the property definition can be updated.
isInherited (boolean) --
A Boolean value that specifies whether the property definition is inherited from a parent entity.
defaultValue (dict) --
An object that contains the default value.
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.
configuration (dict) --
A mapping that specifies configuration information about the property.
(string) --
(string) --
displayName (string) --
A friendly name for the property.
value (dict) --
The value of the 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.
propertyGroups (dict) --
The property groups.
(string) --
(dict) --
The component property group response.
groupType (string) --
The group type.
propertyNames (list) --
The names of properties
(string) --
isInherited (boolean) --
A Boolean value that specifies whether the property group is inherited from a parent entity
syncSource (string) --
The syncSource of the sync job, if this entity was created by a sync job.
parentEntityId (string) --
The ID of the parent entity for this entity.
hasChildEntities (boolean) --
A Boolean value that specifies whether the entity has associated child entities.
creationDateTime (datetime) --
The date and time when the entity was created.
updateDateTime (datetime) --
The date and time when the entity was last updated.
syncSource (string) --
The syncSource of the sync job, if this entity was created by a sync job.
{'componentTypeSummaries': {'componentTypeName': 'string',
'status': {'error': {'code': {'SYNC_CREATING_ERROR',
'SYNC_INITIALIZING_ERROR',
'SYNC_PROCESSING_ERROR'}}}}}
Lists all component types in a workspace.
See also: AWS API Documentation
Request Syntax
client.list_component_types(
workspaceId='string',
filters=[
{
'extendsFrom': 'string',
'namespace': 'string',
'isAbstract': True|False
},
],
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The ID of the workspace.
list
A list of objects that filter the request.
(dict) --
An object that filters items in a list of component types.
Note
Only one object is accepted as a valid input.
extendsFrom (string) --
The component type that the component types in the list extend.
namespace (string) --
The namespace to which the component types in the list belong.
isAbstract (boolean) --
A Boolean value that specifies whether the component types in the list are abstract.
string
The string that specifies the next page of results.
integer
The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
dict
Response Syntax
{
'workspaceId': 'string',
'componentTypeSummaries': [
{
'arn': 'string',
'componentTypeId': 'string',
'creationDateTime': datetime(2015, 1, 1),
'updateDateTime': datetime(2015, 1, 1),
'description': 'string',
'status': {
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR',
'message': 'string'
}
},
'componentTypeName': 'string'
},
],
'nextToken': 'string',
'maxResults': 123
}
Response Structure
(dict) --
workspaceId (string) --
The ID of the workspace.
componentTypeSummaries (list) --
A list of objects that contain information about the component types.
(dict) --
An object that contains information about a component type.
arn (string) --
The ARN of the component type.
componentTypeId (string) --
The ID of the component type.
creationDateTime (datetime) --
The date and time when the component type was created.
updateDateTime (datetime) --
The date and time when the component type was last updated.
description (string) --
The description of the component type.
status (dict) --
The current status of the component type.
state (string) --
The current state of the entity, component, component type, or workspace.
error (dict) --
The error message.
code (string) --
The error code.
message (string) --
The error message.
componentTypeName (string) --
The component type name.
nextToken (string) --
The string that specifies the next page of results.
maxResults (integer) --
Specifies the maximum number of results to display.
{'entitySummaries': {'status': {'error': {'code': {'SYNC_CREATING_ERROR',
'SYNC_INITIALIZING_ERROR',
'SYNC_PROCESSING_ERROR'}}}}}
Lists all entities in a workspace.
See also: AWS API Documentation
Request Syntax
client.list_entities(
workspaceId='string',
filters=[
{
'parentEntityId': 'string',
'componentTypeId': 'string',
'externalId': 'string'
},
],
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The ID of the workspace.
list
A list of objects that filter the request.
Note
Only one object is accepted as a valid input.
(dict) --
An object that filters items in a list of entities.
parentEntityId (string) --
The parent of the entities in the list.
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.
integer
The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
string
The string that specifies the next page of results.
dict
Response Syntax
{
'entitySummaries': [
{
'entityId': 'string',
'entityName': 'string',
'arn': 'string',
'parentEntityId': 'string',
'status': {
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR',
'message': 'string'
}
},
'description': 'string',
'hasChildEntities': True|False,
'creationDateTime': datetime(2015, 1, 1),
'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.
entityId (string) --
The ID of the entity.
entityName (string) --
The name of the entity.
arn (string) --
The ARN of the entity.
parentEntityId (string) --
The ID of the parent entity.
status (dict) --
The current status of the entity.
state (string) --
The current state of the entity, component, component type, or workspace.
error (dict) --
The error message.
code (string) --
The error code.
message (string) --
The error message.
description (string) --
The description of the entity.
hasChildEntities (boolean) --
A Boolean value that specifies whether the entity has child entities or not.
creationDateTime (datetime) --
The date and time when the entity was created.
updateDateTime (datetime) --
The last date and time when the entity was updated.
nextToken (string) --
The string that specifies the next page of results.
{'componentTypeName': 'string',
'propertyDefinitions': {'displayName': 'string'}}
Updates information in a component type.
See also: AWS API Documentation
Request Syntax
client.update_component_type(
workspaceId='string',
isSingleton=True|False,
componentTypeId='string',
description='string',
propertyDefinitions={
'string': {
'dataType': {
'type': 'RELATIONSHIP'|'STRING'|'LONG'|'BOOLEAN'|'INTEGER'|'DOUBLE'|'LIST'|'MAP',
'nestedType': {'... recursive ...'},
'allowedValues': [
{
'booleanValue': True|False,
'doubleValue': 123.0,
'integerValue': 123,
'longValue': 123,
'stringValue': 'string',
'listValue': {'... recursive ...'},
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetEntityId': 'string',
'targetComponentName': 'string'
},
'expression': 'string'
},
],
'unitOfMeasure': 'string',
'relationship': {
'targetComponentTypeId': 'string',
'relationshipType': 'string'
}
},
'isRequiredInEntity': True|False,
'isExternalId': True|False,
'isStoredExternally': True|False,
'isTimeSeries': True|False,
'defaultValue': {
'booleanValue': True|False,
'doubleValue': 123.0,
'integerValue': 123,
'longValue': 123,
'stringValue': 'string',
'listValue': [
{'... recursive ...'},
],
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetEntityId': 'string',
'targetComponentName': 'string'
},
'expression': 'string'
},
'configuration': {
'string': 'string'
},
'displayName': 'string'
}
},
extendsFrom=[
'string',
],
functions={
'string': {
'requiredProperties': [
'string',
],
'scope': 'ENTITY'|'WORKSPACE',
'implementedBy': {
'lambda': {
'arn': 'string'
},
'isNative': True|False
}
}
},
propertyGroups={
'string': {
'groupType': 'TABULAR',
'propertyNames': [
'string',
]
}
},
componentTypeName='string'
)
string
[REQUIRED]
The ID of the workspace.
boolean
A Boolean value that specifies whether an entity can have more than one component of this type.
string
[REQUIRED]
The ID of the component type.
string
The description of the component type.
dict
An object that maps strings to the property definitions 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.
dataType (dict) --
An object that contains information about the data type.
type (string) -- [REQUIRED]
The underlying type of the data type.
nestedType (dict) --
The nested type in 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.
integerValue (integer) --
An integer value.
longValue (integer) --
A long value.
stringValue (string) --
A string value.
listValue (list) --
A list of multiple values.
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.
unitOfMeasure (string) --
The unit of measure used in this data type.
relationship (dict) --
A relationship that associates a component with another component.
targetComponentTypeId (string) --
The ID of the target component type associated with this relationship.
relationshipType (string) --
The type of the relationship.
isRequiredInEntity (boolean) --
A Boolean value that specifies whether the property is required.
isExternalId (boolean) --
A Boolean value that specifies whether the property ID comes from an external data store.
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.
defaultValue (dict) --
An object that contains the default value.
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.
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) --
displayName (string) --
A friendly name for the property.
list
Specifies the component type that this component type extends.
(string) --
dict
An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.
(string) --
(dict) --
The function request body.
requiredProperties (list) --
The required properties of the function.
(string) --
scope (string) --
The scope of the function.
implementedBy (dict) --
The data connector.
lambda (dict) --
The Lambda function associated with this data connector.
arn (string) -- [REQUIRED]
The ARN of the Lambda function.
isNative (boolean) --
A Boolean value that specifies whether the data connector is native to IoT TwinMaker.
dict
The property groups
(string) --
(dict) --
groupType (string) --
The group type.
propertyNames (list) --
The names of properties.
(string) --
string
The component type name.
dict
Response Syntax
{
'workspaceId': 'string',
'arn': 'string',
'componentTypeId': 'string',
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR'
}
Response Structure
(dict) --
workspaceId (string) --
The ID of the workspace that contains the component type.
arn (string) --
The ARN of the component type.
componentTypeId (string) --
The ID of the component type.
state (string) --
The current state of the component type.
{'componentUpdates': {'propertyUpdates': {'definition': {'displayName': 'string'}}}}
Updates an entity.
See also: AWS API Documentation
Request Syntax
client.update_entity(
workspaceId='string',
entityId='string',
entityName='string',
description='string',
componentUpdates={
'string': {
'updateType': 'CREATE'|'UPDATE'|'DELETE',
'description': 'string',
'componentTypeId': 'string',
'propertyUpdates': {
'string': {
'definition': {
'dataType': {
'type': 'RELATIONSHIP'|'STRING'|'LONG'|'BOOLEAN'|'INTEGER'|'DOUBLE'|'LIST'|'MAP',
'nestedType': {'... recursive ...'},
'allowedValues': [
{
'booleanValue': True|False,
'doubleValue': 123.0,
'integerValue': 123,
'longValue': 123,
'stringValue': 'string',
'listValue': {'... recursive ...'},
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetEntityId': 'string',
'targetComponentName': 'string'
},
'expression': 'string'
},
],
'unitOfMeasure': 'string',
'relationship': {
'targetComponentTypeId': 'string',
'relationshipType': 'string'
}
},
'isRequiredInEntity': True|False,
'isExternalId': True|False,
'isStoredExternally': True|False,
'isTimeSeries': True|False,
'defaultValue': {
'booleanValue': True|False,
'doubleValue': 123.0,
'integerValue': 123,
'longValue': 123,
'stringValue': 'string',
'listValue': [
{'... recursive ...'},
],
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetEntityId': 'string',
'targetComponentName': 'string'
},
'expression': 'string'
},
'configuration': {
'string': 'string'
},
'displayName': 'string'
},
'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'
},
'updateType': 'UPDATE'|'DELETE'|'CREATE'
}
},
'propertyGroupUpdates': {
'string': {
'groupType': 'TABULAR',
'propertyNames': [
'string',
],
'updateType': 'UPDATE'|'DELETE'|'CREATE'
}
}
}
},
parentEntityUpdate={
'updateType': 'UPDATE'|'DELETE',
'parentEntityId': 'string'
}
)
string
[REQUIRED]
The ID of the workspace that contains the entity.
string
[REQUIRED]
The ID of the entity.
string
The name of the entity.
string
The description of the entity.
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.
updateType (string) --
The update type of the component update request.
description (string) --
The description of the component type.
componentTypeId (string) --
The ID 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.
dataType (dict) --
An object that contains information about the data type.
type (string) -- [REQUIRED]
The underlying type of the data type.
nestedType (dict) --
The nested type in 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.
integerValue (integer) --
An integer value.
longValue (integer) --
A long value.
stringValue (string) --
A string value.
listValue (list) --
A list of multiple values.
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.
unitOfMeasure (string) --
The unit of measure used in this data type.
relationship (dict) --
A relationship that associates a component with another component.
targetComponentTypeId (string) --
The ID of the target component type associated with this relationship.
relationshipType (string) --
The type of the relationship.
isRequiredInEntity (boolean) --
A Boolean value that specifies whether the property is required.
isExternalId (boolean) --
A Boolean value that specifies whether the property ID comes from an external data store.
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.
defaultValue (dict) --
An object that contains the default value.
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.
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) --
displayName (string) --
A friendly name for the property.
value (dict) --
The value of the 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.
updateType (string) --
The update type of the update property request.
propertyGroupUpdates (dict) --
The property group updates.
(string) --
(dict) --
groupType (string) --
The group type.
propertyNames (list) --
The property names.
(string) --
updateType (string) --
The update type.
dict
An object that describes the update request for a parent entity.
updateType (string) -- [REQUIRED]
The type of the update.
parentEntityId (string) --
The ID of the parent entity.
dict
Response Syntax
{
'updateDateTime': datetime(2015, 1, 1),
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR'
}
Response Structure
(dict) --
updateDateTime (datetime) --
The date and time when the entity was last updated.
state (string) --
The current state of the entity update.