IoTTwinMaker ************ Client ====== class IoTTwinMaker.Client A low-level client representing AWS IoT TwinMaker IoT TwinMaker is a service with which you can 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 * cancel_metadata_transfer_job * close * create_component_type * create_entity * create_metadata_transfer_job * 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_metadata_transfer_job * 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_components * list_entities * list_metadata_transfer_jobs * list_properties * 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 IoTTwinMaker / Client / list_scenes list_scenes *********** IoTTwinMaker.Client.list_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' ) Parameters: * **workspaceId** (*string*) -- **[REQUIRED]** The ID of the workspace that contains the scenes. * **maxResults** (*integer*) -- Specifies the maximum number of results to display. * **nextToken** (*string*) -- The string that specifies the next page of results. Return type: dict Returns: **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.InternalServerException" * "IoTTwinMaker.Client.exceptions.AccessDeniedException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" IoTTwinMaker / Client / update_scene update_scene ************ IoTTwinMaker.Client.update_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', ], sceneMetadata={ 'string': 'string' } ) Parameters: * **workspaceId** (*string*) -- **[REQUIRED]** The ID of the workspace that contains the scene. * **sceneId** (*string*) -- **[REQUIRED]** The ID of the scene. * **contentLocation** (*string*) -- The relative path that specifies the location of the content definition file. * **description** (*string*) -- The description of this scene. * **capabilities** (*list*) -- A list of capabilities that the scene uses to render. * *(string) --* * **sceneMetadata** (*dict*) -- The scene metadata. * *(string) --* * *(string) --* Return type: dict Returns: **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.InternalServerException" * "IoTTwinMaker.Client.exceptions.AccessDeniedException" * "IoTTwinMaker.Client.exceptions.ResourceNotFoundException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" IoTTwinMaker / Client / get_paginator get_paginator ************* IoTTwinMaker.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "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")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. IoTTwinMaker / Client / batch_put_property_values batch_put_property_values ************************* IoTTwinMaker.Client.batch_put_property_values(**kwargs) Sets values for multiple time series properties. See also: AWS API Documentation **Request Syntax** response = client.batch_put_property_values( workspaceId='string', entries=[ { 'entityPropertyReference': { 'componentName': 'string', 'componentPath': 'string', 'externalIdProperty': { 'string': 'string' }, 'entityId': 'string', 'propertyName': 'string' }, 'propertyValues': [ { 'timestamp': datetime(2015, 1, 1), 'value': { 'booleanValue': True|False, 'doubleValue': 123.0, 'integerValue': 123, 'longValue': 123, 'stringValue': 'string', 'listValue': [ {'... recursive ...'}, ], 'mapValue': { 'string': {'... recursive ...'} }, 'relationshipValue': { 'targetEntityId': 'string', 'targetComponentName': 'string' }, 'expression': 'string' }, 'time': 'string' }, ] }, ] ) Parameters: * **workspaceId** (*string*) -- **[REQUIRED]** The ID of the workspace that contains the properties to set. * **entries** (*list*) -- **[REQUIRED]** An object that maps strings to the property value entries to set. Each string in the mapping must be unique to this object. * *(dict) --* An object that specifies information about time series property values. This object is used and consumed by the BatchPutPropertyValues action. * **entityPropertyReference** *(dict) --* **[REQUIRED]** An object that contains information about the entity that has the property. * **componentName** *(string) --* The name of the component. * **componentPath** *(string) --* This string specifies the path to the composite component, starting from the top-level component. * **externalIdProperty** *(dict) --* A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores. * *(string) --* * *(string) --* * **entityId** *(string) --* The ID of the entity. * **propertyName** *(string) --* **[REQUIRED]** The name of the property. * **propertyValues** *(list) --* A list of objects that specify time series property values. * *(dict) --* An object that contains information about a value for a time series property. * **timestamp** *(datetime) --* The timestamp of a value for a time series property. * **value** *(dict) --* **[REQUIRED]** An object that specifies a value for a time series property. * **booleanValue** *(boolean) --* A Boolean value. * **doubleValue** *(float) --* A double value. * **integerValue** *(integer) --* An integer value. * **longValue** *(integer) --* A long value. * **stringValue** *(string) --* A string value. * **listValue** *(list) --* A list of multiple values. * *(dict) --* An object that specifies a value for a property. * **mapValue** *(dict) --* An object that maps strings to multiple "DataValue" objects. * *(string) --* * *(dict) --* An object that specifies a value for a property. * **relationshipValue** *(dict) --* A value that relates a component to another component. * **targetEntityId** *(string) --* The ID of the target entity associated with this relationship value. * **targetComponentName** *(string) --* The name of the target component associated with the relationship value. * **expression** *(string) --* An expression that produces the value. * **time** *(string) --* ISO8601 DateTime of a value for a time series property. The time for when the property value was recorded in ISO 8601 format: *YYYY-MM- DDThh:mm:ss[.SSSSSSSSS][Z/±HH:mm]*. * *[YYYY]*: year * *[MM]*: month * *[DD]*: day * *[hh]*: hour * *[mm]*: minute * *[ss]*: seconds * *[.SSSSSSSSS]*: additional precision, where precedence is maintained. For example: [.573123] is equal to 573123000 nanoseconds. * *Z*: default timezone UTC * *± HH:mm*: time zone offset in Hours and Minutes. *Required sub-fields*: YYYY-MM-DDThh:mm:ss and [Z/±HH:mm] Return type: dict Returns: **Response Syntax** { 'errorEntries': [ { 'errors': [ { 'errorCode': 'string', 'errorMessage': 'string', 'entry': { 'entityPropertyReference': { 'componentName': 'string', 'componentPath': 'string', 'externalIdProperty': { 'string': 'string' }, 'entityId': 'string', 'propertyName': 'string' }, 'propertyValues': [ { 'timestamp': datetime(2015, 1, 1), 'value': { 'booleanValue': True|False, 'doubleValue': 123.0, 'integerValue': 123, 'longValue': 123, 'stringValue': 'string', 'listValue': [ {'... recursive ...'}, ], 'mapValue': { 'string': {'... recursive ...'} }, 'relationshipValue': { 'targetEntityId': 'string', 'targetComponentName': 'string' }, 'expression': 'string' }, 'time': 'string' }, ] } }, ] }, ] } **Response Structure** * *(dict) --* * **errorEntries** *(list) --* Entries that caused errors in the batch put operation. * *(dict) --* An object that contains information about errors returned by the "BatchPutProperty" action. * **errors** *(list) --* A list of objects that contain information about errors returned by the "BatchPutProperty" action. * *(dict) --* An error returned by the "BatchPutProperty" action. * **errorCode** *(string) --* The error code. * **errorMessage** *(string) --* The error message. * **entry** *(dict) --* An object that contains information about errors returned by the "BatchPutProperty" action. * **entityPropertyReference** *(dict) --* An object that contains information about the entity that has the property. * **componentName** *(string) --* The name of the component. * **componentPath** *(string) --* This string specifies the path to the composite component, starting from the top-level component. * **externalIdProperty** *(dict) --* A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores. * *(string) --* * *(string) --* * **entityId** *(string) --* The ID of the entity. * **propertyName** *(string) --* The name of the property. * **propertyValues** *(list) --* A list of objects that specify time series property values. * *(dict) --* An object that contains information about a value for a time series property. * **timestamp** *(datetime) --* The timestamp of a value for a time series property. * **value** *(dict) --* An object that specifies a value for a time series property. * **booleanValue** *(boolean) --* A Boolean value. * **doubleValue** *(float) --* A double value. * **integerValue** *(integer) --* An integer value. * **longValue** *(integer) --* A long value. * **stringValue** *(string) --* A string value. * **listValue** *(list) --* A list of multiple values. * *(dict) --* An object that specifies a value for a property. * **mapValue** *(dict) --* An object that maps strings to multiple "DataValue" objects. * *(string) --* * *(dict) --* An object that specifies a value for a property. * **relationshipValue** *(dict) --* A value that relates a component to another component. * **targetEntityId** *(string) --* The ID of the target entity associated with this relationship value. * **targetComponentName** *(string) --* The name of the target component associated with the relationship value. * **expression** *(string) --* An expression that produces the value. * **time** *(string) --* ISO8601 DateTime of a value for a time series property. The time for when the property value was recorded in ISO 8601 format: *YYYY-MM- DDThh:mm:ss[.SSSSSSSSS][Z/±HH:mm]*. * *[YYYY]*: year * *[MM]*: month * *[DD]*: day * *[hh]*: hour * *[mm]*: minute * *[ss]*: seconds * *[.SSSSSSSSS]*: additional precision, where precedence is maintained. For example: [.573123] is equal to 573123000 nanoseconds. * *Z*: default timezone UTC * *± HH:mm*: time zone offset in Hours and Minutes. *Required sub-fields*: YYYY-MM-DDThh:mm:ss and [Z/±HH:mm] **Exceptions** * "IoTTwinMaker.Client.exceptions.InternalServerException" * "IoTTwinMaker.Client.exceptions.ResourceNotFoundException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" IoTTwinMaker / Client / get_entity get_entity ********** IoTTwinMaker.Client.get_entity(**kwargs) Retrieves information about an entity. See also: AWS API Documentation **Request Syntax** response = client.get_entity( workspaceId='string', entityId='string' ) Parameters: * **workspaceId** (*string*) -- **[REQUIRED]** The ID of the workspace. * **entityId** (*string*) -- **[REQUIRED]** The ID of the entity. Return type: dict Returns: **Response Syntax** { 'entityId': 'string', 'entityName': 'string', 'arn': 'string', 'status': { 'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR', 'error': { 'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR'|'SYNC_DELETING_ERROR'|'PROCESSING_ERROR'|'COMPOSITE_COMPONENT_FAILURE', 'message': 'string' } }, 'workspaceId': 'string', 'description': 'string', 'components': { 'string': { 'componentName': 'string', 'description': 'string', 'componentTypeId': 'string', 'status': { 'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR', 'error': { 'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR'|'SYNC_DELETING_ERROR'|'PROCESSING_ERROR'|'COMPOSITE_COMPONENT_FAILURE', 'message': 'string' } }, 'definedIn': 'string', 'properties': { 'string': { 'definition': { 'dataType': { 'type': 'RELATIONSHIP'|'STRING'|'LONG'|'BOOLEAN'|'INTEGER'|'DOUBLE'|'LIST'|'MAP', 'nestedType': {'... recursive ...'}, 'allowedValues': [ { 'booleanValue': True|False, 'doubleValue': 123.0, 'integerValue': 123, 'longValue': 123, 'stringValue': 'string', 'listValue': {'... recursive ...'}, 'mapValue': { 'string': {'... recursive ...'} }, 'relationshipValue': { 'targetEntityId': 'string', 'targetComponentName': 'string' }, 'expression': 'string' }, ], 'unitOfMeasure': 'string', 'relationship': { 'targetComponentTypeId': 'string', 'relationshipType': 'string' } }, 'isTimeSeries': True|False, 'isRequiredInEntity': True|False, 'isExternalId': True|False, 'isStoredExternally': True|False, 'isImported': True|False, 'isFinal': True|False, 'isInherited': True|False, 'defaultValue': { 'booleanValue': True|False, 'doubleValue': 123.0, 'integerValue': 123, 'longValue': 123, 'stringValue': 'string', 'listValue': [ {'... recursive ...'}, ], 'mapValue': { 'string': {'... recursive ...'} }, 'relationshipValue': { 'targetEntityId': 'string', 'targetComponentName': 'string' }, 'expression': 'string' }, 'configuration': { 'string': 'string' }, 'displayName': 'string' }, 'value': { 'booleanValue': True|False, 'doubleValue': 123.0, 'integerValue': 123, 'longValue': 123, 'stringValue': 'string', 'listValue': [ {'... recursive ...'}, ], 'mapValue': { 'string': {'... recursive ...'} }, 'relationshipValue': { 'targetEntityId': 'string', 'targetComponentName': 'string' }, 'expression': 'string' }, 'areAllPropertyValuesReturned': True|False } }, 'propertyGroups': { 'string': { 'groupType': 'TABULAR', 'propertyNames': [ 'string', ], 'isInherited': True|False } }, 'syncSource': 'string', 'areAllPropertiesReturned': True|False, 'compositeComponents': { 'string': { 'componentName': 'string', 'componentTypeId': 'string', 'definedIn': 'string', 'description': 'string', 'propertyGroups': { 'string': { 'groupType': 'TABULAR', 'propertyNames': [ 'string', ], 'isInherited': True|False } }, 'status': { 'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR', 'error': { 'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR'|'SYNC_DELETING_ERROR'|'PROCESSING_ERROR'|'COMPOSITE_COMPONENT_FAILURE', 'message': 'string' } }, 'syncSource': 'string', 'componentPath': 'string' } }, 'areAllCompositeComponentsReturned': True|False } }, 'parentEntityId': 'string', 'hasChildEntities': True|False, 'creationDateTime': datetime(2015, 1, 1), 'updateDateTime': datetime(2015, 1, 1), 'syncSource': 'string', 'areAllComponentsReturned': True|False } **Response Structure** * *(dict) --* * **entityId** *(string) --* The ID of the entity. * **entityName** *(string) --* The name of the entity. * **arn** *(string) --* The ARN of the entity. * **status** *(dict) --* The current status of the entity. * **state** *(string) --* The current state of the entity, component, component type, or workspace. * **error** *(dict) --* The error message. * **code** *(string) --* The error code. * **message** *(string) --* The error message. * **workspaceId** *(string) --* The ID of the workspace. * **description** *(string) --* The description of the entity. * **components** *(dict) --* An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object. * *(string) --* * *(dict) --* An object that returns information about a component type create or update request. * **componentName** *(string) --* The name of the component. * **description** *(string) --* The description of the component type. * **componentTypeId** *(string) --* The ID of the component type. * **status** *(dict) --* The status of the component type. * **state** *(string) --* The current state of the entity, component, component type, or workspace. * **error** *(dict) --* The error message. * **code** *(string) --* The error code. * **message** *(string) --* The error message. * **definedIn** *(string) --* The name of the property definition set in the request. * **properties** *(dict) --* An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object. * *(string) --* * *(dict) --* An object that contains information about a property response. * **definition** *(dict) --* An object that specifies information about a property. * **dataType** *(dict) --* An object that contains information about the data type. * **type** *(string) --* The underlying type of the data type. * **nestedType** *(dict) --* The nested type in the data type. * **allowedValues** *(list) --* The allowed values for this data type. * *(dict) --* An object that specifies a value for a property. * **booleanValue** *(boolean) --* A Boolean value. * **doubleValue** *(float) --* A double value. * **integerValue** *(integer) --* An integer value. * **longValue** *(integer) --* A long value. * **stringValue** *(string) --* A string value. * **listValue** *(list) --* A list of multiple values. * **mapValue** *(dict) --* An object that maps strings to multiple "DataValue" objects. * *(string) --* * *(dict) --* An object that specifies a value for a property. * **relationshipValue** *(dict) --* A value that relates a component to another component. * **targetEntityId** *(string) --* The ID of the target entity associated with this relationship value. * **targetComponentName** *(string) --* The name of the target component associated with the relationship value. * **expression** *(string) --* An expression that produces the value. * **unitOfMeasure** *(string) --* The unit of measure used in this data type. * **relationship** *(dict) --* A relationship that associates a component with another component. * **targetComponentTypeId** *(string) --* The ID of the target component type associated with this relationship. * **relationshipType** *(string) --* The type of the relationship. * **isTimeSeries** *(boolean) --* A Boolean value that specifies whether the property consists of time series data. * **isRequiredInEntity** *(boolean) --* A Boolean value that specifies whether the property is required in an entity. * **isExternalId** *(boolean) --* A Boolean value that specifies whether the property ID comes from an external data store. * **isStoredExternally** *(boolean) --* A Boolean value that specifies whether the property is stored externally. * **isImported** *(boolean) --* A Boolean value that specifies whether the property definition is imported from an external data store. * **isFinal** *(boolean) --* A Boolean value that specifies whether the property definition can be updated. * **isInherited** *(boolean) --* A Boolean value that specifies whether the property definition is inherited from a parent entity. * **defaultValue** *(dict) --* An object that contains the default value. * **booleanValue** *(boolean) --* A Boolean value. * **doubleValue** *(float) --* A double value. * **integerValue** *(integer) --* An integer value. * **longValue** *(integer) --* A long value. * **stringValue** *(string) --* A string value. * **listValue** *(list) --* A list of multiple values. * *(dict) --* An object that specifies a value for a property. * **mapValue** *(dict) --* An object that maps strings to multiple "DataValue" objects. * *(string) --* * *(dict) --* An object that specifies a value for a property. * **relationshipValue** *(dict) --* A value that relates a component to another component. * **targetEntityId** *(string) --* The ID of the target entity associated with this relationship value. * **targetComponentName** *(string) --* The name of the target component associated with the relationship value. * **expression** *(string) --* An expression that produces the value. * **configuration** *(dict) --* A mapping that specifies configuration information about the property. * *(string) --* * *(string) --* * **displayName** *(string) --* A friendly name for the property. * **value** *(dict) --* The value of the property. * **booleanValue** *(boolean) --* A Boolean value. * **doubleValue** *(float) --* A double value. * **integerValue** *(integer) --* An integer value. * **longValue** *(integer) --* A long value. * **stringValue** *(string) --* A string value. * **listValue** *(list) --* A list of multiple values. * *(dict) --* An object that specifies a value for a property. * **mapValue** *(dict) --* An object that maps strings to multiple "DataValue" objects. * *(string) --* * *(dict) --* An object that specifies a value for a property. * **relationshipValue** *(dict) --* A value that relates a component to another component. * **targetEntityId** *(string) --* The ID of the target entity associated with this relationship value. * **targetComponentName** *(string) --* The name of the target component associated with the relationship value. * **expression** *(string) --* An expression that produces the value. * **areAllPropertyValuesReturned** *(boolean) --* This flag notes whether all values of a list or map type property are returned in the API response. The maximum number of values per property returned is 50. * **propertyGroups** *(dict) --* The property groups. * *(string) --* * *(dict) --* The component property group response. * **groupType** *(string) --* The group type. * **propertyNames** *(list) --* The names of properties * *(string) --* * **isInherited** *(boolean) --* A Boolean value that specifies whether the property group is inherited from a parent entity * **syncSource** *(string) --* The syncSource of the sync job, if this entity was created by a sync job. * **areAllPropertiesReturned** *(boolean) --* This flag notes whether all properties of the component are returned in the API response. The maximum number of properties returned is 800. * **compositeComponents** *(dict) --* This lists objects that contain information about the "compositeComponents". * *(string) --* * *(dict) --* An object that returns information about a component summary. * **componentName** *(string) --* The name of the component. * **componentTypeId** *(string) --* The ID of the component type. * **definedIn** *(string) --* The name of the property definition set in the request. * **description** *(string) --* The description of the component request. * **propertyGroups** *(dict) --* The property groups. * *(string) --* * *(dict) --* The component property group response. * **groupType** *(string) --* The group type. * **propertyNames** *(list) --* The names of properties * *(string) --* * **isInherited** *(boolean) --* A Boolean value that specifies whether the property group is inherited from a parent entity * **status** *(dict) --* The status of the component type. * **state** *(string) --* The current state of the entity, component, component type, or workspace. * **error** *(dict) --* The error message. * **code** *(string) --* The error code. * **message** *(string) --* The error message. * **syncSource** *(string) --* The "syncSource" of the sync job, if this entity was created by a sync job. * **componentPath** *(string) --* This string specifies the path to the composite component, starting from the top-level component. * **areAllCompositeComponentsReturned** *(boolean) --* This flag notes whether all "compositeComponents" are returned in the API response. * **parentEntityId** *(string) --* The ID of the parent entity for this entity. * **hasChildEntities** *(boolean) --* A Boolean value that specifies whether the entity has associated child entities. * **creationDateTime** *(datetime) --* The date and time when the entity was created. * **updateDateTime** *(datetime) --* The date and time when the entity was last updated. * **syncSource** *(string) --* The syncSource of the sync job, if this entity was created by a sync job. * **areAllComponentsReturned** *(boolean) --* This flag notes whether all components are returned in the API response. The maximum number of components returned is 30. **Exceptions** * "IoTTwinMaker.Client.exceptions.InternalServerException" * "IoTTwinMaker.Client.exceptions.ResourceNotFoundException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" * "IoTTwinMaker.Client.exceptions.ServiceQuotaExceededException" IoTTwinMaker / Client / execute_query execute_query ************* IoTTwinMaker.Client.execute_query(**kwargs) Run queries to access information from your knowledge graph of entities within individual workspaces. Note: The ExecuteQuery action only works with Amazon Web Services Java SDK2. ExecuteQuery will not work with any Amazon Web Services Java SDK version < 2.x. See also: AWS API Documentation **Request Syntax** response = client.execute_query( workspaceId='string', queryStatement='string', maxResults=123, nextToken='string' ) Parameters: * **workspaceId** (*string*) -- **[REQUIRED]** The ID of the workspace. * **queryStatement** (*string*) -- **[REQUIRED]** The query statement. * **maxResults** (*integer*) -- The maximum number of results to return at one time. The default is 50. * **nextToken** (*string*) -- The string that specifies the next page of results. Return type: dict Returns: **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. * (*document*) -- * **nextToken** *(string) --* The string that specifies the next page of results. **Exceptions** * "IoTTwinMaker.Client.exceptions.InternalServerException" * "IoTTwinMaker.Client.exceptions.AccessDeniedException" * "IoTTwinMaker.Client.exceptions.QueryTimeoutException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" * "IoTTwinMaker.Client.exceptions.ServiceQuotaExceededException" IoTTwinMaker / Client / list_components list_components *************** IoTTwinMaker.Client.list_components(**kwargs) This API lists the components of an entity. See also: AWS API Documentation **Request Syntax** response = client.list_components( workspaceId='string', entityId='string', componentPath='string', maxResults=123, nextToken='string' ) Parameters: * **workspaceId** (*string*) -- **[REQUIRED]** The workspace ID. * **entityId** (*string*) -- **[REQUIRED]** The ID for the entity whose metadata (component/properties) is returned by the operation. * **componentPath** (*string*) -- This string specifies the path to the composite component, starting from the top-level component. * **maxResults** (*integer*) -- The maximum number of results returned at one time. The default is 25. * **nextToken** (*string*) -- The string that specifies the next page of results. Return type: dict Returns: **Response Syntax** { 'componentSummaries': [ { 'componentName': 'string', 'componentTypeId': 'string', 'definedIn': 'string', 'description': 'string', 'propertyGroups': { 'string': { 'groupType': 'TABULAR', 'propertyNames': [ 'string', ], 'isInherited': True|False } }, 'status': { 'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR', 'error': { 'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR'|'SYNC_DELETING_ERROR'|'PROCESSING_ERROR'|'COMPOSITE_COMPONENT_FAILURE', 'message': 'string' } }, 'syncSource': 'string', 'componentPath': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **componentSummaries** *(list) --* A list of objects that contain information about the components. * *(dict) --* An object that returns information about a component summary. * **componentName** *(string) --* The name of the component. * **componentTypeId** *(string) --* The ID of the component type. * **definedIn** *(string) --* The name of the property definition set in the request. * **description** *(string) --* The description of the component request. * **propertyGroups** *(dict) --* The property groups. * *(string) --* * *(dict) --* The component property group response. * **groupType** *(string) --* The group type. * **propertyNames** *(list) --* The names of properties * *(string) --* * **isInherited** *(boolean) --* A Boolean value that specifies whether the property group is inherited from a parent entity * **status** *(dict) --* The status of the component type. * **state** *(string) --* The current state of the entity, component, component type, or workspace. * **error** *(dict) --* The error message. * **code** *(string) --* The error code. * **message** *(string) --* The error message. * **syncSource** *(string) --* The "syncSource" of the sync job, if this entity was created by a sync job. * **componentPath** *(string) --* This string specifies the path to the composite component, starting from the top-level component. * **nextToken** *(string) --* The string that specifies the next page of component results. **Exceptions** * "IoTTwinMaker.Client.exceptions.InternalServerException" * "IoTTwinMaker.Client.exceptions.AccessDeniedException" * "IoTTwinMaker.Client.exceptions.ResourceNotFoundException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" IoTTwinMaker / Client / update_pricing_plan update_pricing_plan ******************* IoTTwinMaker.Client.update_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', ] ) Parameters: * **pricingMode** (*string*) -- **[REQUIRED]** The pricing mode. * **bundleNames** (*list*) -- The bundle names. * *(string) --* Return type: dict Returns: **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. * *(string) --* * **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. * *(string) --* * **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.InternalServerException" * "IoTTwinMaker.Client.exceptions.AccessDeniedException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" IoTTwinMaker / Client / delete_sync_job delete_sync_job *************** IoTTwinMaker.Client.delete_sync_job(**kwargs) Delete the SyncJob. See also: AWS API Documentation **Request Syntax** response = client.delete_sync_job( workspaceId='string', syncSource='string' ) Parameters: * **workspaceId** (*string*) -- **[REQUIRED]** The workspace ID. * **syncSource** (*string*) -- **[REQUIRED]** The sync source. Note: Currently the only supported syncSource is >>``<>``<<. Return type: dict Returns: **Response Syntax** { 'state': 'CREATING'|'INITIALIZING'|'ACTIVE'|'DELETING'|'ERROR' } **Response Structure** * *(dict) --* * **state** *(string) --* The SyncJob response state. **Exceptions** * "IoTTwinMaker.Client.exceptions.InternalServerException" * "IoTTwinMaker.Client.exceptions.AccessDeniedException" * "IoTTwinMaker.Client.exceptions.ResourceNotFoundException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" * "IoTTwinMaker.Client.exceptions.ServiceQuotaExceededException" IoTTwinMaker / Client / can_paginate can_paginate ************ IoTTwinMaker.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "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")". Returns: "True" if the operation can be paginated, "False" otherwise. IoTTwinMaker / Client / create_metadata_transfer_job create_metadata_transfer_job **************************** IoTTwinMaker.Client.create_metadata_transfer_job(**kwargs) Creates a new metadata transfer job. See also: AWS API Documentation **Request Syntax** response = client.create_metadata_transfer_job( metadataTransferJobId='string', description='string', sources=[ { 'type': 's3'|'iotsitewise'|'iottwinmaker', 's3Configuration': { 'location': 'string' }, 'iotSiteWiseConfiguration': { 'filters': [ { 'filterByAssetModel': { 'assetModelId': 'string', 'assetModelExternalId': 'string', 'includeOffspring': True|False, 'includeAssets': True|False }, 'filterByAsset': { 'assetId': 'string', 'assetExternalId': 'string', 'includeOffspring': True|False, 'includeAssetModel': True|False } }, ] }, 'iotTwinMakerConfiguration': { 'workspace': 'string', 'filters': [ { 'filterByComponentType': { 'componentTypeId': 'string' }, 'filterByEntity': { 'entityId': 'string' } }, ] } }, ], destination={ 'type': 's3'|'iotsitewise'|'iottwinmaker', 's3Configuration': { 'location': 'string' }, 'iotTwinMakerConfiguration': { 'workspace': 'string' } } ) Parameters: * **metadataTransferJobId** (*string*) -- The metadata transfer job Id. * **description** (*string*) -- The metadata transfer job description. * **sources** (*list*) -- **[REQUIRED]** The metadata transfer job sources. * *(dict) --* The source configuration. * **type** *(string) --* **[REQUIRED]** The source configuration type. * **s3Configuration** *(dict) --* The source configuration S3 configuration. * **location** *(string) --* **[REQUIRED]** The S3 destination source configuration location. * **iotSiteWiseConfiguration** *(dict) --* The source configuration IoT SiteWise configuration. * **filters** *(list) --* The AWS IoT SiteWise soucre configuration filters. * *(dict) --* The AWS IoT SiteWise soucre configuration filter.[need held with desc here] Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "filterByAssetModel", "filterByAsset". * **filterByAssetModel** *(dict) --* Filter by asset model. * **assetModelId** *(string) --* The asset model Id. * **assetModelExternalId** *(string) --* The external-Id property of an asset model. * **includeOffspring** *(boolean) --* Include asset offspring. [need desc.] * **includeAssets** *(boolean) --* Bolean to include assets. * **filterByAsset** *(dict) --* Filter by asset. * **assetId** *(string) --* Filter by asset Id. * **assetExternalId** *(string) --* The external-Id property of an asset. * **includeOffspring** *(boolean) --* Includes sub-assets.[need description hekp for this] * **includeAssetModel** *(boolean) --* Boolean to include the asset model. * **iotTwinMakerConfiguration** *(dict) --* The source configuration IoT TwinMaker configuration. * **workspace** *(string) --* **[REQUIRED]** The IoT TwinMaker workspace. * **filters** *(list) --* The metadata transfer job AWS IoT TwinMaker source configuration filters. * *(dict) --* The metadata transfer job AWS IoT TwinMaker source configuration filter. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "filterByComponentType", "filterByEntity". * **filterByComponentType** *(dict) --* Filter by component type. * **componentTypeId** *(string) --* **[REQUIRED]** The component type Id. * **filterByEntity** *(dict) --* Filter by entity. * **entityId** *(string) --* **[REQUIRED]** The entity Id. * **destination** (*dict*) -- **[REQUIRED]** The metadata transfer job destination. * **type** *(string) --* **[REQUIRED]** The destination type. * **s3Configuration** *(dict) --* The metadata transfer job S3 configuration. [need to add S3 entity] * **location** *(string) --* **[REQUIRED]** The S3 destination configuration location. * **iotTwinMakerConfiguration** *(dict) --* The metadata transfer job Amazon Web Services IoT TwinMaker configuration. * **workspace** *(string) --* **[REQUIRED]** The IoT TwinMaker workspace. Return type: dict Returns: **Response Syntax** { 'metadataTransferJobId': 'string', 'arn': 'string', 'creationDateTime': datetime(2015, 1, 1), 'status': { 'state': 'VALIDATING'|'PENDING'|'RUNNING'|'CANCELLING'|'ERROR'|'COMPLETED'|'CANCELLED', 'error': { 'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR'|'SYNC_DELETING_ERROR'|'PROCESSING_ERROR'|'COMPOSITE_COMPONENT_FAILURE', 'message': 'string' }, 'queuedPosition': 123 } } **Response Structure** * *(dict) --* * **metadataTransferJobId** *(string) --* The metadata transfer job Id. * **arn** *(string) --* The metadata transfer job ARN. * **creationDateTime** *(datetime) --* The The metadata transfer job creation DateTime property. * **status** *(dict) --* The metadata transfer job response status. * **state** *(string) --* The metadata transfer job state. * **error** *(dict) --* The metadata transfer job error. * **code** *(string) --* The error code. * **message** *(string) --* The error message. * **queuedPosition** *(integer) --* The queued position. **Exceptions** * "IoTTwinMaker.Client.exceptions.InternalServerException" * "IoTTwinMaker.Client.exceptions.AccessDeniedException" * "IoTTwinMaker.Client.exceptions.ResourceNotFoundException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" * "IoTTwinMaker.Client.exceptions.ConflictException" * "IoTTwinMaker.Client.exceptions.ServiceQuotaExceededException" IoTTwinMaker / Client / list_entities list_entities ************* IoTTwinMaker.Client.list_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' ) Parameters: * **workspaceId** (*string*) -- **[REQUIRED]** The ID of the workspace. * **filters** (*list*) -- A list of objects that filter the request. Note: Only one object is accepted as a valid input. * *(dict) --* An object that filters items in a list of entities. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "parentEntityId", "componentTypeId", "externalId". * **parentEntityId** *(string) --* The parent of the entities in the list. * **componentTypeId** *(string) --* The ID of the component type in the entities in the list. * **externalId** *(string) --* The external-Id property of a component. The external-Id property is the primary key of an external storage system. * **maxResults** (*integer*) -- The maximum number of results to return at one time. The default is 25. Valid Range: Minimum value of 1. Maximum value of 250. * **nextToken** (*string*) -- The string that specifies the next page of results. Return type: dict Returns: **Response Syntax** { 'entitySummaries': [ { 'entityId': 'string', 'entityName': 'string', 'arn': 'string', 'parentEntityId': 'string', 'status': { 'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR', 'error': { 'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR'|'SYNC_DELETING_ERROR'|'PROCESSING_ERROR'|'COMPOSITE_COMPONENT_FAILURE', 'message': 'string' } }, 'description': 'string', 'hasChildEntities': True|False, 'creationDateTime': datetime(2015, 1, 1), 'updateDateTime': datetime(2015, 1, 1) }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **entitySummaries** *(list) --* A list of objects that contain information about the entities. * *(dict) --* An object that contains information about an entity. * **entityId** *(string) --* The ID of the entity. * **entityName** *(string) --* The name of the entity. * **arn** *(string) --* The ARN of the entity. * **parentEntityId** *(string) --* The ID of the parent entity. * **status** *(dict) --* The current status of the entity. * **state** *(string) --* The current state of the entity, component, component type, or workspace. * **error** *(dict) --* The error message. * **code** *(string) --* The error code. * **message** *(string) --* The error message. * **description** *(string) --* The description of the entity. * **hasChildEntities** *(boolean) --* An **eventual** Boolean value that specifies whether the entity has child entities or not. * **creationDateTime** *(datetime) --* The date and time when the entity was created. * **updateDateTime** *(datetime) --* The last date and time when the entity was updated. * **nextToken** *(string) --* The string that specifies the next page of results. **Exceptions** * "IoTTwinMaker.Client.exceptions.InternalServerException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" * "IoTTwinMaker.Client.exceptions.ServiceQuotaExceededException" IoTTwinMaker / Client / delete_component_type delete_component_type ********************* IoTTwinMaker.Client.delete_component_type(**kwargs) Deletes a component type. See also: AWS API Documentation **Request Syntax** response = client.delete_component_type( workspaceId='string', componentTypeId='string' ) Parameters: * **workspaceId** (*string*) -- **[REQUIRED]** The ID of the workspace that contains the component type. * **componentTypeId** (*string*) -- **[REQUIRED]** The ID of the component type to delete. Return type: dict Returns: **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.InternalServerException" * "IoTTwinMaker.Client.exceptions.AccessDeniedException" * "IoTTwinMaker.Client.exceptions.ResourceNotFoundException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" IoTTwinMaker / Client / delete_workspace delete_workspace **************** IoTTwinMaker.Client.delete_workspace(**kwargs) Deletes a workspace. See also: AWS API Documentation **Request Syntax** response = client.delete_workspace( workspaceId='string' ) Parameters: **workspaceId** (*string*) -- **[REQUIRED]** The ID of the workspace to delete. Return type: dict Returns: **Response Syntax** { 'message': 'string' } **Response Structure** * *(dict) --* * **message** *(string) --* The string that specifies the delete result for the workspace. **Exceptions** * "IoTTwinMaker.Client.exceptions.InternalServerException" * "IoTTwinMaker.Client.exceptions.AccessDeniedException" * "IoTTwinMaker.Client.exceptions.ResourceNotFoundException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" IoTTwinMaker / Client / list_sync_jobs list_sync_jobs ************** IoTTwinMaker.Client.list_sync_jobs(**kwargs) List all SyncJobs. See also: AWS API Documentation **Request Syntax** response = client.list_sync_jobs( workspaceId='string', maxResults=123, nextToken='string' ) Parameters: * **workspaceId** (*string*) -- **[REQUIRED]** The ID of the workspace that contains the sync job. * **maxResults** (*integer*) -- The maximum number of results to return at one time. The default is 50. Valid Range: Minimum value of 0. Maximum value of 200. * **nextToken** (*string*) -- The string that specifies the next page of results. Return type: dict Returns: **Response Syntax** { 'syncJobSummaries': [ { 'arn': 'string', 'workspaceId': 'string', 'syncSource': 'string', 'status': { 'state': 'CREATING'|'INITIALIZING'|'ACTIVE'|'DELETING'|'ERROR', 'error': { 'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR'|'SYNC_DELETING_ERROR'|'PROCESSING_ERROR'|'COMPOSITE_COMPONENT_FAILURE', 'message': 'string' } }, 'creationDateTime': datetime(2015, 1, 1), 'updateDateTime': datetime(2015, 1, 1) }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **syncJobSummaries** *(list) --* The listed SyncJob summaries. * *(dict) --* The SyncJob summary. * **arn** *(string) --* The SyncJob summary ARN. * **workspaceId** *(string) --* The ID of the workspace that contains the sync job. * **syncSource** *(string) --* The sync source. * **status** *(dict) --* The SyncJob summaries status. * **state** *(string) --* The SyncJob status state. * **error** *(dict) --* The SyncJob error. * **code** *(string) --* The error code. * **message** *(string) --* The error message. * **creationDateTime** *(datetime) --* The creation date and time. * **updateDateTime** *(datetime) --* The update date and time. * **nextToken** *(string) --* The string that specifies the next page of results. **Exceptions** * "IoTTwinMaker.Client.exceptions.InternalServerException" * "IoTTwinMaker.Client.exceptions.AccessDeniedException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" * "IoTTwinMaker.Client.exceptions.ServiceQuotaExceededException" IoTTwinMaker / Client / create_component_type create_component_type ********************* IoTTwinMaker.Client.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', compositeComponentTypes={ 'string': { 'componentTypeId': 'string' } } ) Parameters: * **workspaceId** (*string*) -- **[REQUIRED]** 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*) -- **[REQUIRED]** 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 sets information about a property. * **dataType** *(dict) --* An object that contains information about the data type. * **type** *(string) --* **[REQUIRED]** The underlying type of the data type. * **nestedType** *(dict) --* The nested type in the data type. * **allowedValues** *(list) --* The allowed values for this data type. * *(dict) --* An object that specifies a value for a property. * **booleanValue** *(boolean) --* A Boolean value. * **doubleValue** *(float) --* A double value. * **integerValue** *(integer) --* An integer value. * **longValue** *(integer) --* A long value. * **stringValue** *(string) --* A string value. * **listValue** *(list) --* A list of multiple values. * **mapValue** *(dict) --* An object that maps strings to multiple "DataValue" objects. * *(string) --* * *(dict) --* An object that specifies a value for a property. * **relationshipValue** *(dict) --* A value that relates a component to another component. * **targetEntityId** *(string) --* The ID of the target entity associated with this relationship value. * **targetComponentName** *(string) --* The name of the target component associated with the relationship value. * **expression** *(string) --* An expression that produces the value. * **unitOfMeasure** *(string) --* The unit of measure used in this data type. * **relationship** *(dict) --* A relationship that associates a component with another component. * **targetComponentTypeId** *(string) --* The ID of the target component type associated with this relationship. * **relationshipType** *(string) --* The type of the relationship. * **isRequiredInEntity** *(boolean) --* A Boolean value that specifies whether the property is required. * **isExternalId** *(boolean) --* A Boolean value that specifies whether the property ID comes from an external data store. * **isStoredExternally** *(boolean) --* A Boolean value that specifies whether the property is stored externally. * **isTimeSeries** *(boolean) --* A Boolean value that specifies whether the property consists of time series data. * **defaultValue** *(dict) --* An object that contains the default value. * **booleanValue** *(boolean) --* A Boolean value. * **doubleValue** *(float) --* A double value. * **integerValue** *(integer) --* An integer value. * **longValue** *(integer) --* A long value. * **stringValue** *(string) --* A string value. * **listValue** *(list) --* A list of multiple values. * *(dict) --* An object that specifies a value for a property. * **mapValue** *(dict) --* An object that maps strings to multiple "DataValue" objects. * *(string) --* * *(dict) --* An object that specifies a value for a property. * **relationshipValue** *(dict) --* A value that relates a component to another component. * **targetEntityId** *(string) --* The ID of the target entity associated with this relationship value. * **targetComponentName** *(string) --* The name of the target component associated with the relationship value. * **expression** *(string) --* An expression that produces the value. * **configuration** *(dict) --* A mapping that specifies configuration information about the property. Use this field to specify information that you read from and write to an external source. * *(string) --* * *(string) --* * **displayName** *(string) --* A friendly name for the property. * **extendsFrom** (*list*) -- Specifies the parent component type to extend. * *(string) --* * **functions** (*dict*) -- An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object. * *(string) --* * *(dict) --* The function request body. * **requiredProperties** *(list) --* The required properties of the function. * *(string) --* * **scope** *(string) --* The scope of the function. * **implementedBy** *(dict) --* The data connector. * **lambda** *(dict) --* The Lambda function associated with this data connector. * **arn** *(string) --* **[REQUIRED]** The ARN of the Lambda function. * **isNative** *(boolean) --* A Boolean value that specifies whether the data connector is native to IoT TwinMaker. * **tags** (*dict*) -- Metadata that you can use to manage the component type. * *(string) --* * *(string) --* * **propertyGroups** (*dict*) -- * *(string) --* * *(dict) --* * **groupType** *(string) --* The group type. * **propertyNames** *(list) --* The names of properties. * *(string) --* * **componentTypeName** (*string*) -- A friendly name for the component type. * **compositeComponentTypes** (*dict*) -- This is an object that maps strings to "compositeComponentTypes" of the "componentType". "CompositeComponentType" is referenced by "componentTypeId". * *(string) --* * *(dict) --* An object that sets information about the composite component types of a component type. * **componentTypeId** *(string) --* This is the "componentTypeId" that the "compositeComponentType" refers to. Return type: dict Returns: **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.InternalServerException" * "IoTTwinMaker.Client.exceptions.AccessDeniedException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" * "IoTTwinMaker.Client.exceptions.ConflictException" * "IoTTwinMaker.Client.exceptions.ServiceQuotaExceededException" IoTTwinMaker / Client / get_scene get_scene ********* IoTTwinMaker.Client.get_scene(**kwargs) Retrieves information about a scene. See also: AWS API Documentation **Request Syntax** response = client.get_scene( workspaceId='string', sceneId='string' ) Parameters: * **workspaceId** (*string*) -- **[REQUIRED]** The ID of the workspace that contains the scene. * **sceneId** (*string*) -- **[REQUIRED]** The ID of the scene. Return type: dict Returns: **Response Syntax** { 'workspaceId': 'string', 'sceneId': 'string', 'contentLocation': 'string', 'arn': 'string', 'creationDateTime': datetime(2015, 1, 1), 'updateDateTime': datetime(2015, 1, 1), 'description': 'string', 'capabilities': [ 'string', ], 'sceneMetadata': { 'string': 'string' }, 'generatedSceneMetadata': { 'string': 'string' }, 'error': { 'code': 'MATTERPORT_ERROR', 'message': '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. * *(string) --* * **sceneMetadata** *(dict) --* The response metadata. * *(string) --* * *(string) --* * **generatedSceneMetadata** *(dict) --* The generated scene metadata. * *(string) --* * *(string) --* * **error** *(dict) --* The SceneResponse error. * **code** *(string) --* The SceneError code. * **message** *(string) --* The SceneError message. **Exceptions** * "IoTTwinMaker.Client.exceptions.InternalServerException" * "IoTTwinMaker.Client.exceptions.AccessDeniedException" * "IoTTwinMaker.Client.exceptions.ResourceNotFoundException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" IoTTwinMaker / Client / create_workspace create_workspace **************** IoTTwinMaker.Client.create_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' } ) Parameters: * **workspaceId** (*string*) -- **[REQUIRED]** The ID of the workspace. * **description** (*string*) -- The description of the workspace. * **s3Location** (*string*) -- The ARN of the S3 bucket where resources associated with the workspace are stored. * **role** (*string*) -- The ARN of the execution role associated with the workspace. * **tags** (*dict*) -- Metadata that you can use to manage the workspace * *(string) --* * *(string) --* Return type: dict Returns: **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.InternalServerException" * "IoTTwinMaker.Client.exceptions.AccessDeniedException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" * "IoTTwinMaker.Client.exceptions.ConflictException" * "IoTTwinMaker.Client.exceptions.ServiceQuotaExceededException" IoTTwinMaker / Client / list_sync_resources list_sync_resources ******************* IoTTwinMaker.Client.list_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' ) Parameters: * **workspaceId** (*string*) -- **[REQUIRED]** The ID of the workspace that contains the sync job. * **syncSource** (*string*) -- **[REQUIRED]** The sync source. Note: Currently the only supported syncSource is >>``<>``<<. * **filters** (*list*) -- A list of objects that filter the request. The following filter combinations are supported: * Filter with state * Filter with ResourceType and ResourceId * Filter with ResourceType and ExternalId * *(dict) --* The sync resource filter. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "state", "resourceType", "resourceId", "externalId". * **state** *(string) --* The sync resource filter's state. * **resourceType** *(string) --* The sync resource filter resource type * **resourceId** *(string) --* The sync resource filter resource ID. * **externalId** *(string) --* The external ID. * **maxResults** (*integer*) -- The maximum number of results to return at one time. The default is 50. Valid Range: Minimum value of 0. Maximum value of 200. * **nextToken** (*string*) -- The string that specifies the next page of results. Return type: dict Returns: **Response Syntax** { 'syncResources': [ { 'resourceType': 'ENTITY'|'COMPONENT_TYPE', 'externalId': 'string', 'resourceId': 'string', 'status': { 'state': 'INITIALIZING'|'PROCESSING'|'DELETED'|'IN_SYNC'|'ERROR', 'error': { 'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR'|'SYNC_DELETING_ERROR'|'PROCESSING_ERROR'|'COMPOSITE_COMPONENT_FAILURE', 'message': 'string' } }, 'updateDateTime': datetime(2015, 1, 1) }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **syncResources** *(list) --* The sync resources. * *(dict) --* The sync resource summary. * **resourceType** *(string) --* The resource type. * **externalId** *(string) --* The external ID. * **resourceId** *(string) --* The resource ID. * **status** *(dict) --* The sync resource summary status. * **state** *(string) --* The sync resource status state. * **error** *(dict) --* The status error. * **code** *(string) --* The error code. * **message** *(string) --* The error message. * **updateDateTime** *(datetime) --* The update date and time. * **nextToken** *(string) --* The string that specifies the next page of results. **Exceptions** * "IoTTwinMaker.Client.exceptions.InternalServerException" * "IoTTwinMaker.Client.exceptions.AccessDeniedException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" * "IoTTwinMaker.Client.exceptions.ServiceQuotaExceededException" IoTTwinMaker / Client / list_tags_for_resource list_tags_for_resource ********************** IoTTwinMaker.Client.list_tags_for_resource(**kwargs) Lists 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' ) Parameters: * **resourceARN** (*string*) -- **[REQUIRED]** The ARN of the resource. * **maxResults** (*integer*) -- The maximum number of results to return at one time. The default is 25. Valid Range: Minimum value of 1. Maximum value of 250. * **nextToken** (*string*) -- The string that specifies the next page of results. Return type: dict Returns: **Response Syntax** { 'tags': { 'string': 'string' }, 'nextToken': 'string' } **Response Structure** * *(dict) --* * **tags** *(dict) --* Metadata that you can use to manage a resource. * *(string) --* * *(string) --* * **nextToken** *(string) --* The string that specifies the next page of results. **Exceptions** * "IoTTwinMaker.Client.exceptions.AccessDeniedException" * "IoTTwinMaker.Client.exceptions.ResourceNotFoundException" IoTTwinMaker / Client / cancel_metadata_transfer_job cancel_metadata_transfer_job **************************** IoTTwinMaker.Client.cancel_metadata_transfer_job(**kwargs) Cancels the metadata transfer job. See also: AWS API Documentation **Request Syntax** response = client.cancel_metadata_transfer_job( metadataTransferJobId='string' ) Parameters: **metadataTransferJobId** (*string*) -- **[REQUIRED]** The metadata transfer job Id. Return type: dict Returns: **Response Syntax** { 'metadataTransferJobId': 'string', 'arn': 'string', 'updateDateTime': datetime(2015, 1, 1), 'status': { 'state': 'VALIDATING'|'PENDING'|'RUNNING'|'CANCELLING'|'ERROR'|'COMPLETED'|'CANCELLED', 'error': { 'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR'|'SYNC_DELETING_ERROR'|'PROCESSING_ERROR'|'COMPOSITE_COMPONENT_FAILURE', 'message': 'string' }, 'queuedPosition': 123 }, 'progress': { 'totalCount': 123, 'succeededCount': 123, 'skippedCount': 123, 'failedCount': 123 } } **Response Structure** * *(dict) --* * **metadataTransferJobId** *(string) --* The metadata transfer job Id. * **arn** *(string) --* The metadata transfer job ARN. * **updateDateTime** *(datetime) --* Used to update the DateTime property. * **status** *(dict) --* The metadata transfer job's status. * **state** *(string) --* The metadata transfer job state. * **error** *(dict) --* The metadata transfer job error. * **code** *(string) --* The error code. * **message** *(string) --* The error message. * **queuedPosition** *(integer) --* The queued position. * **progress** *(dict) --* The metadata transfer job's progress. * **totalCount** *(integer) --* The total count. [of what] * **succeededCount** *(integer) --* The succeeded count. * **skippedCount** *(integer) --* The skipped count. * **failedCount** *(integer) --* The failed count. **Exceptions** * "IoTTwinMaker.Client.exceptions.InternalServerException" * "IoTTwinMaker.Client.exceptions.AccessDeniedException" * "IoTTwinMaker.Client.exceptions.ResourceNotFoundException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" * "IoTTwinMaker.Client.exceptions.ConflictException" IoTTwinMaker / Client / get_property_value_history get_property_value_history ************************** IoTTwinMaker.Client.get_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', componentPath='string', componentTypeId='string', selectedProperties=[ 'string', ], propertyFilters=[ { 'propertyName': 'string', 'operator': 'string', 'value': { 'booleanValue': True|False, 'doubleValue': 123.0, 'integerValue': 123, 'longValue': 123, 'stringValue': 'string', 'listValue': [ {'... recursive ...'}, ], 'mapValue': { 'string': {'... recursive ...'} }, 'relationshipValue': { 'targetEntityId': 'string', 'targetComponentName': 'string' }, 'expression': 'string' } }, ], startDateTime=datetime(2015, 1, 1), endDateTime=datetime(2015, 1, 1), interpolation={ 'interpolationType': 'LINEAR', 'intervalInSeconds': 123 }, nextToken='string', maxResults=123, orderByTime='ASCENDING'|'DESCENDING', startTime='string', endTime='string' ) Parameters: * **workspaceId** (*string*) -- **[REQUIRED]** The ID of the workspace. * **entityId** (*string*) -- The ID of the entity. * **componentName** (*string*) -- The name of the component. * **componentPath** (*string*) -- This string specifies the path to the composite component, starting from the top-level component. * **componentTypeId** (*string*) -- The ID of the component type. * **selectedProperties** (*list*) -- **[REQUIRED]** A list of properties whose value histories the request retrieves. * *(string) --* * **propertyFilters** (*list*) -- A list of objects that filter the property value history request. * *(dict) --* An object that filters items returned by a property request. * **propertyName** *(string) --* The property name associated with this property filter. * **operator** *(string) --* The operator associated with this property filter. * **value** *(dict) --* The value associated with this property filter. * **booleanValue** *(boolean) --* A Boolean value. * **doubleValue** *(float) --* A double value. * **integerValue** *(integer) --* An integer value. * **longValue** *(integer) --* A long value. * **stringValue** *(string) --* A string value. * **listValue** *(list) --* A list of multiple values. * *(dict) --* An object that specifies a value for a property. * **mapValue** *(dict) --* An object that maps strings to multiple "DataValue" objects. * *(string) --* * *(dict) --* An object that specifies a value for a property. * **relationshipValue** *(dict) --* A value that relates a component to another component. * **targetEntityId** *(string) --* The ID of the target entity associated with this relationship value. * **targetComponentName** *(string) --* The name of the target component associated with the relationship value. * **expression** *(string) --* An expression that produces the value. * **startDateTime** (*datetime*) -- The date and time of the earliest property value to return. * **endDateTime** (*datetime*) -- The date and time of the latest property value to return. * **interpolation** (*dict*) -- An object that specifies the interpolation type and the interval over which to interpolate data. * **interpolationType** *(string) --* The interpolation type. * **intervalInSeconds** *(integer) --* The interpolation time interval in seconds. * **nextToken** (*string*) -- The string that specifies the next page of results. * **maxResults** (*integer*) -- The maximum number of results to return at one time. The default is 25. Valid Range: Minimum value of 1. Maximum value of 250. * **orderByTime** (*string*) -- The time direction to use in the result order. * **startTime** (*string*) -- The ISO8601 DateTime of the earliest property value to return. For more information about the ISO8601 DateTime format, see the data type PropertyValue. * **endTime** (*string*) -- The ISO8601 DateTime of the latest property value to return. For more information about the ISO8601 DateTime format, see the data type PropertyValue. Return type: dict Returns: **Response Syntax** { 'propertyValues': [ { 'entityPropertyReference': { 'componentName': 'string', 'componentPath': 'string', 'externalIdProperty': { 'string': 'string' }, 'entityId': 'string', 'propertyName': 'string' }, 'values': [ { 'timestamp': datetime(2015, 1, 1), 'value': { 'booleanValue': True|False, 'doubleValue': 123.0, 'integerValue': 123, 'longValue': 123, 'stringValue': 'string', 'listValue': [ {'... recursive ...'}, ], 'mapValue': { 'string': {'... recursive ...'} }, 'relationshipValue': { 'targetEntityId': 'string', 'targetComponentName': 'string' }, 'expression': 'string' }, 'time': 'string' }, ] }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **propertyValues** *(list) --* An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object. * *(dict) --* The history of values for a time series property. * **entityPropertyReference** *(dict) --* An object that uniquely identifies an entity property. * **componentName** *(string) --* The name of the component. * **componentPath** *(string) --* This string specifies the path to the composite component, starting from the top-level component. * **externalIdProperty** *(dict) --* A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores. * *(string) --* * *(string) --* * **entityId** *(string) --* The ID of the entity. * **propertyName** *(string) --* The name of the property. * **values** *(list) --* A list of objects that contain information about the values in the history of a time series property. * *(dict) --* An object that contains information about a value for a time series property. * **timestamp** *(datetime) --* The timestamp of a value for a time series property. * **value** *(dict) --* An object that specifies a value for a time series property. * **booleanValue** *(boolean) --* A Boolean value. * **doubleValue** *(float) --* A double value. * **integerValue** *(integer) --* An integer value. * **longValue** *(integer) --* A long value. * **stringValue** *(string) --* A string value. * **listValue** *(list) --* A list of multiple values. * *(dict) --* An object that specifies a value for a property. * **mapValue** *(dict) --* An object that maps strings to multiple "DataValue" objects. * *(string) --* * *(dict) --* An object that specifies a value for a property. * **relationshipValue** *(dict) --* A value that relates a component to another component. * **targetEntityId** *(string) --* The ID of the target entity associated with this relationship value. * **targetComponentName** *(string) --* The name of the target component associated with the relationship value. * **expression** *(string) --* An expression that produces the value. * **time** *(string) --* ISO8601 DateTime of a value for a time series property. The time for when the property value was recorded in ISO 8601 format: *YYYY-MM- DDThh:mm:ss[.SSSSSSSSS][Z/±HH:mm]*. * *[YYYY]*: year * *[MM]*: month * *[DD]*: day * *[hh]*: hour * *[mm]*: minute * *[ss]*: seconds * *[.SSSSSSSSS]*: additional precision, where precedence is maintained. For example: [.573123] is equal to 573123000 nanoseconds. * *Z*: default timezone UTC * *± HH:mm*: time zone offset in Hours and Minutes. *Required sub-fields*: YYYY-MM-DDThh:mm:ss and [Z/±HH:mm] * **nextToken** *(string) --* The string that specifies the next page of results. **Exceptions** * "IoTTwinMaker.Client.exceptions.InternalServerException" * "IoTTwinMaker.Client.exceptions.ConnectorFailureException" * "IoTTwinMaker.Client.exceptions.AccessDeniedException" * "IoTTwinMaker.Client.exceptions.ResourceNotFoundException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" * "IoTTwinMaker.Client.exceptions.ConnectorTimeoutException" IoTTwinMaker / Client / get_pricing_plan get_pricing_plan **************** IoTTwinMaker.Client.get_pricing_plan() Gets the pricing plan. See also: AWS API Documentation **Request Syntax** response = client.get_pricing_plan() Return type: dict Returns: **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) --* The chosen pricing plan for the current billing cycle. * **billableEntityCount** *(integer) --* The billable entity count. * **bundleInformation** *(dict) --* The pricing plan's bundle information. * **bundleNames** *(list) --* The bundle names. * *(string) --* * **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) --* The pending pricing plan. * **billableEntityCount** *(integer) --* The billable entity count. * **bundleInformation** *(dict) --* The pricing plan's bundle information. * **bundleNames** *(list) --* The bundle names. * *(string) --* * **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.InternalServerException" * "IoTTwinMaker.Client.exceptions.AccessDeniedException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" IoTTwinMaker / Client / untag_resource untag_resource ************** IoTTwinMaker.Client.untag_resource(**kwargs) Removes tags from a resource. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( resourceARN='string', tagKeys=[ 'string', ] ) Parameters: * **resourceARN** (*string*) -- **[REQUIRED]** The ARN of the resource. * **tagKeys** (*list*) -- **[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. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "IoTTwinMaker.Client.exceptions.AccessDeniedException" * "IoTTwinMaker.Client.exceptions.ResourceNotFoundException" IoTTwinMaker / Client / get_sync_job get_sync_job ************ IoTTwinMaker.Client.get_sync_job(**kwargs) Gets the SyncJob. See also: AWS API Documentation **Request Syntax** response = client.get_sync_job( syncSource='string', workspaceId='string' ) Parameters: * **syncSource** (*string*) -- **[REQUIRED]** The sync source. Note: Currently the only supported syncSource is >>``<>``<<. * **workspaceId** (*string*) -- The workspace ID. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'workspaceId': 'string', 'syncSource': 'string', 'syncRole': 'string', 'status': { 'state': 'CREATING'|'INITIALIZING'|'ACTIVE'|'DELETING'|'ERROR', 'error': { 'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR'|'SYNC_DELETING_ERROR'|'PROCESSING_ERROR'|'COMPOSITE_COMPONENT_FAILURE', 'message': 'string' } }, 'creationDateTime': datetime(2015, 1, 1), 'updateDateTime': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **arn** *(string) --* The sync job ARN. * **workspaceId** *(string) --* The ID of the workspace that contains the sync job. * **syncSource** *(string) --* The sync soucre. Note: Currently the only supported syncSource is >>``<>``<<. * **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.InternalServerException" * "IoTTwinMaker.Client.exceptions.AccessDeniedException" * "IoTTwinMaker.Client.exceptions.ResourceNotFoundException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" * "IoTTwinMaker.Client.exceptions.ServiceQuotaExceededException" IoTTwinMaker / Client / get_waiter get_waiter ********** IoTTwinMaker.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" IoTTwinMaker / Client / create_scene create_scene ************ IoTTwinMaker.Client.create_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' }, sceneMetadata={ 'string': 'string' } ) Parameters: * **workspaceId** (*string*) -- **[REQUIRED]** The ID of the workspace that contains the scene. * **sceneId** (*string*) -- **[REQUIRED]** The ID of the scene. * **contentLocation** (*string*) -- **[REQUIRED]** The relative path that specifies the location of the content definition file. * **description** (*string*) -- The description for this scene. * **capabilities** (*list*) -- A list of capabilities that the scene uses to render itself. * *(string) --* * **tags** (*dict*) -- Metadata that you can use to manage the scene. * *(string) --* * *(string) --* * **sceneMetadata** (*dict*) -- The request metadata. * *(string) --* * *(string) --* Return type: dict Returns: **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.InternalServerException" * "IoTTwinMaker.Client.exceptions.AccessDeniedException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" * "IoTTwinMaker.Client.exceptions.ConflictException" * "IoTTwinMaker.Client.exceptions.ServiceQuotaExceededException" IoTTwinMaker / Client / list_component_types list_component_types ******************** IoTTwinMaker.Client.list_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 ) Parameters: * **workspaceId** (*string*) -- **[REQUIRED]** The ID of the workspace. * **filters** (*list*) -- A list of objects that filter the request. * *(dict) --* An object that filters items in a list of component types. Note: Only one object is accepted as a valid input. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "extendsFrom", "namespace", "isAbstract". * **extendsFrom** *(string) --* The component type that the component types in the list extend. * **namespace** *(string) --* The namespace to which the component types in the list belong. * **isAbstract** *(boolean) --* A Boolean value that specifies whether the component types in the list are abstract. * **nextToken** (*string*) -- The string that specifies the next page of results. * **maxResults** (*integer*) -- The maximum number of results to return at one time. The default is 25. Valid Range: Minimum value of 1. Maximum value of 250. Return type: dict Returns: **Response Syntax** { 'workspaceId': 'string', 'componentTypeSummaries': [ { 'arn': 'string', 'componentTypeId': 'string', 'creationDateTime': datetime(2015, 1, 1), 'updateDateTime': datetime(2015, 1, 1), 'description': 'string', 'status': { 'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR', 'error': { 'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR'|'SYNC_DELETING_ERROR'|'PROCESSING_ERROR'|'COMPOSITE_COMPONENT_FAILURE', 'message': 'string' } }, 'componentTypeName': 'string' }, ], 'nextToken': 'string', 'maxResults': 123 } **Response Structure** * *(dict) --* * **workspaceId** *(string) --* The ID of the workspace. * **componentTypeSummaries** *(list) --* A list of objects that contain information about the component types. * *(dict) --* An object that contains information about a component type. * **arn** *(string) --* The ARN of the component type. * **componentTypeId** *(string) --* The ID of the component type. * **creationDateTime** *(datetime) --* The date and time when the component type was created. * **updateDateTime** *(datetime) --* The date and time when the component type was last updated. * **description** *(string) --* The description of the component type. * **status** *(dict) --* The current status of the component type. * **state** *(string) --* The current state of the entity, component, component type, or workspace. * **error** *(dict) --* The error message. * **code** *(string) --* The error code. * **message** *(string) --* The error message. * **componentTypeName** *(string) --* The component type name. * **nextToken** *(string) --* The string that specifies the next page of results. * **maxResults** *(integer) --* Specifies the maximum number of results to display. **Exceptions** * "IoTTwinMaker.Client.exceptions.InternalServerException" * "IoTTwinMaker.Client.exceptions.AccessDeniedException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" IoTTwinMaker / Client / list_workspaces list_workspaces *************** IoTTwinMaker.Client.list_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' ) Parameters: * **maxResults** (*integer*) -- The maximum number of results to return at one time. The default is 25. Valid Range: Minimum value of 1. Maximum value of 250. * **nextToken** (*string*) -- The string that specifies the next page of results. Return type: dict Returns: **Response Syntax** { 'workspaceSummaries': [ { 'workspaceId': 'string', 'arn': 'string', 'description': 'string', 'linkedServices': [ 'string', ], 'creationDateTime': datetime(2015, 1, 1), 'updateDateTime': datetime(2015, 1, 1) }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **workspaceSummaries** *(list) --* A list of objects that contain information about the workspaces. * *(dict) --* An object that contains information about a workspace. * **workspaceId** *(string) --* The ID of the workspace. * **arn** *(string) --* The ARN of the workspace. * **description** *(string) --* The description of the workspace. * **linkedServices** *(list) --* A list of services that are linked to the workspace. * *(string) --* * **creationDateTime** *(datetime) --* The date and time when the workspace was created. * **updateDateTime** *(datetime) --* The date and time when the workspace was last updated. * **nextToken** *(string) --* The string that specifies the next page of results. **Exceptions** * "IoTTwinMaker.Client.exceptions.InternalServerException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" * "IoTTwinMaker.Client.exceptions.ServiceQuotaExceededException" IoTTwinMaker / Client / update_entity update_entity ************* IoTTwinMaker.Client.update_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'|'RESET_VALUE' } }, 'propertyGroupUpdates': { 'string': { 'groupType': 'TABULAR', 'propertyNames': [ 'string', ], 'updateType': 'UPDATE'|'DELETE'|'CREATE' } } } }, compositeComponentUpdates={ 'string': { 'updateType': 'CREATE'|'UPDATE'|'DELETE', 'description': 'string', 'propertyUpdates': { 'string': { 'definition': { 'dataType': { 'type': 'RELATIONSHIP'|'STRING'|'LONG'|'BOOLEAN'|'INTEGER'|'DOUBLE'|'LIST'|'MAP', 'nestedType': {'... recursive ...'}, 'allowedValues': [ { 'booleanValue': True|False, 'doubleValue': 123.0, 'integerValue': 123, 'longValue': 123, 'stringValue': 'string', 'listValue': {'... recursive ...'}, 'mapValue': { 'string': {'... recursive ...'} }, 'relationshipValue': { 'targetEntityId': 'string', 'targetComponentName': 'string' }, 'expression': 'string' }, ], 'unitOfMeasure': 'string', 'relationship': { 'targetComponentTypeId': 'string', 'relationshipType': 'string' } }, 'isRequiredInEntity': True|False, 'isExternalId': True|False, 'isStoredExternally': True|False, 'isTimeSeries': True|False, 'defaultValue': { 'booleanValue': True|False, 'doubleValue': 123.0, 'integerValue': 123, 'longValue': 123, 'stringValue': 'string', 'listValue': [ {'... recursive ...'}, ], 'mapValue': { 'string': {'... recursive ...'} }, 'relationshipValue': { 'targetEntityId': 'string', 'targetComponentName': 'string' }, 'expression': 'string' }, 'configuration': { 'string': 'string' }, 'displayName': 'string' }, 'value': { 'booleanValue': True|False, 'doubleValue': 123.0, 'integerValue': 123, 'longValue': 123, 'stringValue': 'string', 'listValue': [ {'... recursive ...'}, ], 'mapValue': { 'string': {'... recursive ...'} }, 'relationshipValue': { 'targetEntityId': 'string', 'targetComponentName': 'string' }, 'expression': 'string' }, 'updateType': 'UPDATE'|'DELETE'|'CREATE'|'RESET_VALUE' } }, 'propertyGroupUpdates': { 'string': { 'groupType': 'TABULAR', 'propertyNames': [ 'string', ], 'updateType': 'UPDATE'|'DELETE'|'CREATE' } } } }, parentEntityUpdate={ 'updateType': 'UPDATE'|'DELETE', 'parentEntityId': 'string' } ) Parameters: * **workspaceId** (*string*) -- **[REQUIRED]** The ID of the workspace that contains the entity. * **entityId** (*string*) -- **[REQUIRED]** The ID of the entity. * **entityName** (*string*) -- The name of the entity. * **description** (*string*) -- The description of the entity. * **componentUpdates** (*dict*) -- An object that maps strings to the component updates in the request. Each string in the mapping must be unique to this object. * *(string) --* * *(dict) --* The component update request. * **updateType** *(string) --* The update type of the component update request. * **description** *(string) --* The description of the component type. * **componentTypeId** *(string) --* The ID of the component type. * **propertyUpdates** *(dict) --* An object that maps strings to the properties to set in the component type update. Each string in the mapping must be unique to this object. * *(string) --* * *(dict) --* An object that sets information about a property. * **definition** *(dict) --* An object that specifies information about a property. * **dataType** *(dict) --* An object that contains information about the data type. * **type** *(string) --* **[REQUIRED]** The underlying type of the data type. * **nestedType** *(dict) --* The nested type in the data type. * **allowedValues** *(list) --* The allowed values for this data type. * *(dict) --* An object that specifies a value for a property. * **booleanValue** *(boolean) --* A Boolean value. * **doubleValue** *(float) --* A double value. * **integerValue** *(integer) --* An integer value. * **longValue** *(integer) --* A long value. * **stringValue** *(string) --* A string value. * **listValue** *(list) --* A list of multiple values. * **mapValue** *(dict) --* An object that maps strings to multiple "DataValue" objects. * *(string) --* * *(dict) --* An object that specifies a value for a property. * **relationshipValue** *(dict) --* A value that relates a component to another component. * **targetEntityId** *(string) --* The ID of the target entity associated with this relationship value. * **targetComponentName** *(string) --* The name of the target component associated with the relationship value. * **expression** *(string) --* An expression that produces the value. * **unitOfMeasure** *(string) --* The unit of measure used in this data type. * **relationship** *(dict) --* A relationship that associates a component with another component. * **targetComponentTypeId** *(string) --* The ID of the target component type associated with this relationship. * **relationshipType** *(string) --* The type of the relationship. * **isRequiredInEntity** *(boolean) --* A Boolean value that specifies whether the property is required. * **isExternalId** *(boolean) --* A Boolean value that specifies whether the property ID comes from an external data store. * **isStoredExternally** *(boolean) --* A Boolean value that specifies whether the property is stored externally. * **isTimeSeries** *(boolean) --* A Boolean value that specifies whether the property consists of time series data. * **defaultValue** *(dict) --* An object that contains the default value. * **booleanValue** *(boolean) --* A Boolean value. * **doubleValue** *(float) --* A double value. * **integerValue** *(integer) --* An integer value. * **longValue** *(integer) --* A long value. * **stringValue** *(string) --* A string value. * **listValue** *(list) --* A list of multiple values. * *(dict) --* An object that specifies a value for a property. * **mapValue** *(dict) --* An object that maps strings to multiple "DataValue" objects. * *(string) --* * *(dict) --* An object that specifies a value for a property. * **relationshipValue** *(dict) --* A value that relates a component to another component. * **targetEntityId** *(string) --* The ID of the target entity associated with this relationship value. * **targetComponentName** *(string) --* The name of the target component associated with the relationship value. * **expression** *(string) --* An expression that produces the value. * **configuration** *(dict) --* A mapping that specifies configuration information about the property. Use this field to specify information that you read from and write to an external source. * *(string) --* * *(string) --* * **displayName** *(string) --* A friendly name for the property. * **value** *(dict) --* The value of the property. * **booleanValue** *(boolean) --* A Boolean value. * **doubleValue** *(float) --* A double value. * **integerValue** *(integer) --* An integer value. * **longValue** *(integer) --* A long value. * **stringValue** *(string) --* A string value. * **listValue** *(list) --* A list of multiple values. * *(dict) --* An object that specifies a value for a property. * **mapValue** *(dict) --* An object that maps strings to multiple "DataValue" objects. * *(string) --* * *(dict) --* An object that specifies a value for a property. * **relationshipValue** *(dict) --* A value that relates a component to another component. * **targetEntityId** *(string) --* The ID of the target entity associated with this relationship value. * **targetComponentName** *(string) --* The name of the target component associated with the relationship value. * **expression** *(string) --* An expression that produces the value. * **updateType** *(string) --* The update type of the update property request. * **propertyGroupUpdates** *(dict) --* The property group updates. * *(string) --* * *(dict) --* The component property group request. * **groupType** *(string) --* The group type. * **propertyNames** *(list) --* The property names. * *(string) --* * **updateType** *(string) --* The update type. * **compositeComponentUpdates** (*dict*) -- This is an object that maps strings to "compositeComponent" updates in the request. Each key of the map represents the "componentPath" of the "compositeComponent". * *(string) --* * *(dict) --* An object that sets information about the composite component update request. * **updateType** *(string) --* The update type of the component update request. * **description** *(string) --* The description of the component type. * **propertyUpdates** *(dict) --* An object that maps strings to the properties to set in the component type update. Each string in the mapping must be unique to this object. * *(string) --* * *(dict) --* An object that sets information about a property. * **definition** *(dict) --* An object that specifies information about a property. * **dataType** *(dict) --* An object that contains information about the data type. * **type** *(string) --* **[REQUIRED]** The underlying type of the data type. * **nestedType** *(dict) --* The nested type in the data type. * **allowedValues** *(list) --* The allowed values for this data type. * *(dict) --* An object that specifies a value for a property. * **booleanValue** *(boolean) --* A Boolean value. * **doubleValue** *(float) --* A double value. * **integerValue** *(integer) --* An integer value. * **longValue** *(integer) --* A long value. * **stringValue** *(string) --* A string value. * **listValue** *(list) --* A list of multiple values. * **mapValue** *(dict) --* An object that maps strings to multiple "DataValue" objects. * *(string) --* * *(dict) --* An object that specifies a value for a property. * **relationshipValue** *(dict) --* A value that relates a component to another component. * **targetEntityId** *(string) --* The ID of the target entity associated with this relationship value. * **targetComponentName** *(string) --* The name of the target component associated with the relationship value. * **expression** *(string) --* An expression that produces the value. * **unitOfMeasure** *(string) --* The unit of measure used in this data type. * **relationship** *(dict) --* A relationship that associates a component with another component. * **targetComponentTypeId** *(string) --* The ID of the target component type associated with this relationship. * **relationshipType** *(string) --* The type of the relationship. * **isRequiredInEntity** *(boolean) --* A Boolean value that specifies whether the property is required. * **isExternalId** *(boolean) --* A Boolean value that specifies whether the property ID comes from an external data store. * **isStoredExternally** *(boolean) --* A Boolean value that specifies whether the property is stored externally. * **isTimeSeries** *(boolean) --* A Boolean value that specifies whether the property consists of time series data. * **defaultValue** *(dict) --* An object that contains the default value. * **booleanValue** *(boolean) --* A Boolean value. * **doubleValue** *(float) --* A double value. * **integerValue** *(integer) --* An integer value. * **longValue** *(integer) --* A long value. * **stringValue** *(string) --* A string value. * **listValue** *(list) --* A list of multiple values. * *(dict) --* An object that specifies a value for a property. * **mapValue** *(dict) --* An object that maps strings to multiple "DataValue" objects. * *(string) --* * *(dict) --* An object that specifies a value for a property. * **relationshipValue** *(dict) --* A value that relates a component to another component. * **targetEntityId** *(string) --* The ID of the target entity associated with this relationship value. * **targetComponentName** *(string) --* The name of the target component associated with the relationship value. * **expression** *(string) --* An expression that produces the value. * **configuration** *(dict) --* A mapping that specifies configuration information about the property. Use this field to specify information that you read from and write to an external source. * *(string) --* * *(string) --* * **displayName** *(string) --* A friendly name for the property. * **value** *(dict) --* The value of the property. * **booleanValue** *(boolean) --* A Boolean value. * **doubleValue** *(float) --* A double value. * **integerValue** *(integer) --* An integer value. * **longValue** *(integer) --* A long value. * **stringValue** *(string) --* A string value. * **listValue** *(list) --* A list of multiple values. * *(dict) --* An object that specifies a value for a property. * **mapValue** *(dict) --* An object that maps strings to multiple "DataValue" objects. * *(string) --* * *(dict) --* An object that specifies a value for a property. * **relationshipValue** *(dict) --* A value that relates a component to another component. * **targetEntityId** *(string) --* The ID of the target entity associated with this relationship value. * **targetComponentName** *(string) --* The name of the target component associated with the relationship value. * **expression** *(string) --* An expression that produces the value. * **updateType** *(string) --* The update type of the update property request. * **propertyGroupUpdates** *(dict) --* The property group updates. * *(string) --* * *(dict) --* The component property group request. * **groupType** *(string) --* The group type. * **propertyNames** *(list) --* The property names. * *(string) --* * **updateType** *(string) --* The update type. * **parentEntityUpdate** (*dict*) -- An object that describes the update request for a parent entity. * **updateType** *(string) --* **[REQUIRED]** The type of the update. * **parentEntityId** *(string) --* The ID of the parent entity. Return type: dict Returns: **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.InternalServerException" * "IoTTwinMaker.Client.exceptions.AccessDeniedException" * "IoTTwinMaker.Client.exceptions.ResourceNotFoundException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" * "IoTTwinMaker.Client.exceptions.ConflictException" * "IoTTwinMaker.Client.exceptions.ServiceQuotaExceededException" IoTTwinMaker / Client / list_metadata_transfer_jobs list_metadata_transfer_jobs *************************** IoTTwinMaker.Client.list_metadata_transfer_jobs(**kwargs) Lists the metadata transfer jobs. See also: AWS API Documentation **Request Syntax** response = client.list_metadata_transfer_jobs( sourceType='s3'|'iotsitewise'|'iottwinmaker', destinationType='s3'|'iotsitewise'|'iottwinmaker', filters=[ { 'workspaceId': 'string', 'state': 'VALIDATING'|'PENDING'|'RUNNING'|'CANCELLING'|'ERROR'|'COMPLETED'|'CANCELLED' }, ], nextToken='string', maxResults=123 ) Parameters: * **sourceType** (*string*) -- **[REQUIRED]** The metadata transfer job's source type. * **destinationType** (*string*) -- **[REQUIRED]** The metadata transfer job's destination type. * **filters** (*list*) -- An object that filters metadata transfer jobs. * *(dict) --* The ListMetadataTransferJobs filter. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "workspaceId", "state". * **workspaceId** *(string) --* The workspace Id. * **state** *(string) --* The filter state. * **nextToken** (*string*) -- The string that specifies the next page of results. * **maxResults** (*integer*) -- The maximum number of results to return at one time. Return type: dict Returns: **Response Syntax** { 'metadataTransferJobSummaries': [ { 'metadataTransferJobId': 'string', 'arn': 'string', 'creationDateTime': datetime(2015, 1, 1), 'updateDateTime': datetime(2015, 1, 1), 'status': { 'state': 'VALIDATING'|'PENDING'|'RUNNING'|'CANCELLING'|'ERROR'|'COMPLETED'|'CANCELLED', 'error': { 'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR'|'SYNC_DELETING_ERROR'|'PROCESSING_ERROR'|'COMPOSITE_COMPONENT_FAILURE', 'message': 'string' }, 'queuedPosition': 123 }, 'progress': { 'totalCount': 123, 'succeededCount': 123, 'skippedCount': 123, 'failedCount': 123 } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **metadataTransferJobSummaries** *(list) --* The metadata transfer job summaries. * *(dict) --* The metadata transfer job summary. * **metadataTransferJobId** *(string) --* The metadata transfer job summary Id. * **arn** *(string) --* The metadata transfer job summary ARN. * **creationDateTime** *(datetime) --* The metadata transfer job summary creation DateTime object. * **updateDateTime** *(datetime) --* The metadata transfer job summary update DateTime object * **status** *(dict) --* The metadata transfer job summary status. * **state** *(string) --* The metadata transfer job state. * **error** *(dict) --* The metadata transfer job error. * **code** *(string) --* The error code. * **message** *(string) --* The error message. * **queuedPosition** *(integer) --* The queued position. * **progress** *(dict) --* The metadata transfer job summary progess. * **totalCount** *(integer) --* The total count. [of what] * **succeededCount** *(integer) --* The succeeded count. * **skippedCount** *(integer) --* The skipped count. * **failedCount** *(integer) --* The failed count. * **nextToken** *(string) --* The string that specifies the next page of results. **Exceptions** * "IoTTwinMaker.Client.exceptions.InternalServerException" * "IoTTwinMaker.Client.exceptions.AccessDeniedException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" IoTTwinMaker / Client / create_sync_job create_sync_job *************** IoTTwinMaker.Client.create_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' } ) Parameters: * **workspaceId** (*string*) -- **[REQUIRED]** The workspace ID. * **syncSource** (*string*) -- **[REQUIRED]** The sync source. Note: Currently the only supported syncSoource is >>``<>``<<. * **syncRole** (*string*) -- **[REQUIRED]** The SyncJob IAM role. This IAM role is used by the SyncJob to read from the syncSource, and create, update, or delete the corresponding resources. * **tags** (*dict*) -- The SyncJob tags. * *(string) --* * *(string) --* Return type: dict Returns: **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.InternalServerException" * "IoTTwinMaker.Client.exceptions.AccessDeniedException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" * "IoTTwinMaker.Client.exceptions.ConflictException" * "IoTTwinMaker.Client.exceptions.ServiceQuotaExceededException" IoTTwinMaker / Client / delete_scene delete_scene ************ IoTTwinMaker.Client.delete_scene(**kwargs) Deletes a scene. See also: AWS API Documentation **Request Syntax** response = client.delete_scene( workspaceId='string', sceneId='string' ) Parameters: * **workspaceId** (*string*) -- **[REQUIRED]** The ID of the workspace. * **sceneId** (*string*) -- **[REQUIRED]** The ID of the scene to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "IoTTwinMaker.Client.exceptions.InternalServerException" * "IoTTwinMaker.Client.exceptions.AccessDeniedException" * "IoTTwinMaker.Client.exceptions.ResourceNotFoundException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" IoTTwinMaker / Client / get_workspace get_workspace ************* IoTTwinMaker.Client.get_workspace(**kwargs) Retrieves information about a workspace. See also: AWS API Documentation **Request Syntax** response = client.get_workspace( workspaceId='string' ) Parameters: **workspaceId** (*string*) -- **[REQUIRED]** The ID of the workspace. Return type: dict Returns: **Response Syntax** { 'workspaceId': 'string', 'arn': 'string', 'description': 'string', 'linkedServices': [ 'string', ], 's3Location': 'string', 'role': 'string', 'creationDateTime': datetime(2015, 1, 1), 'updateDateTime': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **workspaceId** *(string) --* The ID of the workspace. * **arn** *(string) --* The ARN of the workspace. * **description** *(string) --* The description of the workspace. * **linkedServices** *(list) --* A list of services that are linked to the workspace. * *(string) --* * **s3Location** *(string) --* The ARN of the S3 bucket where resources associated with the workspace are stored. * **role** *(string) --* The ARN of the execution role associated with the workspace. * **creationDateTime** *(datetime) --* The date and time when the workspace was created. * **updateDateTime** *(datetime) --* The date and time when the workspace was last updated. **Exceptions** * "IoTTwinMaker.Client.exceptions.InternalServerException" * "IoTTwinMaker.Client.exceptions.ResourceNotFoundException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" * "IoTTwinMaker.Client.exceptions.ServiceQuotaExceededException" IoTTwinMaker / Client / update_component_type update_component_type ********************* IoTTwinMaker.Client.update_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', compositeComponentTypes={ 'string': { 'componentTypeId': 'string' } } ) Parameters: * **workspaceId** (*string*) -- **[REQUIRED]** The ID of the workspace. * **isSingleton** (*boolean*) -- A Boolean value that specifies whether an entity can have more than one component of this type. * **componentTypeId** (*string*) -- **[REQUIRED]** 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 sets information about a property. * **dataType** *(dict) --* An object that contains information about the data type. * **type** *(string) --* **[REQUIRED]** The underlying type of the data type. * **nestedType** *(dict) --* The nested type in the data type. * **allowedValues** *(list) --* The allowed values for this data type. * *(dict) --* An object that specifies a value for a property. * **booleanValue** *(boolean) --* A Boolean value. * **doubleValue** *(float) --* A double value. * **integerValue** *(integer) --* An integer value. * **longValue** *(integer) --* A long value. * **stringValue** *(string) --* A string value. * **listValue** *(list) --* A list of multiple values. * **mapValue** *(dict) --* An object that maps strings to multiple "DataValue" objects. * *(string) --* * *(dict) --* An object that specifies a value for a property. * **relationshipValue** *(dict) --* A value that relates a component to another component. * **targetEntityId** *(string) --* The ID of the target entity associated with this relationship value. * **targetComponentName** *(string) --* The name of the target component associated with the relationship value. * **expression** *(string) --* An expression that produces the value. * **unitOfMeasure** *(string) --* The unit of measure used in this data type. * **relationship** *(dict) --* A relationship that associates a component with another component. * **targetComponentTypeId** *(string) --* The ID of the target component type associated with this relationship. * **relationshipType** *(string) --* The type of the relationship. * **isRequiredInEntity** *(boolean) --* A Boolean value that specifies whether the property is required. * **isExternalId** *(boolean) --* A Boolean value that specifies whether the property ID comes from an external data store. * **isStoredExternally** *(boolean) --* A Boolean value that specifies whether the property is stored externally. * **isTimeSeries** *(boolean) --* A Boolean value that specifies whether the property consists of time series data. * **defaultValue** *(dict) --* An object that contains the default value. * **booleanValue** *(boolean) --* A Boolean value. * **doubleValue** *(float) --* A double value. * **integerValue** *(integer) --* An integer value. * **longValue** *(integer) --* A long value. * **stringValue** *(string) --* A string value. * **listValue** *(list) --* A list of multiple values. * *(dict) --* An object that specifies a value for a property. * **mapValue** *(dict) --* An object that maps strings to multiple "DataValue" objects. * *(string) --* * *(dict) --* An object that specifies a value for a property. * **relationshipValue** *(dict) --* A value that relates a component to another component. * **targetEntityId** *(string) --* The ID of the target entity associated with this relationship value. * **targetComponentName** *(string) --* The name of the target component associated with the relationship value. * **expression** *(string) --* An expression that produces the value. * **configuration** *(dict) --* A mapping that specifies configuration information about the property. Use this field to specify information that you read from and write to an external source. * *(string) --* * *(string) --* * **displayName** *(string) --* A friendly name for the property. * **extendsFrom** (*list*) -- Specifies the component type that this component type extends. * *(string) --* * **functions** (*dict*) -- An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object. * *(string) --* * *(dict) --* The function request body. * **requiredProperties** *(list) --* The required properties of the function. * *(string) --* * **scope** *(string) --* The scope of the function. * **implementedBy** *(dict) --* The data connector. * **lambda** *(dict) --* The Lambda function associated with this data connector. * **arn** *(string) --* **[REQUIRED]** The ARN of the Lambda function. * **isNative** *(boolean) --* A Boolean value that specifies whether the data connector is native to IoT TwinMaker. * **propertyGroups** (*dict*) -- The property groups. * *(string) --* * *(dict) --* * **groupType** *(string) --* The group type. * **propertyNames** *(list) --* The names of properties. * *(string) --* * **componentTypeName** (*string*) -- The component type name. * **compositeComponentTypes** (*dict*) -- This is an object that maps strings to "compositeComponentTypes" of the "componentType". "CompositeComponentType" is referenced by "componentTypeId". * *(string) --* * *(dict) --* An object that sets information about the composite component types of a component type. * **componentTypeId** *(string) --* This is the "componentTypeId" that the "compositeComponentType" refers to. Return type: dict Returns: **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.InternalServerException" * "IoTTwinMaker.Client.exceptions.AccessDeniedException" * "IoTTwinMaker.Client.exceptions.ResourceNotFoundException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" * "IoTTwinMaker.Client.exceptions.ServiceQuotaExceededException" IoTTwinMaker / Client / update_workspace update_workspace **************** IoTTwinMaker.Client.update_workspace(**kwargs) Updates a workspace. See also: AWS API Documentation **Request Syntax** response = client.update_workspace( workspaceId='string', description='string', role='string', s3Location='string' ) Parameters: * **workspaceId** (*string*) -- **[REQUIRED]** The ID of the workspace. * **description** (*string*) -- The description of the workspace. * **role** (*string*) -- The ARN of the execution role associated with the workspace. * **s3Location** (*string*) -- The ARN of the S3 bucket where resources associated with the workspace are stored. Return type: dict Returns: **Response Syntax** { 'updateDateTime': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **updateDateTime** *(datetime) --* The date and time of the current update. **Exceptions** * "IoTTwinMaker.Client.exceptions.InternalServerException" * "IoTTwinMaker.Client.exceptions.AccessDeniedException" * "IoTTwinMaker.Client.exceptions.ResourceNotFoundException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" * "IoTTwinMaker.Client.exceptions.ServiceQuotaExceededException" IoTTwinMaker / Client / close close ***** IoTTwinMaker.Client.close() Closes underlying endpoint connections. IoTTwinMaker / Client / create_entity create_entity ************* IoTTwinMaker.Client.create_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'|'RESET_VALUE' } }, 'propertyGroups': { 'string': { 'groupType': 'TABULAR', 'propertyNames': [ 'string', ], 'updateType': 'UPDATE'|'DELETE'|'CREATE' } } } }, compositeComponents={ 'string': { 'description': 'string', 'properties': { 'string': { 'definition': { 'dataType': { 'type': 'RELATIONSHIP'|'STRING'|'LONG'|'BOOLEAN'|'INTEGER'|'DOUBLE'|'LIST'|'MAP', 'nestedType': {'... recursive ...'}, 'allowedValues': [ { 'booleanValue': True|False, 'doubleValue': 123.0, 'integerValue': 123, 'longValue': 123, 'stringValue': 'string', 'listValue': {'... recursive ...'}, 'mapValue': { 'string': {'... recursive ...'} }, 'relationshipValue': { 'targetEntityId': 'string', 'targetComponentName': 'string' }, 'expression': 'string' }, ], 'unitOfMeasure': 'string', 'relationship': { 'targetComponentTypeId': 'string', 'relationshipType': 'string' } }, 'isRequiredInEntity': True|False, 'isExternalId': True|False, 'isStoredExternally': True|False, 'isTimeSeries': True|False, 'defaultValue': { 'booleanValue': True|False, 'doubleValue': 123.0, 'integerValue': 123, 'longValue': 123, 'stringValue': 'string', 'listValue': [ {'... recursive ...'}, ], 'mapValue': { 'string': {'... recursive ...'} }, 'relationshipValue': { 'targetEntityId': 'string', 'targetComponentName': 'string' }, 'expression': 'string' }, 'configuration': { 'string': 'string' }, 'displayName': 'string' }, 'value': { 'booleanValue': True|False, 'doubleValue': 123.0, 'integerValue': 123, 'longValue': 123, 'stringValue': 'string', 'listValue': [ {'... recursive ...'}, ], 'mapValue': { 'string': {'... recursive ...'} }, 'relationshipValue': { 'targetEntityId': 'string', 'targetComponentName': 'string' }, 'expression': 'string' }, 'updateType': 'UPDATE'|'DELETE'|'CREATE'|'RESET_VALUE' } }, 'propertyGroups': { 'string': { 'groupType': 'TABULAR', 'propertyNames': [ 'string', ], 'updateType': 'UPDATE'|'DELETE'|'CREATE' } } } }, parentEntityId='string', tags={ 'string': 'string' } ) Parameters: * **workspaceId** (*string*) -- **[REQUIRED]** The ID of the workspace that contains the entity. * **entityId** (*string*) -- The ID of the entity. * **entityName** (*string*) -- **[REQUIRED]** The name of the entity. * **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 sets information about a component type create or update request. * **description** *(string) --* The description of the component request. * **componentTypeId** *(string) --* The ID of the component type. * **properties** *(dict) --* An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object. * *(string) --* * *(dict) --* An object that sets information about a property. * **definition** *(dict) --* An object that specifies information about a property. * **dataType** *(dict) --* An object that contains information about the data type. * **type** *(string) --* **[REQUIRED]** The underlying type of the data type. * **nestedType** *(dict) --* The nested type in the data type. * **allowedValues** *(list) --* The allowed values for this data type. * *(dict) --* An object that specifies a value for a property. * **booleanValue** *(boolean) --* A Boolean value. * **doubleValue** *(float) --* A double value. * **integerValue** *(integer) --* An integer value. * **longValue** *(integer) --* A long value. * **stringValue** *(string) --* A string value. * **listValue** *(list) --* A list of multiple values. * **mapValue** *(dict) --* An object that maps strings to multiple "DataValue" objects. * *(string) --* * *(dict) --* An object that specifies a value for a property. * **relationshipValue** *(dict) --* A value that relates a component to another component. * **targetEntityId** *(string) --* The ID of the target entity associated with this relationship value. * **targetComponentName** *(string) --* The name of the target component associated with the relationship value. * **expression** *(string) --* An expression that produces the value. * **unitOfMeasure** *(string) --* The unit of measure used in this data type. * **relationship** *(dict) --* A relationship that associates a component with another component. * **targetComponentTypeId** *(string) --* The ID of the target component type associated with this relationship. * **relationshipType** *(string) --* The type of the relationship. * **isRequiredInEntity** *(boolean) --* A Boolean value that specifies whether the property is required. * **isExternalId** *(boolean) --* A Boolean value that specifies whether the property ID comes from an external data store. * **isStoredExternally** *(boolean) --* A Boolean value that specifies whether the property is stored externally. * **isTimeSeries** *(boolean) --* A Boolean value that specifies whether the property consists of time series data. * **defaultValue** *(dict) --* An object that contains the default value. * **booleanValue** *(boolean) --* A Boolean value. * **doubleValue** *(float) --* A double value. * **integerValue** *(integer) --* An integer value. * **longValue** *(integer) --* A long value. * **stringValue** *(string) --* A string value. * **listValue** *(list) --* A list of multiple values. * *(dict) --* An object that specifies a value for a property. * **mapValue** *(dict) --* An object that maps strings to multiple "DataValue" objects. * *(string) --* * *(dict) --* An object that specifies a value for a property. * **relationshipValue** *(dict) --* A value that relates a component to another component. * **targetEntityId** *(string) --* The ID of the target entity associated with this relationship value. * **targetComponentName** *(string) --* The name of the target component associated with the relationship value. * **expression** *(string) --* An expression that produces the value. * **configuration** *(dict) --* A mapping that specifies configuration information about the property. Use this field to specify information that you read from and write to an external source. * *(string) --* * *(string) --* * **displayName** *(string) --* A friendly name for the property. * **value** *(dict) --* The value of the property. * **booleanValue** *(boolean) --* A Boolean value. * **doubleValue** *(float) --* A double value. * **integerValue** *(integer) --* An integer value. * **longValue** *(integer) --* A long value. * **stringValue** *(string) --* A string value. * **listValue** *(list) --* A list of multiple values. * *(dict) --* An object that specifies a value for a property. * **mapValue** *(dict) --* An object that maps strings to multiple "DataValue" objects. * *(string) --* * *(dict) --* An object that specifies a value for a property. * **relationshipValue** *(dict) --* A value that relates a component to another component. * **targetEntityId** *(string) --* The ID of the target entity associated with this relationship value. * **targetComponentName** *(string) --* The name of the target component associated with the relationship value. * **expression** *(string) --* An expression that produces the value. * **updateType** *(string) --* The update type of the update property request. * **propertyGroups** *(dict) --* The property groups. * *(string) --* * *(dict) --* The component property group request. * **groupType** *(string) --* The group type. * **propertyNames** *(list) --* The property names. * *(string) --* * **updateType** *(string) --* The update type. * **compositeComponents** (*dict*) -- This is an object that maps strings to "compositeComponent" updates in the request. Each key of the map represents the "componentPath" of the "compositeComponent". * *(string) --* * *(dict) --* An object that sets information about the composite component update request. * **description** *(string) --* The description of the component type. * **properties** *(dict) --* This is an object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object. * *(string) --* * *(dict) --* An object that sets information about a property. * **definition** *(dict) --* An object that specifies information about a property. * **dataType** *(dict) --* An object that contains information about the data type. * **type** *(string) --* **[REQUIRED]** The underlying type of the data type. * **nestedType** *(dict) --* The nested type in the data type. * **allowedValues** *(list) --* The allowed values for this data type. * *(dict) --* An object that specifies a value for a property. * **booleanValue** *(boolean) --* A Boolean value. * **doubleValue** *(float) --* A double value. * **integerValue** *(integer) --* An integer value. * **longValue** *(integer) --* A long value. * **stringValue** *(string) --* A string value. * **listValue** *(list) --* A list of multiple values. * **mapValue** *(dict) --* An object that maps strings to multiple "DataValue" objects. * *(string) --* * *(dict) --* An object that specifies a value for a property. * **relationshipValue** *(dict) --* A value that relates a component to another component. * **targetEntityId** *(string) --* The ID of the target entity associated with this relationship value. * **targetComponentName** *(string) --* The name of the target component associated with the relationship value. * **expression** *(string) --* An expression that produces the value. * **unitOfMeasure** *(string) --* The unit of measure used in this data type. * **relationship** *(dict) --* A relationship that associates a component with another component. * **targetComponentTypeId** *(string) --* The ID of the target component type associated with this relationship. * **relationshipType** *(string) --* The type of the relationship. * **isRequiredInEntity** *(boolean) --* A Boolean value that specifies whether the property is required. * **isExternalId** *(boolean) --* A Boolean value that specifies whether the property ID comes from an external data store. * **isStoredExternally** *(boolean) --* A Boolean value that specifies whether the property is stored externally. * **isTimeSeries** *(boolean) --* A Boolean value that specifies whether the property consists of time series data. * **defaultValue** *(dict) --* An object that contains the default value. * **booleanValue** *(boolean) --* A Boolean value. * **doubleValue** *(float) --* A double value. * **integerValue** *(integer) --* An integer value. * **longValue** *(integer) --* A long value. * **stringValue** *(string) --* A string value. * **listValue** *(list) --* A list of multiple values. * *(dict) --* An object that specifies a value for a property. * **mapValue** *(dict) --* An object that maps strings to multiple "DataValue" objects. * *(string) --* * *(dict) --* An object that specifies a value for a property. * **relationshipValue** *(dict) --* A value that relates a component to another component. * **targetEntityId** *(string) --* The ID of the target entity associated with this relationship value. * **targetComponentName** *(string) --* The name of the target component associated with the relationship value. * **expression** *(string) --* An expression that produces the value. * **configuration** *(dict) --* A mapping that specifies configuration information about the property. Use this field to specify information that you read from and write to an external source. * *(string) --* * *(string) --* * **displayName** *(string) --* A friendly name for the property. * **value** *(dict) --* The value of the property. * **booleanValue** *(boolean) --* A Boolean value. * **doubleValue** *(float) --* A double value. * **integerValue** *(integer) --* An integer value. * **longValue** *(integer) --* A long value. * **stringValue** *(string) --* A string value. * **listValue** *(list) --* A list of multiple values. * *(dict) --* An object that specifies a value for a property. * **mapValue** *(dict) --* An object that maps strings to multiple "DataValue" objects. * *(string) --* * *(dict) --* An object that specifies a value for a property. * **relationshipValue** *(dict) --* A value that relates a component to another component. * **targetEntityId** *(string) --* The ID of the target entity associated with this relationship value. * **targetComponentName** *(string) --* The name of the target component associated with the relationship value. * **expression** *(string) --* An expression that produces the value. * **updateType** *(string) --* The update type of the update property request. * **propertyGroups** *(dict) --* The property groups. * *(string) --* * *(dict) --* The component property group request. * **groupType** *(string) --* The group type. * **propertyNames** *(list) --* The property names. * *(string) --* * **updateType** *(string) --* The update type. * **parentEntityId** (*string*) -- The ID of the entity's parent entity. * **tags** (*dict*) -- Metadata that you can use to manage the entity. * *(string) --* * *(string) --* Return type: dict Returns: **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.InternalServerException" * "IoTTwinMaker.Client.exceptions.AccessDeniedException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" * "IoTTwinMaker.Client.exceptions.ConflictException" * "IoTTwinMaker.Client.exceptions.ServiceQuotaExceededException" IoTTwinMaker / Client / delete_entity delete_entity ************* IoTTwinMaker.Client.delete_entity(**kwargs) Deletes an entity. See also: AWS API Documentation **Request Syntax** response = client.delete_entity( workspaceId='string', entityId='string', isRecursive=True|False ) Parameters: * **workspaceId** (*string*) -- **[REQUIRED]** The ID of the workspace that contains the entity to delete. * **entityId** (*string*) -- **[REQUIRED]** The ID of the entity to delete. * **isRecursive** (*boolean*) -- A Boolean value that specifies whether the operation deletes child entities. Return type: dict Returns: **Response Syntax** { 'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR' } **Response Structure** * *(dict) --* * **state** *(string) --* The current state of the deleted entity. **Exceptions** * "IoTTwinMaker.Client.exceptions.InternalServerException" * "IoTTwinMaker.Client.exceptions.ResourceNotFoundException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" * "IoTTwinMaker.Client.exceptions.ServiceQuotaExceededException" IoTTwinMaker / Client / get_component_type get_component_type ****************** IoTTwinMaker.Client.get_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' ) Parameters: * **workspaceId** (*string*) -- **[REQUIRED]** The ID of the workspace that contains the component type. * **componentTypeId** (*string*) -- **[REQUIRED]** The ID of the component type. Return type: dict Returns: **Response Syntax** { 'workspaceId': 'string', 'isSingleton': True|False, 'componentTypeId': 'string', 'description': 'string', 'propertyDefinitions': { 'string': { 'dataType': { 'type': 'RELATIONSHIP'|'STRING'|'LONG'|'BOOLEAN'|'INTEGER'|'DOUBLE'|'LIST'|'MAP', 'nestedType': {'... recursive ...'}, 'allowedValues': [ { 'booleanValue': True|False, 'doubleValue': 123.0, 'integerValue': 123, 'longValue': 123, 'stringValue': 'string', 'listValue': {'... recursive ...'}, 'mapValue': { 'string': {'... recursive ...'} }, 'relationshipValue': { 'targetEntityId': 'string', 'targetComponentName': 'string' }, 'expression': 'string' }, ], 'unitOfMeasure': 'string', 'relationship': { 'targetComponentTypeId': 'string', 'relationshipType': 'string' } }, 'isTimeSeries': True|False, 'isRequiredInEntity': True|False, 'isExternalId': True|False, 'isStoredExternally': True|False, 'isImported': True|False, 'isFinal': True|False, 'isInherited': True|False, 'defaultValue': { 'booleanValue': True|False, 'doubleValue': 123.0, 'integerValue': 123, 'longValue': 123, 'stringValue': 'string', 'listValue': [ {'... recursive ...'}, ], 'mapValue': { 'string': {'... recursive ...'} }, 'relationshipValue': { 'targetEntityId': 'string', 'targetComponentName': 'string' }, 'expression': 'string' }, 'configuration': { 'string': 'string' }, 'displayName': 'string' } }, 'extendsFrom': [ 'string', ], 'functions': { 'string': { 'requiredProperties': [ 'string', ], 'scope': 'ENTITY'|'WORKSPACE', 'implementedBy': { 'lambda': { 'arn': 'string' }, 'isNative': True|False }, 'isInherited': True|False } }, 'creationDateTime': datetime(2015, 1, 1), 'updateDateTime': datetime(2015, 1, 1), 'arn': 'string', 'isAbstract': True|False, 'isSchemaInitialized': True|False, 'status': { 'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR', 'error': { 'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR'|'SYNC_DELETING_ERROR'|'PROCESSING_ERROR'|'COMPOSITE_COMPONENT_FAILURE', 'message': 'string' } }, 'propertyGroups': { 'string': { 'groupType': 'TABULAR', 'propertyNames': [ 'string', ], 'isInherited': True|False } }, 'syncSource': 'string', 'componentTypeName': 'string', 'compositeComponentTypes': { 'string': { 'componentTypeId': 'string', 'isInherited': True|False } } } **Response Structure** * *(dict) --* * **workspaceId** *(string) --* The ID of the workspace that contains the component type. * **isSingleton** *(boolean) --* A Boolean value that specifies whether an entity can have more than one component of this type. * **componentTypeId** *(string) --* The ID of the component type. * **description** *(string) --* The description of the component type. * **propertyDefinitions** *(dict) --* An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object. * *(string) --* * *(dict) --* An object that contains response data from a property definition request. * **dataType** *(dict) --* An object that contains information about the data type. * **type** *(string) --* The underlying type of the data type. * **nestedType** *(dict) --* The nested type in the data type. * **allowedValues** *(list) --* The allowed values for this data type. * *(dict) --* An object that specifies a value for a property. * **booleanValue** *(boolean) --* A Boolean value. * **doubleValue** *(float) --* A double value. * **integerValue** *(integer) --* An integer value. * **longValue** *(integer) --* A long value. * **stringValue** *(string) --* A string value. * **listValue** *(list) --* A list of multiple values. * **mapValue** *(dict) --* An object that maps strings to multiple "DataValue" objects. * *(string) --* * *(dict) --* An object that specifies a value for a property. * **relationshipValue** *(dict) --* A value that relates a component to another component. * **targetEntityId** *(string) --* The ID of the target entity associated with this relationship value. * **targetComponentName** *(string) --* The name of the target component associated with the relationship value. * **expression** *(string) --* An expression that produces the value. * **unitOfMeasure** *(string) --* The unit of measure used in this data type. * **relationship** *(dict) --* A relationship that associates a component with another component. * **targetComponentTypeId** *(string) --* The ID of the target component type associated with this relationship. * **relationshipType** *(string) --* The type of the relationship. * **isTimeSeries** *(boolean) --* A Boolean value that specifies whether the property consists of time series data. * **isRequiredInEntity** *(boolean) --* A Boolean value that specifies whether the property is required in an entity. * **isExternalId** *(boolean) --* A Boolean value that specifies whether the property ID comes from an external data store. * **isStoredExternally** *(boolean) --* A Boolean value that specifies whether the property is stored externally. * **isImported** *(boolean) --* A Boolean value that specifies whether the property definition is imported from an external data store. * **isFinal** *(boolean) --* A Boolean value that specifies whether the property definition can be updated. * **isInherited** *(boolean) --* A Boolean value that specifies whether the property definition is inherited from a parent entity. * **defaultValue** *(dict) --* An object that contains the default value. * **booleanValue** *(boolean) --* A Boolean value. * **doubleValue** *(float) --* A double value. * **integerValue** *(integer) --* An integer value. * **longValue** *(integer) --* A long value. * **stringValue** *(string) --* A string value. * **listValue** *(list) --* A list of multiple values. * *(dict) --* An object that specifies a value for a property. * **mapValue** *(dict) --* An object that maps strings to multiple "DataValue" objects. * *(string) --* * *(dict) --* An object that specifies a value for a property. * **relationshipValue** *(dict) --* A value that relates a component to another component. * **targetEntityId** *(string) --* The ID of the target entity associated with this relationship value. * **targetComponentName** *(string) --* The name of the target component associated with the relationship value. * **expression** *(string) --* An expression that produces the value. * **configuration** *(dict) --* A mapping that specifies configuration information about the property. * *(string) --* * *(string) --* * **displayName** *(string) --* A friendly name for the property. * **extendsFrom** *(list) --* The name of the parent component type that this component type extends. * *(string) --* * **functions** *(dict) --* An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object. * *(string) --* * *(dict) --* The function response. * **requiredProperties** *(list) --* The required properties of the function. * *(string) --* * **scope** *(string) --* The scope of the function. * **implementedBy** *(dict) --* The data connector. * **lambda** *(dict) --* The Lambda function associated with this data connector. * **arn** *(string) --* The ARN of the Lambda function. * **isNative** *(boolean) --* A Boolean value that specifies whether the data connector is native to IoT TwinMaker. * **isInherited** *(boolean) --* Indicates whether this function is inherited. * **creationDateTime** *(datetime) --* The date and time when the component type was created. * **updateDateTime** *(datetime) --* The date and time when the component was last updated. * **arn** *(string) --* The ARN of the component type. * **isAbstract** *(boolean) --* A Boolean value that specifies whether the component type is abstract. * **isSchemaInitialized** *(boolean) --* A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run. * **status** *(dict) --* The current status of the component type. * **state** *(string) --* The current state of the entity, component, component type, or workspace. * **error** *(dict) --* The error message. * **code** *(string) --* The error code. * **message** *(string) --* The error message. * **propertyGroups** *(dict) --* The maximum number of results to return at one time. The default is 25. Valid Range: Minimum value of 1. Maximum value of 250. * *(string) --* * *(dict) --* The property group response * **groupType** *(string) --* The group types. * **propertyNames** *(list) --* The names of properties. * *(string) --* * **isInherited** *(boolean) --* A Boolean value that specifies whether the property group is inherited from a parent entity * **syncSource** *(string) --* The syncSource of the SyncJob, if this entity was created by a SyncJob. * **componentTypeName** *(string) --* The component type name. * **compositeComponentTypes** *(dict) --* This is an object that maps strings to "compositeComponentTypes" of the "componentType". "CompositeComponentType" is referenced by "componentTypeId". * *(string) --* * *(dict) --* An object that returns information about the composite component types of a component type. * **componentTypeId** *(string) --* This is the "componentTypeId" that this "compositeComponentType" refers to. * **isInherited** *(boolean) --* This boolean indicates whether this "compositeComponentType" is inherited from its parent. **Exceptions** * "IoTTwinMaker.Client.exceptions.InternalServerException" * "IoTTwinMaker.Client.exceptions.AccessDeniedException" * "IoTTwinMaker.Client.exceptions.ResourceNotFoundException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" IoTTwinMaker / Client / list_properties list_properties *************** IoTTwinMaker.Client.list_properties(**kwargs) This API lists the properties of a component. See also: AWS API Documentation **Request Syntax** response = client.list_properties( workspaceId='string', componentName='string', componentPath='string', entityId='string', maxResults=123, nextToken='string' ) Parameters: * **workspaceId** (*string*) -- **[REQUIRED]** The workspace ID. * **componentName** (*string*) -- The name of the component whose properties are returned by the operation. * **componentPath** (*string*) -- This string specifies the path to the composite component, starting from the top-level component. * **entityId** (*string*) -- **[REQUIRED]** The ID for the entity whose metadata (component/properties) is returned by the operation. * **maxResults** (*integer*) -- The maximum number of results returned at one time. The default is 25. * **nextToken** (*string*) -- The string that specifies the next page of results. Return type: dict Returns: **Response Syntax** { 'propertySummaries': [ { 'definition': { 'dataType': { 'type': 'RELATIONSHIP'|'STRING'|'LONG'|'BOOLEAN'|'INTEGER'|'DOUBLE'|'LIST'|'MAP', 'nestedType': {'... recursive ...'}, 'allowedValues': [ { 'booleanValue': True|False, 'doubleValue': 123.0, 'integerValue': 123, 'longValue': 123, 'stringValue': 'string', 'listValue': {'... recursive ...'}, 'mapValue': { 'string': {'... recursive ...'} }, 'relationshipValue': { 'targetEntityId': 'string', 'targetComponentName': 'string' }, 'expression': 'string' }, ], 'unitOfMeasure': 'string', 'relationship': { 'targetComponentTypeId': 'string', 'relationshipType': 'string' } }, 'isTimeSeries': True|False, 'isRequiredInEntity': True|False, 'isExternalId': True|False, 'isStoredExternally': True|False, 'isImported': True|False, 'isFinal': True|False, 'isInherited': True|False, 'defaultValue': { 'booleanValue': True|False, 'doubleValue': 123.0, 'integerValue': 123, 'longValue': 123, 'stringValue': 'string', 'listValue': [ {'... recursive ...'}, ], 'mapValue': { 'string': {'... recursive ...'} }, 'relationshipValue': { 'targetEntityId': 'string', 'targetComponentName': 'string' }, 'expression': 'string' }, 'configuration': { 'string': 'string' }, 'displayName': 'string' }, 'propertyName': 'string', 'value': { 'booleanValue': True|False, 'doubleValue': 123.0, 'integerValue': 123, 'longValue': 123, 'stringValue': 'string', 'listValue': [ {'... recursive ...'}, ], 'mapValue': { 'string': {'... recursive ...'} }, 'relationshipValue': { 'targetEntityId': 'string', 'targetComponentName': 'string' }, 'expression': 'string' }, 'areAllPropertyValuesReturned': True|False }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **propertySummaries** *(list) --* A list of objects that contain information about the properties. * *(dict) --* This is an object that contains the information of a property. * **definition** *(dict) --* This is the schema for the property. * **dataType** *(dict) --* An object that contains information about the data type. * **type** *(string) --* The underlying type of the data type. * **nestedType** *(dict) --* The nested type in the data type. * **allowedValues** *(list) --* The allowed values for this data type. * *(dict) --* An object that specifies a value for a property. * **booleanValue** *(boolean) --* A Boolean value. * **doubleValue** *(float) --* A double value. * **integerValue** *(integer) --* An integer value. * **longValue** *(integer) --* A long value. * **stringValue** *(string) --* A string value. * **listValue** *(list) --* A list of multiple values. * **mapValue** *(dict) --* An object that maps strings to multiple "DataValue" objects. * *(string) --* * *(dict) --* An object that specifies a value for a property. * **relationshipValue** *(dict) --* A value that relates a component to another component. * **targetEntityId** *(string) --* The ID of the target entity associated with this relationship value. * **targetComponentName** *(string) --* The name of the target component associated with the relationship value. * **expression** *(string) --* An expression that produces the value. * **unitOfMeasure** *(string) --* The unit of measure used in this data type. * **relationship** *(dict) --* A relationship that associates a component with another component. * **targetComponentTypeId** *(string) --* The ID of the target component type associated with this relationship. * **relationshipType** *(string) --* The type of the relationship. * **isTimeSeries** *(boolean) --* A Boolean value that specifies whether the property consists of time series data. * **isRequiredInEntity** *(boolean) --* A Boolean value that specifies whether the property is required in an entity. * **isExternalId** *(boolean) --* A Boolean value that specifies whether the property ID comes from an external data store. * **isStoredExternally** *(boolean) --* A Boolean value that specifies whether the property is stored externally. * **isImported** *(boolean) --* A Boolean value that specifies whether the property definition is imported from an external data store. * **isFinal** *(boolean) --* A Boolean value that specifies whether the property definition can be updated. * **isInherited** *(boolean) --* A Boolean value that specifies whether the property definition is inherited from a parent entity. * **defaultValue** *(dict) --* An object that contains the default value. * **booleanValue** *(boolean) --* A Boolean value. * **doubleValue** *(float) --* A double value. * **integerValue** *(integer) --* An integer value. * **longValue** *(integer) --* A long value. * **stringValue** *(string) --* A string value. * **listValue** *(list) --* A list of multiple values. * *(dict) --* An object that specifies a value for a property. * **mapValue** *(dict) --* An object that maps strings to multiple "DataValue" objects. * *(string) --* * *(dict) --* An object that specifies a value for a property. * **relationshipValue** *(dict) --* A value that relates a component to another component. * **targetEntityId** *(string) --* The ID of the target entity associated with this relationship value. * **targetComponentName** *(string) --* The name of the target component associated with the relationship value. * **expression** *(string) --* An expression that produces the value. * **configuration** *(dict) --* A mapping that specifies configuration information about the property. * *(string) --* * *(string) --* * **displayName** *(string) --* A friendly name for the property. * **propertyName** *(string) --* This is the name of the property. * **value** *(dict) --* This is the value for the property. * **booleanValue** *(boolean) --* A Boolean value. * **doubleValue** *(float) --* A double value. * **integerValue** *(integer) --* An integer value. * **longValue** *(integer) --* A long value. * **stringValue** *(string) --* A string value. * **listValue** *(list) --* A list of multiple values. * *(dict) --* An object that specifies a value for a property. * **mapValue** *(dict) --* An object that maps strings to multiple "DataValue" objects. * *(string) --* * *(dict) --* An object that specifies a value for a property. * **relationshipValue** *(dict) --* A value that relates a component to another component. * **targetEntityId** *(string) --* The ID of the target entity associated with this relationship value. * **targetComponentName** *(string) --* The name of the target component associated with the relationship value. * **expression** *(string) --* An expression that produces the value. * **areAllPropertyValuesReturned** *(boolean) --* This flag notes whether all values of a list or map type property are returned in the API response. The maximum number of values per property returned is 50. * **nextToken** *(string) --* The string that specifies the next page of property results. **Exceptions** * "IoTTwinMaker.Client.exceptions.InternalServerException" * "IoTTwinMaker.Client.exceptions.AccessDeniedException" * "IoTTwinMaker.Client.exceptions.ResourceNotFoundException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" IoTTwinMaker / Client / get_property_value get_property_value ****************** IoTTwinMaker.Client.get_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', componentPath='string', componentTypeId='string', entityId='string', selectedProperties=[ 'string', ], workspaceId='string', maxResults=123, nextToken='string', propertyGroupName='string', tabularConditions={ 'orderBy': [ { 'order': 'ASCENDING'|'DESCENDING', 'propertyName': 'string' }, ], 'propertyFilters': [ { 'propertyName': 'string', 'operator': 'string', 'value': { 'booleanValue': True|False, 'doubleValue': 123.0, 'integerValue': 123, 'longValue': 123, 'stringValue': 'string', 'listValue': [ {'... recursive ...'}, ], 'mapValue': { 'string': {'... recursive ...'} }, 'relationshipValue': { 'targetEntityId': 'string', 'targetComponentName': 'string' }, 'expression': 'string' } }, ] } ) Parameters: * **componentName** (*string*) -- The name of the component whose property values the operation returns. * **componentPath** (*string*) -- This string specifies the path to the composite component, starting from the top-level component. * **componentTypeId** (*string*) -- The ID of the component type whose property values the operation returns. * **entityId** (*string*) -- The ID of the entity whose property values the operation returns. * **selectedProperties** (*list*) -- **[REQUIRED]** The properties whose values the operation returns. * *(string) --* * **workspaceId** (*string*) -- **[REQUIRED]** The ID of the workspace whose values the operation returns. * **maxResults** (*integer*) -- The maximum number of results to return at one time. The default is 25. Valid Range: Minimum value of 1. Maximum value of 250. * **nextToken** (*string*) -- The string that specifies the next page of results. * **propertyGroupName** (*string*) -- The property group name. * **tabularConditions** (*dict*) -- The tabular conditions. * **orderBy** *(list) --* Filter criteria that orders the output. It can be sorted in ascending or descending order. * *(dict) --* Filter criteria that orders the return output. It can be sorted in ascending or descending order. * **order** *(string) --* The set order that filters results. * **propertyName** *(string) --* **[REQUIRED]** The property name. * **propertyFilters** *(list) --* You can filter the request using various logical operators and a key-value format. For example: "{"key": "serverType", "value": "webServer"}" * *(dict) --* An object that filters items returned by a property request. * **propertyName** *(string) --* The property name associated with this property filter. * **operator** *(string) --* The operator associated with this property filter. * **value** *(dict) --* The value associated with this property filter. * **booleanValue** *(boolean) --* A Boolean value. * **doubleValue** *(float) --* A double value. * **integerValue** *(integer) --* An integer value. * **longValue** *(integer) --* A long value. * **stringValue** *(string) --* A string value. * **listValue** *(list) --* A list of multiple values. * *(dict) --* An object that specifies a value for a property. * **mapValue** *(dict) --* An object that maps strings to multiple "DataValue" objects. * *(string) --* * *(dict) --* An object that specifies a value for a property. * **relationshipValue** *(dict) --* A value that relates a component to another component. * **targetEntityId** *(string) --* The ID of the target entity associated with this relationship value. * **targetComponentName** *(string) --* The name of the target component associated with the relationship value. * **expression** *(string) --* An expression that produces the value. Return type: dict Returns: **Response Syntax** { 'propertyValues': { 'string': { 'propertyReference': { 'componentName': 'string', 'componentPath': 'string', 'externalIdProperty': { 'string': 'string' }, 'entityId': 'string', 'propertyName': 'string' }, 'propertyValue': { 'booleanValue': True|False, 'doubleValue': 123.0, 'integerValue': 123, 'longValue': 123, 'stringValue': 'string', 'listValue': [ {'... recursive ...'}, ], 'mapValue': { 'string': {'... recursive ...'} }, 'relationshipValue': { 'targetEntityId': 'string', 'targetComponentName': 'string' }, 'expression': 'string' } } }, 'nextToken': 'string', 'tabularPropertyValues': [ [ { 'string': { 'booleanValue': True|False, 'doubleValue': 123.0, 'integerValue': 123, 'longValue': 123, 'stringValue': 'string', 'listValue': [ {'... recursive ...'}, ], 'mapValue': { 'string': {'... recursive ...'} }, 'relationshipValue': { 'targetEntityId': 'string', 'targetComponentName': 'string' }, 'expression': 'string' } }, ], ] } **Response Structure** * *(dict) --* * **propertyValues** *(dict) --* An object that maps strings to the properties and latest property values in the response. Each string in the mapping must be unique to this object. * *(string) --* * *(dict) --* The latest value of the property. * **propertyReference** *(dict) --* An object that specifies information about a property. * **componentName** *(string) --* The name of the component. * **componentPath** *(string) --* This string specifies the path to the composite component, starting from the top-level component. * **externalIdProperty** *(dict) --* A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores. * *(string) --* * *(string) --* * **entityId** *(string) --* The ID of the entity. * **propertyName** *(string) --* The name of the property. * **propertyValue** *(dict) --* The value of the property. * **booleanValue** *(boolean) --* A Boolean value. * **doubleValue** *(float) --* A double value. * **integerValue** *(integer) --* An integer value. * **longValue** *(integer) --* A long value. * **stringValue** *(string) --* A string value. * **listValue** *(list) --* A list of multiple values. * *(dict) --* An object that specifies a value for a property. * **mapValue** *(dict) --* An object that maps strings to multiple "DataValue" objects. * *(string) --* * *(dict) --* An object that specifies a value for a property. * **relationshipValue** *(dict) --* A value that relates a component to another component. * **targetEntityId** *(string) --* The ID of the target entity associated with this relationship value. * **targetComponentName** *(string) --* The name of the target component associated with the relationship value. * **expression** *(string) --* An expression that produces the value. * **nextToken** *(string) --* The string that specifies the next page of results. * **tabularPropertyValues** *(list) --* A table of property values. * *(list) --* * *(dict) --* * *(string) --* * *(dict) --* An object that specifies a value for a property. * **booleanValue** *(boolean) --* A Boolean value. * **doubleValue** *(float) --* A double value. * **integerValue** *(integer) --* An integer value. * **longValue** *(integer) --* A long value. * **stringValue** *(string) --* A string value. * **listValue** *(list) --* A list of multiple values. * *(dict) --* An object that specifies a value for a property. * **mapValue** *(dict) --* An object that maps strings to multiple "DataValue" objects. * *(string) --* * *(dict) --* An object that specifies a value for a property. * **relationshipValue** *(dict) --* A value that relates a component to another component. * **targetEntityId** *(string) --* The ID of the target entity associated with this relationship value. * **targetComponentName** *(string) --* The name of the target component associated with the relationship value. * **expression** *(string) --* An expression that produces the value. **Exceptions** * "IoTTwinMaker.Client.exceptions.InternalServerException" * "IoTTwinMaker.Client.exceptions.ConnectorFailureException" * "IoTTwinMaker.Client.exceptions.AccessDeniedException" * "IoTTwinMaker.Client.exceptions.ResourceNotFoundException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException" * "IoTTwinMaker.Client.exceptions.ConnectorTimeoutException" IoTTwinMaker / Client / tag_resource tag_resource ************ IoTTwinMaker.Client.tag_resource(**kwargs) Adds tags to a resource. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( resourceARN='string', tags={ 'string': 'string' } ) Parameters: * **resourceARN** (*string*) -- **[REQUIRED]** The ARN of the resource. * **tags** (*dict*) -- **[REQUIRED]** Metadata to add to this resource. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "IoTTwinMaker.Client.exceptions.TooManyTagsException" * "IoTTwinMaker.Client.exceptions.AccessDeniedException" * "IoTTwinMaker.Client.exceptions.ResourceNotFoundException" IoTTwinMaker / Client / get_metadata_transfer_job get_metadata_transfer_job ************************* IoTTwinMaker.Client.get_metadata_transfer_job(**kwargs) Gets a nmetadata transfer job. See also: AWS API Documentation **Request Syntax** response = client.get_metadata_transfer_job( metadataTransferJobId='string' ) Parameters: **metadataTransferJobId** (*string*) -- **[REQUIRED]** The metadata transfer job Id. Return type: dict Returns: **Response Syntax** { 'metadataTransferJobId': 'string', 'arn': 'string', 'description': 'string', 'sources': [ { 'type': 's3'|'iotsitewise'|'iottwinmaker', 's3Configuration': { 'location': 'string' }, 'iotSiteWiseConfiguration': { 'filters': [ { 'filterByAssetModel': { 'assetModelId': 'string', 'assetModelExternalId': 'string', 'includeOffspring': True|False, 'includeAssets': True|False }, 'filterByAsset': { 'assetId': 'string', 'assetExternalId': 'string', 'includeOffspring': True|False, 'includeAssetModel': True|False } }, ] }, 'iotTwinMakerConfiguration': { 'workspace': 'string', 'filters': [ { 'filterByComponentType': { 'componentTypeId': 'string' }, 'filterByEntity': { 'entityId': 'string' } }, ] } }, ], 'destination': { 'type': 's3'|'iotsitewise'|'iottwinmaker', 's3Configuration': { 'location': 'string' }, 'iotTwinMakerConfiguration': { 'workspace': 'string' } }, 'metadataTransferJobRole': 'string', 'reportUrl': 'string', 'creationDateTime': datetime(2015, 1, 1), 'updateDateTime': datetime(2015, 1, 1), 'status': { 'state': 'VALIDATING'|'PENDING'|'RUNNING'|'CANCELLING'|'ERROR'|'COMPLETED'|'CANCELLED', 'error': { 'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR'|'SYNC_DELETING_ERROR'|'PROCESSING_ERROR'|'COMPOSITE_COMPONENT_FAILURE', 'message': 'string' }, 'queuedPosition': 123 }, 'progress': { 'totalCount': 123, 'succeededCount': 123, 'skippedCount': 123, 'failedCount': 123 } } **Response Structure** * *(dict) --* * **metadataTransferJobId** *(string) --* The metadata transfer job Id. * **arn** *(string) --* The metadata transfer job ARN. * **description** *(string) --* The metadata transfer job description. * **sources** *(list) --* The metadata transfer job's sources. * *(dict) --* The source configuration. * **type** *(string) --* The source configuration type. * **s3Configuration** *(dict) --* The source configuration S3 configuration. * **location** *(string) --* The S3 destination source configuration location. * **iotSiteWiseConfiguration** *(dict) --* The source configuration IoT SiteWise configuration. * **filters** *(list) --* The AWS IoT SiteWise soucre configuration filters. * *(dict) --* The AWS IoT SiteWise soucre configuration filter.[need held with desc here] Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "filterByAssetModel", "filterByAsset". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **filterByAssetModel** *(dict) --* Filter by asset model. * **assetModelId** *(string) --* The asset model Id. * **assetModelExternalId** *(string) --* The external-Id property of an asset model. * **includeOffspring** *(boolean) --* Include asset offspring. [need desc.] * **includeAssets** *(boolean) --* Bolean to include assets. * **filterByAsset** *(dict) --* Filter by asset. * **assetId** *(string) --* Filter by asset Id. * **assetExternalId** *(string) --* The external-Id property of an asset. * **includeOffspring** *(boolean) --* Includes sub-assets.[need description hekp for this] * **includeAssetModel** *(boolean) --* Boolean to include the asset model. * **iotTwinMakerConfiguration** *(dict) --* The source configuration IoT TwinMaker configuration. * **workspace** *(string) --* The IoT TwinMaker workspace. * **filters** *(list) --* The metadata transfer job AWS IoT TwinMaker source configuration filters. * *(dict) --* The metadata transfer job AWS IoT TwinMaker source configuration filter. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "filterByComponentType", "filterByEntity". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **filterByComponentType** *(dict) --* Filter by component type. * **componentTypeId** *(string) --* The component type Id. * **filterByEntity** *(dict) --* Filter by entity. * **entityId** *(string) --* The entity Id. * **destination** *(dict) --* The metadata transfer job's destination. * **type** *(string) --* The destination type. * **s3Configuration** *(dict) --* The metadata transfer job S3 configuration. [need to add S3 entity] * **location** *(string) --* The S3 destination configuration location. * **iotTwinMakerConfiguration** *(dict) --* The metadata transfer job Amazon Web Services IoT TwinMaker configuration. * **workspace** *(string) --* The IoT TwinMaker workspace. * **metadataTransferJobRole** *(string) --* The metadata transfer job's role. * **reportUrl** *(string) --* The metadata transfer job's report URL. * **creationDateTime** *(datetime) --* The metadata transfer job's creation DateTime property. * **updateDateTime** *(datetime) --* The metadata transfer job's update DateTime property. * **status** *(dict) --* The metadata transfer job's status. * **state** *(string) --* The metadata transfer job state. * **error** *(dict) --* The metadata transfer job error. * **code** *(string) --* The error code. * **message** *(string) --* The error message. * **queuedPosition** *(integer) --* The queued position. * **progress** *(dict) --* The metadata transfer job's progress. * **totalCount** *(integer) --* The total count. [of what] * **succeededCount** *(integer) --* The succeeded count. * **skippedCount** *(integer) --* The skipped count. * **failedCount** *(integer) --* The failed count. **Exceptions** * "IoTTwinMaker.Client.exceptions.InternalServerException" * "IoTTwinMaker.Client.exceptions.AccessDeniedException" * "IoTTwinMaker.Client.exceptions.ResourceNotFoundException" * "IoTTwinMaker.Client.exceptions.ThrottlingException" * "IoTTwinMaker.Client.exceptions.ValidationException"