Module Smaws_Client_IoTThingsGraph.Types

type nonrec version = Smaws_Lib.CoreTypes.Int64.t
type nonrec urn = string
type nonrec urns = urn list
type nonrec upload_status =
  1. | FAILED
  2. | SUCCEEDED
  3. | IN_PROGRESS
type nonrec upload_id = string
type nonrec upload_entity_definitions_response = {
  1. upload_id : upload_id;
    (*

    The ID that specifies the upload action. You can use this to track the status of the upload.

    *)
}
type nonrec definition_language =
  1. | GRAPHQL
type nonrec definition_text = string
type nonrec definition_document = {
  1. text : definition_text;
    (*

    The GraphQL text that defines the entity.

    *)
  2. language : definition_language;
    (*

    The language used to define the entity. GRAPHQL is the only valid value.

    *)
}

A document that defines an entity.

type nonrec sync_with_public_namespace = bool
type nonrec deprecate_existing_entities = bool
type nonrec upload_entity_definitions_request = {
  1. deprecate_existing_entities : deprecate_existing_entities option;
    (*

    A Boolean that specifies whether to deprecate all entities in the latest version before uploading the new DefinitionDocument. If set to true, the upload will create a new namespace version.

    *)
  2. sync_with_public_namespace : sync_with_public_namespace option;
    (*

    A Boolean that specifies whether to synchronize with the latest version of the public namespace. If set to true, the upload will create a new namespace version.

    *)
  3. document : definition_document option;
    (*

    The DefinitionDocument that defines the updated entities.

    *)
}
type nonrec error_message = string
type nonrec throttling_exception = {
  1. message : error_message option;
}
type nonrec invalid_request_exception = {
  1. message : error_message option;
}
type nonrec internal_failure_exception = {
  1. message : error_message option;
}
type nonrec arn = string
type nonrec timestamp = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec system_template_summary = {
  1. created_at : timestamp option;
    (*

    The date when the system was created.

    *)
  2. revision_number : version option;
    (*

    The revision number of the system.

    *)
  3. arn : arn option;
    (*

    The ARN of the system.

    *)
  4. id : urn option;
    (*

    The ID of the system.

    *)
}

An object that contains information about a system.

type nonrec update_system_template_response = {
  1. summary : system_template_summary option;
    (*

    An object containing summary information about the updated system.

    *)
}
type nonrec update_system_template_request = {
  1. compatible_namespace_version : version option;
    (*

    The version of the user's namespace. Defaults to the latest version of the user's namespace.

    If no value is specified, the latest version is used by default.

    *)
  2. definition : definition_document;
    (*

    The DefinitionDocument that contains the updated system definition.

    *)
  3. id : urn;
    (*

    The ID of the system to be updated.

    The ID should be in the following format.

    urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME

    *)
}
type nonrec resource_not_found_exception = {
  1. message : error_message option;
}
type nonrec flow_template_summary = {
  1. created_at : timestamp option;
    (*

    The date when the workflow was created.

    *)
  2. revision_number : version option;
    (*

    The revision number of the workflow.

    *)
  3. arn : arn option;
    (*

    The ARN of the workflow.

    *)
  4. id : urn option;
    (*

    The ID of the workflow.

    *)
}

An object that contains summary information about a workflow.

type nonrec update_flow_template_response = {
  1. summary : flow_template_summary option;
    (*

    An object containing summary information about the updated workflow.

    *)
}
type nonrec update_flow_template_request = {
  1. compatible_namespace_version : version option;
    (*

    The version of the user's namespace.

    If no value is specified, the latest version is used by default. Use the GetFlowTemplateRevisions if you want to find earlier revisions of the flow to update.

    *)
  2. definition : definition_document;
    (*

    The DefinitionDocument that contains the updated workflow definition.

    *)
  3. id : urn;
    (*

    The ID of the workflow to be updated.

    The ID should be in the following format.

    urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME

    *)
}
type nonrec untag_resource_response = unit
type nonrec resource_arn = string
type nonrec tag_key = string
type nonrec tag_key_list = tag_key list
type nonrec untag_resource_request = {
  1. tag_keys : tag_key_list;
    (*

    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.

    This parameter to the API requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide.

    *)
  2. resource_arn : resource_arn;
    (*

    The Amazon Resource Name (ARN) of the resource whose tags are to be removed.

    *)
}
type nonrec resource_already_exists_exception = {
  1. message : error_message option;
}
type nonrec system_instance_deployment_status =
  1. | DELETED_IN_TARGET
  2. | PENDING_DELETE
  3. | FAILED
  4. | UNDEPLOY_IN_PROGRESS
  5. | DEPLOYED_IN_TARGET
  6. | DEPLOY_IN_PROGRESS
  7. | BOOTSTRAP
  8. | NOT_DEPLOYED
