@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSIoTThingsGraphAsync extends AWSIoTThingsGraph
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSIoTThingsGraphAsync instead.
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.
ENDPOINT_PREFIXassociateEntityToThing, createFlowTemplate, createSystemInstance, createSystemTemplate, deleteFlowTemplate, deleteNamespace, deleteSystemInstance, deleteSystemTemplate, deploySystemInstance, deprecateFlowTemplate, deprecateSystemTemplate, describeNamespace, dissociateEntityFromThing, getCachedResponseMetadata, getEntities, getFlowTemplate, getFlowTemplateRevisions, getNamespaceDeletionStatus, getSystemInstance, getSystemTemplate, getSystemTemplateRevisions, getUploadStatus, listFlowExecutionMessages, listTagsForResource, searchEntities, searchFlowExecutions, searchFlowTemplates, searchSystemInstances, searchSystemTemplates, searchThings, shutdown, tagResource, undeploySystemInstance, untagResource, updateFlowTemplate, updateSystemTemplate, uploadEntityDefinitionsFuture<AssociateEntityToThingResult> associateEntityToThingAsync(AssociateEntityToThingRequest associateEntityToThingRequest)
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.
associateEntityToThingRequest - Future<AssociateEntityToThingResult> associateEntityToThingAsync(AssociateEntityToThingRequest associateEntityToThingRequest, AsyncHandler<AssociateEntityToThingRequest,AssociateEntityToThingResult> asyncHandler)
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.
associateEntityToThingRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateFlowTemplateResult> createFlowTemplateAsync(CreateFlowTemplateRequest createFlowTemplateRequest)
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.
createFlowTemplateRequest - Future<CreateFlowTemplateResult> createFlowTemplateAsync(CreateFlowTemplateRequest createFlowTemplateRequest, AsyncHandler<CreateFlowTemplateRequest,CreateFlowTemplateResult> asyncHandler)
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.
createFlowTemplateRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateSystemInstanceResult> createSystemInstanceAsync(CreateSystemInstanceRequest createSystemInstanceRequest)
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.
createSystemInstanceRequest - Future<CreateSystemInstanceResult> createSystemInstanceAsync(CreateSystemInstanceRequest createSystemInstanceRequest, AsyncHandler<CreateSystemInstanceRequest,CreateSystemInstanceResult> asyncHandler)
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.
createSystemInstanceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateSystemTemplateResult> createSystemTemplateAsync(CreateSystemTemplateRequest createSystemTemplateRequest)
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.
createSystemTemplateRequest - Future<CreateSystemTemplateResult> createSystemTemplateAsync(CreateSystemTemplateRequest createSystemTemplateRequest, AsyncHandler<CreateSystemTemplateRequest,CreateSystemTemplateResult> asyncHandler)
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.
createSystemTemplateRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteFlowTemplateResult> deleteFlowTemplateAsync(DeleteFlowTemplateRequest deleteFlowTemplateRequest)
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).
deleteFlowTemplateRequest - Future<DeleteFlowTemplateResult> deleteFlowTemplateAsync(DeleteFlowTemplateRequest deleteFlowTemplateRequest, AsyncHandler<DeleteFlowTemplateRequest,DeleteFlowTemplateResult> asyncHandler)
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).
deleteFlowTemplateRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteNamespaceResult> deleteNamespaceAsync(DeleteNamespaceRequest deleteNamespaceRequest)
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.
deleteNamespaceRequest - Future<DeleteNamespaceResult> deleteNamespaceAsync(DeleteNamespaceRequest deleteNamespaceRequest, AsyncHandler<DeleteNamespaceRequest,DeleteNamespaceResult> asyncHandler)
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.
deleteNamespaceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteSystemInstanceResult> deleteSystemInstanceAsync(DeleteSystemInstanceRequest deleteSystemInstanceRequest)
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.
deleteSystemInstanceRequest - Future<DeleteSystemInstanceResult> deleteSystemInstanceAsync(DeleteSystemInstanceRequest deleteSystemInstanceRequest, AsyncHandler<DeleteSystemInstanceRequest,DeleteSystemInstanceResult> asyncHandler)
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.
deleteSystemInstanceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteSystemTemplateResult> deleteSystemTemplateAsync(DeleteSystemTemplateRequest deleteSystemTemplateRequest)
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.
deleteSystemTemplateRequest - Future<DeleteSystemTemplateResult> deleteSystemTemplateAsync(DeleteSystemTemplateRequest deleteSystemTemplateRequest, AsyncHandler<DeleteSystemTemplateRequest,DeleteSystemTemplateResult> asyncHandler)
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.
deleteSystemTemplateRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeploySystemInstanceResult> deploySystemInstanceAsync(DeploySystemInstanceRequest deploySystemInstanceRequest)
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.
deploySystemInstanceRequest - Future<DeploySystemInstanceResult> deploySystemInstanceAsync(DeploySystemInstanceRequest deploySystemInstanceRequest, AsyncHandler<DeploySystemInstanceRequest,DeploySystemInstanceResult> asyncHandler)
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.
deploySystemInstanceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeprecateFlowTemplateResult> deprecateFlowTemplateAsync(DeprecateFlowTemplateRequest deprecateFlowTemplateRequest)
Deprecates the specified workflow. This action marks the workflow for deletion. Deprecated flows can't be deployed, but existing deployments will continue to run.
deprecateFlowTemplateRequest - Future<DeprecateFlowTemplateResult> deprecateFlowTemplateAsync(DeprecateFlowTemplateRequest deprecateFlowTemplateRequest, AsyncHandler<DeprecateFlowTemplateRequest,DeprecateFlowTemplateResult> asyncHandler)
Deprecates the specified workflow. This action marks the workflow for deletion. Deprecated flows can't be deployed, but existing deployments will continue to run.
deprecateFlowTemplateRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeprecateSystemTemplateResult> deprecateSystemTemplateAsync(DeprecateSystemTemplateRequest deprecateSystemTemplateRequest)
Deprecates the specified system.
deprecateSystemTemplateRequest - Future<DeprecateSystemTemplateResult> deprecateSystemTemplateAsync(DeprecateSystemTemplateRequest deprecateSystemTemplateRequest, AsyncHandler<DeprecateSystemTemplateRequest,DeprecateSystemTemplateResult> asyncHandler)
Deprecates the specified system.
deprecateSystemTemplateRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeNamespaceResult> describeNamespaceAsync(DescribeNamespaceRequest describeNamespaceRequest)
Gets the latest version of the user's namespace and the public version that it is tracking.
describeNamespaceRequest - Future<DescribeNamespaceResult> describeNamespaceAsync(DescribeNamespaceRequest describeNamespaceRequest, AsyncHandler<DescribeNamespaceRequest,DescribeNamespaceResult> asyncHandler)
Gets the latest version of the user's namespace and the public version that it is tracking.
describeNamespaceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DissociateEntityFromThingResult> dissociateEntityFromThingAsync(DissociateEntityFromThingRequest dissociateEntityFromThingRequest)
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.
dissociateEntityFromThingRequest - Future<DissociateEntityFromThingResult> dissociateEntityFromThingAsync(DissociateEntityFromThingRequest dissociateEntityFromThingRequest, AsyncHandler<DissociateEntityFromThingRequest,DissociateEntityFromThingResult> asyncHandler)
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.
dissociateEntityFromThingRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetEntitiesResult> getEntitiesAsync(GetEntitiesRequest getEntitiesRequest)
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.
getEntitiesRequest - Future<GetEntitiesResult> getEntitiesAsync(GetEntitiesRequest getEntitiesRequest, AsyncHandler<GetEntitiesRequest,GetEntitiesResult> asyncHandler)
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.
getEntitiesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetFlowTemplateResult> getFlowTemplateAsync(GetFlowTemplateRequest getFlowTemplateRequest)
Gets the latest version of the DefinitionDocument and FlowTemplateSummary for the
specified workflow.
getFlowTemplateRequest - Future<GetFlowTemplateResult> getFlowTemplateAsync(GetFlowTemplateRequest getFlowTemplateRequest, AsyncHandler<GetFlowTemplateRequest,GetFlowTemplateResult> asyncHandler)
Gets the latest version of the DefinitionDocument and FlowTemplateSummary for the
specified workflow.
getFlowTemplateRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetFlowTemplateRevisionsResult> getFlowTemplateRevisionsAsync(GetFlowTemplateRevisionsRequest getFlowTemplateRevisionsRequest)
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.
getFlowTemplateRevisionsRequest - Future<GetFlowTemplateRevisionsResult> getFlowTemplateRevisionsAsync(GetFlowTemplateRevisionsRequest getFlowTemplateRevisionsRequest, AsyncHandler<GetFlowTemplateRevisionsRequest,GetFlowTemplateRevisionsResult> asyncHandler)
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.
getFlowTemplateRevisionsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetNamespaceDeletionStatusResult> getNamespaceDeletionStatusAsync(GetNamespaceDeletionStatusRequest getNamespaceDeletionStatusRequest)
Gets the status of a namespace deletion task.
getNamespaceDeletionStatusRequest - Future<GetNamespaceDeletionStatusResult> getNamespaceDeletionStatusAsync(GetNamespaceDeletionStatusRequest getNamespaceDeletionStatusRequest, AsyncHandler<GetNamespaceDeletionStatusRequest,GetNamespaceDeletionStatusResult> asyncHandler)
Gets the status of a namespace deletion task.
getNamespaceDeletionStatusRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetSystemInstanceResult> getSystemInstanceAsync(GetSystemInstanceRequest getSystemInstanceRequest)
Gets a system instance.
getSystemInstanceRequest - Future<GetSystemInstanceResult> getSystemInstanceAsync(GetSystemInstanceRequest getSystemInstanceRequest, AsyncHandler<GetSystemInstanceRequest,GetSystemInstanceResult> asyncHandler)
Gets a system instance.
getSystemInstanceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetSystemTemplateResult> getSystemTemplateAsync(GetSystemTemplateRequest getSystemTemplateRequest)
Gets a system.
getSystemTemplateRequest - Future<GetSystemTemplateResult> getSystemTemplateAsync(GetSystemTemplateRequest getSystemTemplateRequest, AsyncHandler<GetSystemTemplateRequest,GetSystemTemplateResult> asyncHandler)
Gets a system.
getSystemTemplateRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetSystemTemplateRevisionsResult> getSystemTemplateRevisionsAsync(GetSystemTemplateRevisionsRequest getSystemTemplateRevisionsRequest)
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.
getSystemTemplateRevisionsRequest - Future<GetSystemTemplateRevisionsResult> getSystemTemplateRevisionsAsync(GetSystemTemplateRevisionsRequest getSystemTemplateRevisionsRequest, AsyncHandler<GetSystemTemplateRevisionsRequest,GetSystemTemplateRevisionsResult> asyncHandler)
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.
getSystemTemplateRevisionsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetUploadStatusResult> getUploadStatusAsync(GetUploadStatusRequest getUploadStatusRequest)
Gets the status of the specified upload.
getUploadStatusRequest - Future<GetUploadStatusResult> getUploadStatusAsync(GetUploadStatusRequest getUploadStatusRequest, AsyncHandler<GetUploadStatusRequest,GetUploadStatusResult> asyncHandler)
Gets the status of the specified upload.
getUploadStatusRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListFlowExecutionMessagesResult> listFlowExecutionMessagesAsync(ListFlowExecutionMessagesRequest listFlowExecutionMessagesRequest)
Returns a list of objects that contain information about events in a flow execution.
listFlowExecutionMessagesRequest - Future<ListFlowExecutionMessagesResult> listFlowExecutionMessagesAsync(ListFlowExecutionMessagesRequest listFlowExecutionMessagesRequest, AsyncHandler<ListFlowExecutionMessagesRequest,ListFlowExecutionMessagesResult> asyncHandler)
Returns a list of objects that contain information about events in a flow execution.
listFlowExecutionMessagesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags on an AWS IoT Things Graph resource.
listTagsForResourceRequest - Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Lists all tags on an AWS IoT Things Graph resource.
listTagsForResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<SearchEntitiesResult> searchEntitiesAsync(SearchEntitiesRequest searchEntitiesRequest)
Searches for entities of the specified type. You can search for entities in your namespace and the public namespace that you're tracking.
searchEntitiesRequest - Future<SearchEntitiesResult> searchEntitiesAsync(SearchEntitiesRequest searchEntitiesRequest, AsyncHandler<SearchEntitiesRequest,SearchEntitiesResult> asyncHandler)
Searches for entities of the specified type. You can search for entities in your namespace and the public namespace that you're tracking.
searchEntitiesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<SearchFlowExecutionsResult> searchFlowExecutionsAsync(SearchFlowExecutionsRequest searchFlowExecutionsRequest)
Searches for AWS IoT Things Graph workflow execution instances.
searchFlowExecutionsRequest - Future<SearchFlowExecutionsResult> searchFlowExecutionsAsync(SearchFlowExecutionsRequest searchFlowExecutionsRequest, AsyncHandler<SearchFlowExecutionsRequest,SearchFlowExecutionsResult> asyncHandler)
Searches for AWS IoT Things Graph workflow execution instances.
searchFlowExecutionsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<SearchFlowTemplatesResult> searchFlowTemplatesAsync(SearchFlowTemplatesRequest searchFlowTemplatesRequest)
Searches for summary information about workflows.
searchFlowTemplatesRequest - Future<SearchFlowTemplatesResult> searchFlowTemplatesAsync(SearchFlowTemplatesRequest searchFlowTemplatesRequest, AsyncHandler<SearchFlowTemplatesRequest,SearchFlowTemplatesResult> asyncHandler)
Searches for summary information about workflows.
searchFlowTemplatesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<SearchSystemInstancesResult> searchSystemInstancesAsync(SearchSystemInstancesRequest searchSystemInstancesRequest)
Searches for system instances in the user's account.
searchSystemInstancesRequest - Future<SearchSystemInstancesResult> searchSystemInstancesAsync(SearchSystemInstancesRequest searchSystemInstancesRequest, AsyncHandler<SearchSystemInstancesRequest,SearchSystemInstancesResult> asyncHandler)
Searches for system instances in the user's account.
searchSystemInstancesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<SearchSystemTemplatesResult> searchSystemTemplatesAsync(SearchSystemTemplatesRequest searchSystemTemplatesRequest)
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.
searchSystemTemplatesRequest - Future<SearchSystemTemplatesResult> searchSystemTemplatesAsync(SearchSystemTemplatesRequest searchSystemTemplatesRequest, AsyncHandler<SearchSystemTemplatesRequest,SearchSystemTemplatesResult> asyncHandler)
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.
searchSystemTemplatesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<SearchThingsResult> searchThingsAsync(SearchThingsRequest searchThingsRequest)
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.
searchThingsRequest - Future<SearchThingsResult> searchThingsAsync(SearchThingsRequest searchThingsRequest, AsyncHandler<SearchThingsRequest,SearchThingsResult> asyncHandler)
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.
searchThingsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
Creates a tag for the specified resource.
tagResourceRequest - Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Creates a tag for the specified resource.
tagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UndeploySystemInstanceResult> undeploySystemInstanceAsync(UndeploySystemInstanceRequest undeploySystemInstanceRequest)
Removes a system instance from its target (Cloud or Greengrass).
undeploySystemInstanceRequest - Future<UndeploySystemInstanceResult> undeploySystemInstanceAsync(UndeploySystemInstanceRequest undeploySystemInstanceRequest, AsyncHandler<UndeploySystemInstanceRequest,UndeploySystemInstanceResult> asyncHandler)
Removes a system instance from its target (Cloud or Greengrass).
undeploySystemInstanceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes a tag from the specified resource.
untagResourceRequest - Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes a tag from the specified resource.
untagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateFlowTemplateResult> updateFlowTemplateAsync(UpdateFlowTemplateRequest updateFlowTemplateRequest)
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.
updateFlowTemplateRequest - Future<UpdateFlowTemplateResult> updateFlowTemplateAsync(UpdateFlowTemplateRequest updateFlowTemplateRequest, AsyncHandler<UpdateFlowTemplateRequest,UpdateFlowTemplateResult> asyncHandler)
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.
updateFlowTemplateRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateSystemTemplateResult> updateSystemTemplateAsync(UpdateSystemTemplateRequest updateSystemTemplateRequest)
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.
updateSystemTemplateRequest - Future<UpdateSystemTemplateResult> updateSystemTemplateAsync(UpdateSystemTemplateRequest updateSystemTemplateRequest, AsyncHandler<UpdateSystemTemplateRequest,UpdateSystemTemplateResult> asyncHandler)
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.
updateSystemTemplateRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UploadEntityDefinitionsResult> uploadEntityDefinitionsAsync(UploadEntityDefinitionsRequest uploadEntityDefinitionsRequest)
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.
uploadEntityDefinitionsRequest - Future<UploadEntityDefinitionsResult> uploadEntityDefinitionsAsync(UploadEntityDefinitionsRequest uploadEntityDefinitionsRequest, AsyncHandler<UploadEntityDefinitionsRequest,UploadEntityDefinitionsResult> asyncHandler)
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.
uploadEntityDefinitionsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.