com.amazonaws.services.iotanalytics

Interface AWSIoTAnalytics

All Known Subinterfaces:

AWSIoTAnalyticsAsync

All Known Implementing Classes:

AbstractAWSIoTAnalytics, AbstractAWSIoTAnalyticsAsync, AWSIoTAnalyticsAsyncClient, AWSIoTAnalyticsClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSIoTAnalytics

Interface for accessing AWS IoT Analytics.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSIoTAnalytics instead.

AWS IoT Analytics provides advanced data analysis for AWS IoT. It allows you to collect large amounts of device data, process messages, store them, and then query the data and run sophisticated analytics to make accurate decisions in your IoT applications and machine learning use cases. AWS IoT Analytics enables advanced data exploration through integration with Jupyter Notebooks and data visualization through integration with Amazon QuickSight.

Traditional analytics and business intelligence tools are designed to process structured data. IoT data often comes from devices that record noisy processes (such as temperature, motion, or sound). As a result, the data from these devices can have significant gaps, corrupted messages, and false readings that must be cleaned up before analysis can occur. Also, IoT data is often only meaningful in the context of other data from external sources.

AWS IoT Analytics automates each of the steps required to analyze data from IoT devices. AWS IoT Analytics filters, transforms, and enriches IoT data before storing it in a time-series data store for analysis. You can set up the service to collect only the data you need from your devices, apply mathematical transforms to process the data, and enrich the data with device-specific metadata such as device type and location before storing it. Then, you can analyze your data by running queries using the built-in SQL query engine, or perform more complex analytics and machine learning inference. AWS IoT Analytics includes models for common IoT use cases so you can answer questions like which devices are about to fail or which customers are at risk of abandoning their wearable devices.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
BatchPutMessageResult	batchPutMessage(BatchPutMessageRequest batchPutMessageRequest) Sends messages to a channel.
CancelPipelineReprocessingResult	cancelPipelineReprocessing(CancelPipelineReprocessingRequest cancelPipelineReprocessingRequest) Cancels the reprocessing of data through the pipeline.
CreateChannelResult	createChannel(CreateChannelRequest createChannelRequest) Creates a channel.
CreateDatasetResult	createDataset(CreateDatasetRequest createDatasetRequest) Creates a data set.
CreateDatasetContentResult	createDatasetContent(CreateDatasetContentRequest createDatasetContentRequest) Creates the content of a data set by applying an SQL action.
CreateDatastoreResult	createDatastore(CreateDatastoreRequest createDatastoreRequest) Creates a data store, which is a repository for messages.
CreatePipelineResult	createPipeline(CreatePipelineRequest createPipelineRequest) Creates a pipeline.
DeleteChannelResult	deleteChannel(DeleteChannelRequest deleteChannelRequest) Deletes the specified channel.
DeleteDatasetResult	deleteDataset(DeleteDatasetRequest deleteDatasetRequest) Deletes the specified data set.
DeleteDatasetContentResult	deleteDatasetContent(DeleteDatasetContentRequest deleteDatasetContentRequest) Deletes the content of the specified data set.
DeleteDatastoreResult	deleteDatastore(DeleteDatastoreRequest deleteDatastoreRequest) Deletes the specified data store.
DeletePipelineResult	deletePipeline(DeletePipelineRequest deletePipelineRequest) Deletes the specified pipeline.
DescribeChannelResult	describeChannel(DescribeChannelRequest describeChannelRequest) Retrieves information about a channel.
DescribeDatasetResult	describeDataset(DescribeDatasetRequest describeDatasetRequest) Retrieves information about a data set.
DescribeDatastoreResult	describeDatastore(DescribeDatastoreRequest describeDatastoreRequest) Retrieves information about a data store.
DescribeLoggingOptionsResult	describeLoggingOptions(DescribeLoggingOptionsRequest describeLoggingOptionsRequest) Retrieves the current settings of the AWS IoT Analytics logging options.
DescribePipelineResult	describePipeline(DescribePipelineRequest describePipelineRequest) Retrieves information about a pipeline.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetDatasetContentResult	getDatasetContent(GetDatasetContentRequest getDatasetContentRequest) Retrieves the contents of a data set as pre-signed URIs.
ListChannelsResult	listChannels(ListChannelsRequest listChannelsRequest) Retrieves a list of channels.
ListDatasetsResult	listDatasets(ListDatasetsRequest listDatasetsRequest) Retrieves information about data sets.
ListDatastoresResult	listDatastores(ListDatastoresRequest listDatastoresRequest) Retrieves a list of data stores.
ListPipelinesResult	listPipelines(ListPipelinesRequest listPipelinesRequest) Retrieves a list of pipelines.
PutLoggingOptionsResult	putLoggingOptions(PutLoggingOptionsRequest putLoggingOptionsRequest) Sets or updates the AWS IoT Analytics logging options.
RunPipelineActivityResult	runPipelineActivity(RunPipelineActivityRequest runPipelineActivityRequest) Simulates the results of running a pipeline activity on a message payload.
SampleChannelDataResult	sampleChannelData(SampleChannelDataRequest sampleChannelDataRequest) Retrieves a sample of messages from the specified channel ingested during the specified timeframe.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartPipelineReprocessingResult	startPipelineReprocessing(StartPipelineReprocessingRequest startPipelineReprocessingRequest) Starts the reprocessing of raw message data through the pipeline.
UpdateChannelResult	updateChannel(UpdateChannelRequest updateChannelRequest) Updates the settings of a channel.
UpdateDatasetResult	updateDataset(UpdateDatasetRequest updateDatasetRequest) Updates the settings of a data set.
UpdateDatastoreResult	updateDatastore(UpdateDatastoreRequest updateDatastoreRequest) Updates the settings of a data store.
UpdatePipelineResult	updatePipeline(UpdatePipelineRequest updatePipelineRequest) Updates the settings of a pipeline.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