type nonrec deployment_target =
  1. | CLOUD
  2. | GREENGRASS
type nonrec group_name = string
type nonrec greengrass_group_id = string
type nonrec greengrass_group_version_id = string
type nonrec system_instance_summary = {
  1. greengrass_group_version_id : greengrass_group_version_id option;
    (*

    The version of the Greengrass group where the system instance is deployed.

    *)
  2. greengrass_group_id : greengrass_group_id option;
    (*

    The ID of the Greengrass group where the system instance is deployed.

    *)
  3. updated_at : timestamp option;
    (*

    The date and time when the system instance was last updated.

    *)
  4. created_at : timestamp option;
    (*

    The date when the system instance was created.

    *)
  5. greengrass_group_name : group_name option;
    (*

    The ID of the Greengrass group where the system instance is deployed.

    *)
  6. target : deployment_target option;
    (*

    The target of the system instance.

    *)
  7. status : system_instance_deployment_status option;
    (*

    The status of the system instance.

    *)
  8. arn : arn option;
    (*

    The ARN of the system instance.

    *)
  9. id : urn option;
    (*

    The ID of the system instance.

    *)
}

An object that contains summary information about a system instance.

type nonrec undeploy_system_instance_response = {
  1. summary : system_instance_summary option;
    (*

    An object that contains summary information about the system instance that was removed from its target.

    *)
}
type nonrec undeploy_system_instance_request = {
  1. id : urn option;
    (*

    The ID of the system instance to remove from its target.

    *)
}
type nonrec resource_in_use_exception = {
  1. message : error_message option;
}
type nonrec thing_arn = string
type nonrec thing_name = string
type nonrec thing = {
  1. thing_name : thing_name option;
    (*

    The name of the thing.

    *)
  2. thing_arn : thing_arn option;
    (*

    The ARN of the thing.

    *)
}

An AWS IoT thing.

type nonrec things = thing list
type nonrec tag_value = string
type nonrec tag_resource_response = unit
type nonrec tag = {
  1. value : tag_value;
    (*

    The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length.

    *)
  2. key : tag_key;
    (*

    The required name of the tag. The string value can be from 1 to 128 Unicode characters in length.

    *)
}

Metadata assigned to an AWS IoT Things Graph resource consisting of a key-value pair.

type nonrec tag_list = tag list
type nonrec tag_resource_request = {
  1. tags : tag_list;
    (*

    A list of tags to add to the resource.>

    *)
  2. resource_arn : resource_arn;
    (*

    The Amazon Resource Name (ARN) of the resource whose tags are returned.

    *)
}
type nonrec system_template_summaries = system_template_summary list
type nonrec system_template_filter_name =
  1. | FLOW_TEMPLATE_ID
type nonrec system_template_filter_value = string
type nonrec system_template_filter_values = system_template_filter_value list
type nonrec system_template_filter = {
  1. value : system_template_filter_values;
    (*

    An array of string values for the search filter field. Multiple values function as AND criteria in the search.

    *)
  2. name : system_template_filter_name;
    (*

    The name of the system search filter field.

    *)
}

An object that filters a system search.

type nonrec system_template_filters = system_template_filter list
type nonrec system_template_description = {
  1. validated_namespace_version : version option;
    (*

    The namespace version against which the system was validated. Use this value in your system instance.

    *)
  2. definition : definition_document option;
    (*

    The definition document of a system.

    *)
  3. summary : system_template_summary option;
    (*

    An object that contains summary information about a system.

    *)
}

