IoTThingsGraph class

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.

Constructors

IoTThingsGraph({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

associateEntityToThing({required String entityId, required String thingName, int? namespaceVersion}) → Future<void>
Associates a device with a concrete thing that is in the user's registry.
close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createFlowTemplate({required DefinitionDocument definition, int? compatibleNamespaceVersion}) → Future<CreateFlowTemplateResponse>
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.
createSystemInstance({required DefinitionDocument definition, required DeploymentTarget target, String? flowActionsRoleArn, String? greengrassGroupName, MetricsConfiguration? metricsConfiguration, String? s3BucketName, List<Tag>? tags}) → Future<CreateSystemInstanceResponse>
Creates a system instance.
createSystemTemplate({required DefinitionDocument definition, int? compatibleNamespaceVersion}) → Future<CreateSystemTemplateResponse>
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.
deleteFlowTemplate({required String id}) → Future<void>
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).
deleteNamespace() → Future<DeleteNamespaceResponse>
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.
deleteSystemInstance({String? id}) → Future<void>
Deletes a system instance. Only system instances that have never been deployed, or that have been undeployed can be deleted.
deleteSystemTemplate({required String id}) → Future<void>
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.
deploySystemInstance({String? id}) → Future<DeploySystemInstanceResponse>
Greengrass and Cloud Deployments
deprecateFlowTemplate({required String id}) → Future<void>
Deprecates the specified workflow. This action marks the workflow for deletion. Deprecated flows can't be deployed, but existing deployments will continue to run.
deprecateSystemTemplate({required String id}) → Future<void>
Deprecates the specified system.
describeNamespace({String? namespaceName}) → Future<DescribeNamespaceResponse>
Gets the latest version of the user's namespace and the public version that it is tracking.
dissociateEntityFromThing({required EntityType entityType, required String thingName}) → Future<void>
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.
getEntities({required List<String> ids, int? namespaceVersion}) → Future<GetEntitiesResponse>
Gets definitions of the specified entities. Uses the latest version of the user's namespace by default. This API returns the following TDM entities.
getFlowTemplate({required String id, int? revisionNumber}) → Future<GetFlowTemplateResponse>
Gets the latest version of the DefinitionDocument and FlowTemplateSummary for the specified workflow.
getFlowTemplateRevisions({required String id, int? maxResults, String? nextToken}) → Future<GetFlowTemplateRevisionsResponse>
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.
getNamespaceDeletionStatus() → Future<GetNamespaceDeletionStatusResponse>
Gets the status of a namespace deletion task.
getSystemInstance({required String id}) → Future<GetSystemInstanceResponse>
Gets a system instance.
getSystemTemplate({required String id, int? revisionNumber}) → Future<GetSystemTemplateResponse>
Gets a system.
getSystemTemplateRevisions({required String id, int? maxResults, String? nextToken}) → Future<GetSystemTemplateRevisionsResponse>
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.
getUploadStatus({required String uploadId}) → Future<GetUploadStatusResponse>
Gets the status of the specified upload.
listFlowExecutionMessages({required String flowExecutionId, int? maxResults, String? nextToken}) → Future<ListFlowExecutionMessagesResponse>
Returns a list of objects that contain information about events in a flow execution.
listTagsForResource({required String resourceArn, int? maxResults, String? nextToken}) → Future<ListTagsForResourceResponse>
Lists all tags on an AWS IoT Things Graph resource.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
searchEntities({required List<EntityType> entityTypes, List<EntityFilter>? filters, int? maxResults, int? namespaceVersion, String? nextToken}) → Future<SearchEntitiesResponse>
Searches for entities of the specified type. You can search for entities in your namespace and the public namespace that you're tracking.
searchFlowExecutions({required String systemInstanceId, DateTime? endTime, String? flowExecutionId, int? maxResults, String? nextToken, DateTime? startTime}) → Future<SearchFlowExecutionsResponse>
Searches for AWS IoT Things Graph workflow execution instances.
searchFlowTemplates({List<FlowTemplateFilter>? filters, int? maxResults, String? nextToken}) → Future<SearchFlowTemplatesResponse>
Searches for summary information about workflows.
searchSystemInstances({List<SystemInstanceFilter>? filters, int? maxResults, String? nextToken}) → Future<SearchSystemInstancesResponse>
Searches for system instances in the user's account.
searchSystemTemplates({List<SystemTemplateFilter>? filters, int? maxResults, String? nextToken}) → Future<SearchSystemTemplatesResponse>
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.
searchThings({required String entityId, int? maxResults, int? namespaceVersion, String? nextToken}) → Future<SearchThingsResponse>
Searches for things associated with the specified entity. You can search by both device and device model.
tagResource({required String resourceArn, required List<Tag> tags}) → Future<void>
Creates a tag for the specified resource.
toString() → String
A string representation of this object.
inherited
undeploySystemInstance({String? id}) → Future<UndeploySystemInstanceResponse>
Removes a system instance from its target (Cloud or Greengrass).
untagResource({required String resourceArn, required List<String> tagKeys}) → Future<void>
Removes a tag from the specified resource.
updateFlowTemplate({required DefinitionDocument definition, required String id, int? compatibleNamespaceVersion}) → Future<UpdateFlowTemplateResponse>
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.
updateSystemTemplate({required DefinitionDocument definition, required String id, int? compatibleNamespaceVersion}) → Future<UpdateSystemTemplateResponse>
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.
uploadEntityDefinitions({bool? deprecateExistingEntities, DefinitionDocument? document, bool? syncWithPublicNamespace}) → Future<UploadEntityDefinitionsResponse>
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.

Operators

operator ==(Object other) → bool
The equality operator.
inherited