Class: Aws::IoTAnalytics::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::IoTAnalytics::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb
Overview
An API client for IoTAnalytics. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::IoTAnalytics::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 messages to a channel.
-
#cancel_pipeline_reprocessing(params = {}) ⇒ Struct
Cancels the reprocessing of data through the pipeline.
-
#create_channel(params = {}) ⇒ Types::CreateChannelResponse
Used to create a channel.
-
#create_dataset(params = {}) ⇒ Types::CreateDatasetResponse
Used to create a dataset.
-
#create_dataset_content(params = {}) ⇒ Types::CreateDatasetContentResponse
Creates the content of a dataset by applying a
queryAction
(a SQL query) or acontainerAction
(executing a containerized application). -
#create_datastore(params = {}) ⇒ Types::CreateDatastoreResponse
Creates a data store, which is a repository for messages.
-
#create_pipeline(params = {}) ⇒ Types::CreatePipelineResponse
Creates a pipeline.
-
#delete_channel(params = {}) ⇒ Struct
Deletes the specified channel.
-
#delete_dataset(params = {}) ⇒ Struct
Deletes the specified dataset.
-
#delete_dataset_content(params = {}) ⇒ Struct
Deletes the content of the specified dataset.
-
#delete_datastore(params = {}) ⇒ Struct
Deletes the specified data store.
-
#delete_pipeline(params = {}) ⇒ Struct
Deletes the specified pipeline.
-
#describe_channel(params = {}) ⇒ Types::DescribeChannelResponse
Retrieves information about a channel.
-
#describe_dataset(params = {}) ⇒ Types::DescribeDatasetResponse
Retrieves information about a dataset.
-
#describe_datastore(params = {}) ⇒ Types::DescribeDatastoreResponse
Retrieves information about a data store.
-
#describe_logging_options(params = {}) ⇒ Types::DescribeLoggingOptionsResponse
Retrieves the current settings of the IoT Analytics logging options.
-
#describe_pipeline(params = {}) ⇒ Types::DescribePipelineResponse
Retrieves information about a pipeline.
-
#get_dataset_content(params = {}) ⇒ Types::GetDatasetContentResponse
Retrieves the contents of a dataset as presigned URIs.
-
#list_channels(params = {}) ⇒ Types::ListChannelsResponse
Retrieves a list of channels.
-
#list_dataset_contents(params = {}) ⇒ Types::ListDatasetContentsResponse
Lists information about dataset contents that have been created.
-
#list_datasets(params = {}) ⇒ Types::ListDatasetsResponse
Retrieves information about datasets.
-
#list_datastores(params = {}) ⇒ Types::ListDatastoresResponse
Retrieves a list of data stores.
-
#list_pipelines(params = {}) ⇒ Types::ListPipelinesResponse
Retrieves a list of pipelines.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags (metadata) that you have assigned to the resource.
-
#put_logging_options(params = {}) ⇒ Struct
Sets or updates the IoT Analytics logging options.
-
#run_pipeline_activity(params = {}) ⇒ Types::RunPipelineActivityResponse
Simulates the results of running a pipeline activity on a message payload.
-
#sample_channel_data(params = {}) ⇒ Types::SampleChannelDataResponse
Retrieves a sample of messages from the specified channel ingested during the specified timeframe.
-
#start_pipeline_reprocessing(params = {}) ⇒ Types::StartPipelineReprocessingResponse
Starts the reprocessing of raw message data through the pipeline.
-
#tag_resource(params = {}) ⇒ Struct
Adds to or modifies the tags of the given resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes the given tags (metadata) from the resource.
-
#update_channel(params = {}) ⇒ Struct
Used to update the settings of a channel.
-
#update_dataset(params = {}) ⇒ Struct
Updates the settings of a dataset.
-
#update_datastore(params = {}) ⇒ Struct
Used to update the settings of a data store.
-
#update_pipeline(params = {}) ⇒ Struct
Updates the settings of a pipeline.
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.
410 411 412 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 410 def initialize(*args) super end |
Instance Method Details
#batch_put_message(params = {}) ⇒ Types::BatchPutMessageResponse
Sends messages to a channel.
472 473 474 475 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 472 def (params = {}, = {}) req = build_request(:batch_put_message, params) req.send_request() end |
#cancel_pipeline_reprocessing(params = {}) ⇒ Struct
Cancels the reprocessing of data through the pipeline.
497 498 499 500 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 497 def cancel_pipeline_reprocessing(params = {}, = {}) req = build_request(:cancel_pipeline_reprocessing, params) req.send_request() end |
#create_channel(params = {}) ⇒ Types::CreateChannelResponse
Used to create a channel. A channel collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline.
562 563 564 565 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 562 def create_channel(params = {}, = {}) req = build_request(:create_channel, params) req.send_request() end |
#create_dataset(params = {}) ⇒ Types::CreateDatasetResponse
Used to create a dataset. A dataset stores data retrieved from a data
store by applying a queryAction
(a SQL query) or a containerAction
(executing a containerized application). This operation creates the
skeleton of a dataset. The dataset can be populated manually by
calling CreateDatasetContent
or automatically according to a trigger
you specify.
739 740 741 742 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 739 def create_dataset(params = {}, = {}) req = build_request(:create_dataset, params) req.send_request() end |
#create_dataset_content(params = {}) ⇒ Types::CreateDatasetContentResponse
Creates the content of a dataset by applying a queryAction
(a SQL
query) or a containerAction
(executing a containerized application).
775 776 777 778 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 775 def create_dataset_content(params = {}, = {}) req = build_request(:create_dataset_content, params) req.send_request() end |
#create_datastore(params = {}) ⇒ Types::CreateDatastoreResponse
Creates a data store, which is a repository for messages.
887 888 889 890 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 887 def create_datastore(params = {}, = {}) req = build_request(:create_datastore, params) req.send_request() end |
#create_pipeline(params = {}) ⇒ Types::CreatePipelineResponse
Creates a pipeline. A pipeline consumes messages from a channel and
allows you to process the messages before storing them in a data
store. You must specify both a channel
and a datastore
activity
and, optionally, as many as 23 additional activities in the
pipelineActivities
array.
1003 1004 1005 1006 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1003 def create_pipeline(params = {}, = {}) req = build_request(:create_pipeline, params) req.send_request() end |
#delete_channel(params = {}) ⇒ Struct
Deletes the specified channel.
1023 1024 1025 1026 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1023 def delete_channel(params = {}, = {}) req = build_request(:delete_channel, params) req.send_request() end |
#delete_dataset(params = {}) ⇒ Struct
Deletes the specified dataset.
You do not have to delete the content of the dataset before you perform this operation.
1046 1047 1048 1049 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1046 def delete_dataset(params = {}, = {}) req = build_request(:delete_dataset, params) req.send_request() end |
#delete_dataset_content(params = {}) ⇒ Struct
Deletes the content of the specified dataset.
1073 1074 1075 1076 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1073 def delete_dataset_content(params = {}, = {}) req = build_request(:delete_dataset_content, params) req.send_request() end |
#delete_datastore(params = {}) ⇒ Struct
Deletes the specified data store.
1093 1094 1095 1096 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1093 def delete_datastore(params = {}, = {}) req = build_request(:delete_datastore, params) req.send_request() end |
#delete_pipeline(params = {}) ⇒ Struct
Deletes the specified pipeline.
1113 1114 1115 1116 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1113 def delete_pipeline(params = {}, = {}) req = build_request(:delete_pipeline, params) req.send_request() end |
#describe_channel(params = {}) ⇒ Types::DescribeChannelResponse
Retrieves information about a channel.
1158 1159 1160 1161 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1158 def describe_channel(params = {}, = {}) req = build_request(:describe_channel, params) req.send_request() end |
#describe_dataset(params = {}) ⇒ Types::DescribeDatasetResponse
Retrieves information about a dataset.
1223 1224 1225 1226 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1223 def describe_dataset(params = {}, = {}) req = build_request(:describe_dataset, params) req.send_request() end |
#describe_datastore(params = {}) ⇒ Types::DescribeDatastoreResponse
Retrieves information about a data store.
1277 1278 1279 1280 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1277 def describe_datastore(params = {}, = {}) req = build_request(:describe_datastore, params) req.send_request() end |
#describe_logging_options(params = {}) ⇒ Types::DescribeLoggingOptionsResponse
Retrieves the current settings of the IoT Analytics logging options.
1296 1297 1298 1299 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1296 def (params = {}, = {}) req = build_request(:describe_logging_options, params) req.send_request() end |
#describe_pipeline(params = {}) ⇒ Types::DescribePipelineResponse
Retrieves information about a pipeline.
1368 1369 1370 1371 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1368 def describe_pipeline(params = {}, = {}) req = build_request(:describe_pipeline, params) req.send_request() end |
#get_dataset_content(params = {}) ⇒ Types::GetDatasetContentResponse
Retrieves the contents of a dataset as presigned URIs.
1408 1409 1410 1411 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1408 def get_dataset_content(params = {}, = {}) req = build_request(:get_dataset_content, params) req.send_request() end |
#list_channels(params = {}) ⇒ Types::ListChannelsResponse
Retrieves a list of channels.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1452 1453 1454 1455 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1452 def list_channels(params = {}, = {}) req = build_request(:list_channels, params) req.send_request() end |
#list_dataset_contents(params = {}) ⇒ Types::ListDatasetContentsResponse
Lists information about dataset contents that have been created.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1508 1509 1510 1511 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1508 def list_dataset_contents(params = {}, = {}) req = build_request(:list_dataset_contents, params) req.send_request() end |
#list_datasets(params = {}) ⇒ Types::ListDatasetsResponse
Retrieves information about datasets.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1554 1555 1556 1557 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1554 def list_datasets(params = {}, = {}) req = build_request(:list_datasets, params) req.send_request() end |
#list_datastores(params = {}) ⇒ Types::ListDatastoresResponse
Retrieves a list of data stores.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1605 1606 1607 1608 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1605 def list_datastores(params = {}, = {}) req = build_request(:list_datastores, params) req.send_request() end |
#list_pipelines(params = {}) ⇒ Types::ListPipelinesResponse
Retrieves a list of pipelines.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1648 1649 1650 1651 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1648 def list_pipelines(params = {}, = {}) req = build_request(:list_pipelines, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags (metadata) that you have assigned to the resource.
1676 1677 1678 1679 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1676 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_logging_options(params = {}) ⇒ Struct
Sets or updates the IoT Analytics logging options.
If you update the value of any loggingOptions
field, it takes up to
one minute for the change to take effect. Also, if you change the
policy attached to the role you specified in the roleArn
field (for
example, to correct an invalid policy), it takes up to five minutes
for that change to take effect.
1706 1707 1708 1709 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1706 def (params = {}, = {}) req = build_request(:put_logging_options, params) req.send_request() end |
#run_pipeline_activity(params = {}) ⇒ Types::RunPipelineActivityResponse
Simulates the results of running a pipeline activity on a message payload.
1803 1804 1805 1806 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1803 def run_pipeline_activity(params = {}, = {}) req = build_request(:run_pipeline_activity, params) req.send_request() end |
#sample_channel_data(params = {}) ⇒ Types::SampleChannelDataResponse
Retrieves a sample of messages from the specified channel ingested during the specified timeframe. Up to 10 messages can be retrieved.
1844 1845 1846 1847 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1844 def sample_channel_data(params = {}, = {}) req = build_request(:sample_channel_data, params) req.send_request() end |
#start_pipeline_reprocessing(params = {}) ⇒ Types::StartPipelineReprocessingResponse
Starts the reprocessing of raw message data through the pipeline.
1894 1895 1896 1897 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1894 def start_pipeline_reprocessing(params = {}, = {}) req = build_request(:start_pipeline_reprocessing, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
1924 1925 1926 1927 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1924 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes the given tags (metadata) from the resource.
1948 1949 1950 1951 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1948 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_channel(params = {}) ⇒ Struct
Used to update the settings of a channel.
1992 1993 1994 1995 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1992 def update_channel(params = {}, = {}) req = build_request(:update_channel, params) req.send_request() end |
#update_dataset(params = {}) ⇒ Struct
Updates the settings of a dataset.
2132 2133 2134 2135 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 2132 def update_dataset(params = {}, = {}) req = build_request(:update_dataset, params) req.send_request() end |
#update_datastore(params = {}) ⇒ Struct
Used to update the settings of a data store.
2209 2210 2211 2212 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 2209 def update_datastore(params = {}, = {}) req = build_request(:update_datastore, params) req.send_request() end |
#update_pipeline(params = {}) ⇒ Struct
Updates the settings of a pipeline. You must specify both a channel
and a datastore
activity and, optionally, as many as 23 additional
activities in the pipelineActivities
array.
2306 2307 2308 2309 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 2306 def update_pipeline(params = {}, = {}) req = build_request(:update_pipeline, params) req.send_request() end |