An object that contains a system's definition document and summary information.

type nonrec system_instance_summaries = system_instance_summary list
type nonrec system_instance_filter_name =
  1. | GREENGRASS_GROUP_NAME
  2. | STATUS
  3. | SYSTEM_TEMPLATE_ID
type nonrec system_instance_filter_value = string
type nonrec system_instance_filter_values = system_instance_filter_value list
type nonrec system_instance_filter = {
  1. value : system_instance_filter_values option;
    (*

    An array of string values for the search filter field. Multiple values function as AND criteria in the search.

    *)
  2. name : system_instance_filter_name option;
    (*

    The name of the search filter field.

    *)
}

An object that filters a system instance search. Multiple filters function as OR criteria in the search. For example a search that includes a GREENGRASS_GROUP_NAME and a STATUS filter searches for system instances in the specified Greengrass group that have the specified status.

type nonrec system_instance_filters = system_instance_filter list
type nonrec s3_bucket_name = string
type nonrec enabled = bool
type nonrec role_arn = string
type nonrec metrics_configuration = {
  1. metric_rule_role_arn : role_arn option;
    (*

    The ARN of the role that is used to collect cloud metrics.

    *)
  2. cloud_metric_enabled : enabled option;
    (*

    A Boolean that specifies whether cloud metrics are collected.

    *)
}

An object that specifies whether cloud metrics are collected in a deployment and, if so, what role is used to collect metrics.

type nonrec dependency_revision = {
  1. revision_number : version option;
    (*

    The revision number of the workflow or system.

    *)
  2. id : urn option;
    (*

    The ID of the workflow or system.

    *)
}

An object that contains the ID and revision number of a workflow or system that is part of a deployment.

type nonrec dependency_revisions = dependency_revision list
type nonrec system_instance_description = {
  1. flow_actions_role_arn : role_arn option;
    (*

    The AWS Identity and Access Management (IAM) role that AWS IoT Things Graph assumes during flow execution in a cloud deployment. This role must have read and write permissionss to AWS Lambda and AWS IoT and to any other AWS services that the flow uses.

    *)
  2. validated_dependency_revisions : dependency_revisions option;
    (*

    A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.

    *)
  3. validated_namespace_version : version option;
    (*

    The version of the user's namespace against which the system instance was validated.

    *)
  4. metrics_configuration : metrics_configuration option;
  5. s3_bucket_name : s3_bucket_name option;
    (*

    The Amazon Simple Storage Service bucket where information about a system instance is stored.

    *)
  6. definition : definition_document option;
  7. summary : system_instance_summary option;
    (*

    An object that contains summary information about a system instance.

    *)
}

An object that contains a system instance definition and summary information.