batchPutMessage

BatchPutMessageResult batchPutMessage(BatchPutMessageRequest batchPutMessageRequest)

Sends messages to a channel.

Parameters:

batchPutMessageRequest -

Returns:

Result of the BatchPutMessage operation returned by the service.

Throws:

ResourceNotFoundException - A resource with the specified name could not be found.

InvalidRequestException - The request was not valid.

InternalFailureException - There was an internal failure.

ServiceUnavailableException - The service is temporarily unavailable.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

cancelPipelineReprocessing

CancelPipelineReprocessingResult cancelPipelineReprocessing(CancelPipelineReprocessingRequest cancelPipelineReprocessingRequest)

Cancels the reprocessing of data through the pipeline.

Parameters:

cancelPipelineReprocessingRequest -

Returns:

Result of the CancelPipelineReprocessing operation returned by the service.

Throws:

ResourceNotFoundException - A resource with the specified name could not be found.

InvalidRequestException - The request was not valid.

InternalFailureException - There was an internal failure.

ServiceUnavailableException - The service is temporarily unavailable.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

createChannel

CreateChannelResult createChannel(CreateChannelRequest createChannelRequest)

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

Parameters:

createChannelRequest -

Returns:

Result of the CreateChannel operation returned by the service.

Throws:

InvalidRequestException - The request was not valid.

ResourceAlreadyExistsException - A resource with the same name already exists.

InternalFailureException - There was an internal failure.

ServiceUnavailableException - The service is temporarily unavailable.

ThrottlingException - The request was denied due to request throttling.

LimitExceededException - The command caused an internal limit to be exceeded.

See Also:

AWS API Documentation

createDataset

CreateDatasetResult createDataset(CreateDatasetRequest createDatasetRequest)

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

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

Parameters:

createDatasetRequest -

Returns:

Result of the CreateDataset operation returned by the service.

Throws:

InvalidRequestException - The request was not valid.

ResourceAlreadyExistsException - A resource with the same name already exists.

InternalFailureException - There was an internal failure.

ServiceUnavailableException - The service is temporarily unavailable.

ThrottlingException - The request was denied due to request throttling.

LimitExceededException - The command caused an internal limit to be exceeded.

See Also:

AWS API Documentation

createDatasetContent

CreateDatasetContentResult createDatasetContent(CreateDatasetContentRequest createDatasetContentRequest)

Creates the content of a data set by applying an SQL action.

Parameters:

createDatasetContentRequest -

Returns:

Result of the CreateDatasetContent operation returned by the service.

Throws:

InvalidRequestException - The request was not valid.

ResourceNotFoundException - A resource with the specified name could not be found.

InternalFailureException - There was an internal failure.

ServiceUnavailableException - The service is temporarily unavailable.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

createDatastore

CreateDatastoreResult createDatastore(CreateDatastoreRequest createDatastoreRequest)

Creates a data store, which is a repository for messages.

Parameters:

createDatastoreRequest -

Returns:

Result of the CreateDatastore operation returned by the service.

Throws:

InvalidRequestException - The request was not valid.

ResourceAlreadyExistsException - A resource with the same name already exists.

InternalFailureException - There was an internal failure.

ServiceUnavailableException - The service is temporarily unavailable.

ThrottlingException - The request was denied due to request throttling.

LimitExceededException - The command caused an internal limit to be exceeded.

See Also:

AWS API Documentation

createPipeline

CreatePipelineResult createPipeline(CreatePipelineRequest createPipelineRequest)

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 store.

Parameters:

createPipelineRequest -

Returns:

Result of the CreatePipeline operation returned by the service.

Throws:

InvalidRequestException - The request was not valid.

ResourceAlreadyExistsException - A resource with the same name already exists.

InternalFailureException - There was an internal failure.

ServiceUnavailableException - The service is temporarily unavailable.

ThrottlingException - The request was denied due to request throttling.

LimitExceededException - The command caused an internal limit to be exceeded.

See Also:

AWS API Documentation

deleteChannel

DeleteChannelResult deleteChannel(DeleteChannelRequest deleteChannelRequest)

Deletes the specified channel.

Parameters:

deleteChannelRequest -

Returns:

Result of the DeleteChannel operation returned by the service.

Throws:

InvalidRequestException - The request was not valid.

ResourceNotFoundException - A resource with the specified name could not be found.

InternalFailureException - There was an internal failure.

ServiceUnavailableException - The service is temporarily unavailable.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

deleteDataset

DeleteDatasetResult deleteDataset(DeleteDatasetRequest deleteDatasetRequest)

Deletes the specified data set.

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

Parameters:

deleteDatasetRequest -

Returns:

Result of the DeleteDataset operation returned by the service.

Throws:

InvalidRequestException - The request was not valid.

ResourceNotFoundException - A resource with the specified name could not be found.

InternalFailureException - There was an internal failure.

ServiceUnavailableException - The service is temporarily unavailable.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

deleteDatasetContent

DeleteDatasetContentResult deleteDatasetContent(DeleteDatasetContentRequest deleteDatasetContentRequest)

Deletes the content of the specified data set.

Parameters:

deleteDatasetContentRequest -

Returns:

Result of the DeleteDatasetContent operation returned by the service.

Throws:

InvalidRequestException - The request was not valid.

ResourceNotFoundException - A resource with the specified name could not be found.

InternalFailureException - There was an internal failure.

ServiceUnavailableException - The service is temporarily unavailable.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

deleteDatastore

DeleteDatastoreResult deleteDatastore(DeleteDatastoreRequest deleteDatastoreRequest)

Deletes the specified data store.

Parameters:

deleteDatastoreRequest -

Returns:

Result of the DeleteDatastore operation returned by the service.

Throws:

InvalidRequestException - The request was not valid.

ResourceNotFoundException - A resource with the specified name could not be found.

InternalFailureException - There was an internal failure.

ServiceUnavailableException - The service is temporarily unavailable.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

deletePipeline

DeletePipelineResult deletePipeline(DeletePipelineRequest deletePipelineRequest)

Deletes the specified pipeline.

Parameters:

deletePipelineRequest -

Returns:

Result of the DeletePipeline operation returned by the service.

Throws:

InvalidRequestException - The request was not valid.

ResourceNotFoundException - A resource with the specified name could not be found.

InternalFailureException - There was an internal failure.

ServiceUnavailableException - The service is temporarily unavailable.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

describeChannel

DescribeChannelResult describeChannel(DescribeChannelRequest describeChannelRequest)

Retrieves information about a channel.

Parameters:

describeChannelRequest -

Returns:

Result of the DescribeChannel operation returned by the service.

Throws:

