IoTAnalyticsClient Class

Member Function Documentation

IoTAnalyticsClient::IoTAnalyticsClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a IoTAnalyticsClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

IoTAnalyticsClient::IoTAnalyticsClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads IoTAnalyticsClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] BatchPutMessageResponse *IoTAnalyticsClient::batchPutMessage(const BatchPutMessageRequest &request)

Sends request to the IoTAnalyticsClient service, and returns a pointer to an BatchPutMessageResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Sends messages to a

[slot] CancelPipelineReprocessingResponse *IoTAnalyticsClient::cancelPipelineReprocessing(const CancelPipelineReprocessingRequest &request)

Sends request to the IoTAnalyticsClient service, and returns a pointer to an CancelPipelineReprocessingResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Cancels the reprocessing of data through the

[slot] CreateChannelResponse *IoTAnalyticsClient::createChannel(const CreateChannelRequest &request)

Sends request to the IoTAnalyticsClient service, and returns a pointer to an CreateChannelResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a channel. A channel collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a

[slot] CreateDatasetResponse *IoTAnalyticsClient::createDataset(const CreateDatasetRequest &request)

Sends request to the IoTAnalyticsClient service, and returns a pointer to an CreateDatasetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a data set. A data set stores data retrieved from a data store by applying an SQL

action> <note>

This operation creates the skeleton of a data set. To populate the data set, call

[slot] CreateDatasetContentResponse *IoTAnalyticsClient::createDatasetContent(const CreateDatasetContentRequest &request)

Sends request to the IoTAnalyticsClient service, and returns a pointer to an CreateDatasetContentResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates the content of a data set by applying an SQL

[slot] CreateDatastoreResponse *IoTAnalyticsClient::createDatastore(const CreateDatastoreRequest &request)

Sends request to the IoTAnalyticsClient service, and returns a pointer to an CreateDatastoreResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a data store, which is a repository for

[slot] CreatePipelineResponse *IoTAnalyticsClient::createPipeline(const CreatePipelineRequest &request)

Sends request to the IoTAnalyticsClient service, and returns a pointer to an CreatePipelineResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a pipeline. A pipeline consumes messages from one or more channels and allows you to process the messages before storing them in a data

[slot] DeleteChannelResponse *IoTAnalyticsClient::deleteChannel(const DeleteChannelRequest &request)

Sends request to the IoTAnalyticsClient service, and returns a pointer to an DeleteChannelResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the specified

[slot] DeleteDatasetResponse *IoTAnalyticsClient::deleteDataset(const DeleteDatasetRequest &request)

Sends request to the IoTAnalyticsClient service, and returns a pointer to an DeleteDatasetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the specified data

set>

You do not have to delete the content of the data set before you perform this

[slot] DeleteDatasetContentResponse *IoTAnalyticsClient::deleteDatasetContent(const DeleteDatasetContentRequest &request)

Sends request to the IoTAnalyticsClient service, and returns a pointer to an DeleteDatasetContentResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the content of the specified data

[slot] DeleteDatastoreResponse *IoTAnalyticsClient::deleteDatastore(const DeleteDatastoreRequest &request)

Sends request to the IoTAnalyticsClient service, and returns a pointer to an DeleteDatastoreResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the specified data

[slot] DeletePipelineResponse *IoTAnalyticsClient::deletePipeline(const DeletePipelineRequest &request)

Sends request to the IoTAnalyticsClient service, and returns a pointer to an DeletePipelineResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the specified

[slot] DescribeChannelResponse *IoTAnalyticsClient::describeChannel(const DescribeChannelRequest &request)

Sends request to the IoTAnalyticsClient service, and returns a pointer to an DescribeChannelResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves information about a

[slot] DescribeDatasetResponse *IoTAnalyticsClient::describeDataset(const DescribeDatasetRequest &request)

Sends request to the IoTAnalyticsClient service, and returns a pointer to an DescribeDatasetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves information about a data

[slot] DescribeDatastoreResponse *IoTAnalyticsClient::describeDatastore(const DescribeDatastoreRequest &request)