type nonrec string_ = string
type nonrec string_list = string_ list
type nonrec next_token = string
type nonrec search_things_response = {
  1. next_token : next_token option;
    (*

    The string to specify as nextToken when you request the next page of results.

    *)
  2. things : things option;
    (*

    An array of things in the result set.

    *)
}
type nonrec max_results = int
type nonrec search_things_request = {
  1. namespace_version : version option;
    (*

    The version of the user's namespace. Defaults to the latest version of the user's namespace.

    *)
  2. max_results : max_results option;
    (*

    The maximum number of results to return in the response.

    *)
  3. next_token : next_token option;
    (*

    The string that specifies the next page of results. Use this when you're paginating results.

    *)
  4. entity_id : urn;
    (*

    The ID of the entity to which the things are associated.

    The IDs should be in the following format.

    urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME

    *)
}
type nonrec search_system_templates_response = {
  1. next_token : next_token option;
    (*

    The string to specify as nextToken when you request the next page of results.

    *)
  2. summaries : system_template_summaries option;
    (*

    An array of objects that contain summary information about each system deployment in the result set.

    *)
}
type nonrec search_system_templates_request = {
  1. max_results : max_results option;
    (*

    The maximum number of results to return in the response.

    *)
  2. next_token : next_token option;
    (*

    The string that specifies the next page of results. Use this when you're paginating results.

    *)
  3. filters : system_template_filters option;
    (*

    An array of filters that limit the result set. The only valid filter is FLOW_TEMPLATE_ID.

    *)
}
type nonrec search_system_instances_response = {
  1. next_token : next_token option;
    (*

    The string to specify as nextToken when you request the next page of results.

    *)
  2. summaries : system_instance_summaries option;
    (*

    An array of objects that contain summary data abour the system instances in the result set.

    *)
}
type nonrec search_system_instances_request = {
  1. max_results : max_results option;
    (*

    The maximum number of results to return in the response.

    *)
  2. next_token : next_token option;
    (*

    The string that specifies the next page of results. Use this when you're paginating results.

    *)
  3. filters : system_instance_filters option;
    (*

    Optional filter to apply to the search. Valid filters are SYSTEM_TEMPLATE_ID, STATUS, and GREENGRASS_GROUP_NAME.

    Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.

    *)
}
type nonrec flow_template_summaries = flow_template_summary list
type nonrec search_flow_templates_response = {
  1. next_token : next_token option;
    (*

    The string to specify as nextToken when you request the next page of results.

    *)
  2. summaries : flow_template_summaries option;
    (*

    An array of objects that contain summary information about each workflow in the result set.

    *)
}
type nonrec flow_template_filter_name =
  1. | DEVICE_MODEL_ID
type nonrec flow_template_filter_value = string
type nonrec flow_template_filter_values = flow_template_filter_value list
type nonrec flow_template_filter = {
  1. value : flow_template_filter_values;
    (*

    An array of string values for the search filter field. Multiple values function as AND criteria in the search.

    *)
  2. name : flow_template_filter_name;
    (*

    The name of the search filter field.

    *)
}

An object that filters a workflow search.

type nonrec flow_template_filters = flow_template_filter list
type nonrec search_flow_templates_request = {
  1. max_results : max_results option;
    (*

    The maximum number of results to return in the response.

    *)
  2. next_token : next_token option;
    (*

    The string that specifies the next page of results. Use this when you're paginating results.

    *)
  3. filters : flow_template_filters option;
    (*

    An array of objects that limit the result set. The only valid filter is DEVICE_MODEL_ID.

    *)
}
type nonrec flow_execution_id = string
type nonrec flow_execution_status =
  1. | FAILED
  2. | SUCCEEDED
  3. | ABORTED
  4. | RUNNING
type nonrec flow_execution_summary = {
  1. updated_at : timestamp option;
    (*

    The date and time when the flow execution summary was last updated.

    *)
  2. created_at : timestamp option;
    (*

    The date and time when the flow execution summary was created.

    *)
  3. flow_template_id : urn option;
    (*

    The ID of the flow.

    *)
  4. system_instance_id : urn option;
    (*

    The ID of the system instance that contains the flow.

    *)
  5. status : flow_execution_status option;
    (*

    The current status of the flow execution.

    *)
  6. flow_execution_id : flow_execution_id option;
    (*

    The ID of the flow execution.

    *)
}

An object that contains summary information about a flow execution.

type nonrec flow_execution_summaries = flow_execution_summary list
type nonrec search_flow_executions_response = {
  1. next_token : next_token option;
    (*

    The string to specify as nextToken when you request the next page of results.

    *)
  2. summaries : flow_execution_summaries option;
    (*

    An array of objects that contain summary information about each workflow execution in the result set.

    *)
}
type nonrec search_flow_executions_request = {
  1. max_results : max_results option;
    (*

    The maximum number of results to return in the response.

    *)
  2. next_token : next_token option;
    (*

    The string that specifies the next page of results. Use this when you're paginating results.

    *)
  3. end_time : timestamp option;
    (*

    The date and time of the latest flow execution to return.

    *)
  4. start_time : timestamp option;
    (*

    The date and time of the earliest flow execution to return.

    *)
  5. flow_execution_id : flow_execution_id option;
    (*

    The ID of a flow execution.

    *)
  6. system_instance_id : urn;
    (*

    The ID of the system instance that contains the flow.

    *)
}
type nonrec entity_type =
  1. | ENUM
  2. | MAPPING
  3. | PROPERTY
  4. | EVENT
  5. | ACTION
  6. | STATE
  7. | CAPABILITY
  8. | DEVICE_MODEL
  9. | SERVICE
  10. | DEVICE
