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.
348 349 350 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 348 def initialize(*args) super end |
Instance Method Details
#batch_put_message(params = {}) ⇒ Types::BatchPutMessageResponse
Sends messages to a channel.
410 411 412 413 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 410 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.
435 436 437 438 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 435 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.
500 501 502 503 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 500 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.
677 678 679 680 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 677 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).
713 714 715 716 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 713 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.
825 826 827 828 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 825 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.
941 942 943 944 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 941 def create_pipeline(params = {}, = {}) req = build_request(:create_pipeline, params) req.send_request() end |
#delete_channel(params = {}) ⇒ Struct
Deletes the specified channel.
961 962 963 964 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 961 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.
984 985 986 987 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 984 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.
1011 1012 1013 1014 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1011 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.
1031 1032 1033 1034 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1031 def delete_datastore(params = {}, = {}) req = build_request(:delete_datastore, params) req.send_request() end |
#delete_pipeline(params = {}) ⇒ Struct
Deletes the specified pipeline.
1051 1052 1053 1054 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1051 def delete_pipeline(params = {}, = {}) req = build_request(:delete_pipeline, params) req.send_request() end |
#describe_channel(params = {}) ⇒ Types::DescribeChannelResponse
Retrieves information about a channel.
1096 1097 1098 1099 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1096 def describe_channel(params = {}, = {}) req = build_request(:describe_channel, params) req.send_request() end |
#describe_dataset(params = {}) ⇒ Types::DescribeDatasetResponse
Retrieves information about a dataset.
1161 1162 1163 1164 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1161 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.
1215 1216 1217 1218 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1215 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.
1234 1235 1236 1237 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1234 def (params = {}, = {}) req = build_request(:describe_logging_options, params) req.send_request() end |
#describe_pipeline(params = {}) ⇒ Types::DescribePipelineResponse
Retrieves information about a pipeline.
1306 1307 1308 1309 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1306 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.
1346 1347 1348 1349 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1346 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.
1390 1391 1392 1393 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1390 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.
1446 1447 1448 1449 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1446 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.
1492 1493 1494 1495 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1492 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.
1543 1544 1545 1546 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1543 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.
1586 1587 1588 1589 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1586 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.
1614 1615 1616 1617 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1614 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.
1644 1645 1646 1647 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1644 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.
1741 1742 1743 1744 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1741 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.
1782 1783 1784 1785 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1782 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.
1832 1833 1834 1835 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1832 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.
1862 1863 1864 1865 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1862 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.
1886 1887 1888 1889 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1886 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.
1930 1931 1932 1933 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 1930 def update_channel(params = {}, = {}) req = build_request(:update_channel, params) req.send_request() end |
#update_dataset(params = {}) ⇒ Struct
Updates the settings of a dataset.
2070 2071 2072 2073 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 2070 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.
2147 2148 2149 2150 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 2147 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.
2244 2245 2246 2247 |
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/client.rb', line 2244 def update_pipeline(params = {}, = {}) req = build_request(:update_pipeline, params) req.send_request() end |