Class: Aws::IoTThingsGraph::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::IoTThingsGraph::Client
- Includes:
- ClientStubs
- Defined in:
- 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](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
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` and `FlowTemplateSummary` 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.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
395 396 397 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 395 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1975 1976 1977 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 1975 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1978 1979 1980 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 1978 def errors_module Errors 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.
434 435 436 437 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 434 def associate_entity_to_thing(params = {}, = {}) req = build_request(:associate_entity_to_thing, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 1953 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-iotthingsgraph' context[:gem_version] = '1.36.0' Seahorse::Client::Request.new(handlers, context) 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.
477 478 479 480 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 477 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.
578 579 580 581 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 578 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.
618 619 620 621 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 618 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).
645 646 647 648 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 645 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.
667 668 669 670 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 667 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.
691 692 693 694 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 691 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.
718 719 720 721 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 718 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].
[1]: docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-greengrass.html
781 782 783 784 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 781 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.
807 808 809 810 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 807 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.
831 832 833 834 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 831 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.
867 868 869 870 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 867 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.
893 894 895 896 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 893 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.
957 958 959 960 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 957 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.
998 999 1000 1001 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 998 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.
1048 1049 1050 1051 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 1048 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.
1073 1074 1075 1076 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 1073 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.
1122 1123 1124 1125 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 1122 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.
1162 1163 1164 1165 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 1162 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.
1213 1214 1215 1216 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 1213 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.
1253 1254 1255 1256 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 1253 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.
1297 1298 1299 1300 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 1297 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.
1338 1339 1340 1341 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 1338 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.
1406 1407 1408 1409 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 1406 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.
1463 1464 1465 1466 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 1463 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.
1512 1513 1514 1515 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 1512 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.
1569 1570 1571 1572 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 1569 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.
1620 1621 1622 1623 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 1620 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.
1679 1680 1681 1682 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 1679 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.
1709 1710 1711 1712 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 1709 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).
1743 1744 1745 1746 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 1743 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.
1778 1779 1780 1781 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 1778 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.
1831 1832 1833 1834 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 1831 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.
1880 1881 1882 1883 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 1880 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`.
1944 1945 1946 1947 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 1944 def upload_entity_definitions(params = {}, = {}) req = build_request(:upload_entity_definitions, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1968 1969 1970 |
# File 'lib/aws-sdk-iotthingsgraph/client.rb', line 1968 def waiter_names [] end |