InvalidRequestException - The request was not valid.

ResourceNotFoundException - A resource with the specified name could not be found.

InternalFailureException - There was an internal failure.

ServiceUnavailableException - The service is temporarily unavailable.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

describeDataset

DescribeDatasetResult describeDataset(DescribeDatasetRequest describeDatasetRequest)

Retrieves information about a data set.

Parameters:

describeDatasetRequest -

Returns:

Result of the DescribeDataset operation returned by the service.

Throws:

InvalidRequestException - The request was not valid.

ResourceNotFoundException - A resource with the specified name could not be found.

InternalFailureException - There was an internal failure.

ServiceUnavailableException - The service is temporarily unavailable.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

describeDatastore

DescribeDatastoreResult describeDatastore(DescribeDatastoreRequest describeDatastoreRequest)

Retrieves information about a data store.

Parameters:

describeDatastoreRequest -

Returns:

Result of the DescribeDatastore operation returned by the service.

Throws:

InvalidRequestException - The request was not valid.

ResourceNotFoundException - A resource with the specified name could not be found.

InternalFailureException - There was an internal failure.

ServiceUnavailableException - The service is temporarily unavailable.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

describeLoggingOptions

DescribeLoggingOptionsResult describeLoggingOptions(DescribeLoggingOptionsRequest describeLoggingOptionsRequest)

Retrieves the current settings of the AWS IoT Analytics logging options.

Parameters:

describeLoggingOptionsRequest -

Returns:

Result of the DescribeLoggingOptions operation returned by the service.

Throws:

InvalidRequestException - The request was not valid.

ResourceNotFoundException - A resource with the specified name could not be found.

InternalFailureException - There was an internal failure.

ServiceUnavailableException - The service is temporarily unavailable.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

describePipeline

DescribePipelineResult describePipeline(DescribePipelineRequest describePipelineRequest)

Retrieves information about a pipeline.

Parameters:

describePipelineRequest -

Returns:

Result of the DescribePipeline operation returned by the service.

Throws:

InvalidRequestException - The request was not valid.

ResourceNotFoundException - A resource with the specified name could not be found.

InternalFailureException - There was an internal failure.

ServiceUnavailableException - The service is temporarily unavailable.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

getDatasetContent

GetDatasetContentResult getDatasetContent(GetDatasetContentRequest getDatasetContentRequest)

Retrieves the contents of a data set as pre-signed URIs.

Parameters:

getDatasetContentRequest -

Returns:

Result of the GetDatasetContent operation returned by the service.

Throws:

InvalidRequestException - The request was not valid.

ResourceNotFoundException - A resource with the specified name could not be found.

InternalFailureException - There was an internal failure.

ServiceUnavailableException - The service is temporarily unavailable.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

listChannels

ListChannelsResult listChannels(ListChannelsRequest listChannelsRequest)

Retrieves a list of channels.

Parameters:

listChannelsRequest -

Returns:

Result of the ListChannels operation returned by the service.

Throws:

InvalidRequestException - The request was not valid.

InternalFailureException - There was an internal failure.

ServiceUnavailableException - The service is temporarily unavailable.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

listDatasets

ListDatasetsResult listDatasets(ListDatasetsRequest listDatasetsRequest)

Retrieves information about data sets.

Parameters:

listDatasetsRequest -

Returns:

Result of the ListDatasets operation returned by the service.

Throws:

InvalidRequestException - The request was not valid.

InternalFailureException - There was an internal failure.

ServiceUnavailableException - The service is temporarily unavailable.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

listDatastores

ListDatastoresResult listDatastores(ListDatastoresRequest listDatastoresRequest)

Retrieves a list of data stores.

Parameters:

listDatastoresRequest -

Returns:

Result of the ListDatastores operation returned by the service.

Throws:

InvalidRequestException - The request was not valid.

InternalFailureException - There was an internal failure.

ServiceUnavailableException - The service is temporarily unavailable.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

listPipelines

ListPipelinesResult listPipelines(ListPipelinesRequest listPipelinesRequest)

Retrieves a list of pipelines.

Parameters:

listPipelinesRequest -

Returns:

Result of the ListPipelines operation returned by the service.

Throws:

