Table of Contents
IoTTwinMaker.Client¶A low-level client representing AWS IoT TwinMaker
IoT TwinMaker is a service that enables you to build operational digital twins of physical systems. IoT TwinMaker overlays measurements and analysis from real-world sensors, cameras, and enterprise applications so you can create data visualizations to monitor your physical factory, building, or industrial plant. You can use this real-world data to monitor operations and diagnose and repair errors.
import boto3
client = boto3.client('iottwinmaker')
These are the available methods:
batch_put_property_values()can_paginate()close()create_component_type()create_entity()create_scene()create_sync_job()create_workspace()delete_component_type()delete_entity()delete_scene()delete_sync_job()delete_workspace()execute_query()get_component_type()get_entity()get_paginator()get_pricing_plan()get_property_value()get_property_value_history()get_scene()get_sync_job()get_waiter()get_workspace()list_component_types()list_entities()list_scenes()list_sync_jobs()list_sync_resources()list_tags_for_resource()list_workspaces()tag_resource()untag_resource()update_component_type()update_entity()update_pricing_plan()update_scene()update_workspace()batch_put_property_values(**kwargs)¶Sets values for multiple time series properties.
See also: AWS API Documentation
Request Syntax
response = client.batch_put_property_values(
workspaceId='string',
entries=[
{
'entityPropertyReference': {
'componentName': 'string',
'externalIdProperty': {
'string': 'string'
},
'entityId': 'string',
'propertyName': 'string'
},
'propertyValues': [
{
'timestamp': datetime(2015, 1, 1),
'value': {
'booleanValue': True|False,
'doubleValue': 123.0,
'integerValue': 123,
'longValue': 123,
'stringValue': 'string',
'listValue': [
{'... recursive ...'},
],
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetEntityId': 'string',
'targetComponentName': 'string'
},
'expression': 'string'
},
'time': 'string'
},
]
},
]
)
[REQUIRED]
The ID of the workspace that contains the properties to set.
[REQUIRED]
An object that maps strings to the property value entries to set. Each string in the mapping must be unique to this object.
An object that specifies information about time series property values. This object is used and consumed by the BatchPutPropertyValues action.
An object that contains information about the entity that has the property.
The name of the component.
A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.
The ID of the entity.
The name of the property.
A list of objects that specify time series property values.
An object that contains information about a value for a time series property.
The timestamp of a value for a time series property.
An object that specifies a value for a time series property.
A Boolean value.
A double value.
An integer value.
A long value.
A string value.
A list of multiple values.
An object that specifies a value for a property.
An object that maps strings to multiple DataValue objects.
An object that specifies a value for a property.
A value that relates a component to another component.
The ID of the target entity associated with this relationship value.
The name of the target component associated with the relationship value.
An expression that produces the value.
ISO8601 DateTime of a value for a time series property.
The time for when the property value was recorded in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.SSSSSSSSS][Z/±HH:mm] .
Required sub-fields : YYYY-MM-DDThh:mm:ss and [Z/±HH:mm]
dict
Response Syntax
{
'errorEntries': [
{
'errors': [
{
'errorCode': 'string',
'errorMessage': 'string',
'entry': {
'entityPropertyReference': {
'componentName': 'string',
'externalIdProperty': {
'string': 'string'
},
'entityId': 'string',
'propertyName': 'string'
},
'propertyValues': [
{
'timestamp': datetime(2015, 1, 1),
'value': {
'booleanValue': True|False,
'doubleValue': 123.0,
'integerValue': 123,
'longValue': 123,
'stringValue': 'string',
'listValue': [
{'... recursive ...'},
],
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetEntityId': 'string',
'targetComponentName': 'string'
},
'expression': 'string'
},
'time': 'string'
},
]
}
},
]
},
]
}
Response Structure
(dict) --
errorEntries (list) --
Entries that caused errors in the batch put operation.
(dict) --
An object that contains information about errors returned by the BatchPutProperty action.
errors (list) --
A list of objects that contain information about errors returned by the BatchPutProperty action.
(dict) --
An error returned by the BatchPutProperty action.
errorCode (string) --
The error code.
errorMessage (string) --
The error message.
entry (dict) --
An object that contains information about errors returned by the BatchPutProperty action.
entityPropertyReference (dict) --
An object that contains information about the entity that has the property.
componentName (string) --
The name of the component.
externalIdProperty (dict) --
A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.
entityId (string) --
The ID of the entity.
propertyName (string) --
The name of the property.
propertyValues (list) --
A list of objects that specify time series property values.
(dict) --
An object that contains information about a value for a time series property.
timestamp (datetime) --
The timestamp of a value for a time series property.
value (dict) --
An object that specifies a value for a time series property.
booleanValue (boolean) --
A Boolean value.
doubleValue (float) --
A double value.
integerValue (integer) --
An integer value.
longValue (integer) --
A long value.
stringValue (string) --
A string value.
listValue (list) --
A list of multiple values.
(dict) --
An object that specifies a value for a property.
mapValue (dict) --
An object that maps strings to multiple DataValue objects.
(string) --
(dict) --
An object that specifies a value for a property.
relationshipValue (dict) --
A value that relates a component to another component.
targetEntityId (string) --
The ID of the target entity associated with this relationship value.
targetComponentName (string) --
The name of the target component associated with the relationship value.
expression (string) --
An expression that produces the value.
time (string) --
ISO8601 DateTime of a value for a time series property.
The time for when the property value was recorded in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.SSSSSSSSS][Z/±HH:mm] .
Required sub-fields : YYYY-MM-DDThh:mm:ss and [Z/±HH:mm]
Exceptions
IoTTwinMaker.Client.exceptions.InternalServerExceptionIoTTwinMaker.Client.exceptions.ResourceNotFoundExceptionIoTTwinMaker.Client.exceptions.ThrottlingExceptionIoTTwinMaker.Client.exceptions.ValidationExceptioncan_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
create_component_type(**kwargs)¶Creates a component type.
See also: AWS API Documentation
Request Syntax
response = 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'
)
[REQUIRED]
The ID of the workspace that contains the component type.
[REQUIRED]
The ID of the component type.
An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.
An object that sets information about a property.
An object that contains information about the data type.
The underlying type of the data type.
The nested type in the data type.
The allowed values for this data type.
An object that specifies a value for a property.
A Boolean value.
A double value.
An integer value.
A long value.
A string value.
A list of multiple values.
An object that maps strings to multiple DataValue objects.
An object that specifies a value for a property.
A value that relates a component to another component.
The ID of the target entity associated with this relationship value.
The name of the target component associated with the relationship value.
An expression that produces the value.
The unit of measure used in this data type.
A relationship that associates a component with another component.
The ID of the target component type associated with this relationship.
The type of the relationship.
A Boolean value that specifies whether the property is required.
A Boolean value that specifies whether the property ID comes from an external data store.
A Boolean value that specifies whether the property is stored externally.
A Boolean value that specifies whether the property consists of time series data.
An object that contains the default value.
A Boolean value.
A double value.
An integer value.
A long value.
A string value.
A list of multiple values.
An object that specifies a value for a property.
An object that maps strings to multiple DataValue objects.
An object that specifies a value for a property.
A value that relates a component to another component.
The ID of the target entity associated with this relationship value.
The name of the target component associated with the relationship value.
An expression that produces the value.
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.
A friendly name for the property.
Specifies the parent component type to extend.
An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.
The function request body.
The required properties of the function.
The scope of the function.
The data connector.
The Lambda function associated with this data connector.
The ARN of the Lambda function.
A Boolean value that specifies whether the data connector is native to IoT TwinMaker.
Metadata that you can use to manage the component type.
The group type.
The names of properties.
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.
Exceptions
IoTTwinMaker.Client.exceptions.InternalServerExceptionIoTTwinMaker.Client.exceptions.AccessDeniedExceptionIoTTwinMaker.Client.exceptions.ThrottlingExceptionIoTTwinMaker.Client.exceptions.ValidationExceptionIoTTwinMaker.Client.exceptions.ConflictExceptionIoTTwinMaker.Client.exceptions.ServiceQuotaExceededExceptioncreate_entity(**kwargs)¶Creates an entity.
See also: AWS API Documentation
Request Syntax
response = client.create_entity(
workspaceId='string',
entityId='string',
entityName='string',
description='string',
components={
'string': {
'description': 'string',
'componentTypeId': 'string',
'properties': {
'string': {
'definition': {
'dataType': {
'type': 'RELATIONSHIP'|'STRING'|'LONG'|'BOOLEAN'|'INTEGER'|'DOUBLE'|'LIST'|'MAP',
'nestedType': {'... recursive ...'},
'allowedValues': [
{
'booleanValue': True|False,
'doubleValue': 123.0,
'integerValue': 123,
'longValue': 123,
'stringValue': 'string',
'listValue': {'... recursive ...'},
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetEntityId': 'string',
'targetComponentName': 'string'
},
'expression': 'string'
},
],
'unitOfMeasure': 'string',
'relationship': {
'targetComponentTypeId': 'string',
'relationshipType': 'string'
}
},
'isRequiredInEntity': True|False,
'isExternalId': True|False,
'isStoredExternally': True|False,
'isTimeSeries': True|False,
'defaultValue': {
'booleanValue': True|False,
'doubleValue': 123.0,
'integerValue': 123,
'longValue': 123,
'stringValue': 'string',
'listValue': [
{'... recursive ...'},
],
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetEntityId': 'string',
'targetComponentName': 'string'
},
'expression': 'string'
},
'configuration': {
'string': 'string'
},
'displayName': 'string'
},
'value': {
'booleanValue': True|False,
'doubleValue': 123.0,
'integerValue': 123,
'longValue': 123,
'stringValue': 'string',
'listValue': [
{'... recursive ...'},
],
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetEntityId': 'string',
'targetComponentName': 'string'
},
'expression': 'string'
},
'updateType': 'UPDATE'|'DELETE'|'CREATE'
}
},
'propertyGroups': {
'string': {
'groupType': 'TABULAR',
'propertyNames': [
'string',
],
'updateType': 'UPDATE'|'DELETE'|'CREATE'
}
}
}
},
parentEntityId='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The ID of the workspace that contains the entity.
[REQUIRED]
The name of the entity.
An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.
An object that sets information about a component type create or update request.
The description of the component request.
The ID of the component type.
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.
An object that sets information about a property.
An object that specifies information about a property.
An object that contains information about the data type.
The underlying type of the data type.
The nested type in the data type.
The allowed values for this data type.
An object that specifies a value for a property.
A Boolean value.
A double value.
An integer value.
A long value.
A string value.
A list of multiple values.
An object that maps strings to multiple DataValue objects.
An object that specifies a value for a property.
A value that relates a component to another component.
The ID of the target entity associated with this relationship value.
The name of the target component associated with the relationship value.
An expression that produces the value.
The unit of measure used in this data type.
A relationship that associates a component with another component.
The ID of the target component type associated with this relationship.
The type of the relationship.
A Boolean value that specifies whether the property is required.
A Boolean value that specifies whether the property ID comes from an external data store.
A Boolean value that specifies whether the property is stored externally.
A Boolean value that specifies whether the property consists of time series data.
An object that contains the default value.
A Boolean value.
A double value.
An integer value.
A long value.
A string value.
A list of multiple values.
An object that specifies a value for a property.
An object that maps strings to multiple DataValue objects.
An object that specifies a value for a property.
A value that relates a component to another component.
The ID of the target entity associated with this relationship value.
The name of the target component associated with the relationship value.
An expression that produces the value.
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.
A friendly name for the property.
The value of the property.
A Boolean value.
A double value.
An integer value.
A long value.
A string value.
A list of multiple values.
An object that specifies a value for a property.
An object that maps strings to multiple DataValue objects.
An object that specifies a value for a property.
A value that relates a component to another component.
The ID of the target entity associated with this relationship value.
The name of the target component associated with the relationship value.
An expression that produces the value.
The update type of the update property request.
The property groups.
The group type.
The property names.
The update type.
Metadata that you can use to manage the entity.
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.
Exceptions
IoTTwinMaker.Client.exceptions.InternalServerExceptionIoTTwinMaker.Client.exceptions.AccessDeniedExceptionIoTTwinMaker.Client.exceptions.ThrottlingExceptionIoTTwinMaker.Client.exceptions.ValidationExceptionIoTTwinMaker.Client.exceptions.ConflictExceptionIoTTwinMaker.Client.exceptions.ServiceQuotaExceededExceptioncreate_scene(**kwargs)¶Creates a scene.
See also: AWS API Documentation
Request Syntax
response = client.create_scene(
workspaceId='string',
sceneId='string',
contentLocation='string',
description='string',
capabilities=[
'string',
],
tags={
'string': 'string'
}
)
[REQUIRED]
The ID of the workspace that contains the scene.
[REQUIRED]
The ID of the scene.
[REQUIRED]
The relative path that specifies the location of the content definition file.
A list of capabilities that the scene uses to render itself.
Metadata that you can use to manage the scene.
dict
Response Syntax
{
'arn': 'string',
'creationDateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
arn (string) --
The ARN of the scene.
creationDateTime (datetime) --
The date and time when the scene was created.
Exceptions
IoTTwinMaker.Client.exceptions.InternalServerExceptionIoTTwinMaker.Client.exceptions.AccessDeniedExceptionIoTTwinMaker.Client.exceptions.ThrottlingExceptionIoTTwinMaker.Client.exceptions.ValidationExceptionIoTTwinMaker.Client.exceptions.ConflictExceptionIoTTwinMaker.Client.exceptions.ServiceQuotaExceededExceptioncreate_sync_job(**kwargs)¶This action creates a SyncJob.
See also: AWS API Documentation
Request Syntax
response = client.create_sync_job(
workspaceId='string',
syncSource='string',
syncRole='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The workspace Id.
[REQUIRED]
The sync source.
Note
Currently the only supported syncSoucre is SITEWISE .
[REQUIRED]
The SyncJob IAM role. This IAM role is used by the sync job to read from the syncSource, and create, update or delete the corresponding resources.
The SyncJob tags.
dict
Response Syntax
{
'arn': 'string',
'creationDateTime': datetime(2015, 1, 1),
'state': 'CREATING'|'INITIALIZING'|'ACTIVE'|'DELETING'|'ERROR'
}
Response Structure
(dict) --
arn (string) --
The SyncJob ARN.
creationDateTime (datetime) --
The date and time for the SyncJob creation.
state (string) --
The SyncJob response state.
Exceptions
IoTTwinMaker.Client.exceptions.InternalServerExceptionIoTTwinMaker.Client.exceptions.AccessDeniedExceptionIoTTwinMaker.Client.exceptions.ThrottlingExceptionIoTTwinMaker.Client.exceptions.ValidationExceptionIoTTwinMaker.Client.exceptions.ConflictExceptionIoTTwinMaker.Client.exceptions.ServiceQuotaExceededExceptioncreate_workspace(**kwargs)¶Creates a workplace.
See also: AWS API Documentation
Request Syntax
response = client.create_workspace(
workspaceId='string',
description='string',
s3Location='string',
role='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The ID of the workspace.
[REQUIRED]
The ARN of the S3 bucket where resources associated with the workspace are stored.
[REQUIRED]
The ARN of the execution role associated with the workspace.
Metadata that you can use to manage the workspace
dict
Response Syntax
{
'arn': 'string',
'creationDateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
arn (string) --
The ARN of the workspace.
creationDateTime (datetime) --
The date and time when the workspace was created.
Exceptions
IoTTwinMaker.Client.exceptions.InternalServerExceptionIoTTwinMaker.Client.exceptions.AccessDeniedExceptionIoTTwinMaker.Client.exceptions.ThrottlingExceptionIoTTwinMaker.Client.exceptions.ValidationExceptionIoTTwinMaker.Client.exceptions.ConflictExceptionIoTTwinMaker.Client.exceptions.ServiceQuotaExceededExceptiondelete_component_type(**kwargs)¶Deletes a component type.
See also: AWS API Documentation
Request Syntax
response = client.delete_component_type(
workspaceId='string',
componentTypeId='string'
)
[REQUIRED]
The ID of the workspace that contains the component type.
[REQUIRED]
The ID of the component type to delete.
dict
Response Syntax
{
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR'
}
Response Structure
(dict) --
state (string) --
The current state of the component type to be deleted.
Exceptions
IoTTwinMaker.Client.exceptions.InternalServerExceptionIoTTwinMaker.Client.exceptions.AccessDeniedExceptionIoTTwinMaker.Client.exceptions.ResourceNotFoundExceptionIoTTwinMaker.Client.exceptions.ThrottlingExceptionIoTTwinMaker.Client.exceptions.ValidationExceptiondelete_entity(**kwargs)¶Deletes an entity.
See also: AWS API Documentation
Request Syntax
response = client.delete_entity(
workspaceId='string',
entityId='string',
isRecursive=True|False
)
[REQUIRED]
The ID of the workspace that contains the entity to delete.
[REQUIRED]
The ID of the entity to delete.
dict
Response Syntax
{
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR'
}
Response Structure
(dict) --
state (string) --
The current state of the deleted entity.
Exceptions
IoTTwinMaker.Client.exceptions.InternalServerExceptionIoTTwinMaker.Client.exceptions.ResourceNotFoundExceptionIoTTwinMaker.Client.exceptions.ThrottlingExceptionIoTTwinMaker.Client.exceptions.ValidationExceptionIoTTwinMaker.Client.exceptions.ServiceQuotaExceededExceptiondelete_scene(**kwargs)¶Deletes a scene.
See also: AWS API Documentation
Request Syntax
response = client.delete_scene(
workspaceId='string',
sceneId='string'
)
[REQUIRED]
The ID of the workspace.
[REQUIRED]
The ID of the scene to delete.
dict
Response Syntax
{}
Response Structure
Exceptions
IoTTwinMaker.Client.exceptions.InternalServerExceptionIoTTwinMaker.Client.exceptions.AccessDeniedExceptionIoTTwinMaker.Client.exceptions.ResourceNotFoundExceptionIoTTwinMaker.Client.exceptions.ThrottlingExceptionIoTTwinMaker.Client.exceptions.ValidationExceptiondelete_sync_job(**kwargs)¶Delete the SyncJob.
See also: AWS API Documentation
Request Syntax
response = client.delete_sync_job(
workspaceId='string',
syncSource='string'
)
[REQUIRED]
The workspace Id.
[REQUIRED]
The sync source.
Note
Currently the only supported syncSoucre is SITEWISE .
dict
Response Syntax
{
'state': 'CREATING'|'INITIALIZING'|'ACTIVE'|'DELETING'|'ERROR'
}
Response Structure
(dict) --
state (string) --
The SyncJob response state.
Exceptions
IoTTwinMaker.Client.exceptions.InternalServerExceptionIoTTwinMaker.Client.exceptions.AccessDeniedExceptionIoTTwinMaker.Client.exceptions.ResourceNotFoundExceptionIoTTwinMaker.Client.exceptions.ThrottlingExceptionIoTTwinMaker.Client.exceptions.ValidationExceptionIoTTwinMaker.Client.exceptions.ServiceQuotaExceededExceptiondelete_workspace(**kwargs)¶Deletes a workspace.
See also: AWS API Documentation
Request Syntax
response = client.delete_workspace(
workspaceId='string'
)
[REQUIRED]
The ID of the workspace to delete.
{}
Response Structure
Exceptions
IoTTwinMaker.Client.exceptions.InternalServerExceptionIoTTwinMaker.Client.exceptions.AccessDeniedExceptionIoTTwinMaker.Client.exceptions.ResourceNotFoundExceptionIoTTwinMaker.Client.exceptions.ThrottlingExceptionIoTTwinMaker.Client.exceptions.ValidationExceptionexecute_query(**kwargs)¶Run queries to access information from your knowledge graph of entities within individual workspaces.
See also: AWS API Documentation
Request Syntax
response = client.execute_query(
workspaceId='string',
queryStatement='string',
maxResults=123,
nextToken='string'
)
[REQUIRED]
The ID of the workspace.
[REQUIRED]
The query statement.
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
{
'columnDescriptions': [
{
'name': 'string',
'type': 'NODE'|'EDGE'|'VALUE'
},
],
'rows': [
{
'rowData': [
{...}|[...]|123|123.4|'string'|True|None,
]
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
columnDescriptions (list) --
A list of ColumnDescription objects.
(dict) --
A description of the column in the query results.
name (string) --
The name of the column description.
type (string) --
The type of the column description.
rows (list) --
Represents a single row in the query results.
(dict) --
Represents a single row in the query results.
rowData (list) --
The data in a row of query results.
nextToken (string) --
The string that specifies the next page of results.
Exceptions
IoTTwinMaker.Client.exceptions.InternalServerExceptionIoTTwinMaker.Client.exceptions.AccessDeniedExceptionIoTTwinMaker.Client.exceptions.QueryTimeoutExceptionIoTTwinMaker.Client.exceptions.ThrottlingExceptionIoTTwinMaker.Client.exceptions.ValidationExceptionIoTTwinMaker.Client.exceptions.ServiceQuotaExceededExceptionget_component_type(**kwargs)¶Retrieves information about a component type.
See also: AWS API Documentation
Request Syntax
response = client.get_component_type(
workspaceId='string',
componentTypeId='string'
)
[REQUIRED]
The ID of the workspace that contains the component type.
[REQUIRED]
The ID of the component type.
dict
Response Syntax
{
'workspaceId': 'string',
'isSingleton': True|False,
'componentTypeId': 'string',
'description': 'string',
'propertyDefinitions': {
'string': {
'dataType': {
'type': 'RELATIONSHIP'|'STRING'|'LONG'|'BOOLEAN'|'INTEGER'|'DOUBLE'|'LIST'|'MAP',
'nestedType': {'... recursive ...'},
'allowedValues': [
{
'booleanValue': True|False,
'doubleValue': 123.0,
'integerValue': 123,
'longValue': 123,
'stringValue': 'string',
'listValue': {'... recursive ...'},
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetEntityId': 'string',
'targetComponentName': 'string'
},
'expression': 'string'
},
],
'unitOfMeasure': 'string',
'relationship': {
'targetComponentTypeId': 'string',
'relationshipType': 'string'
}
},
'isTimeSeries': True|False,
'isRequiredInEntity': True|False,
'isExternalId': True|False,
'isStoredExternally': True|False,
'isImported': True|False,
'isFinal': True|False,
'isInherited': True|False,
'defaultValue': {
'booleanValue': True|False,
'doubleValue': 123.0,
'integerValue': 123,
'longValue': 123,
'stringValue': 'string',
'listValue': [
{'... recursive ...'},
],
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetEntityId': 'string',
'targetComponentName': 'string'
},
'expression': 'string'
},
'configuration': {
'string': 'string'
},
'displayName': 'string'
}
},
'extendsFrom': [
'string',
],
'functions': {
'string': {
'requiredProperties': [
'string',
],
'scope': 'ENTITY'|'WORKSPACE',
'implementedBy': {
'lambda': {
'arn': 'string'
},
'isNative': True|False
},
'isInherited': True|False
}
},
'creationDateTime': datetime(2015, 1, 1),
'updateDateTime': datetime(2015, 1, 1),
'arn': 'string',
'isAbstract': True|False,
'isSchemaInitialized': True|False,
'status': {
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR',
'message': 'string'
}
},
'propertyGroups': {
'string': {
'groupType': 'TABULAR',
'propertyNames': [
'string',
],
'isInherited': True|False
}
},
'syncSource': 'string',
'componentTypeName': 'string'
}
Response Structure
(dict) --
workspaceId (string) --
The ID of the workspace that contains the component type.
isSingleton (boolean) --
A Boolean value that specifies whether an entity can have more than one component of this type.
componentTypeId (string) --
The ID of the component type.
description (string) --
The description of the component type.
propertyDefinitions (dict) --
An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.
(string) --
(dict) --
An object that contains response data from a property definition request.
dataType (dict) --
An object that contains information about the data type.
type (string) --
The underlying type of the data type.
nestedType (dict) --
The nested type in the data type.
allowedValues (list) --
The allowed values for this data type.
(dict) --
An object that specifies a value for a property.
booleanValue (boolean) --
A Boolean value.
doubleValue (float) --
A double value.
integerValue (integer) --
An integer value.
longValue (integer) --
A long value.
stringValue (string) --
A string value.
listValue (list) --
A list of multiple values.
mapValue (dict) --
An object that maps strings to multiple DataValue objects.
(string) --
(dict) --
An object that specifies a value for a property.
relationshipValue (dict) --
A value that relates a component to another component.
targetEntityId (string) --
The ID of the target entity associated with this relationship value.
targetComponentName (string) --
The name of the target component associated with the relationship value.
expression (string) --
An expression that produces the value.
unitOfMeasure (string) --
The unit of measure used in this data type.
relationship (dict) --
A relationship that associates a component with another component.
targetComponentTypeId (string) --
The ID of the target component type associated with this relationship.
relationshipType (string) --
The type of the relationship.
isTimeSeries (boolean) --
A Boolean value that specifies whether the property consists of time series data.
isRequiredInEntity (boolean) --
A Boolean value that specifies whether the property is required in an entity.
isExternalId (boolean) --
A Boolean value that specifies whether the property ID comes from an external data store.
isStoredExternally (boolean) --
A Boolean value that specifies whether the property is stored externally.
isImported (boolean) --
A Boolean value that specifies whether the property definition is imported from an external data store.
isFinal (boolean) --
A Boolean value that specifies whether the property definition can be updated.
isInherited (boolean) --
A Boolean value that specifies whether the property definition is inherited from a parent entity.
defaultValue (dict) --
An object that contains the default value.
booleanValue (boolean) --
A Boolean value.
doubleValue (float) --
A double value.
integerValue (integer) --
An integer value.
longValue (integer) --
A long value.
stringValue (string) --
A string value.
listValue (list) --
A list of multiple values.
(dict) --
An object that specifies a value for a property.
mapValue (dict) --
An object that maps strings to multiple DataValue objects.
(string) --
(dict) --
An object that specifies a value for a property.
relationshipValue (dict) --
A value that relates a component to another component.
targetEntityId (string) --
The ID of the target entity associated with this relationship value.
targetComponentName (string) --
The name of the target component associated with the relationship value.
expression (string) --
An expression that produces the value.
configuration (dict) --
A mapping that specifies configuration information about the property.
displayName (string) --
A friendly name for the property.
extendsFrom (list) --
The name of the parent component type that this component type extends.
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.
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.
isInherited (boolean) --
A Boolean value that specifies whether the property group is inherited from a parent entity
syncSource (string) --
The syncSource of the sync job, if this entity was created by a sync job.
componentTypeName (string) --
The component type name.
Exceptions
IoTTwinMaker.Client.exceptions.InternalServerExceptionIoTTwinMaker.Client.exceptions.AccessDeniedExceptionIoTTwinMaker.Client.exceptions.ResourceNotFoundExceptionIoTTwinMaker.Client.exceptions.ThrottlingExceptionIoTTwinMaker.Client.exceptions.ValidationExceptionget_entity(**kwargs)¶Retrieves information about an entity.
See also: AWS API Documentation
Request Syntax
response = client.get_entity(
workspaceId='string',
entityId='string'
)
[REQUIRED]
The ID of the workspace.
[REQUIRED]
The ID of the entity.
dict
Response Syntax
{
'entityId': 'string',
'entityName': 'string',
'arn': 'string',
'status': {
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR',
'message': 'string'
}
},
'workspaceId': 'string',
'description': 'string',
'components': {
'string': {
'componentName': 'string',
'description': 'string',
'componentTypeId': 'string',
'status': {
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR',
'message': 'string'
}
},
'definedIn': 'string',
'properties': {
'string': {
'definition': {
'dataType': {
'type': 'RELATIONSHIP'|'STRING'|'LONG'|'BOOLEAN'|'INTEGER'|'DOUBLE'|'LIST'|'MAP',
'nestedType': {'... recursive ...'},
'allowedValues': [
{
'booleanValue': True|False,
'doubleValue': 123.0,
'integerValue': 123,
'longValue': 123,
'stringValue': 'string',
'listValue': {'... recursive ...'},
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetEntityId': 'string',
'targetComponentName': 'string'
},
'expression': 'string'
},
],
'unitOfMeasure': 'string',
'relationship': {
'targetComponentTypeId': 'string',
'relationshipType': 'string'
}
},
'isTimeSeries': True|False,
'isRequiredInEntity': True|False,
'isExternalId': True|False,
'isStoredExternally': True|False,
'isImported': True|False,
'isFinal': True|False,
'isInherited': True|False,
'defaultValue': {
'booleanValue': True|False,
'doubleValue': 123.0,
'integerValue': 123,
'longValue': 123,
'stringValue': 'string',
'listValue': [
{'... recursive ...'},
],
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetEntityId': 'string',
'targetComponentName': 'string'
},
'expression': 'string'
},
'configuration': {
'string': 'string'
},
'displayName': 'string'
},
'value': {
'booleanValue': True|False,
'doubleValue': 123.0,
'integerValue': 123,
'longValue': 123,
'stringValue': 'string',
'listValue': [
{'... recursive ...'},
],
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetEntityId': 'string',
'targetComponentName': 'string'
},
'expression': 'string'
}
}
},
'propertyGroups': {
'string': {
'groupType': 'TABULAR',
'propertyNames': [
'string',
],
'isInherited': True|False
}
},
'syncSource': 'string'
}
},
'parentEntityId': 'string',
'hasChildEntities': True|False,
'creationDateTime': datetime(2015, 1, 1),
'updateDateTime': datetime(2015, 1, 1),
'syncSource': 'string'
}
Response Structure
(dict) --
entityId (string) --
The ID of the entity.
entityName (string) --
The name of the entity.
arn (string) --
The ARN of the entity.
status (dict) --
The current status of the entity.
state (string) --
The current state of the entity, component, component type, or workspace.
error (dict) --
The error message.
code (string) --
The error code.
message (string) --
The error message.
workspaceId (string) --
The ID of the workspace.
description (string) --
The description of the entity.
components (dict) --
An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.
(string) --
(dict) --
An object that returns information about a component type create or update request.
componentName (string) --
The name of the component.
description (string) --
The description of the component type.
componentTypeId (string) --
The ID of the component type.
status (dict) --
The status of the component type.
state (string) --
The current state of the entity, component, component type, or workspace.
error (dict) --
The error message.
code (string) --
The error code.
message (string) --
The error message.
definedIn (string) --
The name of the property definition set in the request.
properties (dict) --
An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.
(string) --
(dict) --
An object that contains information about a property response.
definition (dict) --
An object that specifies information about a property.
dataType (dict) --
An object that contains information about the data type.
type (string) --
The underlying type of the data type.
nestedType (dict) --
The nested type in the data type.
allowedValues (list) --
The allowed values for this data type.
(dict) --
An object that specifies a value for a property.
booleanValue (boolean) --
A Boolean value.
doubleValue (float) --
A double value.
integerValue (integer) --
An integer value.
longValue (integer) --
A long value.
stringValue (string) --
A string value.
listValue (list) --
A list of multiple values.
mapValue (dict) --
An object that maps strings to multiple DataValue objects.
(string) --
(dict) --
An object that specifies a value for a property.
relationshipValue (dict) --
A value that relates a component to another component.
targetEntityId (string) --
The ID of the target entity associated with this relationship value.
targetComponentName (string) --
The name of the target component associated with the relationship value.
expression (string) --
An expression that produces the value.
unitOfMeasure (string) --
The unit of measure used in this data type.
relationship (dict) --
A relationship that associates a component with another component.
targetComponentTypeId (string) --
The ID of the target component type associated with this relationship.
relationshipType (string) --
The type of the relationship.
isTimeSeries (boolean) --
A Boolean value that specifies whether the property consists of time series data.
isRequiredInEntity (boolean) --
A Boolean value that specifies whether the property is required in an entity.
isExternalId (boolean) --
A Boolean value that specifies whether the property ID comes from an external data store.
isStoredExternally (boolean) --
A Boolean value that specifies whether the property is stored externally.
isImported (boolean) --
A Boolean value that specifies whether the property definition is imported from an external data store.
isFinal (boolean) --
A Boolean value that specifies whether the property definition can be updated.
isInherited (boolean) --
A Boolean value that specifies whether the property definition is inherited from a parent entity.
defaultValue (dict) --
An object that contains the default value.
booleanValue (boolean) --
A Boolean value.
doubleValue (float) --
A double value.
integerValue (integer) --
An integer value.
longValue (integer) --
A long value.
stringValue (string) --
A string value.
listValue (list) --
A list of multiple values.
(dict) --
An object that specifies a value for a property.
mapValue (dict) --
An object that maps strings to multiple DataValue objects.
(string) --
(dict) --
An object that specifies a value for a property.
relationshipValue (dict) --
A value that relates a component to another component.
targetEntityId (string) --
The ID of the target entity associated with this relationship value.
targetComponentName (string) --
The name of the target component associated with the relationship value.
expression (string) --
An expression that produces the value.
configuration (dict) --
A mapping that specifies configuration information about the property.
displayName (string) --
A friendly name for the property.
value (dict) --
The value of the property.
booleanValue (boolean) --
A Boolean value.
doubleValue (float) --
A double value.
integerValue (integer) --
An integer value.
longValue (integer) --
A long value.
stringValue (string) --
A string value.
listValue (list) --
A list of multiple values.
(dict) --
An object that specifies a value for a property.
mapValue (dict) --
An object that maps strings to multiple DataValue objects.
(string) --
(dict) --
An object that specifies a value for a property.
relationshipValue (dict) --
A value that relates a component to another component.
targetEntityId (string) --
The ID of the target entity associated with this relationship value.
targetComponentName (string) --
The name of the target component associated with the relationship value.
expression (string) --
An expression that produces the value.
propertyGroups (dict) --
The property groups.
(string) --
(dict) --
The component property group response.
groupType (string) --
The group type.
propertyNames (list) --
The names of properties
isInherited (boolean) --
A Boolean value that specifies whether the property group is inherited from a parent entity
syncSource (string) --
The syncSource of the sync job, if this entity was created by a sync job.
parentEntityId (string) --
The ID of the parent entity for this entity.
hasChildEntities (boolean) --
A Boolean value that specifies whether the entity has associated child entities.
creationDateTime (datetime) --
The date and time when the entity was created.
updateDateTime (datetime) --
The date and time when the entity was last updated.
syncSource (string) --
The syncSource of the sync job, if this entity was created by a sync job.
Exceptions
IoTTwinMaker.Client.exceptions.InternalServerExceptionIoTTwinMaker.Client.exceptions.ResourceNotFoundExceptionIoTTwinMaker.Client.exceptions.ThrottlingExceptionIoTTwinMaker.Client.exceptions.ValidationExceptionIoTTwinMaker.Client.exceptions.ServiceQuotaExceededExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_pricing_plan()¶Gets the pricing plan.
See also: AWS API Documentation
Request Syntax
response = client.get_pricing_plan()
{
'currentPricingPlan': {
'billableEntityCount': 123,
'bundleInformation': {
'bundleNames': [
'string',
],
'pricingTier': 'TIER_1'|'TIER_2'|'TIER_3'|'TIER_4'
},
'effectiveDateTime': datetime(2015, 1, 1),
'pricingMode': 'BASIC'|'STANDARD'|'TIERED_BUNDLE',
'updateDateTime': datetime(2015, 1, 1),
'updateReason': 'DEFAULT'|'PRICING_TIER_UPDATE'|'ENTITY_COUNT_UPDATE'|'PRICING_MODE_UPDATE'|'OVERWRITTEN'
},
'pendingPricingPlan': {
'billableEntityCount': 123,
'bundleInformation': {
'bundleNames': [
'string',
],
'pricingTier': 'TIER_1'|'TIER_2'|'TIER_3'|'TIER_4'
},
'effectiveDateTime': datetime(2015, 1, 1),
'pricingMode': 'BASIC'|'STANDARD'|'TIERED_BUNDLE',
'updateDateTime': datetime(2015, 1, 1),
'updateReason': 'DEFAULT'|'PRICING_TIER_UPDATE'|'ENTITY_COUNT_UPDATE'|'PRICING_MODE_UPDATE'|'OVERWRITTEN'
}
}
Response Structure
The chosen pricing plan for the current billing cycle.
The billable entity count.
The pricing plan's bundle information.
The bundle names.
The pricing tier.
The effective date and time of the pricing plan.
The pricing mode.
The set date and time for updating a pricing plan.
The update reason, for changing a pricing plan.
The pending pricing plan.
The billable entity count.
The pricing plan's bundle information.
The bundle names.
The pricing tier.
The effective date and time of the pricing plan.
The pricing mode.
The set date and time for updating a pricing plan.
The update reason, for changing a pricing plan.
Exceptions
IoTTwinMaker.Client.exceptions.InternalServerExceptionIoTTwinMaker.Client.exceptions.AccessDeniedExceptionIoTTwinMaker.Client.exceptions.ThrottlingExceptionIoTTwinMaker.Client.exceptions.ValidationExceptionget_property_value(**kwargs)¶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
response = client.get_property_value(
componentName='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'
}
},
]
}
)
[REQUIRED]
The properties whose values the operation returns.
[REQUIRED]
The ID of the workspace whose values the operation returns.
The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
The tabular conditions.
Filter criteria that orders the output. It can be sorted in ascending or descending order.
Filter criteria that orders the return output. It can be sorted in ascending or descending order.
The set order that filters results.
The property name.
You can filter the request using various logical operators and a key-value format. For example:
{"key": "serverType", "value": "webServer"}
An object that filters items returned by a property request.
The property name associated with this property filter.
The operator associated with this property filter.
The value associated with this property filter.
A Boolean value.
A double value.
An integer value.
A long value.
A string value.
A list of multiple values.
An object that specifies a value for a property.
An object that maps strings to multiple DataValue objects.
An object that specifies a value for a property.
A value that relates a component to another component.
The ID of the target entity associated with this relationship value.
The name of the target component associated with the relationship value.
An expression that produces the value.
dict
Response Syntax
{
'propertyValues': {
'string': {
'propertyReference': {
'componentName': '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.
externalIdProperty (dict) --
A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.
entityId (string) --
The ID of the entity.
propertyName (string) --
The name of the property.
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.
Exceptions
IoTTwinMaker.Client.exceptions.InternalServerExceptionIoTTwinMaker.Client.exceptions.ConnectorFailureExceptionIoTTwinMaker.Client.exceptions.AccessDeniedExceptionIoTTwinMaker.Client.exceptions.ResourceNotFoundExceptionIoTTwinMaker.Client.exceptions.ThrottlingExceptionIoTTwinMaker.Client.exceptions.ValidationExceptionIoTTwinMaker.Client.exceptions.ConnectorTimeoutExceptionget_property_value_history(**kwargs)¶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
response = client.get_property_value_history(
workspaceId='string',
entityId='string',
componentName='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'
)
[REQUIRED]
The ID of the workspace.
[REQUIRED]
A list of properties whose value histories the request retrieves.
A list of objects that filter the property value history request.
An object that filters items returned by a property request.
The property name associated with this property filter.
The operator associated with this property filter.
The value associated with this property filter.
A Boolean value.
A double value.
An integer value.
A long value.
A string value.
A list of multiple values.
An object that specifies a value for a property.
An object that maps strings to multiple DataValue objects.
An object that specifies a value for a property.
A value that relates a component to another component.
The ID of the target entity associated with this relationship value.
The name of the target component associated with the relationship value.
An expression that produces the value.
An object that specifies the interpolation type and the interval over which to interpolate data.
The interpolation type.
The interpolation time interval in seconds.
The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
The ISO8601 DateTime of the earliest property value to return.
For more information about the ISO8601 DateTime format, see the data type PropertyValue.
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',
'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.
externalIdProperty (dict) --
A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.
entityId (string) --
The ID of the entity.
propertyName (string) --
The name of the property.
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] .
Required sub-fields : YYYY-MM-DDThh:mm:ss and [Z/±HH:mm]
nextToken (string) --
The string that specifies the next page of results.
Exceptions
IoTTwinMaker.Client.exceptions.InternalServerExceptionIoTTwinMaker.Client.exceptions.ConnectorFailureExceptionIoTTwinMaker.Client.exceptions.AccessDeniedExceptionIoTTwinMaker.Client.exceptions.ResourceNotFoundExceptionIoTTwinMaker.Client.exceptions.ThrottlingExceptionIoTTwinMaker.Client.exceptions.ValidationExceptionIoTTwinMaker.Client.exceptions.ConnectorTimeoutExceptionget_scene(**kwargs)¶Retrieves information about a scene.
See also: AWS API Documentation
Request Syntax
response = client.get_scene(
workspaceId='string',
sceneId='string'
)
[REQUIRED]
The ID of the workspace that contains the scene.
[REQUIRED]
The ID of the scene.
dict
Response Syntax
{
'workspaceId': 'string',
'sceneId': 'string',
'contentLocation': 'string',
'arn': 'string',
'creationDateTime': datetime(2015, 1, 1),
'updateDateTime': datetime(2015, 1, 1),
'description': 'string',
'capabilities': [
'string',
]
}
Response Structure
(dict) --
workspaceId (string) --
The ID of the workspace that contains the scene.
sceneId (string) --
The ID of the scene.
contentLocation (string) --
The relative path that specifies the location of the content definition file.
arn (string) --
The ARN of the scene.
creationDateTime (datetime) --
The date and time when the scene was created.
updateDateTime (datetime) --
The date and time when the scene was last updated.
description (string) --
The description of the scene.
capabilities (list) --
A list of capabilities that the scene uses to render.
Exceptions
IoTTwinMaker.Client.exceptions.InternalServerExceptionIoTTwinMaker.Client.exceptions.AccessDeniedExceptionIoTTwinMaker.Client.exceptions.ResourceNotFoundExceptionIoTTwinMaker.Client.exceptions.ThrottlingExceptionIoTTwinMaker.Client.exceptions.ValidationExceptionget_sync_job(**kwargs)¶Gets the SyncJob.
See also: AWS API Documentation
Request Syntax
response = client.get_sync_job(
syncSource='string',
workspaceId='string'
)
[REQUIRED]
The sync soucre.
Note
Currently the only supported syncSoucre is SITEWISE .
dict
Response Syntax
{
'arn': 'string',
'workspaceId': 'string',
'syncSource': 'string',
'syncRole': 'string',
'status': {
'state': 'CREATING'|'INITIALIZING'|'ACTIVE'|'DELETING'|'ERROR',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR',
'message': 'string'
}
},
'creationDateTime': datetime(2015, 1, 1),
'updateDateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
arn (string) --
The sync job ARN.
workspaceId (string) --
The ID of the workspace that contains the sync job.
syncSource (string) --
The sync soucre.
Note
Currently the only supported syncSoucre is SITEWISE .
syncRole (string) --
The sync IAM role.
status (dict) --
The SyncJob response status.
state (string) --
The SyncJob status state.
error (dict) --
The SyncJob error.
code (string) --
The error code.
message (string) --
The error message.
creationDateTime (datetime) --
The creation date and time.
updateDateTime (datetime) --
The update date and time.
Exceptions
IoTTwinMaker.Client.exceptions.InternalServerExceptionIoTTwinMaker.Client.exceptions.AccessDeniedExceptionIoTTwinMaker.Client.exceptions.ResourceNotFoundExceptionIoTTwinMaker.Client.exceptions.ThrottlingExceptionIoTTwinMaker.Client.exceptions.ValidationExceptionIoTTwinMaker.Client.exceptions.ServiceQuotaExceededExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
get_workspace(**kwargs)¶Retrieves information about a workspace.
See also: AWS API Documentation
Request Syntax
response = client.get_workspace(
workspaceId='string'
)
[REQUIRED]
The ID of the workspace.
{
'workspaceId': 'string',
'arn': 'string',
'description': 'string',
's3Location': 'string',
'role': 'string',
'creationDateTime': datetime(2015, 1, 1),
'updateDateTime': datetime(2015, 1, 1)
}
Response Structure
The ID of the workspace.
The ARN of the workspace.
The description of the workspace.
The ARN of the S3 bucket where resources associated with the workspace are stored.
The ARN of the execution role associated with the workspace.
The date and time when the workspace was created.
The date and time when the workspace was last updated.
Exceptions
IoTTwinMaker.Client.exceptions.InternalServerExceptionIoTTwinMaker.Client.exceptions.ResourceNotFoundExceptionIoTTwinMaker.Client.exceptions.ThrottlingExceptionIoTTwinMaker.Client.exceptions.ValidationExceptionIoTTwinMaker.Client.exceptions.ServiceQuotaExceededExceptionlist_component_types(**kwargs)¶Lists all component types in a workspace.
See also: AWS API Documentation
Request Syntax
response = client.list_component_types(
workspaceId='string',
filters=[
{
'extendsFrom': 'string',
'namespace': 'string',
'isAbstract': True|False
},
],
nextToken='string',
maxResults=123
)
[REQUIRED]
The ID of the workspace.
A list of objects that filter the request.
An object that filters items in a list of component types.
Note
Only one object is accepted as a valid input.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: extendsFrom, namespace, isAbstract.
The component type that the component types in the list extend.
The namespace to which the component types in the list belong.
A Boolean value that specifies whether the component types in the list are abstract.
The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
dict
Response Syntax
{
'workspaceId': 'string',
'componentTypeSummaries': [
{
'arn': 'string',
'componentTypeId': 'string',
'creationDateTime': datetime(2015, 1, 1),
'updateDateTime': datetime(2015, 1, 1),
'description': 'string',
'status': {
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR',
'message': 'string'
}
},
'componentTypeName': 'string'
},
],
'nextToken': 'string',
'maxResults': 123
}
Response Structure
(dict) --
workspaceId (string) --
The ID of the workspace.
componentTypeSummaries (list) --
A list of objects that contain information about the component types.
(dict) --
An object that contains information about a component type.
arn (string) --
The ARN of the component type.
componentTypeId (string) --
The ID of the component type.
creationDateTime (datetime) --
The date and time when the component type was created.
updateDateTime (datetime) --
The date and time when the component type was last updated.
description (string) --
The description of the component type.
status (dict) --
The current status of the component type.
state (string) --
The current state of the entity, component, component type, or workspace.
error (dict) --
The error message.
code (string) --
The error code.
message (string) --
The error message.
componentTypeName (string) --
The component type name.
nextToken (string) --
The string that specifies the next page of results.
maxResults (integer) --
Specifies the maximum number of results to display.
Exceptions
IoTTwinMaker.Client.exceptions.InternalServerExceptionIoTTwinMaker.Client.exceptions.AccessDeniedExceptionIoTTwinMaker.Client.exceptions.ThrottlingExceptionIoTTwinMaker.Client.exceptions.ValidationExceptionlist_entities(**kwargs)¶Lists all entities in a workspace.
See also: AWS API Documentation
Request Syntax
response = client.list_entities(
workspaceId='string',
filters=[
{
'parentEntityId': 'string',
'componentTypeId': 'string',
'externalId': 'string'
},
],
maxResults=123,
nextToken='string'
)
[REQUIRED]
The ID of the workspace.
A list of objects that filter the request.
Note
Only one object is accepted as a valid input.
An object that filters items in a list of entities.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: parentEntityId, componentTypeId, externalId.
The parent of the entities in the list.
The ID of the component type in the entities in the list.
The external-Id property of a component. The external-Id property is the primary key of an external storage system.
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
{
'entitySummaries': [
{
'entityId': 'string',
'entityName': 'string',
'arn': 'string',
'parentEntityId': 'string',
'status': {
'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR',
'message': 'string'
}
},
'description': 'string',
'hasChildEntities': True|False,
'creationDateTime': datetime(2015, 1, 1),
'updateDateTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
entitySummaries (list) --
A list of objects that contain information about the entities.
(dict) --
An object that contains information about an entity.
entityId (string) --
The ID of the entity.
entityName (string) --
The name of the entity.
arn (string) --
The ARN of the entity.
parentEntityId (string) --
The ID of the parent entity.
status (dict) --
The current status of the entity.
state (string) --
The current state of the entity, component, component type, or workspace.
error (dict) --
The error message.
code (string) --
The error code.
message (string) --
The error message.
description (string) --
The description of the entity.
hasChildEntities (boolean) --
A Boolean value that specifies whether the entity has child entities or not.
creationDateTime (datetime) --
The date and time when the entity was created.
updateDateTime (datetime) --
The last date and time when the entity was updated.
nextToken (string) --
The string that specifies the next page of results.
Exceptions
IoTTwinMaker.Client.exceptions.InternalServerExceptionIoTTwinMaker.Client.exceptions.ThrottlingExceptionIoTTwinMaker.Client.exceptions.ValidationExceptionIoTTwinMaker.Client.exceptions.ServiceQuotaExceededExceptionlist_scenes(**kwargs)¶Lists all scenes in a workspace.
See also: AWS API Documentation
Request Syntax
response = client.list_scenes(
workspaceId='string',
maxResults=123,
nextToken='string'
)
[REQUIRED]
The ID of the workspace that contains the scenes.
dict
Response Syntax
{
'sceneSummaries': [
{
'sceneId': 'string',
'contentLocation': 'string',
'arn': 'string',
'creationDateTime': datetime(2015, 1, 1),
'updateDateTime': datetime(2015, 1, 1),
'description': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
sceneSummaries (list) --
A list of objects that contain information about the scenes.
(dict) --
An object that contains information about a scene.
sceneId (string) --
The ID of the scene.
contentLocation (string) --
The relative path that specifies the location of the content definition file.
arn (string) --
The ARN of the scene.
creationDateTime (datetime) --
The date and time when the scene was created.
updateDateTime (datetime) --
The date and time when the scene was last updated.
description (string) --
The scene description.
nextToken (string) --
The string that specifies the next page of results.
Exceptions
IoTTwinMaker.Client.exceptions.InternalServerExceptionIoTTwinMaker.Client.exceptions.AccessDeniedExceptionIoTTwinMaker.Client.exceptions.ThrottlingExceptionIoTTwinMaker.Client.exceptions.ValidationExceptionlist_sync_jobs(**kwargs)¶List all SyncJobs.
See also: AWS API Documentation
Request Syntax
response = client.list_sync_jobs(
workspaceId='string',
maxResults=123,
nextToken='string'
)
[REQUIRED]
The ID of the workspace that contains the sync job.
The maximum number of results to return at one time. The default is 50.
Valid Range: Minimum value of 0. Maximum value of 200.
dict
Response Syntax
{
'syncJobSummaries': [
{
'arn': 'string',
'workspaceId': 'string',
'syncSource': 'string',
'status': {
'state': 'CREATING'|'INITIALIZING'|'ACTIVE'|'DELETING'|'ERROR',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR',
'message': 'string'
}
},
'creationDateTime': datetime(2015, 1, 1),
'updateDateTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
syncJobSummaries (list) --
The listed SyncJob summaries.
(dict) --
The SyncJob summary.
arn (string) --
The SyncJob summary ARN.
workspaceId (string) --
The ID of the workspace that contains the sync job.
syncSource (string) --
The sync source.
status (dict) --
The SyncJob summaries status.
state (string) --
The SyncJob status state.
error (dict) --
The SyncJob error.
code (string) --
The error code.
message (string) --
The error message.
creationDateTime (datetime) --
The creation date and time.
updateDateTime (datetime) --
The update date and time.
nextToken (string) --
The string that specifies the next page of results.
Exceptions
IoTTwinMaker.Client.exceptions.InternalServerExceptionIoTTwinMaker.Client.exceptions.AccessDeniedExceptionIoTTwinMaker.Client.exceptions.ThrottlingExceptionIoTTwinMaker.Client.exceptions.ValidationExceptionIoTTwinMaker.Client.exceptions.ServiceQuotaExceededExceptionlist_sync_resources(**kwargs)¶Lists the sync resources.
See also: AWS API Documentation
Request Syntax
response = 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'
)
[REQUIRED]
The ID of the workspace that contains the sync job.
[REQUIRED]
The sync soucre.
Note
Currently the only supported syncSoucre is SITEWISE .
A list of objects that filter the request.
The sync resource filter.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: state, resourceType, resourceId, externalId.
The sync resource filter's state.
The sync resource filter resoucre type
The sync resource filter resource Id.
The external Id.
The maximum number of results to return at one time. The default is 50.
Valid Range: Minimum value of 0. Maximum value of 200.
dict
Response Syntax
{
'syncResources': [
{
'resourceType': 'ENTITY'|'COMPONENT_TYPE',
'externalId': 'string',
'resourceId': 'string',
'status': {
'state': 'INITIALIZING'|'PROCESSING'|'DELETED'|'IN_SYNC'|'ERROR',
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR',
'message': 'string'
}
},
'updateDateTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
syncResources (list) --
The sync resources.
(dict) --
The sync resource summary.
resourceType (string) --
The resource type.
externalId (string) --
The external Id.
resourceId (string) --
The resource Id.
status (dict) --
The sync resource summary status.
state (string) --
The sync resource status state.
error (dict) --
The status error.
code (string) --
The error code.
message (string) --
The error message.
updateDateTime (datetime) --
The update date and time.
nextToken (string) --
The string that specifies the next page of results.
Exceptions
IoTTwinMaker.Client.exceptions.InternalServerExceptionIoTTwinMaker.Client.exceptions.AccessDeniedExceptionIoTTwinMaker.Client.exceptions.ThrottlingExceptionIoTTwinMaker.Client.exceptions.ValidationExceptionIoTTwinMaker.Client.exceptions.ServiceQuotaExceededExceptionLists all tags associated with a resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceARN='string',
maxResults=123,
nextToken='string'
)
[REQUIRED]
The ARN of the resource.
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
{
'tags': {
'string': 'string'
},
'nextToken': 'string'
}
Response Structure
(dict) --
tags (dict) --
Metadata that you can use to manage a resource.
nextToken (string) --
The string that specifies the next page of results.
Exceptions
IoTTwinMaker.Client.exceptions.AccessDeniedExceptionIoTTwinMaker.Client.exceptions.ResourceNotFoundExceptionlist_workspaces(**kwargs)¶Retrieves information about workspaces in the current account.
See also: AWS API Documentation
Request Syntax
response = client.list_workspaces(
maxResults=123,
nextToken='string'
)
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
{
'workspaceSummaries': [
{
'workspaceId': 'string',
'arn': 'string',
'description': '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.
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.
Exceptions
IoTTwinMaker.Client.exceptions.InternalServerExceptionIoTTwinMaker.Client.exceptions.ThrottlingExceptionIoTTwinMaker.Client.exceptions.ValidationExceptionIoTTwinMaker.Client.exceptions.ServiceQuotaExceededExceptiontag_resource(**kwargs)¶Adds tags to a resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceARN='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The ARN of the resource.
[REQUIRED]
Metadata to add to this resource.
dict
Response Syntax
{}
Response Structure
Exceptions
IoTTwinMaker.Client.exceptions.TooManyTagsExceptionIoTTwinMaker.Client.exceptions.AccessDeniedExceptionIoTTwinMaker.Client.exceptions.ResourceNotFoundExceptionuntag_resource(**kwargs)¶Removes tags from a resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceARN='string',
tagKeys=[
'string',
]
)
[REQUIRED]
The ARN of the resource.
[REQUIRED]
A list of tag key names to remove from the resource. You don't specify the value. Both the key and its associated value are removed.
dict
Response Syntax
{}
Response Structure
Exceptions
IoTTwinMaker.Client.exceptions.AccessDeniedExceptionIoTTwinMaker.Client.exceptions.ResourceNotFoundExceptionupdate_component_type(**kwargs)¶Updates information in a component type.
See also: AWS API Documentation
Request Syntax
response = 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'
)
[REQUIRED]
The ID of the workspace.
[REQUIRED]
The ID of the component type.
An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.
An object that sets information about a property.
An object that contains information about the data type.
The underlying type of the data type.
The nested type in the data type.
The allowed values for this data type.
An object that specifies a value for a property.
A Boolean value.
A double value.
An integer value.
A long value.
A string value.
A list of multiple values.
An object that maps strings to multiple DataValue objects.
An object that specifies a value for a property.
A value that relates a component to another component.
The ID of the target entity associated with this relationship value.
The name of the target component associated with the relationship value.
An expression that produces the value.
The unit of measure used in this data type.
A relationship that associates a component with another component.
The ID of the target component type associated with this relationship.
The type of the relationship.
A Boolean value that specifies whether the property is required.
A Boolean value that specifies whether the property ID comes from an external data store.
A Boolean value that specifies whether the property is stored externally.
A Boolean value that specifies whether the property consists of time series data.
An object that contains the default value.
A Boolean value.
A double value.
An integer value.
A long value.
A string value.
A list of multiple values.
An object that specifies a value for a property.
An object that maps strings to multiple DataValue objects.
An object that specifies a value for a property.
A value that relates a component to another component.
The ID of the target entity associated with this relationship value.
The name of the target component associated with the relationship value.
An expression that produces the value.
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.
A friendly name for the property.
Specifies the component type that this component type extends.
An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.
The function request body.
The required properties of the function.
The scope of the function.
The data connector.
The Lambda function associated with this data connector.
The ARN of the Lambda function.
A Boolean value that specifies whether the data connector is native to IoT TwinMaker.
The property groups
The group type.
The names of properties.
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.
Exceptions
IoTTwinMaker.Client.exceptions.InternalServerExceptionIoTTwinMaker.Client.exceptions.AccessDeniedExceptionIoTTwinMaker.Client.exceptions.ResourceNotFoundExceptionIoTTwinMaker.Client.exceptions.ThrottlingExceptionIoTTwinMaker.Client.exceptions.ValidationExceptionIoTTwinMaker.Client.exceptions.ServiceQuotaExceededExceptionupdate_entity(**kwargs)¶Updates an entity.
See also: AWS API Documentation
Request Syntax
response = client.update_entity(
workspaceId='string',
entityId='string',
entityName='string',
description='string',
componentUpdates={
'string': {
'updateType': 'CREATE'|'UPDATE'|'DELETE',
'description': 'string',
'componentTypeId': 'string',
'propertyUpdates': {
'string': {
'definition': {
'dataType': {
'type': 'RELATIONSHIP'|'STRING'|'LONG'|'BOOLEAN'|'INTEGER'|'DOUBLE'|'LIST'|'MAP',
'nestedType': {'... recursive ...'},
'allowedValues': [
{
'booleanValue': True|False,
'doubleValue': 123.0,
'integerValue': 123,
'longValue': 123,
'stringValue': 'string',
'listValue': {'... recursive ...'},
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetEntityId': 'string',
'targetComponentName': 'string'
},
'expression': 'string'
},
],
'unitOfMeasure': 'string',
'relationship': {
'targetComponentTypeId': 'string',
'relationshipType': 'string'
}
},
'isRequiredInEntity': True|False,
'isExternalId': True|False,
'isStoredExternally': True|False,
'isTimeSeries': True|False,
'defaultValue': {
'booleanValue': True|False,
'doubleValue': 123.0,
'integerValue': 123,
'longValue': 123,
'stringValue': 'string',
'listValue': [
{'... recursive ...'},
],
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetEntityId': 'string',
'targetComponentName': 'string'
},
'expression': 'string'
},
'configuration': {
'string': 'string'
},
'displayName': 'string'
},
'value': {
'booleanValue': True|False,
'doubleValue': 123.0,
'integerValue': 123,
'longValue': 123,
'stringValue': 'string',
'listValue': [
{'... recursive ...'},
],
'mapValue': {
'string': {'... recursive ...'}
},
'relationshipValue': {
'targetEntityId': 'string',
'targetComponentName': 'string'
},
'expression': 'string'
},
'updateType': 'UPDATE'|'DELETE'|'CREATE'
}
},
'propertyGroupUpdates': {
'string': {
'groupType': 'TABULAR',
'propertyNames': [
'string',
],
'updateType': 'UPDATE'|'DELETE'|'CREATE'
}
}
}
},
parentEntityUpdate={
'updateType': 'UPDATE'|'DELETE',
'parentEntityId': 'string'
}
)
[REQUIRED]
The ID of the workspace that contains the entity.
[REQUIRED]
The ID of the entity.
An object that maps strings to the component updates in the request. Each string in the mapping must be unique to this object.
The component update request.
The update type of the component update request.
The description of the component type.
The ID of the component type.
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.
An object that sets information about a property.
An object that specifies information about a property.
An object that contains information about the data type.
The underlying type of the data type.
The nested type in the data type.
The allowed values for this data type.
An object that specifies a value for a property.
A Boolean value.
A double value.
An integer value.
A long value.
A string value.
A list of multiple values.
An object that maps strings to multiple DataValue objects.
An object that specifies a value for a property.
A value that relates a component to another component.
The ID of the target entity associated with this relationship value.
The name of the target component associated with the relationship value.
An expression that produces the value.
The unit of measure used in this data type.
A relationship that associates a component with another component.
The ID of the target component type associated with this relationship.
The type of the relationship.
A Boolean value that specifies whether the property is required.
A Boolean value that specifies whether the property ID comes from an external data store.
A Boolean value that specifies whether the property is stored externally.
A Boolean value that specifies whether the property consists of time series data.
An object that contains the default value.
A Boolean value.
A double value.
An integer value.
A long value.
A string value.
A list of multiple values.
An object that specifies a value for a property.
An object that maps strings to multiple DataValue objects.
An object that specifies a value for a property.
A value that relates a component to another component.
The ID of the target entity associated with this relationship value.
The name of the target component associated with the relationship value.
An expression that produces the value.
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.
A friendly name for the property.
The value of the property.
A Boolean value.
A double value.
An integer value.
A long value.
A string value.
A list of multiple values.
An object that specifies a value for a property.
An object that maps strings to multiple DataValue objects.
An object that specifies a value for a property.
A value that relates a component to another component.
The ID of the target entity associated with this relationship value.
The name of the target component associated with the relationship value.
An expression that produces the value.
The update type of the update property request.
The property group updates.
The group type.
The property names.
The update type.
An object that describes the update request for a parent entity.
The type of the update.
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.
Exceptions
IoTTwinMaker.Client.exceptions.InternalServerExceptionIoTTwinMaker.Client.exceptions.AccessDeniedExceptionIoTTwinMaker.Client.exceptions.ResourceNotFoundExceptionIoTTwinMaker.Client.exceptions.ThrottlingExceptionIoTTwinMaker.Client.exceptions.ValidationExceptionIoTTwinMaker.Client.exceptions.ConflictExceptionIoTTwinMaker.Client.exceptions.ServiceQuotaExceededExceptionupdate_pricing_plan(**kwargs)¶Update the pricing plan.
See also: AWS API Documentation
Request Syntax
response = client.update_pricing_plan(
pricingMode='BASIC'|'STANDARD'|'TIERED_BUNDLE',
bundleNames=[
'string',
]
)
[REQUIRED]
The pricing mode.
The bundle names.
dict
Response Syntax
{
'currentPricingPlan': {
'billableEntityCount': 123,
'bundleInformation': {
'bundleNames': [
'string',
],
'pricingTier': 'TIER_1'|'TIER_2'|'TIER_3'|'TIER_4'
},
'effectiveDateTime': datetime(2015, 1, 1),
'pricingMode': 'BASIC'|'STANDARD'|'TIERED_BUNDLE',
'updateDateTime': datetime(2015, 1, 1),
'updateReason': 'DEFAULT'|'PRICING_TIER_UPDATE'|'ENTITY_COUNT_UPDATE'|'PRICING_MODE_UPDATE'|'OVERWRITTEN'
},
'pendingPricingPlan': {
'billableEntityCount': 123,
'bundleInformation': {
'bundleNames': [
'string',
],
'pricingTier': 'TIER_1'|'TIER_2'|'TIER_3'|'TIER_4'
},
'effectiveDateTime': datetime(2015, 1, 1),
'pricingMode': 'BASIC'|'STANDARD'|'TIERED_BUNDLE',
'updateDateTime': datetime(2015, 1, 1),
'updateReason': 'DEFAULT'|'PRICING_TIER_UPDATE'|'ENTITY_COUNT_UPDATE'|'PRICING_MODE_UPDATE'|'OVERWRITTEN'
}
}
Response Structure
(dict) --
currentPricingPlan (dict) --
Update the current pricing plan.
billableEntityCount (integer) --
The billable entity count.
bundleInformation (dict) --
The pricing plan's bundle information.
bundleNames (list) --
The bundle names.
pricingTier (string) --
The pricing tier.
effectiveDateTime (datetime) --
The effective date and time of the pricing plan.
pricingMode (string) --
The pricing mode.
updateDateTime (datetime) --
The set date and time for updating a pricing plan.
updateReason (string) --
The update reason, for changing a pricing plan.
pendingPricingPlan (dict) --
Update the pending pricing plan.
billableEntityCount (integer) --
The billable entity count.
bundleInformation (dict) --
The pricing plan's bundle information.
bundleNames (list) --
The bundle names.
pricingTier (string) --
The pricing tier.
effectiveDateTime (datetime) --
The effective date and time of the pricing plan.
pricingMode (string) --
The pricing mode.
updateDateTime (datetime) --
The set date and time for updating a pricing plan.
updateReason (string) --
The update reason, for changing a pricing plan.
Exceptions
IoTTwinMaker.Client.exceptions.InternalServerExceptionIoTTwinMaker.Client.exceptions.AccessDeniedExceptionIoTTwinMaker.Client.exceptions.ThrottlingExceptionIoTTwinMaker.Client.exceptions.ValidationExceptionupdate_scene(**kwargs)¶Updates a scene.
See also: AWS API Documentation
Request Syntax
response = client.update_scene(
workspaceId='string',
sceneId='string',
contentLocation='string',
description='string',
capabilities=[
'string',
]
)
[REQUIRED]
The ID of the workspace that contains the scene.
[REQUIRED]
The ID of the scene.
A list of capabilities that the scene uses to render.
dict
Response Syntax
{
'updateDateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
updateDateTime (datetime) --
The date and time when the scene was last updated.
Exceptions
IoTTwinMaker.Client.exceptions.InternalServerExceptionIoTTwinMaker.Client.exceptions.AccessDeniedExceptionIoTTwinMaker.Client.exceptions.ResourceNotFoundExceptionIoTTwinMaker.Client.exceptions.ThrottlingExceptionIoTTwinMaker.Client.exceptions.ValidationExceptionupdate_workspace(**kwargs)¶Updates a workspace.
See also: AWS API Documentation
Request Syntax
response = client.update_workspace(
workspaceId='string',
description='string',
role='string'
)
[REQUIRED]
The ID of the workspace.
dict
Response Syntax
{
'updateDateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
updateDateTime (datetime) --
The date and time of the current update.
Exceptions
IoTTwinMaker.Client.exceptions.InternalServerExceptionIoTTwinMaker.Client.exceptions.AccessDeniedExceptionIoTTwinMaker.Client.exceptions.ResourceNotFoundExceptionIoTTwinMaker.Client.exceptions.ThrottlingExceptionIoTTwinMaker.Client.exceptions.ValidationExceptionIoTTwinMaker.Client.exceptions.ServiceQuotaExceededExceptionThe available paginators are: