AWS.IoTThingsGraph (aws-elixir v0.8.0) View Source

AWS IoT Things Graph

AWS IoT Things Graph provides an integrated set of tools that enable developers to connect devices and services that use different standards, such as units of measure and communication protocols.

AWS IoT Things Graph makes it possible to build IoT applications with little to no code by connecting devices and services and defining how they interact at an abstract level.

For more information about how AWS IoT Things Graph works, see the User Guide.

Link to this section Summary

Functions

Associates a device with a concrete thing that is in the user's registry.

Deletes the specified namespace.

Greengrass and Cloud Deployments

Deploys the system instance to the target specified in CreateSystemInstance.

Deprecates the specified workflow.

Gets the latest version of the user's namespace and the public version that it is tracking.

Dissociates a device entity from a concrete thing.

Gets definitions of the specified entities.

Gets the latest version of the DefinitionDocument and FlowTemplateSummary for the specified workflow.

Gets revisions of the specified workflow.

Gets the status of a namespace deletion task.

Gets revisions made to the specified system template.

Gets the status of the specified upload.

Returns a list of objects that contain information about events in a flow execution.

Lists all tags on an AWS IoT Things Graph resource.

Searches for entities of the specified type.

Searches for AWS IoT Things Graph workflow execution instances.

Searches for summary information about workflows.

Searches for system instances in the user's account.

Searches for summary information about systems in the user's account.

Searches for things associated with the specified entity.

Creates a tag for the specified resource.

Removes a system instance from its target (Cloud or Greengrass).

Removes a tag from the specified resource.

Updates the specified workflow.

Asynchronously uploads one or more entity definitions to the user's namespace.

Link to this section Functions

Link to this function

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

View Source

Associates a device with a concrete thing that is in the user's registry.

A thing can be associated with only one device at a time. If you associate a thing with a new device id, its previous association will be removed.

Link to this function

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

View Source

Creates a workflow template.

Workflows can be created only in the user's namespace. (The public namespace contains only entities.) The workflow can contain only entities in the specified namespace. The workflow is validated against the entities in the latest version of the user's namespace unless another namespace version is specified in the request.

Link to this function

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

View Source

Creates a system instance.

This action validates the system instance, prepares the deployment-related resources. For Greengrass deployments, it updates the Greengrass group that is specified by the greengrassGroupName parameter. It also adds a file to the S3 bucket specified by the s3BucketName parameter. You need to call DeploySystemInstance after running this action.

For Greengrass deployments, since this action modifies and adds resources to a Greengrass group and an S3 bucket on the caller's behalf, the calling identity must have write permissions to both the specified Greengrass group and S3 bucket. Otherwise, the call will fail with an authorization error.

For cloud deployments, this action requires a flowActionsRoleArn value. This is an IAM role that has permissions to access AWS services, such as AWS Lambda and AWS IoT, that the flow uses when it executes.

If the definition document doesn't specify a version of the user's namespace, the latest version will be used by default.

Link to this function

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

View Source

Creates a system.

The system is validated against the entities in the latest version of the user's namespace unless another namespace version is specified in the request.

Link to this function

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

View Source

Deletes a workflow.

Any new system or deployment that contains this workflow will fail to update or deploy. Existing deployments that contain the workflow will continue to run (since they use a snapshot of the workflow taken at the time of deployment).

Link to this function

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

View Source

Deletes the specified namespace.

This action deletes all of the entities in the namespace. Delete the systems and flows that use entities in the namespace before performing this action.

Link to this function

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

View Source

Deletes a system instance.

Only system instances that have never been deployed, or that have been undeployed can be deleted.

Users can create a new system instance that has the same ID as a deleted system instance.

Link to this function

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

View Source

Deletes a system.

New deployments can't contain the system after its deletion. Existing deployments that contain the system will continue to work because they use a snapshot of the system that is taken when it is deployed.

Link to this function

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

View Source

Greengrass and Cloud Deployments

Deploys the system instance to the target specified in CreateSystemInstance.

Greengrass Deployments

If the system or any workflows and entities have been updated before this action is called, then the deployment will create a new Amazon Simple Storage Service resource file and then deploy it.

Since this action creates a Greengrass deployment on the caller's behalf, the calling identity must have write permissions to the specified Greengrass group. Otherwise, the call will fail with an authorization error.

For information about the artifacts that get added to your Greengrass core device when you use this API, see AWS IoT Things Graph and AWS IoT Greengrass.

