Iotthingsgraph

associate_entity_to_thing(entity_id, thing_name)
associate_entity_to_thing(entity_id, thing_name, params::Dict{String,<:Any})

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.

Arguments

• entity_id: 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
• thing_name: The name of the thing to which the entity is to be associated.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "namespaceVersion": The version of the user's namespace. Defaults to the latest version of the user's namespace.

create_flow_template(definition)
create_flow_template(definition, params::Dict{String,<:Any})

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.

Arguments

• definition: The workflow DefinitionDocument.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "compatibleNamespaceVersion": The namespace version in which the workflow is to be created. If no value is specified, the latest version is used by default.

create_system_instance(definition, target)
create_system_instance(definition, target, params::Dict{String,<:Any})

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.

Arguments

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "flowActionsRoleArn": 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.
• "greengrassGroupName": 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.
• "metricsConfiguration":
• "s3BucketName": 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.
• "tags": Metadata, consisting of key-value pairs, that can be used to categorize your system instances.

create_system_template(definition)
create_system_template(definition, params::Dict{String,<:Any})

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.

Arguments

• definition: The DefinitionDocument used to create the system.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "compatibleNamespaceVersion": The namespace version in which the system is to be created. If no value is specified, the latest version is used by default.

delete_flow_template(id)
delete_flow_template(id, params::Dict{String,<:Any})

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

Arguments

• id: The ID of the workflow to be deleted. The ID should be in the following format. urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME

delete_namespace()
delete_namespace(params::Dict{String,<:Any})

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.