Sends request to the IoTAnalyticsClient service, and returns a pointer to an DescribeDatastoreResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves information about a data

[slot] DescribeLoggingOptionsResponse *IoTAnalyticsClient::describeLoggingOptions(const DescribeLoggingOptionsRequest &request)

Sends request to the IoTAnalyticsClient service, and returns a pointer to an DescribeLoggingOptionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves the current settings of the AWS IoT Analytics logging

[slot] DescribePipelineResponse *IoTAnalyticsClient::describePipeline(const DescribePipelineRequest &request)

Sends request to the IoTAnalyticsClient service, and returns a pointer to an DescribePipelineResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves information about a

[slot] GetDatasetContentResponse *IoTAnalyticsClient::getDatasetContent(const GetDatasetContentRequest &request)

Sends request to the IoTAnalyticsClient service, and returns a pointer to an GetDatasetContentResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves the contents of a data set as pre-signed

[slot] ListChannelsResponse *IoTAnalyticsClient::listChannels(const ListChannelsRequest &request)

Sends request to the IoTAnalyticsClient service, and returns a pointer to an ListChannelsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves a list of

[slot] ListDatasetsResponse *IoTAnalyticsClient::listDatasets(const ListDatasetsRequest &request)

Sends request to the IoTAnalyticsClient service, and returns a pointer to an ListDatasetsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves information about data

[slot] ListDatastoresResponse *IoTAnalyticsClient::listDatastores(const ListDatastoresRequest &request)

Sends request to the IoTAnalyticsClient service, and returns a pointer to an ListDatastoresResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves a list of data

[slot] ListPipelinesResponse *IoTAnalyticsClient::listPipelines(const ListPipelinesRequest &request)

Sends request to the IoTAnalyticsClient service, and returns a pointer to an ListPipelinesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves a list of

[slot] PutLoggingOptionsResponse *IoTAnalyticsClient::putLoggingOptions(const PutLoggingOptionsRequest &request)

Sends request to the IoTAnalyticsClient service, and returns a pointer to an PutLoggingOptionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Sets or updates the AWS IoT Analytics logging

[slot] RunPipelineActivityResponse *IoTAnalyticsClient::runPipelineActivity(const RunPipelineActivityRequest &request)

Sends request to the IoTAnalyticsClient service, and returns a pointer to an RunPipelineActivityResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Simulates the results of running a pipeline activity on a message

[slot] SampleChannelDataResponse *IoTAnalyticsClient::sampleChannelData(const SampleChannelDataRequest &request)

Sends request to the IoTAnalyticsClient service, and returns a pointer to an SampleChannelDataResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves a sample of messages from the specified channel ingested during the specified timeframe. Up to 10 messages can be

[slot] StartPipelineReprocessingResponse *IoTAnalyticsClient::startPipelineReprocessing(const StartPipelineReprocessingRequest &request)

Sends request to the IoTAnalyticsClient service, and returns a pointer to an StartPipelineReprocessingResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Starts the reprocessing of raw message data through the

[slot] UpdateChannelResponse *IoTAnalyticsClient::updateChannel(const UpdateChannelRequest &request)

Sends request to the IoTAnalyticsClient service, and returns a pointer to an UpdateChannelResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates the settings of a

[slot] UpdateDatasetResponse *IoTAnalyticsClient::updateDataset(const UpdateDatasetRequest &request)

Sends request to the IoTAnalyticsClient service, and returns a pointer to an UpdateDatasetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates the settings of a data

[slot] UpdateDatastoreResponse *IoTAnalyticsClient::updateDatastore(const UpdateDatastoreRequest &request)

Sends request to the IoTAnalyticsClient service, and returns a pointer to an UpdateDatastoreResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates the settings of a data

[slot] UpdatePipelineResponse *IoTAnalyticsClient::updatePipeline(const UpdatePipelineRequest &request)

Sends request to the IoTAnalyticsClient service, and returns a pointer to an UpdatePipelineResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates the settings of a