type nonrec entity_description = {
  1. definition : definition_document option;
    (*

    The definition document of the entity.

    *)
  2. created_at : timestamp option;
    (*

    The time at which the entity was created.

    *)
  3. type_ : entity_type option;
    (*

    The entity type.

    *)
  4. arn : arn option;
    (*

    The entity ARN.

    *)
  5. id : urn option;
    (*

    The entity ID.

    *)
}

Describes the properties of an entity.

type nonrec entity_descriptions = entity_description list
type nonrec search_entities_response = {
  1. next_token : next_token option;
    (*

    The string to specify as nextToken when you request the next page of results.

    *)
  2. descriptions : entity_descriptions option;
    (*

    An array of descriptions for each entity returned in the search result.

    *)
}
type nonrec entity_types = entity_type list
type nonrec entity_filter_name =
  1. | REFERENCED_ENTITY_ID
  2. | SEMANTIC_TYPE_PATH
  3. | NAMESPACE
  4. | NAME
type nonrec entity_filter_value = string
type nonrec entity_filter_values = entity_filter_value list
type nonrec entity_filter = {
  1. value : entity_filter_values option;
    (*

    An array of string values for the search filter field. Multiple values function as AND criteria in the search.

    *)
  2. name : entity_filter_name option;
    (*

    The name of the entity search filter field. REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.

    *)
}

An object that filters an entity search. Multiple filters function as OR criteria in the search. For example a search that includes a NAMESPACE and a REFERENCED_ENTITY_ID filter searches for entities in the specified namespace that use the entity specified by the value of REFERENCED_ENTITY_ID.

type nonrec entity_filters = entity_filter list
type nonrec search_entities_request = {
  1. namespace_version : version option;
    (*

    The version of the user's namespace. Defaults to the latest version of the user's namespace.

    *)
  2. max_results : max_results option;
    (*

    The maximum number of results to return in the response.

    *)
  3. next_token : next_token option;
    (*

    The string that specifies the next page of results. Use this when you're paginating results.

    *)
  4. filters : entity_filters option;
    (*

    Optional filter to apply to the search. Valid filters are NAME NAMESPACE, SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.

    Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.

    *)
  5. entity_types : entity_types;
    (*

    The entity types for which to search.

    *)
}
type nonrec namespace_name = string
type nonrec namespace_deletion_status_error_codes =
  1. | VALIDATION_FAILED
type nonrec namespace_deletion_status =
  1. | FAILED
  2. | SUCCEEDED
  3. | IN_PROGRESS
type nonrec list_tags_for_resource_response = {
  1. next_token : next_token option;
    (*

    The token that specifies the next page of results to return.

    *)
  2. tags : tag_list option;
    (*

    List of tags returned by the ListTagsForResource operation.

    *)
}
type nonrec list_tags_for_resource_request = {
  1. next_token : next_token option;
    (*

    The token that specifies the next page of results to return.

    *)
  2. resource_arn : resource_arn;
    (*

    The Amazon Resource Name (ARN) of the resource whose tags are to be returned.

    *)
  3. max_results : max_results option;
    (*

    The maximum number of tags to return.

    *)
}
type nonrec flow_execution_message_id = string
type nonrec flow_execution_event_type =
  1. | ACKNOWLEDGE_TASK_MESSAGE
  2. | THING_ACTION_TASK_SUCCEEDED
  3. | THING_ACTION_TASK_FAILED
  4. | THING_ACTION_TASK
  5. | SCHEDULE_NEXT_READY_STEPS_TASK
  6. | START_FLOW_EXECUTION_TASK
  7. | ACTIVITY_SUCCEEDED
  8. | ACTIVITY_FAILED
  9. | ACTIVITY_STARTED
  10. | ACTIVITY_SCHEDULED
  11. | STEP_SUCCEEDED
  12. | STEP_FAILED
  13. | STEP_STARTED
  14. | EXECUTION_SUCCEEDED
  15. | EXECUTION_ABORTED
  16. | EXECUTION_FAILED
  17. | EXECUTION_STARTED
