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.
422 423 424 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 422 def initialize(*args) super end |
Instance Method Details
#batch_put_message(params = {}) ⇒ Types::BatchPutMessageResponse
Sends messages to a channel.
484 485 486 487 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 484 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.
509 510 511 512 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 509 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.
574 575 576 577 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 574 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.
751 752 753 754 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 751 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).
787 788 789 790 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 787 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.
899 900 901 902 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 899 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.
1015 1016 1017 1018 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1015 def create_pipeline(params = {}, = {}) req = build_request(:create_pipeline, params) req.send_request() end |
#delete_channel(params = {}) ⇒ Struct
Deletes the specified channel.
1035 1036 1037 1038 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1035 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.
1058 1059 1060 1061 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1058 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.
1085 1086 1087 1088 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1085 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.
1105 1106 1107 1108 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1105 def delete_datastore(params = {}, = {}) req = build_request(:delete_datastore, params) req.send_request() end |
#delete_pipeline(params = {}) ⇒ Struct
Deletes the specified pipeline.
1125 1126 1127 1128 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1125 def delete_pipeline(params = {}, = {}) req = build_request(:delete_pipeline, params) req.send_request() end |
#describe_channel(params = {}) ⇒ Types::DescribeChannelResponse
Retrieves information about a channel.
1170 1171 1172 1173 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1170 def describe_channel(params = {}, = {}) req = build_request(:describe_channel, params) req.send_request() end |
#describe_dataset(params = {}) ⇒ Types::DescribeDatasetResponse
Retrieves information about a dataset.
1235 1236 1237 1238 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1235 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.
1289 1290 1291 1292 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1289 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.
1308 1309 1310 1311 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1308 def (params = {}, = {}) req = build_request(:describe_logging_options, params) req.send_request() end |
#describe_pipeline(params = {}) ⇒ Types::DescribePipelineResponse
Retrieves information about a pipeline.
1380 1381 1382 1383 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1380 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.
1420 1421 1422 1423 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1420 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.
1464 1465 1466 1467 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1464 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.
1520 1521 1522 1523 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1520 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.
1566 1567 1568 1569 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1566 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.
1617 1618 1619 1620 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1617 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.
1660 1661 1662 1663 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1660 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.
1688 1689 1690 1691 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1688 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.
1718 1719 1720 1721 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1718 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.
1815 1816 1817 1818 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1815 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.
1856 1857 1858 1859 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1856 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.
1906 1907 1908 1909 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1906 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.
1936 1937 1938 1939 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1936 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.
1960 1961 1962 1963 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1960 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.
2004 2005 2006 2007 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 2004 def update_channel(params = {}, = {}) req = build_request(:update_channel, params) req.send_request() end |
#update_dataset(params = {}) ⇒ Struct
Updates the settings of a dataset.
2144 2145 2146 2147 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 2144 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.
2221 2222 2223 2224 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 2221 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.
2318 2319 2320 2321 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 2318 def update_pipeline(params = {}, = {}) req = build_request(:update_pipeline, params) req.send_request() end |