2023/11/21 - AWS IoT TwinMaker - 6 new 18 updated api methods
Changes This release adds following support. 1. New APIs for metadata bulk operations. 2. Modify the component type API to support composite component types - nesting component types within one another. 3. New list APIs for components and properties. 4. Support the larger scope digital twin modeling.
This API lists the properties of a component.
See also: AWS API Documentation
Request Syntax
client.list_properties(
workspaceId='string',
componentName='string',
componentPath='string',
entityId='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The workspace ID.
string
The name of the component whose properties are returned by the operation.
string
This string specifies the path to the composite component, starting from the top-level component.
string
[REQUIRED]
The ID for the entity whose metadata (component/properties) is returned by the operation.
integer
The maximum number of results returned at one time. The default is 25.
string
The string that specifies the next page of results.
dict
Response Syntax
{
'propertySummaries': [
{
'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'
},
'propertyName': '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'
},
'areAllPropertyValuesReturned': True|False
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
propertySummaries (list) --
A list of objects that contain information about the properties.
(dict) --
This is an object that contains the information of a property.
definition (dict) --
This is the schema for the 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.
propertyName (string) --
This is the name of the property.
value (dict) --
This is the value for 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.
areAllPropertyValuesReturned (boolean) --
This flag notes whether all values of a list or map type property are returned in the API response. The maximum number of values per property returned is 50.
nextToken (string) --
The string that specifies the next page of property results.
This API lists the components of an entity.
See also: AWS API Documentation
Request Syntax
client.list_components(
workspaceId='string',
entityId='string',
componentPath='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The workspace ID.
string
[REQUIRED]
The ID for the entity whose metadata (component/properties) is returned by the operation.
string
This string specifies the path to the composite component, starting from the top-level component.
integer
The maximum number of results returned at one time. The default is 25.
string
The string that specifies the next page of results.
dict
Response Syntax
{
'componentSummaries': [
{
'componentName': 'string',
'componentTypeId': 'string',
'definedIn': 'string',
'description': 'string',
'propertyGroups': {
'string': {
'groupType': 'TABULAR',
'propertyNames': [
'string',
],
'isInherited': True|False
}
},
'status': {
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR'|'SYNC_DELETING_ERROR'|'PROCESSING_ERROR'|'COMPOSITE_COMPONENT_FAILURE',
'message': 'string'
}
},
'syncSource': 'string',
'componentPath': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
componentSummaries (list) --
A list of objects that contain information about the components.
(dict) --
An object that returns information about a component summary.
componentName (string) --
The name of the component.
componentTypeId (string) --
The ID of the component type.
definedIn (string) --
The name of the property definition set in the request.
description (string) --
The description of the component request.
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
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.
syncSource (string) --
The syncSource of the sync job, if this entity was created by a sync job.
componentPath (string) --
This string specifies the path to the composite component, starting from the top-level component.
nextToken (string) --
The string that specifies the next page of component results.
Cancels the metadata transfer job.
See also: AWS API Documentation
Request Syntax
client.cancel_metadata_transfer_job(
metadataTransferJobId='string'
)
string
[REQUIRED]
The metadata transfer job Id.
dict
Response Syntax
{
'metadataTransferJobId': 'string',
'arn': 'string',
'updateDateTime': datetime(2015, 1, 1),
'status': {
'state': 'VALIDATING'|'PENDING'|'RUNNING'|'CANCELLING'|'ERROR'|'COMPLETED'|'CANCELLED',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR'|'SYNC_DELETING_ERROR'|'PROCESSING_ERROR'|'COMPOSITE_COMPONENT_FAILURE',
'message': 'string'
},
'queuedPosition': 123
},
'progress': {
'totalCount': 123,
'succeededCount': 123,
'skippedCount': 123,
'failedCount': 123
}
}
Response Structure
(dict) --
metadataTransferJobId (string) --
The metadata transfer job Id.
arn (string) --
The metadata transfer job ARN.
updateDateTime (datetime) --
Used to update the DateTime property.
status (dict) --
The metadata transfer job's status.
state (string) --
The metadata transfer job state.
error (dict) --
The metadata transfer job error.
code (string) --
The error code.
message (string) --
The error message.
queuedPosition (integer) --
The queued position.
progress (dict) --
The metadata transfer job's progress.
totalCount (integer) --
The total count. [of what]
succeededCount (integer) --
The succeeded count.
skippedCount (integer) --
The skipped count.
failedCount (integer) --
The failed count.
Creates a new metadata transfer job.
See also: AWS API Documentation
Request Syntax
client.create_metadata_transfer_job(
metadataTransferJobId='string',
description='string',
sources=[
{
'type': 's3'|'iotsitewise'|'iottwinmaker',
's3Configuration': {
'location': 'string'
},
'iotSiteWiseConfiguration': {
'filters': [
{
'filterByAssetModel': {
'assetModelId': 'string',
'assetModelExternalId': 'string',
'includeOffspring': True|False,
'includeAssets': True|False
},
'filterByAsset': {
'assetId': 'string',
'assetExternalId': 'string',
'includeOffspring': True|False,
'includeAssetModel': True|False
}
},
]
},
'iotTwinMakerConfiguration': {
'workspace': 'string',
'filters': [
{
'filterByComponentType': {
'componentTypeId': 'string'
},
'filterByEntity': {
'entityId': 'string'
}
},
]
}
},
],
destination={
'type': 's3'|'iotsitewise'|'iottwinmaker',
's3Configuration': {
'location': 'string'
},
'iotTwinMakerConfiguration': {
'workspace': 'string'
}
}
)
string
The metadata transfer job Id.
string
The metadata transfer job description.
list
[REQUIRED]
The metadata transfer job sources.
(dict) --
The source configuration.
type (string) -- [REQUIRED]
The source configuration type.
s3Configuration (dict) --
The source configuration S3 configuration.
location (string) -- [REQUIRED]
The S3 destination source configuration location.
iotSiteWiseConfiguration (dict) --
The source configuration IoT SiteWise configuration.
filters (list) --
The AWS IoT SiteWise soucre configuration filters.
(dict) --
The AWS IoT SiteWise soucre configuration filter.[need held with desc here]
filterByAssetModel (dict) --
Filter by asset model.
assetModelId (string) --
The asset model Id.
assetModelExternalId (string) --
The external-Id property of an asset model.
includeOffspring (boolean) --
Include asset offspring. [need desc.]
includeAssets (boolean) --
Bolean to include assets.
filterByAsset (dict) --
Filter by asset.
assetId (string) --
Filter by asset Id.
assetExternalId (string) --
The external-Id property of an asset.
includeOffspring (boolean) --
Includes sub-assets.[need description hekp for this]
includeAssetModel (boolean) --
Boolean to include the asset model.
iotTwinMakerConfiguration (dict) --
The source configuration IoT TwinMaker configuration.
workspace (string) -- [REQUIRED]
The IoT TwinMaker workspace.
filters (list) --
The metadata transfer job AWS IoT TwinMaker source configuration filters.
(dict) --
The metadata transfer job AWS IoT TwinMaker source configuration filter.
filterByComponentType (dict) --
Filter by component type.
componentTypeId (string) -- [REQUIRED]
The component type Id.
filterByEntity (dict) --
Filter by entity.
entityId (string) -- [REQUIRED]
The entity Id.
dict
[REQUIRED]
The metadata transfer job destination.
type (string) -- [REQUIRED]
The destination type.
s3Configuration (dict) --
The metadata transfer job S3 configuration. [need to add S3 entity]
location (string) -- [REQUIRED]
The S3 destination configuration location.
iotTwinMakerConfiguration (dict) --
The metadata transfer job Amazon Web Services IoT TwinMaker configuration.
workspace (string) -- [REQUIRED]
The IoT TwinMaker workspace.
dict
Response Syntax
{
'metadataTransferJobId': 'string',
'arn': 'string',
'creationDateTime': datetime(2015, 1, 1),
'status': {
'state': 'VALIDATING'|'PENDING'|'RUNNING'|'CANCELLING'|'ERROR'|'COMPLETED'|'CANCELLED',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR'|'SYNC_DELETING_ERROR'|'PROCESSING_ERROR'|'COMPOSITE_COMPONENT_FAILURE',
'message': 'string'
},
'queuedPosition': 123
}
}
Response Structure
(dict) --
metadataTransferJobId (string) --
The metadata transfer job Id.
arn (string) --
The metadata transfer job ARN.
creationDateTime (datetime) --
The The metadata transfer job creation DateTime property.
status (dict) --
The metadata transfer job response status.
state (string) --
The metadata transfer job state.
error (dict) --
The metadata transfer job error.
code (string) --
The error code.
message (string) --
The error message.
queuedPosition (integer) --
The queued position.
Gets a nmetadata transfer job.
See also: AWS API Documentation
Request Syntax
client.get_metadata_transfer_job(
metadataTransferJobId='string'
)
string
[REQUIRED]
The metadata transfer job Id.
dict
Response Syntax
{
'metadataTransferJobId': 'string',
'arn': 'string',
'description': 'string',
'sources': [
{
'type': 's3'|'iotsitewise'|'iottwinmaker',
's3Configuration': {
'location': 'string'
},
'iotSiteWiseConfiguration': {
'filters': [
{
'filterByAssetModel': {
'assetModelId': 'string',
'assetModelExternalId': 'string',
'includeOffspring': True|False,
'includeAssets': True|False
},
'filterByAsset': {
'assetId': 'string',
'assetExternalId': 'string',
'includeOffspring': True|False,
'includeAssetModel': True|False
}
},
]
},
'iotTwinMakerConfiguration': {
'workspace': 'string',
'filters': [
{
'filterByComponentType': {
'componentTypeId': 'string'
},
'filterByEntity': {
'entityId': 'string'
}
},
]
}
},
],
'destination': {
'type': 's3'|'iotsitewise'|'iottwinmaker',
's3Configuration': {
'location': 'string'
},
'iotTwinMakerConfiguration': {
'workspace': 'string'
}
},
'metadataTransferJobRole': 'string',
'reportUrl': 'string',
'creationDateTime': datetime(2015, 1, 1),
'updateDateTime': datetime(2015, 1, 1),
'status': {
'state': 'VALIDATING'|'PENDING'|'RUNNING'|'CANCELLING'|'ERROR'|'COMPLETED'|'CANCELLED',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR'|'SYNC_DELETING_ERROR'|'PROCESSING_ERROR'|'COMPOSITE_COMPONENT_FAILURE',
'message': 'string'
},
'queuedPosition': 123
},
'progress': {
'totalCount': 123,
'succeededCount': 123,
'skippedCount': 123,
'failedCount': 123
}
}
Response Structure
(dict) --
metadataTransferJobId (string) --
The metadata transfer job Id.
arn (string) --
The metadata transfer job ARN.
description (string) --
The metadata transfer job description.
sources (list) --
The metadata transfer job's sources.
(dict) --
The source configuration.
type (string) --
The source configuration type.
s3Configuration (dict) --
The source configuration S3 configuration.
location (string) --
The S3 destination source configuration location.
iotSiteWiseConfiguration (dict) --
The source configuration IoT SiteWise configuration.
filters (list) --
The AWS IoT SiteWise soucre configuration filters.
(dict) --
The AWS IoT SiteWise soucre configuration filter.[need held with desc here]
filterByAssetModel (dict) --
Filter by asset model.
assetModelId (string) --
The asset model Id.
assetModelExternalId (string) --
The external-Id property of an asset model.
includeOffspring (boolean) --
Include asset offspring. [need desc.]
includeAssets (boolean) --
Bolean to include assets.
filterByAsset (dict) --
Filter by asset.
assetId (string) --
Filter by asset Id.
assetExternalId (string) --
The external-Id property of an asset.
includeOffspring (boolean) --
Includes sub-assets.[need description hekp for this]
includeAssetModel (boolean) --
Boolean to include the asset model.
iotTwinMakerConfiguration (dict) --
The source configuration IoT TwinMaker configuration.
workspace (string) --
The IoT TwinMaker workspace.
filters (list) --
The metadata transfer job AWS IoT TwinMaker source configuration filters.
(dict) --
The metadata transfer job AWS IoT TwinMaker source configuration filter.
filterByComponentType (dict) --
Filter by component type.
componentTypeId (string) --
The component type Id.
filterByEntity (dict) --
Filter by entity.
entityId (string) --
The entity Id.
destination (dict) --
The metadata transfer job's destination.
type (string) --
The destination type.
s3Configuration (dict) --
The metadata transfer job S3 configuration. [need to add S3 entity]
location (string) --
The S3 destination configuration location.
iotTwinMakerConfiguration (dict) --
The metadata transfer job Amazon Web Services IoT TwinMaker configuration.
workspace (string) --
The IoT TwinMaker workspace.
metadataTransferJobRole (string) --
The metadata transfer job's role.
reportUrl (string) --
The metadata transfer job's report URL.
creationDateTime (datetime) --
The metadata transfer job's creation DateTime property.
updateDateTime (datetime) --
The metadata transfer job's update DateTime property.
status (dict) --
The metadata transfer job's status.
state (string) --
The metadata transfer job state.
error (dict) --
The metadata transfer job error.
code (string) --
The error code.
message (string) --
The error message.
queuedPosition (integer) --
The queued position.
progress (dict) --
The metadata transfer job's progress.
totalCount (integer) --
The total count. [of what]
succeededCount (integer) --
The succeeded count.
skippedCount (integer) --
The skipped count.
failedCount (integer) --
The failed count.
Lists the metadata transfer jobs.
See also: AWS API Documentation
Request Syntax
client.list_metadata_transfer_jobs(
sourceType='s3'|'iotsitewise'|'iottwinmaker',
destinationType='s3'|'iotsitewise'|'iottwinmaker',
filters=[
{
'workspaceId': 'string',
'state': 'VALIDATING'|'PENDING'|'RUNNING'|'CANCELLING'|'ERROR'|'COMPLETED'|'CANCELLED'
},
],
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The metadata transfer job's source type.
string
[REQUIRED]
The metadata transfer job's destination type.
list
An object that filters metadata transfer jobs.
(dict) --
The ListMetadataTransferJobs filter.
workspaceId (string) --
The workspace Id.
state (string) --
The filter state.
string
The string that specifies the next page of results.
integer
The maximum number of results to return at one time.
dict
Response Syntax
{
'metadataTransferJobSummaries': [
{
'metadataTransferJobId': 'string',
'arn': 'string',
'creationDateTime': datetime(2015, 1, 1),
'updateDateTime': datetime(2015, 1, 1),
'status': {
'state': 'VALIDATING'|'PENDING'|'RUNNING'|'CANCELLING'|'ERROR'|'COMPLETED'|'CANCELLED',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR'|'SYNC_DELETING_ERROR'|'PROCESSING_ERROR'|'COMPOSITE_COMPONENT_FAILURE',
'message': 'string'
},
'queuedPosition': 123
},
'progress': {
'totalCount': 123,
'succeededCount': 123,
'skippedCount': 123,
'failedCount': 123
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
metadataTransferJobSummaries (list) --
The metadata transfer job summaries.
(dict) --
The metadata transfer job summary.
metadataTransferJobId (string) --
The metadata transfer job summary Id.
arn (string) --
The metadata transfer job summary ARN.
creationDateTime (datetime) --
The metadata transfer job summary creation DateTime object.
updateDateTime (datetime) --
The metadata transfer job summary update DateTime object
status (dict) --
The metadata transfer job summary status.
state (string) --
The metadata transfer job state.
error (dict) --
The metadata transfer job error.
code (string) --
The error code.
message (string) --
The error message.
queuedPosition (integer) --
The queued position.
progress (dict) --
The metadata transfer job summary progess.
totalCount (integer) --
The total count. [of what]
succeededCount (integer) --
The succeeded count.
skippedCount (integer) --
The skipped count.
failedCount (integer) --
The failed count.
nextToken (string) --
The string that specifies the next page of results.
{'entries': {'entityPropertyReference': {'componentPath': 'string'}}}
Response {'errorEntries': {'errors': {'entry': {'entityPropertyReference': {'componentPath': 'string'}}}}}
Sets values for multiple time series properties.
See also: AWS API Documentation
Request Syntax
client.batch_put_property_values(
workspaceId='string',
entries=[
{
'entityPropertyReference': {
'componentName': 'string',
'componentPath': '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'
},
]
},
]
)
string
[REQUIRED]
The ID of the workspace that contains the properties to set.
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. This object is used and consumed by the BatchPutPropertyValues action.
entityPropertyReference (dict) -- [REQUIRED]
An object that contains information about the entity that has the property.
componentName (string) --
The name of the component.
componentPath (string) --
This string specifies the path to the composite component, starting from the top-level component.
externalIdProperty (dict) --
A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.
(string) --
(string) --
entityId (string) --
The ID of the entity.
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.
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.
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] .
[YYYY] : year
[MM] : month
[DD] : day
[hh] : hour
[mm] : minute
[ss] : seconds
[.SSSSSSSSS] : additional precision, where precedence is maintained. For example: [.573123] is equal to 573123000 nanoseconds.
Z : default timezone UTC
± HH:mm : time zone offset in Hours and Minutes.
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',
'componentPath': '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.
componentPath (string) --
This string specifies the path to the composite component, starting from the top-level component.
externalIdProperty (dict) --
A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.
(string) --
(string) --
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] .
[YYYY] : year
[MM] : month
[DD] : day
[hh] : hour
[mm] : minute
[ss] : seconds
[.SSSSSSSSS] : additional precision, where precedence is maintained. For example: [.573123] is equal to 573123000 nanoseconds.
Z : default timezone UTC
± HH:mm : time zone offset in Hours and Minutes.
Required sub-fields : YYYY-MM-DDThh:mm:ss and [Z/±HH:mm]
{'compositeComponentTypes': {'string': {'componentTypeId': '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',
compositeComponentTypes={
'string': {
'componentTypeId': '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
This is an object that maps strings to compositeComponentTypes of the componentType . CompositeComponentType is referenced by componentTypeId .
(string) --
(dict) --
An object that sets information about the composite component types of a component type.
componentTypeId (string) --
This is the componentTypeId that the compositeComponentType refers to.
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.
{'compositeComponents': {'string': {'description': 'string',
'properties': {'string': {'definition': {'configuration': {'string': 'string'},
'dataType': {'allowedValues': [{'booleanValue': 'boolean',
'doubleValue': 'double',
'expression': 'string',
'integerValue': 'integer',
'listValue': (),
'longValue': 'long',
'mapValue': {'string': ()},
'relationshipValue': {'targetComponentName': 'string',
'targetEntityId': 'string'},
'stringValue': 'string'}],
'nestedType': (),
'relationship': {'relationshipType': 'string',
'targetComponentTypeId': 'string'},
'type': 'RELATIONSHIP '
'| '
'STRING '
'| '
'LONG '
'| '
'BOOLEAN '
'| '
'INTEGER '
'| '
'DOUBLE '
'| '
'LIST '
'| '
'MAP',
'unitOfMeasure': 'string'},
'defaultValue': {'booleanValue': 'boolean',
'doubleValue': 'double',
'expression': 'string',
'integerValue': 'integer',
'listValue': [()],
'longValue': 'long',
'mapValue': {'string': ()},
'relationshipValue': {'targetComponentName': 'string',
'targetEntityId': 'string'},
'stringValue': 'string'},
'displayName': 'string',
'isExternalId': 'boolean',
'isRequiredInEntity': 'boolean',
'isStoredExternally': 'boolean',
'isTimeSeries': 'boolean'},
'updateType': 'UPDATE '
'| '
'DELETE '
'| '
'CREATE',
'value': {'booleanValue': 'boolean',
'doubleValue': 'double',
'expression': 'string',
'integerValue': 'integer',
'listValue': [()],
'longValue': 'long',
'mapValue': {'string': ()},
'relationshipValue': {'targetComponentName': 'string',
'targetEntityId': 'string'},
'stringValue': 'string'}}},
'propertyGroups': {'string': {'groupType': 'TABULAR',
'propertyNames': ['string'],
'updateType': 'UPDATE '
'| '
'DELETE '
'| '
'CREATE'}}}}}
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'
}
}
}
},
compositeComponents={
'string': {
'description': '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) --
The component property group request.
groupType (string) --
The group type.
propertyNames (list) --
The property names.
(string) --
updateType (string) --
The update type.
dict
This is an object that maps strings to compositeComponent updates in the request. Each key of the map represents the componentPath of the compositeComponent .
(string) --
(dict) --
An object that sets information about the composite component update request.
description (string) --
The description of the component type.
properties (dict) --
This is 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) --
The component property group request.
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.
{'message': 'string'}
Deletes a workspace.
See also: AWS API Documentation
Request Syntax
client.delete_workspace(
workspaceId='string'
)
string
[REQUIRED]
The ID of the workspace to delete.
dict
Response Syntax
{
'message': 'string'
}
Response Structure
(dict) --
message (string) --
The string that specifies the delete result for the workspace.
{'compositeComponentTypes': {'string': {'componentTypeId': 'string',
'isInherited': 'boolean'}},
'status': {'error': {'code': {'COMPOSITE_COMPONENT_FAILURE',
'PROCESSING_ERROR',
'SYNC_DELETING_ERROR'}}}}
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'|'SYNC_DELETING_ERROR'|'PROCESSING_ERROR'|'COMPOSITE_COMPONENT_FAILURE',
'message': 'string'
}
},
'propertyGroups': {
'string': {
'groupType': 'TABULAR',
'propertyNames': [
'string',
],
'isInherited': True|False
}
},
'syncSource': 'string',
'componentTypeName': 'string',
'compositeComponentTypes': {
'string': {
'componentTypeId': 'string',
'isInherited': True|False
}
}
}
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 SyncJob, if this entity was created by a SyncJob.
componentTypeName (string) --
The component type name.
compositeComponentTypes (dict) --
This is an object that maps strings to compositeComponentTypes of the componentType . CompositeComponentType is referenced by componentTypeId .
(string) --
(dict) --
An object that returns information about the composite component types of a component type.
componentTypeId (string) --
This is the componentTypeId that this compositeComponentType refers to.
isInherited (boolean) --
This boolean indicates whether this compositeComponentType is inherited from its parent.
{'areAllComponentsReturned': 'boolean',
'components': {'areAllCompositeComponentsReturned': 'boolean',
'areAllPropertiesReturned': 'boolean',
'compositeComponents': {'string': {'componentName': 'string',
'componentPath': 'string',
'componentTypeId': 'string',
'definedIn': 'string',
'description': 'string',
'propertyGroups': {'string': {'groupType': 'TABULAR',
'isInherited': 'boolean',
'propertyNames': ['string']}},
'status': {'error': {'code': 'VALIDATION_ERROR '
'| '
'INTERNAL_FAILURE '
'| '
'SYNC_INITIALIZING_ERROR '
'| '
'SYNC_CREATING_ERROR '
'| '
'SYNC_PROCESSING_ERROR '
'| '
'SYNC_DELETING_ERROR '
'| '
'PROCESSING_ERROR '
'| '
'COMPOSITE_COMPONENT_FAILURE',
'message': 'string'},
'state': 'CREATING '
'| '
'UPDATING '
'| '
'DELETING '
'| '
'ACTIVE '
'| '
'ERROR'},
'syncSource': 'string'}},
'properties': {'areAllPropertyValuesReturned': 'boolean'},
'status': {'error': {'code': {'COMPOSITE_COMPONENT_FAILURE',
'PROCESSING_ERROR',
'SYNC_DELETING_ERROR'}}}},
'status': {'error': {'code': {'COMPOSITE_COMPONENT_FAILURE',
'PROCESSING_ERROR',
'SYNC_DELETING_ERROR'}}}}
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'|'SYNC_DELETING_ERROR'|'PROCESSING_ERROR'|'COMPOSITE_COMPONENT_FAILURE',
'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'|'SYNC_DELETING_ERROR'|'PROCESSING_ERROR'|'COMPOSITE_COMPONENT_FAILURE',
'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'
},
'areAllPropertyValuesReturned': True|False
}
},
'propertyGroups': {
'string': {
'groupType': 'TABULAR',
'propertyNames': [
'string',
],
'isInherited': True|False
}
},
'syncSource': 'string',
'areAllPropertiesReturned': True|False,
'compositeComponents': {
'string': {
'componentName': 'string',
'componentTypeId': 'string',
'definedIn': 'string',
'description': 'string',
'propertyGroups': {
'string': {
'groupType': 'TABULAR',
'propertyNames': [
'string',
],
'isInherited': True|False
}
},
'status': {
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR'|'SYNC_DELETING_ERROR'|'PROCESSING_ERROR'|'COMPOSITE_COMPONENT_FAILURE',
'message': 'string'
}
},
'syncSource': 'string',
'componentPath': 'string'
}
},
'areAllCompositeComponentsReturned': True|False
}
},
'parentEntityId': 'string',
'hasChildEntities': True|False,
'creationDateTime': datetime(2015, 1, 1),
'updateDateTime': datetime(2015, 1, 1),
'syncSource': 'string',
'areAllComponentsReturned': True|False
}
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.
areAllPropertyValuesReturned (boolean) --
This flag notes whether all values of a list or map type property are returned in the API response. The maximum number of values per property returned is 50.
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.
areAllPropertiesReturned (boolean) --
This flag notes whether all properties of the component are returned in the API response. The maximum number of properties returned is 800.
compositeComponents (dict) --
This lists objects that contain information about the compositeComponents .
(string) --
(dict) --
An object that returns information about a component summary.
componentName (string) --
The name of the component.
componentTypeId (string) --
The ID of the component type.
definedIn (string) --
The name of the property definition set in the request.
description (string) --
The description of the component request.
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
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.
syncSource (string) --
The syncSource of the sync job, if this entity was created by a sync job.
componentPath (string) --
This string specifies the path to the composite component, starting from the top-level component.
areAllCompositeComponentsReturned (boolean) --
This flag notes whether all compositeComponents are returned in the API response.
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.
areAllComponentsReturned (boolean) --
This flag notes whether all components are returned in the API response. The maximum number of components returned is 30.
{'componentPath': 'string'}
Response {'propertyValues': {'propertyReference': {'componentPath': 'string'}}}
Gets the property values for a component, component type, entity, or workspace.
You must specify a value for either componentName , componentTypeId , entityId , or workspaceId .
See also: AWS API Documentation
Request Syntax
client.get_property_value(
componentName='string',
componentPath='string',
componentTypeId='string',
entityId='string',
selectedProperties=[
'string',
],
workspaceId='string',
maxResults=123,
nextToken='string',
propertyGroupName='string',
tabularConditions={
'orderBy': [
{
'order': 'ASCENDING'|'DESCENDING',
'propertyName': 'string'
},
],
'propertyFilters': [
{
'propertyName': 'string',
'operator': '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'
}
},
]
}
)
string
The name of the component whose property values the operation returns.
string
This string specifies the path to the composite component, starting from the top-level component.
string
The ID of the component type whose property values the operation returns.
string
The ID of the entity whose property values the operation returns.
list
[REQUIRED]
The properties whose values the operation returns.
(string) --
string
[REQUIRED]
The ID of the workspace whose values the operation returns.
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.
string
The property group name.
dict
The tabular conditions.
orderBy (list) --
Filter criteria that orders the output. It can be sorted in ascending or descending order.
(dict) --
Filter criteria that orders the return output. It can be sorted in ascending or descending order.
order (string) --
The set order that filters results.
propertyName (string) -- [REQUIRED]
The property name.
propertyFilters (list) --
You can filter the request using various logical operators and a key-value format. For example:
{"key": "serverType", "value": "webServer"}
(dict) --
An object that filters items returned by a property request.
propertyName (string) --
The property name associated with this property filter.
operator (string) --
The operator associated with this property filter.
value (dict) --
The value associated with this property filter.
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.
dict
Response Syntax
{
'propertyValues': {
'string': {
'propertyReference': {
'componentName': 'string',
'componentPath': 'string',
'externalIdProperty': {
'string': 'string'
},
'entityId': 'string',
'propertyName': 'string'
},
'propertyValue': {
'booleanValue': True|False,
'doubleValue': 123.0,
'integerValue': 123,
'longValue': 123,
'stringValue': 'string',
'listValue': [
{'... recursive ...'},
],
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetEntityId': 'string',
'targetComponentName': 'string'
},
'expression': 'string'
}
}
},
'nextToken': 'string',
'tabularPropertyValues': [
[
{
'string': {
'booleanValue': True|False,
'doubleValue': 123.0,
'integerValue': 123,
'longValue': 123,
'stringValue': 'string',
'listValue': [
{'... recursive ...'},
],
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetEntityId': 'string',
'targetComponentName': 'string'
},
'expression': 'string'
}
},
],
]
}
Response Structure
(dict) --
propertyValues (dict) --
An object that maps strings to the properties and latest property values in the response. Each string in the mapping must be unique to this object.
(string) --
(dict) --
The latest value of the property.
propertyReference (dict) --
An object that specifies information about a property.
componentName (string) --
The name of the component.
componentPath (string) --
This string specifies the path to the composite component, starting from the top-level component.
externalIdProperty (dict) --
A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.
(string) --
(string) --
entityId (string) --
The ID of the entity.
propertyName (string) --
The name of the property.
propertyValue (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.
nextToken (string) --
The string that specifies the next page of results.
tabularPropertyValues (list) --
A table of property values.
(list) --
(dict) --
(string) --
(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.
(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.
{'componentPath': 'string'}
Response {'propertyValues': {'entityPropertyReference': {'componentPath': '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(
workspaceId='string',
entityId='string',
componentName='string',
componentPath='string',
componentTypeId='string',
selectedProperties=[
'string',
],
propertyFilters=[
{
'propertyName': 'string',
'operator': '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'
}
},
],
startDateTime=datetime(2015, 1, 1),
endDateTime=datetime(2015, 1, 1),
interpolation={
'interpolationType': 'LINEAR',
'intervalInSeconds': 123
},
nextToken='string',
maxResults=123,
orderByTime='ASCENDING'|'DESCENDING',
startTime='string',
endTime='string'
)
string
[REQUIRED]
The ID of the workspace.
string
The ID of the entity.
string
The name of the component.
string
This string specifies the path to the composite component, starting from the top-level component.
string
The ID of the component type.
list
[REQUIRED]
A list of properties whose value histories the request retrieves.
(string) --
list
A list of objects that filter the property value history request.
(dict) --
An object that filters items returned by a property request.
propertyName (string) --
The property name associated with this property filter.
operator (string) --
The operator associated with this property filter.
value (dict) --
The value associated with this property filter.
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.
datetime
The date and time of the earliest property value to return.
datetime
The date and time of the latest property value to return.
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.
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.
string
The time direction to use in the result order.
string
The ISO8601 DateTime of the earliest property value to return.
For more information about the ISO8601 DateTime format, see the data type PropertyValue .
string
The ISO8601 DateTime of the latest property value to return.
For more information about the ISO8601 DateTime format, see the data type PropertyValue .
dict
Response Syntax
{
'propertyValues': [
{
'entityPropertyReference': {
'componentName': 'string',
'componentPath': 'string',
'externalIdProperty': {
'string': 'string'
},
'entityId': 'string',
'propertyName': 'string'
},
'values': [
{
'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'
},
]
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
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.
componentPath (string) --
This string specifies the path to the composite component, starting from the top-level component.
externalIdProperty (dict) --
A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.
(string) --
(string) --
entityId (string) --
The ID of the entity.
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.
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] .
[YYYY] : year
[MM] : month
[DD] : day
[hh] : hour
[mm] : minute
[ss] : seconds
[.SSSSSSSSS] : additional precision, where precedence is maintained. For example: [.573123] is equal to 573123000 nanoseconds.
Z : default timezone UTC
± HH:mm : time zone offset in Hours and Minutes.
Required sub-fields : YYYY-MM-DDThh:mm:ss and [Z/±HH:mm]
nextToken (string) --
The string that specifies the next page of results.
{'status': {'error': {'code': {'COMPOSITE_COMPONENT_FAILURE',
'PROCESSING_ERROR',
'SYNC_DELETING_ERROR'}}}}
Gets the SyncJob.
See also: AWS API Documentation
Request Syntax
client.get_sync_job(
syncSource='string',
workspaceId='string'
)
string
[REQUIRED]
The sync source.
Note
Currently the only supported syncSource 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'|'SYNC_DELETING_ERROR'|'PROCESSING_ERROR'|'COMPOSITE_COMPONENT_FAILURE',
'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 syncSource 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.
{'linkedServices': ['string']}
Retrieves information about a workspace.
See also: AWS API Documentation
Request Syntax
client.get_workspace(
workspaceId='string'
)
string
[REQUIRED]
The ID of the workspace.
dict
Response Syntax
{
'workspaceId': 'string',
'arn': 'string',
'description': 'string',
'linkedServices': [
'string',
],
's3Location': 'string',
'role': 'string',
'creationDateTime': datetime(2015, 1, 1),
'updateDateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
workspaceId (string) --
The ID of the workspace.
arn (string) --
The ARN of the workspace.
description (string) --
The description of the workspace.
linkedServices (list) --
A list of services that are linked to the workspace.
(string) --
s3Location (string) --
The ARN of the S3 bucket where resources associated with the workspace are stored.
role (string) --
The ARN of the execution role associated with the workspace.
creationDateTime (datetime) --
The date and time when the workspace was created.
updateDateTime (datetime) --
The date and time when the workspace was last updated.
{'componentTypeSummaries': {'status': {'error': {'code': {'COMPOSITE_COMPONENT_FAILURE',
'PROCESSING_ERROR',
'SYNC_DELETING_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'|'SYNC_DELETING_ERROR'|'PROCESSING_ERROR'|'COMPOSITE_COMPONENT_FAILURE',
'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': {'COMPOSITE_COMPONENT_FAILURE',
'PROCESSING_ERROR',
'SYNC_DELETING_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'|'SYNC_DELETING_ERROR'|'PROCESSING_ERROR'|'COMPOSITE_COMPONENT_FAILURE',
'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) --
An eventual 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.
{'syncJobSummaries': {'status': {'error': {'code': {'COMPOSITE_COMPONENT_FAILURE',
'PROCESSING_ERROR',
'SYNC_DELETING_ERROR'}}}}}
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'|'SYNC_DELETING_ERROR'|'PROCESSING_ERROR'|'COMPOSITE_COMPONENT_FAILURE',
'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.
{'syncResources': {'status': {'error': {'code': {'COMPOSITE_COMPONENT_FAILURE',
'PROCESSING_ERROR',
'SYNC_DELETING_ERROR'}}}}}
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 source.
Note
Currently the only supported syncSource is SITEWISE .
list
A list of objects that filter the request.
The following filter combinations are supported:
Filter with state
Filter with ResourceType and ResourceId
Filter with ResourceType and ExternalId
(dict) --
The sync resource filter.
state (string) --
The sync resource filter's state.
resourceType (string) --
The sync resource filter resource 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'|'SYNC_DELETING_ERROR'|'PROCESSING_ERROR'|'COMPOSITE_COMPONENT_FAILURE',
'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.
{'workspaceSummaries': {'linkedServices': ['string']}}
Retrieves information about workspaces in the current account.
See also: AWS API Documentation
Request Syntax
client.list_workspaces(
maxResults=123,
nextToken='string'
)
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
{
'workspaceSummaries': [
{
'workspaceId': 'string',
'arn': 'string',
'description': 'string',
'linkedServices': [
'string',
],
'creationDateTime': datetime(2015, 1, 1),
'updateDateTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
workspaceSummaries (list) --
A list of objects that contain information about the workspaces.
(dict) --
An object that contains information about a workspace.
workspaceId (string) --
The ID of the workspace.
arn (string) --
The ARN of the workspace.
description (string) --
The description of the workspace.
linkedServices (list) --
A list of services that are linked to the workspace.
(string) --
creationDateTime (datetime) --
The date and time when the workspace was created.
updateDateTime (datetime) --
The date and time when the workspace was last updated.
nextToken (string) --
The string that specifies the next page of results.
{'compositeComponentTypes': {'string': {'componentTypeId': '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',
compositeComponentTypes={
'string': {
'componentTypeId': '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
This is an object that maps strings to compositeComponentTypes of the componentType . CompositeComponentType is referenced by componentTypeId .
(string) --
(dict) --
An object that sets information about the composite component types of a component type.
componentTypeId (string) --
This is the componentTypeId that the compositeComponentType refers to.
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.
{'compositeComponentUpdates': {'string': {'description': 'string',
'propertyGroupUpdates': {'string': {'groupType': 'TABULAR',
'propertyNames': ['string'],
'updateType': 'UPDATE '
'| '
'DELETE '
'| '
'CREATE'}},
'propertyUpdates': {'string': {'definition': {'configuration': {'string': 'string'},
'dataType': {'allowedValues': [{'booleanValue': 'boolean',
'doubleValue': 'double',
'expression': 'string',
'integerValue': 'integer',
'listValue': (),
'longValue': 'long',
'mapValue': {'string': ()},
'relationshipValue': {'targetComponentName': 'string',
'targetEntityId': 'string'},
'stringValue': 'string'}],
'nestedType': (),
'relationship': {'relationshipType': 'string',
'targetComponentTypeId': 'string'},
'type': 'RELATIONSHIP '
'| '
'STRING '
'| '
'LONG '
'| '
'BOOLEAN '
'| '
'INTEGER '
'| '
'DOUBLE '
'| '
'LIST '
'| '
'MAP',
'unitOfMeasure': 'string'},
'defaultValue': {'booleanValue': 'boolean',
'doubleValue': 'double',
'expression': 'string',
'integerValue': 'integer',
'listValue': [()],
'longValue': 'long',
'mapValue': {'string': ()},
'relationshipValue': {'targetComponentName': 'string',
'targetEntityId': 'string'},
'stringValue': 'string'},
'displayName': 'string',
'isExternalId': 'boolean',
'isRequiredInEntity': 'boolean',
'isStoredExternally': 'boolean',
'isTimeSeries': 'boolean'},
'updateType': 'UPDATE '
'| '
'DELETE '
'| '
'CREATE',
'value': {'booleanValue': 'boolean',
'doubleValue': 'double',
'expression': 'string',
'integerValue': 'integer',
'listValue': [()],
'longValue': 'long',
'mapValue': {'string': ()},
'relationshipValue': {'targetComponentName': 'string',
'targetEntityId': 'string'},
'stringValue': 'string'}}},
'updateType': 'CREATE | UPDATE | '
'DELETE'}}}
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'
}
}
}
},
compositeComponentUpdates={
'string': {
'updateType': 'CREATE'|'UPDATE'|'DELETE',
'description': '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) --
The component property group request.
groupType (string) --
The group type.
propertyNames (list) --
The property names.
(string) --
updateType (string) --
The update type.
dict
This is an object that maps strings to compositeComponent updates in the request. Each key of the map represents the componentPath of the compositeComponent .
(string) --
(dict) --
An object that sets information about the composite component update request.
updateType (string) --
The update type of the component update request.
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.
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) --
The component property group request.
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.
{'s3Location': 'string'}
Updates a workspace.
See also: AWS API Documentation
Request Syntax
client.update_workspace(
workspaceId='string',
description='string',
role='string',
s3Location='string'
)
string
[REQUIRED]
The ID of the workspace.
string
The description of the workspace.
string
The ARN of the execution role associated with the workspace.
string
The ARN of the S3 bucket where resources associated with the workspace are stored.
dict
Response Syntax
{
'updateDateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
updateDateTime (datetime) --
The date and time of the current update.