type nonrec flow_execution_message_payload = string
type nonrec flow_execution_message = {
  1. payload : flow_execution_message_payload option;
    (*

    A string containing information about the flow event.

    *)
  2. timestamp : timestamp option;
    (*

    The date and time when the message was last updated.

    *)
  3. event_type : flow_execution_event_type option;
    (*

    The type of flow event .

    *)
  4. message_id : flow_execution_message_id option;
    (*

    The unique identifier of the message.

    *)
}

An object that contains information about a flow event.

type nonrec flow_execution_messages = flow_execution_message list
type nonrec list_flow_execution_messages_response = {
  1. next_token : next_token option;
    (*

    The string to specify as nextToken when you request the next page of results.

    *)
  2. messages : flow_execution_messages option;
    (*

    A list of objects that contain information about events in the specified flow execution.

    *)
}
type nonrec list_flow_execution_messages_request = {
  1. max_results : max_results option;
    (*

    The maximum number of results to return in the response.

    *)
  2. next_token : next_token option;
    (*

    The string that specifies the next page of results. Use this when you're paginating results.

    *)
  3. flow_execution_id : flow_execution_id;
    (*

    The ID of the flow execution.

    *)
}
type nonrec limit_exceeded_exception = {
  1. message : error_message option;
}
type nonrec get_upload_status_response = {
  1. created_date : timestamp;
    (*

    The date at which the upload was created.

    *)
  2. failure_reason : string_list option;
    (*

    The reason for an upload failure.

    *)
  3. namespace_version : version option;
    (*

    The version of the user's namespace. Defaults to the latest version of the user's namespace.

    *)
  4. namespace_name : namespace_name option;
    (*

    The name of the upload's namespace.

    *)
  5. namespace_arn : arn option;
    (*

    The ARN of the upload.

    *)
  6. upload_status : upload_status;
    (*

    The status of the upload. The initial status is IN_PROGRESS. The response show all validation failures if the upload fails.

    *)
  7. upload_id : upload_id;
    (*

    The ID of the upload.

    *)
}
type nonrec get_upload_status_request = {
  1. upload_id : upload_id;
    (*

    The ID of the upload. This value is returned by the UploadEntityDefinitions action.

    *)
}
type nonrec get_system_template_revisions_response = {
  1. next_token : next_token option;
    (*

    The string to specify as nextToken when you request the next page of results.

    *)
  2. summaries : system_template_summaries option;
    (*

    An array of objects that contain summary data about the system template revisions.

    *)
}
type nonrec get_system_template_revisions_request = {
  1. max_results : max_results option;
    (*

    The maximum number of results to return in the response.

    *)
  2. next_token : next_token option;
    (*

    The string that specifies the next page of results. Use this when you're paginating results.

    *)
  3. id : urn;
    (*

    The ID of the system template.

    The ID should be in the following format.

    urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME

    *)
}
type nonrec get_system_template_response = {
  1. description : system_template_description option;
    (*

    An object that contains summary data about the system.

    *)
}
type nonrec get_system_template_request = {
  1. revision_number : version option;
    (*

    The number that specifies the revision of the system to get.

    *)
  2. id : urn;
    (*

    The ID of the system to get. This ID must be in the user's namespace.

    The ID should be in the following format.

    urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME

    *)
}
type nonrec get_system_instance_response = {
  1. description : system_instance_description option;
    (*

    An object that describes the system instance.

    *)
}
type nonrec get_system_instance_request = {
  1. id : urn;
    (*

    The ID of the system deployment instance. This value is returned by CreateSystemInstance.

    The ID should be in the following format.

    urn:tdm:REGION/ACCOUNT ID/default:deployment:DEPLOYMENTNAME

    *)
}
type nonrec get_namespace_deletion_status_response = {
  1. error_message : string_ option;
    (*

    An error code returned by the namespace deletion task.

    *)
  2. error_code : namespace_deletion_status_error_codes option;
    (*

    An error code returned by the namespace deletion task.

    *)
  3. status : namespace_deletion_status option;
    (*

    The status of the deletion request.

    *)
  4. namespace_name : namespace_name option;
    (*

    The name of the namespace that is being deleted.

    *)
  5. namespace_arn : arn option;
    (*

    The ARN of the namespace that is being deleted.

    *)
}
type nonrec get_namespace_deletion_status_request = unit
type nonrec get_flow_template_revisions_response = {
  1. next_token : next_token option;
    (*

    The string to specify as nextToken when you request the next page of results.

    *)
  2. summaries : flow_template_summaries option;
    (*

    An array of objects that provide summary data about each revision.

    *)
}
type nonrec get_flow_template_revisions_request = {
  1. max_results : max_results option;
    (*

    The maximum number of results to return in the response.

    *)
  2. next_token : next_token option;
    (*

    The string that specifies the next page of results. Use this when you're paginating results.

    *)
  3. id : urn;
    (*

    The ID of the workflow.

    The ID should be in the following format.

    urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME

    *)
}
type nonrec flow_template_description = {
  1. validated_namespace_version : version option;
    (*

    The version of the user's namespace against which the workflow was validated. Use this value in your system instance.

    *)
  2. definition : definition_document option;
    (*

    A workflow's definition document.

    *)
  3. summary : flow_template_summary option;
    (*

    An object that contains summary information about a workflow.

    *)
}

