Class: Aws::IoTEventsData::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::IoTEventsData::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-ioteventsdata/lib/aws-sdk-ioteventsdata/client.rb
Overview
An API client for IoTEventsData. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::IoTEventsData::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
-
#batch_put_message(params = {}) ⇒ Types::BatchPutMessageResponse
Sends a set of messages to the AWS IoT Events system.
-
#batch_update_detector(params = {}) ⇒ Types::BatchUpdateDetectorResponse
Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.
-
#describe_detector(params = {}) ⇒ Types::DescribeDetectorResponse
Returns information about the specified detector (instance).
-
#list_detectors(params = {}) ⇒ Types::ListDetectorsResponse
Lists detectors (the instances of a detector model).
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.
324 325 326 |
# File 'gems/aws-sdk-ioteventsdata/lib/aws-sdk-ioteventsdata/client.rb', line 324 def initialize(*args) super end |
Instance Method Details
#batch_put_message(params = {}) ⇒ Types::BatchPutMessageResponse
Sends a set of messages to the AWS IoT Events system. Each message
payload is transformed into the input you specify ("inputName"
) and
ingested into any detectors that monitor that input. If multiple
messages are sent, the order in which the messages are processed
isn't guaranteed. To guarantee ordering, you must send messages one
at a time and wait for a successful response.
367 368 369 370 |
# File 'gems/aws-sdk-ioteventsdata/lib/aws-sdk-ioteventsdata/client.rb', line 367 def (params = {}, = {}) req = build_request(:batch_put_message, params) req.send_request() end |
#batch_update_detector(params = {}) ⇒ Types::BatchUpdateDetectorResponse
Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.
419 420 421 422 |
# File 'gems/aws-sdk-ioteventsdata/lib/aws-sdk-ioteventsdata/client.rb', line 419 def batch_update_detector(params = {}, = {}) req = build_request(:batch_update_detector, params) req.send_request() end |
#describe_detector(params = {}) ⇒ Types::DescribeDetectorResponse
Returns information about the specified detector (instance).
462 463 464 465 |
# File 'gems/aws-sdk-ioteventsdata/lib/aws-sdk-ioteventsdata/client.rb', line 462 def describe_detector(params = {}, = {}) req = build_request(:describe_detector, params) req.send_request() end |
#list_detectors(params = {}) ⇒ Types::ListDetectorsResponse
Lists detectors (the instances of a detector model).
509 510 511 512 |
# File 'gems/aws-sdk-ioteventsdata/lib/aws-sdk-ioteventsdata/client.rb', line 509 def list_detectors(params = {}, = {}) req = build_request(:list_detectors, params) req.send_request() end |