Class: Aws::IoTThingsGraph::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::IoTThingsGraph::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb
Overview
An API client for IoTThingsGraph. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::IoTThingsGraph::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#associate_entity_to_thing(params = {}) ⇒ Struct
Associates a device with a concrete thing that is in the user's registry.
-
#create_flow_template(params = {}) ⇒ Types::CreateFlowTemplateResponse
Creates a workflow template.
-
#create_system_instance(params = {}) ⇒ Types::CreateSystemInstanceResponse
Creates a system instance.
-
#create_system_template(params = {}) ⇒ Types::CreateSystemTemplateResponse
Creates a system.
-
#delete_flow_template(params = {}) ⇒ Struct
Deletes a workflow.
-
#delete_namespace(params = {}) ⇒ Types::DeleteNamespaceResponse
Deletes the specified namespace.
-
#delete_system_instance(params = {}) ⇒ Struct
Deletes a system instance.
-
#delete_system_template(params = {}) ⇒ Struct
Deletes a system.
-
#deploy_system_instance(params = {}) ⇒ Types::DeploySystemInstanceResponse
Greengrass and Cloud Deployments.
-
#deprecate_flow_template(params = {}) ⇒ Struct
Deprecates the specified workflow.
-
#deprecate_system_template(params = {}) ⇒ Struct
Deprecates the specified system.
-
#describe_namespace(params = {}) ⇒ Types::DescribeNamespaceResponse
Gets the latest version of the user's namespace and the public version that it is tracking.
-
#dissociate_entity_from_thing(params = {}) ⇒ Struct
Dissociates a device entity from a concrete thing.
-
#get_entities(params = {}) ⇒ Types::GetEntitiesResponse
Gets definitions of the specified entities.
-
#get_flow_template(params = {}) ⇒ Types::GetFlowTemplateResponse
Gets the latest version of the
DefinitionDocument
andFlowTemplateSummary
for the specified workflow. -
#get_flow_template_revisions(params = {}) ⇒ Types::GetFlowTemplateRevisionsResponse
Gets revisions of the specified workflow.
-
#get_namespace_deletion_status(params = {}) ⇒ Types::GetNamespaceDeletionStatusResponse
Gets the status of a namespace deletion task.
-
#get_system_instance(params = {}) ⇒ Types::GetSystemInstanceResponse
Gets a system instance.
-
#get_system_template(params = {}) ⇒ Types::GetSystemTemplateResponse
Gets a system.
-
#get_system_template_revisions(params = {}) ⇒ Types::GetSystemTemplateRevisionsResponse
Gets revisions made to the specified system template.
-
#get_upload_status(params = {}) ⇒ Types::GetUploadStatusResponse
Gets the status of the specified upload.
-
#list_flow_execution_messages(params = {}) ⇒ Types::ListFlowExecutionMessagesResponse
Returns a list of objects that contain information about events in a flow execution.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all tags on an AWS IoT Things Graph resource.
-
#search_entities(params = {}) ⇒ Types::SearchEntitiesResponse
Searches for entities of the specified type.
-
#search_flow_executions(params = {}) ⇒ Types::SearchFlowExecutionsResponse
Searches for AWS IoT Things Graph workflow execution instances.
-
#search_flow_templates(params = {}) ⇒ Types::SearchFlowTemplatesResponse
Searches for summary information about workflows.
-
#search_system_instances(params = {}) ⇒ Types::SearchSystemInstancesResponse
Searches for system instances in the user's account.
-
#search_system_templates(params = {}) ⇒ Types::SearchSystemTemplatesResponse
Searches for summary information about systems in the user's account.
-
#search_things(params = {}) ⇒ Types::SearchThingsResponse
Searches for things associated with the specified entity.
-
#tag_resource(params = {}) ⇒ Struct
Creates a tag for the specified resource.
-
#undeploy_system_instance(params = {}) ⇒ Types::UndeploySystemInstanceResponse
Removes a system instance from its target (Cloud or Greengrass).
-
#untag_resource(params = {}) ⇒ Struct
Removes a tag from the specified resource.
-
#update_flow_template(params = {}) ⇒ Types::UpdateFlowTemplateResponse
Updates the specified workflow.
-
#update_system_template(params = {}) ⇒ Types::UpdateSystemTemplateResponse
Updates the specified system.
-
#upload_entity_definitions(params = {}) ⇒ Types::UploadEntityDefinitionsResponse
Asynchronously uploads one or more entity definitions to the user's namespace.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
420 421 422 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 420 def initialize(*args) super end |
Instance Method Details
#associate_entity_to_thing(params = {}) ⇒ Struct
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.
459 460 461 462 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 459 def associate_entity_to_thing(params = {}, = {}) req = build_request(:associate_entity_to_thing, params) req.send_request() end |
#create_flow_template(params = {}) ⇒ Types::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.
502 503 504 505 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 502 def create_flow_template(params = {}, = {}) req = build_request(:create_flow_template, params) req.send_request() end |
#create_system_instance(params = {}) ⇒ Types::CreateSystemInstanceResponse
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.
603 604 605 606 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 603 def create_system_instance(params = {}, = {}) req = build_request(:create_system_instance, params) req.send_request() end |
#create_system_template(params = {}) ⇒ Types::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.
643 644 645 646 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 643 def create_system_template(params = {}, = {}) req = build_request(:create_system_template, params) req.send_request() end |
#delete_flow_template(params = {}) ⇒ Struct
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).
670 671 672 673 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 670 def delete_flow_template(params = {}, = {}) req = build_request(:delete_flow_template, params) req.send_request() end |
#delete_namespace(params = {}) ⇒ Types::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. This action takes no request parameters.
692 693 694 695 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 692 def delete_namespace(params = {}, = {}) req = build_request(:delete_namespace, params) req.send_request() end |
#delete_system_instance(params = {}) ⇒ Struct
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.
716 717 718 719 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 716 def delete_system_instance(params = {}, = {}) req = build_request(:delete_system_instance, params) req.send_request() end |
#delete_system_template(params = {}) ⇒ Struct
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.
743 744 745 746 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 743 def delete_system_template(params = {}, = {}) req = build_request(:delete_system_template, params) req.send_request() end |
#deploy_system_instance(params = {}) ⇒ Types::DeploySystemInstanceResponse
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.
806 807 808 809 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 806 def deploy_system_instance(params = {}, = {}) req = build_request(:deploy_system_instance, params) req.send_request() end |
#deprecate_flow_template(params = {}) ⇒ Struct
Deprecates the specified workflow. This action marks the workflow for deletion. Deprecated flows can't be deployed, but existing deployments will continue to run.
832 833 834 835 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 832 def deprecate_flow_template(params = {}, = {}) req = build_request(:deprecate_flow_template, params) req.send_request() end |
#deprecate_system_template(params = {}) ⇒ Struct
Deprecates the specified system.
856 857 858 859 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 856 def deprecate_system_template(params = {}, = {}) req = build_request(:deprecate_system_template, params) req.send_request() end |
#describe_namespace(params = {}) ⇒ Types::DescribeNamespaceResponse
Gets the latest version of the user's namespace and the public version that it is tracking.
892 893 894 895 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 892 def describe_namespace(params = {}, = {}) req = build_request(:describe_namespace, params) req.send_request() end |
#dissociate_entity_from_thing(params = {}) ⇒ Struct
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.
918 919 920 921 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 918 def dissociate_entity_from_thing(params = {}, = {}) req = build_request(:dissociate_entity_from_thing, params) req.send_request() end |
#get_entities(params = {}) ⇒ Types::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.
Properties
States
Events
Actions
Capabilities
Mappings
Devices
Device Models
Services
This action doesn't return definitions for systems, flows, and deployments.
982 983 984 985 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 982 def get_entities(params = {}, = {}) req = build_request(:get_entities, params) req.send_request() end |
#get_flow_template(params = {}) ⇒ Types::GetFlowTemplateResponse
Gets the latest version of the DefinitionDocument
and
FlowTemplateSummary
for the specified workflow.
1023 1024 1025 1026 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 1023 def get_flow_template(params = {}, = {}) req = build_request(:get_flow_template, params) req.send_request() end |
#get_flow_template_revisions(params = {}) ⇒ Types::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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1073 1074 1075 1076 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 1073 def get_flow_template_revisions(params = {}, = {}) req = build_request(:get_flow_template_revisions, params) req.send_request() end |
#get_namespace_deletion_status(params = {}) ⇒ Types::GetNamespaceDeletionStatusResponse
Gets the status of a namespace deletion task.
1098 1099 1100 1101 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 1098 def get_namespace_deletion_status(params = {}, = {}) req = build_request(:get_namespace_deletion_status, params) req.send_request() end |
#get_system_instance(params = {}) ⇒ Types::GetSystemInstanceResponse
Gets a system instance.
1147 1148 1149 1150 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 1147 def get_system_instance(params = {}, = {}) req = build_request(:get_system_instance, params) req.send_request() end |
#get_system_template(params = {}) ⇒ Types::GetSystemTemplateResponse
Gets a system.
1187 1188 1189 1190 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 1187 def get_system_template(params = {}, = {}) req = build_request(:get_system_template, params) req.send_request() end |
#get_system_template_revisions(params = {}) ⇒ Types::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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1238 1239 1240 1241 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 1238 def get_system_template_revisions(params = {}, = {}) req = build_request(:get_system_template_revisions, params) req.send_request() end |
#get_upload_status(params = {}) ⇒ Types::GetUploadStatusResponse
Gets the status of the specified upload.
1278 1279 1280 1281 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 1278 def get_upload_status(params = {}, = {}) req = build_request(:get_upload_status, params) req.send_request() end |
#list_flow_execution_messages(params = {}) ⇒ Types::ListFlowExecutionMessagesResponse
Returns a list of objects that contain information about events in a flow execution.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1322 1323 1324 1325 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 1322 def (params = {}, = {}) req = build_request(:list_flow_execution_messages, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all tags on an AWS IoT Things Graph resource.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1363 1364 1365 1366 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 1363 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#search_entities(params = {}) ⇒ Types::SearchEntitiesResponse
Searches for entities of the specified type. You can search for entities in your namespace and the public namespace that you're tracking.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1431 1432 1433 1434 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 1431 def search_entities(params = {}, = {}) req = build_request(:search_entities, params) req.send_request() end |
#search_flow_executions(params = {}) ⇒ Types::SearchFlowExecutionsResponse
Searches for AWS IoT Things Graph workflow execution instances.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1488 1489 1490 1491 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 1488 def search_flow_executions(params = {}, = {}) req = build_request(:search_flow_executions, params) req.send_request() end |
#search_flow_templates(params = {}) ⇒ Types::SearchFlowTemplatesResponse
Searches for summary information about workflows.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1537 1538 1539 1540 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 1537 def search_flow_templates(params = {}, = {}) req = build_request(:search_flow_templates, params) req.send_request() end |
#search_system_instances(params = {}) ⇒ Types::SearchSystemInstancesResponse
Searches for system instances in the user's account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1594 1595 1596 1597 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 1594 def search_system_instances(params = {}, = {}) req = build_request(:search_system_instances, params) req.send_request() end |
#search_system_templates(params = {}) ⇒ Types::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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1645 1646 1647 1648 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 1645 def search_system_templates(params = {}, = {}) req = build_request(:search_system_templates, params) req.send_request() end |
#search_things(params = {}) ⇒ Types::SearchThingsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1704 1705 1706 1707 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 1704 def search_things(params = {}, = {}) req = build_request(:search_things, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Creates a tag for the specified resource.
1734 1735 1736 1737 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 1734 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#undeploy_system_instance(params = {}) ⇒ Types::UndeploySystemInstanceResponse
Removes a system instance from its target (Cloud or Greengrass).
1768 1769 1770 1771 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 1768 def undeploy_system_instance(params = {}, = {}) req = build_request(:undeploy_system_instance, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes a tag from the specified resource.
1803 1804 1805 1806 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 1803 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_flow_template(params = {}) ⇒ Types::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.
1856 1857 1858 1859 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 1856 def update_flow_template(params = {}, = {}) req = build_request(:update_flow_template, params) req.send_request() end |
#update_system_template(params = {}) ⇒ Types::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.
1905 1906 1907 1908 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 1905 def update_system_template(params = {}, = {}) req = build_request(:update_system_template, params) req.send_request() end |
#upload_entity_definitions(params = {}) ⇒ Types::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.
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
.
1969 1970 1971 1972 |
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/client.rb', line 1969 def upload_entity_definitions(params = {}, = {}) req = build_request(:upload_entity_definitions, params) req.send_request() end |