aws-elixir v0.13.3

View Source AWS.IoTTwinMaker (aws-elixir v0.13.3)

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.

Link to this section Summary

Functions

batch_put_property_values(client, workspace_id, input, options \\ [])

Sets values for multiple time series properties.

create_component_type(client, component_type_id, workspace_id, input, options \\ [])

Creates a component type.

create_entity(client, workspace_id, input, options \\ [])

Creates an entity.

create_scene(client, workspace_id, input, options \\ [])

Creates a scene.

create_sync_job(client, sync_source, workspace_id, input, options \\ [])

This action creates a SyncJob.

create_workspace(client, workspace_id, input, options \\ [])

Creates a workplace.

delete_component_type(client, component_type_id, workspace_id, input, options \\ [])

Deletes a component type.

delete_entity(client, entity_id, workspace_id, input, options \\ [])

Deletes an entity.

delete_scene(client, scene_id, workspace_id, input, options \\ [])

Deletes a scene.

delete_sync_job(client, sync_source, workspace_id, input, options \\ [])

Delete the SyncJob.

delete_workspace(client, workspace_id, input, options \\ [])

Deletes a workspace.

execute_query(client, input, options \\ [])

Run queries to access information from your knowledge graph of entities within individual workspaces.

get_component_type(client, component_type_id, workspace_id, options \\ [])

Retrieves information about a component type.

get_entity(client, entity_id, workspace_id, options \\ [])

Retrieves information about an entity.

get_pricing_plan(client, options \\ [])

Gets the pricing plan.

get_property_value(client, workspace_id, input, options \\ [])

Gets the property values for a component, component type, entity, or workspace.

get_property_value_history(client, workspace_id, input, options \\ [])

Retrieves information about the history of a time series property value for a component, component type, entity, or workspace.

get_scene(client, scene_id, workspace_id, options \\ [])

Retrieves information about a scene.

get_sync_job(client, sync_source, workspace_id \\ nil, options \\ [])

Gets the SyncJob.

get_workspace(client, workspace_id, options \\ [])

Retrieves information about a workspace.

list_component_types(client, workspace_id, input, options \\ [])

Lists all component types in a workspace.

list_entities(client, workspace_id, input, options \\ [])

Lists all entities in a workspace.

list_scenes(client, workspace_id, input, options \\ [])

Lists all scenes in a workspace.

list_sync_jobs(client, workspace_id, input, options \\ [])

List all SyncJobs.

list_sync_resources(client, sync_source, workspace_id, input, options \\ [])

Lists the sync resources.

list_tags_for_resource(client, input, options \\ [])

Lists all tags associated with a resource.

list_workspaces(client, input, options \\ [])

Retrieves information about workspaces in the current account.

metadata()
tag_resource(client, input, options \\ [])

Adds tags to a resource.

untag_resource(client, input, options \\ [])

Removes tags from a resource.

update_component_type(client, component_type_id, workspace_id, input, options \\ [])

Updates information in a component type.

update_entity(client, entity_id, workspace_id, input, options \\ [])

Updates an entity.

update_pricing_plan(client, input, options \\ [])

Update the pricing plan.

update_scene(client, scene_id, workspace_id, input, options \\ [])

Updates a scene.

update_workspace(client, workspace_id, input, options \\ [])

Updates a workspace.

Link to this section Functions

Link to this function

batch_put_property_values(client, workspace_id, input, options \\ [])

View Source

Sets values for multiple time series properties.

Link to this function

create_component_type(client, component_type_id, workspace_id, input, options \\ [])

View Source

Creates a component type.

Link to this function

create_entity(client, workspace_id, input, options \\ [])

View Source

Creates an entity.

Link to this function

create_scene(client, workspace_id, input, options \\ [])

View Source

Creates a scene.

Link to this function

create_sync_job(client, sync_source, workspace_id, input, options \\ [])

View Source

This action creates a SyncJob.

Link to this function

create_workspace(client, workspace_id, input, options \\ [])

View Source

Creates a workplace.

Link to this function

delete_component_type(client, component_type_id, workspace_id, input, options \\ [])

View Source

Deletes a component type.

Link to this function

delete_entity(client, entity_id, workspace_id, input, options \\ [])

View Source

Deletes an entity.

Link to this function

delete_scene(client, scene_id, workspace_id, input, options \\ [])

View Source

Deletes a scene.

Link to this function

delete_sync_job(client, sync_source, workspace_id, input, options \\ [])

View Source

Delete the SyncJob.

Link to this function

delete_workspace(client, workspace_id, input, options \\ [])

View Source

Deletes a workspace.

Link to this function

execute_query(client, input, options \\ [])

View Source

Run queries to access information from your knowledge graph of entities within individual workspaces.

Link to this function

get_component_type(client, component_type_id, workspace_id, options \\ [])

View Source

Retrieves information about a component type.

Link to this function

get_entity(client, entity_id, workspace_id, options \\ [])

View Source

Retrieves information about an entity.

Link to this function

get_pricing_plan(client, options \\ [])

View Source

Gets the pricing plan.

Link to this function

get_property_value(client, workspace_id, input, options \\ [])

View Source

Gets the property values for a component, component type, entity, or workspace.

You must specify a value for either componentName, componentTypeId, entityId, or workspaceId.

Link to this function

get_property_value_history(client, workspace_id, input, options \\ [])

View Source

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.

Link to this function

get_scene(client, scene_id, workspace_id, options \\ [])

View Source

Retrieves information about a scene.

Link to this function

get_sync_job(client, sync_source, workspace_id \\ nil, options \\ [])

View Source

Gets the SyncJob.

Link to this function

get_workspace(client, workspace_id, options \\ [])

View Source

Retrieves information about a workspace.

Link to this function

list_component_types(client, workspace_id, input, options \\ [])

View Source

Lists all component types in a workspace.

Link to this function

list_entities(client, workspace_id, input, options \\ [])

View Source

Lists all entities in a workspace.

Link to this function

list_scenes(client, workspace_id, input, options \\ [])

View Source

Lists all scenes in a workspace.

Link to this function

list_sync_jobs(client, workspace_id, input, options \\ [])

View Source

List all SyncJobs.

Link to this function

list_sync_resources(client, sync_source, workspace_id, input, options \\ [])

View Source

Lists the sync resources.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

Lists all tags associated with a resource.

Link to this function

list_workspaces(client, input, options \\ [])

View Source

Retrieves information about workspaces in the current account.

Link to this function

metadata()

View Source
Link to this function

tag_resource(client, input, options \\ [])

View Source

Adds tags to a resource.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Removes tags from a resource.

Link to this function

update_component_type(client, component_type_id, workspace_id, input, options \\ [])

View Source

Updates information in a component type.

Link to this function

update_entity(client, entity_id, workspace_id, input, options \\ [])

View Source

Updates an entity.

Link to this function

update_pricing_plan(client, input, options \\ [])

View Source

Update the pricing plan.

Link to this function

update_scene(client, scene_id, workspace_id, input, options \\ [])

View Source

Updates a scene.

Link to this function

update_workspace(client, workspace_id, input, options \\ [])

View Source

Updates a workspace.