Link to this function

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

View Source

Deprecates the specified workflow.

This action marks the workflow for deletion. Deprecated flows can't be deployed, but existing deployments will continue to run.

Link to this function

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

View Source

Deprecates the specified system.

Link to this function

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

View Source

Gets the latest version of the user's namespace and the public version that it is tracking.

Link to this function

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

View Source

Dissociates a device entity from a concrete thing.

The action takes only the type of the entity that you need to dissociate because only one entity of a particular type can be associated with a thing.

Link to this function

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

View Source

Gets definitions of the specified entities.

Uses the latest version of the user's namespace by default. This API returns the following TDM entities.

  • Properties

  • States

  • Events

  • Actions

  • Capabilities

  • Mappings

  • Devices

  • Device Models

  • Services

This action doesn't return definitions for systems, flows, and deployments.

Link to this function

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

View Source

Gets the latest version of the DefinitionDocument and FlowTemplateSummary for the specified workflow.

Link to this function

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

View Source

Gets revisions of the specified workflow.

Only the last 100 revisions are stored. If the workflow has been deprecated, this action will return revisions that occurred before the deprecation. This action won't work for workflows that have been deleted.

Link to this function

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

View Source

Gets the status of a namespace deletion task.

Link to this function

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

View Source

Gets a system instance.

Link to this function

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

View Source

Gets a system.

Link to this function

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

View Source

Gets revisions made to the specified system template.

Only the previous 100 revisions are stored. If the system has been deprecated, this action will return the revisions that occurred before its deprecation. This action won't work with systems that have been deleted.

Link to this function

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

View Source

Gets the status of the specified upload.

Link to this function

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

View Source

Returns a list of objects that contain information about events in a flow execution.

Link to this function

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

View Source

Lists all tags on an AWS IoT Things Graph resource.

Link to this function

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

View Source

Searches for entities of the specified type.

You can search for entities in your namespace and the public namespace that you're tracking.

Link to this function

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

View Source

Searches for AWS IoT Things Graph workflow execution instances.

Link to this function

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

View Source

Searches for summary information about workflows.

Link to this function

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

View Source

Searches for system instances in the user's account.

Link to this function

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

View Source

Searches for summary information about systems in the user's account.

You can filter by the ID of a workflow to return only systems that use the specified workflow.

Link to this function

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

View Source

Searches for things associated with the specified entity.

You can search by both device and device model.

For example, if two different devices, camera1 and camera2, implement the camera device model, the user can associate thing1 to camera1 and thing2 to camera2. SearchThings(camera2) will return only thing2, but SearchThings(camera) will return both thing1 and thing2.

This action searches for exact matches and doesn't perform partial text matching.

Link to this function

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

View Source

Creates a tag for the specified resource.

Link to this function

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

View Source

Removes a system instance from its target (Cloud or Greengrass).

Link to this function

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

View Source

Removes a tag from the specified resource.

Link to this function

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

View Source

Updates the specified workflow.

All deployed systems and system instances that use the workflow will see the changes in the flow when it is redeployed. If you don't want this behavior, copy the workflow (creating a new workflow with a different ID), and update the copy. The workflow can contain only entities in the specified namespace.

Link to this function

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

View Source

Updates the specified system.

You don't need to run this action after updating a workflow. Any deployment that uses the system will see the changes in the system when it is redeployed.

Link to this function

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

View Source

Asynchronously uploads one or more entity definitions to the user's namespace.

The document parameter is required if syncWithPublicNamespace and deleteExistingEntites are false. If the syncWithPublicNamespace parameter is set to true, the user's namespace will synchronize with the latest version of the public namespace. If deprecateExistingEntities is set to true, all entities in the latest version will be deleted before the new DefinitionDocument is uploaded.

When a user uploads entity definitions for the first time, the service creates a new namespace for the user. The new namespace tracks the public namespace. Currently users can have only one namespace. The namespace version increments whenever a user uploads entity definitions that are backwards-incompatible and whenever a user sets the syncWithPublicNamespace parameter or the deprecateExistingEntities parameter to true.

The IDs for all of the entities should be in URN format. Each entity must be in the user's namespace. Users can't create entities in the public namespace, but entity definitions can refer to entities in the public namespace.

Valid entities are Device, DeviceModel, Service, Capability, State, Action, Event, Property, Mapping, Enum.