delete_system_instance()
delete_system_instance(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "id": The ID of the system instance to be deleted.

delete_system_template(id)
delete_system_template(id, params::Dict{String,<:Any})

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.

Arguments

• id: The ID of the system to be deleted. The ID should be in the following format. urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME

deploy_system_instance()
deploy_system_instance(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "id": 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

deprecate_flow_template(id)
deprecate_flow_template(id, params::Dict{String,<:Any})

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

Arguments

• id: The ID of the workflow to be deleted. The ID should be in the following format. urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME

deprecate_system_template(id)
deprecate_system_template(id, params::Dict{String,<:Any})

Deprecates the specified system.

Arguments

• id: The ID of the system to delete. The ID should be in the following format. urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME

describe_namespace()
describe_namespace(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "namespaceName": The name of the user's namespace. Set this to aws to get the public namespace.

dissociate_entity_from_thing(entity_type, thing_name)
dissociate_entity_from_thing(entity_type, thing_name, params::Dict{String,<:Any})

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.

Arguments

• entity_type: The entity type from which to disassociate the thing.
• thing_name: The name of the thing to disassociate.

get_entities(ids)
get_entities(ids, params::Dict{String,<:Any})

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.

Arguments

• ids: An array of entity IDs. The IDs should be in the following format. urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "namespaceVersion": The version of the user's namespace. Defaults to the latest version of the user's namespace.

get_flow_template(id)
get_flow_template(id, params::Dict{String,<:Any})

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

Arguments

• id: The ID of the workflow. The ID should be in the following format. urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "revisionNumber": The number of the workflow revision to retrieve.

get_flow_template_revisions(id)
get_flow_template_revisions(id, params::Dict{String,<:Any})

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.

Arguments

• id: The ID of the workflow. The ID should be in the following format. urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return in the response.
• "nextToken": The string that specifies the next page of results. Use this when you're paginating results.

get_namespace_deletion_status()
get_namespace_deletion_status(params::Dict{String,<:Any})

Gets the status of a namespace deletion task.

get_system_instance(id)
get_system_instance(id, params::Dict{String,<:Any})

Gets a system instance.

Arguments

• id: 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

get_system_template(id)
get_system_template(id, params::Dict{String,<:Any})

Gets a system.

Arguments

• id: 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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "revisionNumber": The number that specifies the revision of the system to get.

get_system_template_revisions(id)
get_system_template_revisions(id, params::Dict{String,<:Any})

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.

Arguments

• id: The ID of the system template. The ID should be in the following format. urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return in the response.
• "nextToken": The string that specifies the next page of results. Use this when you're paginating results.

get_upload_status(upload_id)
get_upload_status(upload_id, params::Dict{String,<:Any})

Gets the status of the specified upload.

Arguments

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

list_flow_execution_messages(flow_execution_id)
list_flow_execution_messages(flow_execution_id, params::Dict{String,<:Any})

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

Arguments

• flow_execution_id: The ID of the flow execution.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return in the response.
• "nextToken": The string that specifies the next page of results. Use this when you're paginating results.

list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

Lists all tags on an AWS IoT Things Graph resource.

Arguments

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of tags to return.
• "nextToken": The token that specifies the next page of results to return.

search_entities(entity_types)
search_entities(entity_types, params::Dict{String,<:Any})

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

Arguments

• entity_types: The entity types for which to search.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "filters": Optional filter to apply to the search. Valid filters are NAME NAMESPACE, SEMANTICTYPEPATH and REFERENCEDENTITYID. REFERENCEDENTITYID 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.
• "maxResults": The maximum number of results to return in the response.
• "namespaceVersion": The version of the user's namespace. Defaults to the latest version of the user's namespace.
• "nextToken": The string that specifies the next page of results. Use this when you're paginating results.

search_flow_executions(system_instance_id)
search_flow_executions(system_instance_id, params::Dict{String,<:Any})

Searches for AWS IoT Things Graph workflow execution instances.

Arguments

• system_instance_id: The ID of the system instance that contains the flow.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "endTime": The date and time of the latest flow execution to return.
• "flowExecutionId": The ID of a flow execution.
• "maxResults": The maximum number of results to return in the response.
• "nextToken": The string that specifies the next page of results. Use this when you're paginating results.
• "startTime": The date and time of the earliest flow execution to return.

search_flow_templates()
search_flow_templates(params::Dict{String,<:Any})

Searches for summary information about workflows.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "filters": An array of objects that limit the result set. The only valid filter is DEVICEMODELID.
• "maxResults": The maximum number of results to return in the response.
• "nextToken": The string that specifies the next page of results. Use this when you're paginating results.

search_system_instances()
search_system_instances(params::Dict{String,<:Any})

Searches for system instances in the user's account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "filters": Optional filter to apply to the search. Valid filters are SYSTEMTEMPLATEID, STATUS, and GREENGRASSGROUPNAME. Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.
• "maxResults": The maximum number of results to return in the response.
• "nextToken": The string that specifies the next page of results. Use this when you're paginating results.

search_system_templates()
search_system_templates(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "filters": An array of filters that limit the result set. The only valid filter is FLOWTEMPLATEID.
• "maxResults": The maximum number of results to return in the response.
• "nextToken": The string that specifies the next page of results. Use this when you're paginating results.

search_things(entity_id)
search_things(entity_id, params::Dict{String,<:Any})

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.

Arguments

• entity_id: 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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return in the response.
• "namespaceVersion": The version of the user's namespace. Defaults to the latest version of the user's namespace.
• "nextToken": The string that specifies the next page of results. Use this when you're paginating results.

tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Creates a tag for the specified resource.

Arguments

• resource_arn: The Amazon Resource Name (ARN) of the resource whose tags are returned.
• tags: A list of tags to add to the resource.>

undeploy_system_instance()
undeploy_system_instance(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "id": The ID of the system instance to remove from its target.

untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Removes a tag from the specified resource.

Arguments

• resource_arn: The Amazon Resource Name (ARN) of the resource whose tags are to be removed.
• tag_keys: 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.

update_flow_template(definition, id)
update_flow_template(definition, id, params::Dict{String,<:Any})

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.

Arguments

• definition: The DefinitionDocument that contains the updated workflow definition.
• id: The ID of the workflow to be updated. The ID should be in the following format. urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "compatibleNamespaceVersion": 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.

update_system_template(definition, id)
update_system_template(definition, id, params::Dict{String,<:Any})

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.

Arguments

• definition: The DefinitionDocument that contains the updated system definition.
• id: The ID of the system to be updated. The ID should be in the following format. urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "compatibleNamespaceVersion": 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.

upload_entity_definitions()
upload_entity_definitions(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "deprecateExistingEntities": 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.
• "document": The DefinitionDocument that defines the updated entities.
• "syncWithPublicNamespace": 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.