InvalidRequestException - The request was not valid.

InternalFailureException - There was an internal failure.

ServiceUnavailableException - The service is temporarily unavailable.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

putLoggingOptions

PutLoggingOptionsResult putLoggingOptions(PutLoggingOptionsRequest putLoggingOptionsRequest)

Sets or updates the AWS IoT Analytics logging options.

Parameters:

putLoggingOptionsRequest -

Returns:

Result of the PutLoggingOptions operation returned by the service.

Throws:

InvalidRequestException - The request was not valid.

InternalFailureException - There was an internal failure.

ServiceUnavailableException - The service is temporarily unavailable.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

runPipelineActivity

RunPipelineActivityResult runPipelineActivity(RunPipelineActivityRequest runPipelineActivityRequest)

Simulates the results of running a pipeline activity on a message payload.

Parameters:

runPipelineActivityRequest -

Returns:

Result of the RunPipelineActivity operation returned by the service.

Throws:

InvalidRequestException - The request was not valid.

InternalFailureException - There was an internal failure.

ServiceUnavailableException - The service is temporarily unavailable.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

sampleChannelData

SampleChannelDataResult sampleChannelData(SampleChannelDataRequest sampleChannelDataRequest)

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

Parameters:

sampleChannelDataRequest -

Returns:

Result of the SampleChannelData operation returned by the service.

Throws:

InvalidRequestException - The request was not valid.

ResourceNotFoundException - A resource with the specified name could not be found.

InternalFailureException - There was an internal failure.

ServiceUnavailableException - The service is temporarily unavailable.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

startPipelineReprocessing

StartPipelineReprocessingResult startPipelineReprocessing(StartPipelineReprocessingRequest startPipelineReprocessingRequest)

Starts the reprocessing of raw message data through the pipeline.

Parameters:

startPipelineReprocessingRequest -

Returns:

Result of the StartPipelineReprocessing operation returned by the service.

Throws:

ResourceNotFoundException - A resource with the specified name could not be found.

ResourceAlreadyExistsException - A resource with the same name already exists.

InvalidRequestException - The request was not valid.

InternalFailureException - There was an internal failure.

ServiceUnavailableException - The service is temporarily unavailable.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

updateChannel

UpdateChannelResult updateChannel(UpdateChannelRequest updateChannelRequest)

Updates the settings of a channel.

Parameters:

updateChannelRequest -

Returns:

Result of the UpdateChannel operation returned by the service.

Throws:

InvalidRequestException - The request was not valid.

ResourceNotFoundException - A resource with the specified name could not be found.

InternalFailureException - There was an internal failure.

ServiceUnavailableException - The service is temporarily unavailable.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

updateDataset

UpdateDatasetResult updateDataset(UpdateDatasetRequest updateDatasetRequest)

Updates the settings of a data set.

Parameters:

updateDatasetRequest -

Returns:

Result of the UpdateDataset operation returned by the service.

Throws:

InvalidRequestException - The request was not valid.

ResourceNotFoundException - A resource with the specified name could not be found.

InternalFailureException - There was an internal failure.

ServiceUnavailableException - The service is temporarily unavailable.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

updateDatastore

UpdateDatastoreResult updateDatastore(UpdateDatastoreRequest updateDatastoreRequest)

Updates the settings of a data store.

Parameters:

updateDatastoreRequest -

Returns:

Result of the UpdateDatastore operation returned by the service.

Throws:

InvalidRequestException - The request was not valid.

ResourceNotFoundException - A resource with the specified name could not be found.

InternalFailureException - There was an internal failure.

ServiceUnavailableException - The service is temporarily unavailable.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

updatePipeline

UpdatePipelineResult updatePipeline(UpdatePipelineRequest updatePipelineRequest)

Updates the settings of a pipeline.

Parameters:

updatePipelineRequest -

Returns:

Result of the UpdatePipeline operation returned by the service.

Throws:

InvalidRequestException - The request was not valid.

ResourceNotFoundException - A resource with the specified name could not be found.

InternalFailureException - There was an internal failure.

ServiceUnavailableException - The service is temporarily unavailable.

ThrottlingException - The request was denied due to request throttling.

LimitExceededException - The command caused an internal limit to be exceeded.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.