Smaws_Client_IoTThingsGraph (smaws-clients.Smaws_Client

Types

module Types : sig ... end

Builders

val make_upload_entity_definitions_response : 
  upload_id:Types.upload_id ->
  unit ->
  Types.upload_entity_definitions_response

val make_definition_document : 
  text:Types.definition_text ->
  language:Types.definition_language ->
  unit ->
  Types.definition_document

val make_upload_entity_definitions_request : 
  ?deprecate_existing_entities:Types.deprecate_existing_entities ->
  ?sync_with_public_namespace:Types.sync_with_public_namespace ->
  ?document:Types.definition_document ->
  unit ->
  Types.upload_entity_definitions_request

val make_system_template_summary : 
  ?created_at:Types.timestamp ->
  ?revision_number:Types.version ->
  ?arn:Types.arn ->
  ?id:Types.urn ->
  unit ->
  Types.system_template_summary

val make_update_system_template_response : 
  ?summary:Types.system_template_summary ->
  unit ->
  Types.update_system_template_response

val make_update_system_template_request : 
  ?compatible_namespace_version:Types.version ->
  definition:Types.definition_document ->
  id:Types.urn ->
  unit ->
  Types.update_system_template_request

val make_flow_template_summary : 
  ?created_at:Types.timestamp ->
  ?revision_number:Types.version ->
  ?arn:Types.arn ->
  ?id:Types.urn ->
  unit ->
  Types.flow_template_summary

val make_update_flow_template_response : 
  ?summary:Types.flow_template_summary ->
  unit ->
  Types.update_flow_template_response

val make_update_flow_template_request : 
  ?compatible_namespace_version:Types.version ->
  definition:Types.definition_document ->
  id:Types.urn ->
  unit ->
  Types.update_flow_template_request

val make_untag_resource_response : unit -> unit

val make_untag_resource_request : 
  tag_keys:Types.tag_key_list ->
  resource_arn:Types.resource_arn ->
  unit ->
  Types.untag_resource_request

val make_system_instance_summary : 
  ?greengrass_group_version_id:Types.greengrass_group_version_id ->
  ?greengrass_group_id:Types.greengrass_group_id ->
  ?updated_at:Types.timestamp ->
  ?created_at:Types.timestamp ->
  ?greengrass_group_name:Types.group_name ->
  ?target:Types.deployment_target ->
  ?status:Types.system_instance_deployment_status ->
  ?arn:Types.arn ->
  ?id:Types.urn ->
  unit ->
  Types.system_instance_summary

val make_undeploy_system_instance_response : 
  ?summary:Types.system_instance_summary ->
  unit ->
  Types.undeploy_system_instance_response

val make_undeploy_system_instance_request : 
  ?id:Types.urn ->
  unit ->
  Types.undeploy_system_instance_request

val make_thing : 
  ?thing_name:Types.thing_name ->
  ?thing_arn:Types.thing_arn ->
  unit ->
  Types.thing

val make_tag_resource_response : unit -> unit

val make_tag : value:Types.tag_value -> key:Types.tag_key -> unit -> Types.tag

val make_tag_resource_request : 
  tags:Types.tag_list ->
  resource_arn:Types.resource_arn ->
  unit ->
  Types.tag_resource_request

val make_system_template_filter : 
  value:Types.system_template_filter_values ->
  name:Types.system_template_filter_name ->
  unit ->
  Types.system_template_filter

val make_system_template_description : 
  ?validated_namespace_version:Types.version ->
  ?definition:Types.definition_document ->
  ?summary:Types.system_template_summary ->
  unit ->
  Types.system_template_description

val make_system_instance_filter : 
  ?value:Types.system_instance_filter_values ->
  ?name:Types.system_instance_filter_name ->
  unit ->
  Types.system_instance_filter

val make_metrics_configuration : 
  ?metric_rule_role_arn:Types.role_arn ->
  ?cloud_metric_enabled:Types.enabled ->
  unit ->
  Types.metrics_configuration

val make_dependency_revision : 
  ?revision_number:Types.version ->
  ?id:Types.urn ->
  unit ->
  Types.dependency_revision

val make_system_instance_description : 
  ?flow_actions_role_arn:Types.role_arn ->
  ?validated_dependency_revisions:Types.dependency_revisions ->
  ?validated_namespace_version:Types.version ->
  ?metrics_configuration:Types.metrics_configuration ->
  ?s3_bucket_name:Types.s3_bucket_name ->
  ?definition:Types.definition_document ->
  ?summary:Types.system_instance_summary ->
  unit ->
  Types.system_instance_description

val make_search_things_response : 
  ?next_token:Types.next_token ->
  ?things:Types.things ->
  unit ->
  Types.search_things_response

val make_search_things_request : 
  ?namespace_version:Types.version ->
  ?max_results:Types.max_results ->
  ?next_token:Types.next_token ->
  entity_id:Types.urn ->
  unit ->
  Types.search_things_request

val make_search_system_templates_response : 
  ?next_token:Types.next_token ->
  ?summaries:Types.system_template_summaries ->
  unit ->
  Types.search_system_templates_response

val make_search_system_templates_request : 
  ?max_results:Types.max_results ->
  ?next_token:Types.next_token ->
  ?filters:Types.system_template_filters ->
  unit ->
  Types.search_system_templates_request

val make_search_system_instances_response : 
  ?next_token:Types.next_token ->
  ?summaries:Types.system_instance_summaries ->
  unit ->
  Types.search_system_instances_response

val make_search_system_instances_request : 
  ?max_results:Types.max_results ->
  ?next_token:Types.next_token ->
  ?filters:Types.system_instance_filters ->
  unit ->
  Types.search_system_instances_request

val make_search_flow_templates_response : 
  ?next_token:Types.next_token ->
  ?summaries:Types.flow_template_summaries ->
  unit ->
  Types.search_flow_templates_response

val make_flow_template_filter : 
  value:Types.flow_template_filter_values ->
  name:Types.flow_template_filter_name ->
  unit ->
  Types.flow_template_filter

val make_search_flow_templates_request : 
  ?max_results:Types.max_results ->
  ?next_token:Types.next_token ->
  ?filters:Types.flow_template_filters ->
  unit ->
  Types.search_flow_templates_request

val make_flow_execution_summary : 
  ?updated_at:Types.timestamp ->
  ?created_at:Types.timestamp ->
  ?flow_template_id:Types.urn ->
  ?system_instance_id:Types.urn ->
  ?status:Types.flow_execution_status ->
  ?flow_execution_id:Types.flow_execution_id ->
  unit ->
  Types.flow_execution_summary

val make_search_flow_executions_response : 
  ?next_token:Types.next_token ->
  ?summaries:Types.flow_execution_summaries ->
  unit ->
  Types.search_flow_executions_response

val make_search_flow_executions_request : 
  ?max_results:Types.max_results ->
  ?next_token:Types.next_token ->
  ?end_time:Types.timestamp ->
  ?start_time:Types.timestamp ->
  ?flow_execution_id:Types.flow_execution_id ->
  system_instance_id:Types.urn ->
  unit ->
  Types.search_flow_executions_request

val make_entity_description : 
  ?definition:Types.definition_document ->
  ?created_at:Types.timestamp ->
  ?type_:Types.entity_type ->
  ?arn:Types.arn ->
  ?id:Types.urn ->
  unit ->
  Types.entity_description

val make_search_entities_response : 
  ?next_token:Types.next_token ->
  ?descriptions:Types.entity_descriptions ->
  unit ->
  Types.search_entities_response

val make_entity_filter : 
  ?value:Types.entity_filter_values ->
  ?name:Types.entity_filter_name ->
  unit ->
  Types.entity_filter

val make_search_entities_request : 
  ?namespace_version:Types.version ->
  ?max_results:Types.max_results ->
  ?next_token:Types.next_token ->
  ?filters:Types.entity_filters ->
  entity_types:Types.entity_types ->
  unit ->
  Types.search_entities_request

val make_list_tags_for_resource_response : 
  ?next_token:Types.next_token ->
  ?tags:Types.tag_list ->
  unit ->
  Types.list_tags_for_resource_response

val make_list_tags_for_resource_request : 
  ?next_token:Types.next_token ->
  ?max_results:Types.max_results ->
  resource_arn:Types.resource_arn ->
  unit ->
  Types.list_tags_for_resource_request

val make_flow_execution_message : 
  ?payload:Types.flow_execution_message_payload ->
  ?timestamp:Types.timestamp ->
  ?event_type:Types.flow_execution_event_type ->
  ?message_id:Types.flow_execution_message_id ->
  unit ->
  Types.flow_execution_message

val make_list_flow_execution_messages_response : 
  ?next_token:Types.next_token ->
  ?messages:Types.flow_execution_messages ->
  unit ->
  Types.list_flow_execution_messages_response

val make_list_flow_execution_messages_request : 
  ?max_results:Types.max_results ->
  ?next_token:Types.next_token ->
  flow_execution_id:Types.flow_execution_id ->
  unit ->
  Types.list_flow_execution_messages_request

val make_get_upload_status_response : 
  ?failure_reason:Types.string_list ->
  ?namespace_version:Types.version ->
  ?namespace_name:Types.namespace_name ->
  ?namespace_arn:Types.arn ->
  created_date:Types.timestamp ->
  upload_status:Types.upload_status ->
  upload_id:Types.upload_id ->
  unit ->
  Types.get_upload_status_response

val make_get_upload_status_request : 
  upload_id:Types.upload_id ->
  unit ->
  Types.get_upload_status_request

val make_get_system_template_revisions_response : 
  ?next_token:Types.next_token ->
  ?summaries:Types.system_template_summaries ->
  unit ->
  Types.get_system_template_revisions_response

val make_get_system_template_revisions_request : 
  ?max_results:Types.max_results ->
  ?next_token:Types.next_token ->
  id:Types.urn ->
  unit ->
  Types.get_system_template_revisions_request

val make_get_system_template_response : 
  ?description:Types.system_template_description ->
  unit ->
  Types.get_system_template_response

val make_get_system_template_request : 
  ?revision_number:Types.version ->
  id:Types.urn ->
  unit ->
  Types.get_system_template_request

val make_get_system_instance_response : 
  ?description:Types.system_instance_description ->
  unit ->
  Types.get_system_instance_response

val make_get_system_instance_request : 
  id:Types.urn ->
  unit ->
  Types.get_system_instance_request

val make_get_namespace_deletion_status_response : 
  ?error_message:Types.string_ ->
  ?error_code:Types.namespace_deletion_status_error_codes ->
  ?status:Types.namespace_deletion_status ->
  ?namespace_name:Types.namespace_name ->
  ?namespace_arn:Types.arn ->
  unit ->
  Types.get_namespace_deletion_status_response

val make_get_namespace_deletion_status_request : unit -> unit

val make_get_flow_template_revisions_response : 
  ?next_token:Types.next_token ->
  ?summaries:Types.flow_template_summaries ->
  unit ->
  Types.get_flow_template_revisions_response

val make_get_flow_template_revisions_request : 
  ?max_results:Types.max_results ->
  ?next_token:Types.next_token ->
  id:Types.urn ->
  unit ->
  Types.get_flow_template_revisions_request

val make_flow_template_description : 
  ?validated_namespace_version:Types.version ->
  ?definition:Types.definition_document ->
  ?summary:Types.flow_template_summary ->
  unit ->
  Types.flow_template_description

val make_get_flow_template_response : 
  ?description:Types.flow_template_description ->
  unit ->
  Types.get_flow_template_response

val make_get_flow_template_request : 
  ?revision_number:Types.version ->
  id:Types.urn ->
  unit ->
  Types.get_flow_template_request

val make_get_entities_response : 
  ?descriptions:Types.entity_descriptions ->
  unit ->
  Types.get_entities_response

val make_get_entities_request : 
  ?namespace_version:Types.version ->
  ids:Types.urns ->
  unit ->
  Types.get_entities_request

val make_dissociate_entity_from_thing_response : unit -> unit

val make_dissociate_entity_from_thing_request : 
  entity_type:Types.entity_type ->
  thing_name:Types.thing_name ->
  unit ->
  Types.dissociate_entity_from_thing_request

val make_describe_namespace_response : 
  ?namespace_version:Types.version ->
  ?tracking_namespace_version:Types.version ->
  ?tracking_namespace_name:Types.namespace_name ->
  ?namespace_name:Types.namespace_name ->
  ?namespace_arn:Types.arn ->
  unit ->
  Types.describe_namespace_response

val make_describe_namespace_request : 
  ?namespace_name:Types.namespace_name ->
  unit ->
  Types.describe_namespace_request

val make_deprecate_system_template_response : unit -> unit

val make_deprecate_system_template_request : 
  id:Types.urn ->
  unit ->
  Types.deprecate_system_template_request

val make_deprecate_flow_template_response : unit -> unit

val make_deprecate_flow_template_request : 
  id:Types.urn ->
  unit ->
  Types.deprecate_flow_template_request

val make_deploy_system_instance_response : 
  ?greengrass_deployment_id:Types.greengrass_deployment_id ->
  summary:Types.system_instance_summary ->
  unit ->
  Types.deploy_system_instance_response

val make_deploy_system_instance_request : 
  ?id:Types.urn ->
  unit ->
  Types.deploy_system_instance_request

val make_delete_system_template_response : unit -> unit

val make_delete_system_template_request : 
  id:Types.urn ->
  unit ->
  Types.delete_system_template_request

val make_delete_system_instance_response : unit -> unit

val make_delete_system_instance_request : 
  ?id:Types.urn ->
  unit ->
  Types.delete_system_instance_request

val make_delete_namespace_response : 
  ?namespace_name:Types.namespace_name ->
  ?namespace_arn:Types.arn ->
  unit ->
  Types.delete_namespace_response

val make_delete_namespace_request : unit -> unit

val make_delete_flow_template_response : unit -> unit

val make_delete_flow_template_request : 
  id:Types.urn ->
  unit ->
  Types.delete_flow_template_request

val make_create_system_template_response : 
  ?summary:Types.system_template_summary ->
  unit ->
  Types.create_system_template_response

val make_create_system_template_request : 
  ?compatible_namespace_version:Types.version ->
  definition:Types.definition_document ->
  unit ->
  Types.create_system_template_request

val make_create_system_instance_response : 
  ?summary:Types.system_instance_summary ->
  unit ->
  Types.create_system_instance_response

val make_create_system_instance_request : 
  ?flow_actions_role_arn:Types.role_arn ->
  ?metrics_configuration:Types.metrics_configuration ->
  ?s3_bucket_name:Types.s3_bucket_name ->
  ?greengrass_group_name:Types.group_name ->
  ?tags:Types.tag_list ->
  target:Types.deployment_target ->
  definition:Types.definition_document ->
  unit ->
  Types.create_system_instance_request

val make_create_flow_template_response : 
  ?summary:Types.flow_template_summary ->
  unit ->
  Types.create_flow_template_response

val make_create_flow_template_request : 
  ?compatible_namespace_version:Types.version ->
  definition:Types.definition_document ->
  unit ->
  Types.create_flow_template_request

val make_associate_entity_to_thing_response : unit -> unit

val make_associate_entity_to_thing_request : 
  ?namespace_version:Types.version ->
  entity_id:Types.urn ->
  thing_name:Types.thing_name ->
  unit ->
  Types.associate_entity_to_thing_request

Operations

module AssociateEntityToThing : sig ... end

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

module CreateFlowTemplate : sig ... end

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.

module CreateSystemInstance : sig ... end

Creates a system instance.

module CreateSystemTemplate : sig ... end

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.

module DeleteFlowTemplate : sig ... end

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).