An object that contains a workflow's definition and summary information.

type nonrec get_flow_template_response = {
  1. description : flow_template_description option;
    (*

    The object that describes the specified workflow.

    *)
}
type nonrec get_flow_template_request = {
  1. revision_number : version option;
    (*

    The number of the workflow revision to retrieve.

    *)
  2. id : urn;
    (*

    The ID of the workflow.

    The ID should be in the following format.

    urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME

    *)
}
type nonrec get_entities_response = {
  1. descriptions : entity_descriptions option;
    (*

    An array of descriptions for the specified entities.

    *)
}
type nonrec get_entities_request = {
  1. namespace_version : version option;
    (*

    The version of the user's namespace. Defaults to the latest version of the user's namespace.

    *)
  2. ids : urns;
    (*

    An array of entity IDs.

    The IDs should be in the following format.

    urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME

    *)
}
type nonrec dissociate_entity_from_thing_response = unit
type nonrec dissociate_entity_from_thing_request = {
  1. entity_type : entity_type;
    (*

    The entity type from which to disassociate the thing.

    *)
  2. thing_name : thing_name;
    (*

    The name of the thing to disassociate.

    *)
}
type nonrec describe_namespace_response = {
  1. namespace_version : version option;
    (*

    The version of the user's namespace to describe.

    *)
  2. tracking_namespace_version : version option;
    (*

    The version of the public namespace that the latest version is tracking.

    *)
  3. tracking_namespace_name : namespace_name option;
    (*

    The name of the public namespace that the latest namespace version is tracking.

    *)
  4. namespace_name : namespace_name option;
    (*

    The name of the namespace.

    *)
  5. namespace_arn : arn option;
    (*

    The ARN of the namespace.

    *)
}
type nonrec describe_namespace_request = {
  1. namespace_name : namespace_name option;
    (*

    The name of the user's namespace. Set this to aws to get the public namespace.

    *)
}
type nonrec deprecate_system_template_response = unit
type nonrec deprecate_system_template_request = {
  1. id : urn;
    (*

    The ID of the system to delete.

    The ID should be in the following format.

    urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME

    *)
}
type nonrec deprecate_flow_template_response = unit
type nonrec deprecate_flow_template_request = {
  1. id : urn;
    (*

    The ID of the workflow to be deleted.

    The ID should be in the following format.

    urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME

    *)
}
type nonrec greengrass_deployment_id = string
type nonrec deploy_system_instance_response = {
  1. greengrass_deployment_id : greengrass_deployment_id option;
    (*

    The ID of the Greengrass deployment used to deploy the system instance.

    *)
  2. summary : system_instance_summary;
    (*

    An object that contains summary information about a system instance that was deployed.

    *)
}
type nonrec deploy_system_instance_request = {
  1. id : urn option;
    (*

    The ID of the system instance. This value is returned by the CreateSystemInstance action.

    The ID should be in the following format.

    urn:tdm:REGION/ACCOUNT ID/default:deployment:DEPLOYMENTNAME

    *)
}
type nonrec delete_system_template_response = unit
type nonrec delete_system_template_request = {
  1. id : urn;
    (*

    The ID of the system to be deleted.

    The ID should be in the following format.

    urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME

    *)
}
type nonrec delete_system_instance_response = unit
type nonrec delete_system_instance_request = {
  1. id : urn option;
    (*

    The ID of the system instance to be deleted.

    *)
}
type nonrec delete_namespace_response = {
  1. namespace_name : namespace_name option;
    (*

    The name of the namespace to be deleted.

    *)
  2. namespace_arn : arn option;
    (*

    The ARN of the namespace to be deleted.

    *)
}
type nonrec delete_namespace_request = unit
type nonrec delete_flow_template_response = unit
type nonrec delete_flow_template_request = {
  1. id : urn;
    (*

    The ID of the workflow to be deleted.

    The ID should be in the following format.

    urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME

    *)
}
type nonrec create_system_template_response = {
  1. summary : system_template_summary option;
    (*

    The summary object that describes the created system.

    *)
}
type nonrec create_system_template_request = {
  1. compatible_namespace_version : version option;
    (*

    The namespace version in which the system is to be created.

    If no value is specified, the latest version is used by default.

    *)
  2. definition : definition_document;
    (*

    The DefinitionDocument used to create the system.

    *)
}
type nonrec create_system_instance_response = {
  1. summary : system_instance_summary option;
    (*

    The summary object that describes the new system instance.

    *)
}
type nonrec create_system_instance_request = {
  1. flow_actions_role_arn : role_arn option;
    (*

    The ARN of the IAM role that AWS IoT Things Graph will assume when it executes the flow. This role must have read and write access to AWS Lambda and AWS IoT and any other AWS services that the flow uses when it executes. This value is required if the value of the target parameter is CLOUD.

    *)
  2. metrics_configuration : metrics_configuration option;
  3. s3_bucket_name : s3_bucket_name option;
    (*

    The name of the Amazon Simple Storage Service bucket that will be used to store and deploy the system instance's resource file. This value is required if the value of the target parameter is GREENGRASS.

    *)
  4. greengrass_group_name : group_name option;
    (*

    The name of the Greengrass group where the system instance will be deployed. This value is required if the value of the target parameter is GREENGRASS.

    *)
  5. target : deployment_target;
    (*

    The target type of the deployment. Valid values are GREENGRASS and CLOUD.

    *)
  6. definition : definition_document;
  7. tags : tag_list option;
    (*

    Metadata, consisting of key-value pairs, that can be used to categorize your system instances.

    *)
}
type nonrec create_flow_template_response = {
  1. summary : flow_template_summary option;
    (*

    The summary object that describes the created workflow.

    *)
}
type nonrec create_flow_template_request = {
  1. compatible_namespace_version : version option;
    (*

    The namespace version in which the workflow is to be created.

    If no value is specified, the latest version is used by default.

    *)
  2. definition : definition_document;
    (*

    The workflow DefinitionDocument.

    *)
}
type nonrec associate_entity_to_thing_response = unit
type nonrec associate_entity_to_thing_request = {
  1. namespace_version : version option;
    (*

    The version of the user's namespace. Defaults to the latest version of the user's namespace.

    *)
  2. entity_id : urn;
    (*

    The ID of the device to be associated with the thing.

    The ID should be in the following format.

    urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME

    *)
  3. thing_name : thing_name;
    (*

    The name of the thing to which the entity is to be associated.

    *)
}