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
Creates a channel.
-
#create_dataset(params = {}) ⇒ Types::CreateDatasetResponse
Creates a dataset.
-
#create_dataset_content(params = {}) ⇒ Types::CreateDatasetContentResponse
Creates the content of a data set 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 AWS 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 data set as presigned URIs.
-
#list_channels(params = {}) ⇒ Types::ListChannelsResponse
Retrieves a list of channels.
-
#list_dataset_contents(params = {}) ⇒ Types::ListDatasetContentsResponse
Lists information about data set contents that have been created.
-
#list_datasets(params = {}) ⇒ Types::ListDatasetsResponse
Retrieves information about data sets.
-
#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 AWS 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
Updates the settings of a channel.
-
#update_dataset(params = {}) ⇒ Struct
Updates the settings of a data set.
-
#update_datastore(params = {}) ⇒ Struct
Updates 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.
324 325 326 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 324 def initialize(*args) super end |
Instance Method Details
#batch_put_message(params = {}) ⇒ Types::BatchPutMessageResponse
Sends messages to a channel.
386 387 388 389 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 386 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.
411 412 413 414 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 411 def cancel_pipeline_reprocessing(params = {}, = {}) req = build_request(:cancel_pipeline_reprocessing, params) req.send_request() end |
#create_channel(params = {}) ⇒ Types::CreateChannelResponse
Creates a channel. A channel collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline.
476 477 478 479 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 476 def create_channel(params = {}, = {}) req = build_request(:create_channel, params) req.send_request() end |
#create_dataset(params = {}) ⇒ Types::CreateDatasetResponse
Creates 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.
653 654 655 656 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 653 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 data set by applying a queryAction
(a SQL
query) or a containerAction
(executing a containerized application).
689 690 691 692 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 689 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.
778 779 780 781 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 778 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.
894 895 896 897 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 894 def create_pipeline(params = {}, = {}) req = build_request(:create_pipeline, params) req.send_request() end |
#delete_channel(params = {}) ⇒ Struct
Deletes the specified channel.
914 915 916 917 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 914 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.
937 938 939 940 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 937 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.
964 965 966 967 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 964 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.
984 985 986 987 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 984 def delete_datastore(params = {}, = {}) req = build_request(:delete_datastore, params) req.send_request() end |
#delete_pipeline(params = {}) ⇒ Struct
Deletes the specified pipeline.
1004 1005 1006 1007 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1004 def delete_pipeline(params = {}, = {}) req = build_request(:delete_pipeline, params) req.send_request() end |
#describe_channel(params = {}) ⇒ Types::DescribeChannelResponse
Retrieves information about a channel.
1049 1050 1051 1052 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1049 def describe_channel(params = {}, = {}) req = build_request(:describe_channel, params) req.send_request() end |
#describe_dataset(params = {}) ⇒ Types::DescribeDatasetResponse
Retrieves information about a dataset.
1114 1115 1116 1117 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1114 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.
1162 1163 1164 1165 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1162 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 AWS IoT Analytics logging options.
1182 1183 1184 1185 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1182 def (params = {}, = {}) req = build_request(:describe_logging_options, params) req.send_request() end |
#describe_pipeline(params = {}) ⇒ Types::DescribePipelineResponse
Retrieves information about a pipeline.
1254 1255 1256 1257 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1254 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 data set as presigned URIs.
1294 1295 1296 1297 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1294 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.
1338 1339 1340 1341 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1338 def list_channels(params = {}, = {}) req = build_request(:list_channels, params) req.send_request() end |
#list_dataset_contents(params = {}) ⇒ Types::ListDatasetContentsResponse
Lists information about data set contents that have been created.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1394 1395 1396 1397 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1394 def list_dataset_contents(params = {}, = {}) req = build_request(:list_dataset_contents, params) req.send_request() end |
#list_datasets(params = {}) ⇒ Types::ListDatasetsResponse
Retrieves information about data sets.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1440 1441 1442 1443 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1440 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.
1485 1486 1487 1488 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1485 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.
1528 1529 1530 1531 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1528 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.
1556 1557 1558 1559 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1556 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_logging_options(params = {}) ⇒ Struct
Sets or updates the AWS 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.
1586 1587 1588 1589 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1586 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.
1683 1684 1685 1686 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1683 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.
1724 1725 1726 1727 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1724 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.
1774 1775 1776 1777 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1774 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.
1804 1805 1806 1807 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1804 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.
1828 1829 1830 1831 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1828 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_channel(params = {}) ⇒ Struct
Updates the settings of a channel.
1872 1873 1874 1875 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1872 def update_channel(params = {}, = {}) req = build_request(:update_channel, params) req.send_request() end |
#update_dataset(params = {}) ⇒ Struct
Updates the settings of a data set.
2012 2013 2014 2015 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 2012 def update_dataset(params = {}, = {}) req = build_request(:update_dataset, params) req.send_request() end |
#update_datastore(params = {}) ⇒ Struct
Updates the settings of a data store.
2082 2083 2084 2085 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 2082 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.
2179 2180 2181 2182 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 2179 def update_pipeline(params = {}, = {}) req = build_request(:update_pipeline, params) req.send_request() end |