module DeleteNamespace : sig ... end

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. This action takes no request parameters.

module DeleteSystemInstance : sig ... end

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

module DeleteSystemTemplate : sig ... end

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.

module DeploySystemInstance : sig ... end

Greengrass and Cloud Deployments

module DeprecateFlowTemplate : sig ... end

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

module DeprecateSystemTemplate : sig ... end

Deprecates the specified system.

module DescribeNamespace : sig ... end

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

module DissociateEntityFromThing : sig ... end

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.

module GetEntities : sig ... end

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

module GetFlowTemplate : sig ... end

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

module GetFlowTemplateRevisions : sig ... end

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.

module GetNamespaceDeletionStatus : sig ... end

Gets the status of a namespace deletion task.

module GetSystemInstance : sig ... end

Gets a system instance.

module GetSystemTemplate : sig ... end

Gets a system.

module GetSystemTemplateRevisions : sig ... end

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.

module GetUploadStatus : sig ... end

Gets the status of the specified upload.

module ListFlowExecutionMessages : sig ... end

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

module ListTagsForResource : sig ... end

Lists all tags on an AWS IoT Things Graph resource.

module SearchEntities : sig ... end

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

module SearchFlowExecutions : sig ... end

Searches for AWS IoT Things Graph workflow execution instances.

module SearchFlowTemplates : sig ... end

Searches for summary information about workflows.

module SearchSystemInstances : sig ... end

Searches for system instances in the user's account.

module SearchSystemTemplates : sig ... end

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.

module SearchThings : sig ... end

Searches for things associated with the specified entity. You can search by both device and device model.

module TagResource : sig ... end

Creates a tag for the specified resource.

module UndeploySystemInstance : sig ... end

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

module UntagResource : sig ... end

Removes a tag from the specified resource.

module UpdateFlowTemplate : sig ... end

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.

module UpdateSystemTemplate : sig ... end

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.

module UploadEntityDefinitions : sig ... end

module Json_serializers : sig ... end

module Json_deserializers : sig ... end