@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSIoTThingsGraph
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSIoTThingsGraph 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.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
AssociateEntityToThingResult |
associateEntityToThing(AssociateEntityToThingRequest associateEntityToThingRequest)
Associates a device with a concrete thing that is in the user's registry.
|
CreateFlowTemplateResult |
createFlowTemplate(CreateFlowTemplateRequest createFlowTemplateRequest)
Creates a workflow template.
|
CreateSystemInstanceResult |
createSystemInstance(CreateSystemInstanceRequest createSystemInstanceRequest)
Creates a system instance.
|
CreateSystemTemplateResult |
createSystemTemplate(CreateSystemTemplateRequest createSystemTemplateRequest)
Creates a system.
|
DeleteFlowTemplateResult |
deleteFlowTemplate(DeleteFlowTemplateRequest deleteFlowTemplateRequest)
Deletes a workflow.
|
DeleteNamespaceResult |
deleteNamespace(DeleteNamespaceRequest deleteNamespaceRequest)
Deletes the specified namespace.
|
DeleteSystemInstanceResult |
deleteSystemInstance(DeleteSystemInstanceRequest deleteSystemInstanceRequest)
Deletes a system instance.
|
DeleteSystemTemplateResult |
deleteSystemTemplate(DeleteSystemTemplateRequest deleteSystemTemplateRequest)
Deletes a system.
|
DeploySystemInstanceResult |
deploySystemInstance(DeploySystemInstanceRequest deploySystemInstanceRequest)
Greengrass and Cloud Deployments
|
DeprecateFlowTemplateResult |
deprecateFlowTemplate(DeprecateFlowTemplateRequest deprecateFlowTemplateRequest)
Deprecates the specified workflow.
|
DeprecateSystemTemplateResult |
deprecateSystemTemplate(DeprecateSystemTemplateRequest deprecateSystemTemplateRequest)
Deprecates the specified system.
|
DescribeNamespaceResult |
describeNamespace(DescribeNamespaceRequest describeNamespaceRequest)
Gets the latest version of the user's namespace and the public version that it is tracking.
|
DissociateEntityFromThingResult |
dissociateEntityFromThing(DissociateEntityFromThingRequest dissociateEntityFromThingRequest)
Dissociates a device entity from a concrete thing.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetEntitiesResult |
getEntities(GetEntitiesRequest getEntitiesRequest)
Gets definitions of the specified entities.
|
GetFlowTemplateResult |
getFlowTemplate(GetFlowTemplateRequest getFlowTemplateRequest)
Gets the latest version of the
DefinitionDocument and FlowTemplateSummary for the
specified workflow. |
GetFlowTemplateRevisionsResult |
getFlowTemplateRevisions(GetFlowTemplateRevisionsRequest getFlowTemplateRevisionsRequest)
Gets revisions of the specified workflow.
|
GetNamespaceDeletionStatusResult |
getNamespaceDeletionStatus(GetNamespaceDeletionStatusRequest getNamespaceDeletionStatusRequest)
Gets the status of a namespace deletion task.
|
GetSystemInstanceResult |
getSystemInstance(GetSystemInstanceRequest getSystemInstanceRequest)
Gets a system instance.
|
GetSystemTemplateResult |
getSystemTemplate(GetSystemTemplateRequest getSystemTemplateRequest)
Gets a system.
|
GetSystemTemplateRevisionsResult |
getSystemTemplateRevisions(GetSystemTemplateRevisionsRequest getSystemTemplateRevisionsRequest)
Gets revisions made to the specified system template.
|
GetUploadStatusResult |
getUploadStatus(GetUploadStatusRequest getUploadStatusRequest)
Gets the status of the specified upload.
|
ListFlowExecutionMessagesResult |
listFlowExecutionMessages(ListFlowExecutionMessagesRequest listFlowExecutionMessagesRequest)
Returns a list of objects that contain information about events in a flow execution.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags on an AWS IoT Things Graph resource.
|
SearchEntitiesResult |
searchEntities(SearchEntitiesRequest searchEntitiesRequest)
Searches for entities of the specified type.
|
SearchFlowExecutionsResult |
searchFlowExecutions(SearchFlowExecutionsRequest searchFlowExecutionsRequest)
Searches for AWS IoT Things Graph workflow execution instances.
|
SearchFlowTemplatesResult |
searchFlowTemplates(SearchFlowTemplatesRequest searchFlowTemplatesRequest)
Searches for summary information about workflows.
|
SearchSystemInstancesResult |
searchSystemInstances(SearchSystemInstancesRequest searchSystemInstancesRequest)
Searches for system instances in the user's account.
|
SearchSystemTemplatesResult |
searchSystemTemplates(SearchSystemTemplatesRequest searchSystemTemplatesRequest)
Searches for summary information about systems in the user's account.
|
SearchThingsResult |
searchThings(SearchThingsRequest searchThingsRequest)
Searches for things associated with the specified entity.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Creates a tag for the specified resource.
|
UndeploySystemInstanceResult |
undeploySystemInstance(UndeploySystemInstanceRequest undeploySystemInstanceRequest)
Removes a system instance from its target (Cloud or Greengrass).
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from the specified resource.
|
UpdateFlowTemplateResult |
updateFlowTemplate(UpdateFlowTemplateRequest updateFlowTemplateRequest)
Updates the specified workflow.
|
UpdateSystemTemplateResult |
updateSystemTemplate(UpdateSystemTemplateRequest updateSystemTemplateRequest)
Updates the specified system.
|
UploadEntityDefinitionsResult |
uploadEntityDefinitions(UploadEntityDefinitionsRequest uploadEntityDefinitionsRequest)
Asynchronously uploads one or more entity definitions to the user's namespace.
|
static final String ENDPOINT_PREFIX
AssociateEntityToThingResult associateEntityToThing(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 - InvalidRequestExceptionResourceNotFoundExceptionInternalFailureExceptionThrottlingExceptionCreateFlowTemplateResult createFlowTemplate(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 - InvalidRequestExceptionResourceAlreadyExistsExceptionThrottlingExceptionLimitExceededExceptionInternalFailureExceptionCreateSystemInstanceResult createSystemInstance(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 - InvalidRequestExceptionResourceAlreadyExistsExceptionThrottlingExceptionInternalFailureExceptionLimitExceededExceptionCreateSystemTemplateResult createSystemTemplate(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 - InvalidRequestExceptionResourceAlreadyExistsExceptionThrottlingExceptionInternalFailureExceptionDeleteFlowTemplateResult deleteFlowTemplate(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 - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceInUseExceptionDeleteNamespaceResult deleteNamespace(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 - InternalFailureExceptionThrottlingExceptionDeleteSystemInstanceResult deleteSystemInstance(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 - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceInUseExceptionDeleteSystemTemplateResult deleteSystemTemplate(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 - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceInUseExceptionDeploySystemInstanceResult deploySystemInstance(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 - ResourceNotFoundExceptionInvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceInUseExceptionDeprecateFlowTemplateResult deprecateFlowTemplate(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 - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionDeprecateSystemTemplateResult deprecateSystemTemplate(DeprecateSystemTemplateRequest deprecateSystemTemplateRequest)
Deprecates the specified system.
deprecateSystemTemplateRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionDescribeNamespaceResult describeNamespace(DescribeNamespaceRequest describeNamespaceRequest)
Gets the latest version of the user's namespace and the public version that it is tracking.
describeNamespaceRequest - ResourceNotFoundExceptionInvalidRequestExceptionInternalFailureExceptionThrottlingExceptionDissociateEntityFromThingResult dissociateEntityFromThing(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 - InvalidRequestExceptionResourceNotFoundExceptionInternalFailureExceptionThrottlingExceptionGetEntitiesResult getEntities(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 - InvalidRequestExceptionResourceNotFoundExceptionThrottlingExceptionInternalFailureExceptionGetFlowTemplateResult getFlowTemplate(GetFlowTemplateRequest getFlowTemplateRequest)
Gets the latest version of the DefinitionDocument and FlowTemplateSummary for the
specified workflow.
getFlowTemplateRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionGetFlowTemplateRevisionsResult getFlowTemplateRevisions(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 - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionGetNamespaceDeletionStatusResult getNamespaceDeletionStatus(GetNamespaceDeletionStatusRequest getNamespaceDeletionStatusRequest)
Gets the status of a namespace deletion task.
getNamespaceDeletionStatusRequest - InvalidRequestExceptionInternalFailureExceptionThrottlingExceptionGetSystemInstanceResult getSystemInstance(GetSystemInstanceRequest getSystemInstanceRequest)
Gets a system instance.
getSystemInstanceRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionGetSystemTemplateResult getSystemTemplate(GetSystemTemplateRequest getSystemTemplateRequest)
Gets a system.
getSystemTemplateRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionGetSystemTemplateRevisionsResult getSystemTemplateRevisions(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 - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionGetUploadStatusResult getUploadStatus(GetUploadStatusRequest getUploadStatusRequest)
Gets the status of the specified upload.
getUploadStatusRequest - InvalidRequestExceptionResourceNotFoundExceptionInternalFailureExceptionThrottlingExceptionListFlowExecutionMessagesResult listFlowExecutionMessages(ListFlowExecutionMessagesRequest listFlowExecutionMessagesRequest)
Returns a list of objects that contain information about events in a flow execution.
listFlowExecutionMessagesRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags on an AWS IoT Things Graph resource.
listTagsForResourceRequest - InvalidRequestExceptionResourceAlreadyExistsExceptionThrottlingExceptionInternalFailureExceptionSearchEntitiesResult searchEntities(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 - InvalidRequestExceptionInternalFailureExceptionThrottlingExceptionSearchFlowExecutionsResult searchFlowExecutions(SearchFlowExecutionsRequest searchFlowExecutionsRequest)
Searches for AWS IoT Things Graph workflow execution instances.
searchFlowExecutionsRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionSearchFlowTemplatesResult searchFlowTemplates(SearchFlowTemplatesRequest searchFlowTemplatesRequest)
Searches for summary information about workflows.
searchFlowTemplatesRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionSearchSystemInstancesResult searchSystemInstances(SearchSystemInstancesRequest searchSystemInstancesRequest)
Searches for system instances in the user's account.
searchSystemInstancesRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionSearchSystemTemplatesResult searchSystemTemplates(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 - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionSearchThingsResult searchThings(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 - InvalidRequestExceptionResourceNotFoundExceptionInternalFailureExceptionThrottlingExceptionTagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Creates a tag for the specified resource.
tagResourceRequest - InvalidRequestExceptionResourceAlreadyExistsExceptionThrottlingExceptionInternalFailureExceptionUndeploySystemInstanceResult undeploySystemInstance(UndeploySystemInstanceRequest undeploySystemInstanceRequest)
Removes a system instance from its target (Cloud or Greengrass).
undeploySystemInstanceRequest - InvalidRequestExceptionThrottlingExceptionInternalFailureExceptionResourceNotFoundExceptionResourceInUseExceptionUntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from the specified resource.
untagResourceRequest - InvalidRequestExceptionResourceAlreadyExistsExceptionThrottlingExceptionInternalFailureExceptionUpdateFlowTemplateResult updateFlowTemplate(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 - InvalidRequestExceptionResourceNotFoundExceptionThrottlingExceptionInternalFailureExceptionUpdateSystemTemplateResult updateSystemTemplate(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 - InvalidRequestExceptionResourceNotFoundExceptionThrottlingExceptionInternalFailureExceptionUploadEntityDefinitionsResult uploadEntityDefinitions(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 - InvalidRequestExceptionInternalFailureExceptionThrottlingExceptionvoid shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.Copyright © 2022. All rights reserved.