Class: Aws::IoTDataPlane::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::IoTDataPlane::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-iotdataplane/lib/aws-sdk-iotdataplane/client.rb
Overview
An API client for IoTDataPlane. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::IoTDataPlane::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
-
#delete_thing_shadow(params = {}) ⇒ Types::DeleteThingShadowResponse
Deletes the shadow for the specified thing.
-
#get_thing_shadow(params = {}) ⇒ Types::GetThingShadowResponse
Gets the shadow for the specified thing.
-
#list_named_shadows_for_thing(params = {}) ⇒ Types::ListNamedShadowsForThingResponse
Lists the shadows for the specified thing.
-
#publish(params = {}) ⇒ Struct
Publishes state information.
-
#update_thing_shadow(params = {}) ⇒ Types::UpdateThingShadowResponse
Updates the shadow for the specified thing.
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-iotdataplane/lib/aws-sdk-iotdataplane/client.rb', line 324 def initialize(*args) super end |
Instance Method Details
#delete_thing_shadow(params = {}) ⇒ Types::DeleteThingShadowResponse
Deletes the shadow for the specified thing.
For more information, see DeleteThingShadow in the AWS IoT Developer Guide.
362 363 364 365 |
# File 'gems/aws-sdk-iotdataplane/lib/aws-sdk-iotdataplane/client.rb', line 362 def delete_thing_shadow(params = {}, = {}) req = build_request(:delete_thing_shadow, params) req.send_request() end |
#get_thing_shadow(params = {}) ⇒ Types::GetThingShadowResponse
Gets the shadow for the specified thing.
For more information, see GetThingShadow in the AWS IoT Developer Guide.
399 400 401 402 |
# File 'gems/aws-sdk-iotdataplane/lib/aws-sdk-iotdataplane/client.rb', line 399 def get_thing_shadow(params = {}, = {}) req = build_request(:get_thing_shadow, params) req.send_request() end |
#list_named_shadows_for_thing(params = {}) ⇒ Types::ListNamedShadowsForThingResponse
Lists the shadows for the specified thing.
438 439 440 441 |
# File 'gems/aws-sdk-iotdataplane/lib/aws-sdk-iotdataplane/client.rb', line 438 def list_named_shadows_for_thing(params = {}, = {}) req = build_request(:list_named_shadows_for_thing, params) req.send_request() end |
#publish(params = {}) ⇒ Struct
Publishes state information.
For more information, see HTTP Protocol in the AWS IoT Developer Guide.
473 474 475 476 |
# File 'gems/aws-sdk-iotdataplane/lib/aws-sdk-iotdataplane/client.rb', line 473 def publish(params = {}, = {}) req = build_request(:publish, params) req.send_request() end |
#update_thing_shadow(params = {}) ⇒ Types::UpdateThingShadowResponse
Updates the shadow for the specified thing.
For more information, see UpdateThingShadow in the AWS IoT Developer Guide.
514 515 516 517 |
# File 'gems/aws-sdk-iotdataplane/lib/aws-sdk-iotdataplane/client.rb', line 514 def update_thing_shadow(params = {}, = {}) req = build_request(:update_thing_shadow, params) req.send_request() end |