AWSIoTAnalyticsClient (AWS Java SDK for AWS IoT Analytics 1.11.645 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.iotanalytics.AWSIoTAnalyticsClient

All Implemented Interfaces:

AWSIoTAnalytics

Direct Known Subclasses:

AWSIoTAnalyticsAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSIoTAnalyticsClient
extends AmazonWebServiceClient
implements AWSIoTAnalytics
```
Client for accessing AWS IoT Analytics. All service calls made using this client are blocking, and will not return until the service call completes.

AWS IoT Analytics allows you to collect large amounts of device data, process messages, and store them. You can then query the data and run sophisticated analytics on it. 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 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 pre-built 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

protected static ClientConfigurationFactory configFactory
Client configuration factory providing ClientConfigurations tailored to this client
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
- Fields inherited from interface com.amazonaws.services.iotanalytics.AWSIoTAnalytics
  ENDPOINT_PREFIX

Fields
Modifier and Type	Field and Description
`protected static ClientConfigurationFactory`	`configFactory` Client configuration factory providing ClientConfigurations tailored to this client

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BatchPutMessageResult`	`batchPutMessage(BatchPutMessageRequest request)` Sends messages to a channel.
`static AWSIoTAnalyticsClientBuilder`	`builder()`
`CancelPipelineReprocessingResult`	`cancelPipelineReprocessing(CancelPipelineReprocessingRequest request)` Cancels the reprocessing of data through the pipeline.
`CreateChannelResult`	`createChannel(CreateChannelRequest request)` Creates a channel.
`CreateDatasetResult`	`createDataset(CreateDatasetRequest request)` Creates a data set.
`CreateDatasetContentResult`	`createDatasetContent(CreateDatasetContentRequest request)` Creates the content of a data set by applying a "queryAction" (a SQL query) or a "containerAction" (executing a containerized application).
`CreateDatastoreResult`	`createDatastore(CreateDatastoreRequest request)` Creates a data store, which is a repository for messages.
`CreatePipelineResult`	`createPipeline(CreatePipelineRequest request)` Creates a pipeline.
`DeleteChannelResult`	`deleteChannel(DeleteChannelRequest request)` Deletes the specified channel.
`DeleteDatasetResult`	`deleteDataset(DeleteDatasetRequest request)` Deletes the specified data set.
`DeleteDatasetContentResult`	`deleteDatasetContent(DeleteDatasetContentRequest request)` Deletes the content of the specified data set.
`DeleteDatastoreResult`	`deleteDatastore(DeleteDatastoreRequest request)` Deletes the specified data store.
`DeletePipelineResult`	`deletePipeline(DeletePipelineRequest request)` Deletes the specified pipeline.
`DescribeChannelResult`	`describeChannel(DescribeChannelRequest request)` Retrieves information about a channel.
`DescribeDatasetResult`	`describeDataset(DescribeDatasetRequest request)` Retrieves information about a data set.
`DescribeDatastoreResult`	`describeDatastore(DescribeDatastoreRequest request)` Retrieves information about a data store.
`DescribeLoggingOptionsResult`	`describeLoggingOptions(DescribeLoggingOptionsRequest request)` Retrieves the current settings of the AWS IoT Analytics logging options.
`DescribePipelineResult`	`describePipeline(DescribePipelineRequest request)` 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 request)` Retrieves the contents of a data set as pre-signed URIs.
`ListChannelsResult`	`listChannels(ListChannelsRequest request)` Retrieves a list of channels.
`ListDatasetContentsResult`	`listDatasetContents(ListDatasetContentsRequest request)` Lists information about data set contents that have been created.
`ListDatasetsResult`	`listDatasets(ListDatasetsRequest request)` Retrieves information about data sets.
`ListDatastoresResult`	`listDatastores(ListDatastoresRequest request)` Retrieves a list of data stores.
`ListPipelinesResult`	`listPipelines(ListPipelinesRequest request)` Retrieves a list of pipelines.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Lists the tags (metadata) which you have assigned to the resource.
`PutLoggingOptionsResult`	`putLoggingOptions(PutLoggingOptionsRequest request)` Sets or updates the AWS IoT Analytics logging options.
`RunPipelineActivityResult`	`runPipelineActivity(RunPipelineActivityRequest request)` Simulates the results of running a pipeline activity on a message payload.
`SampleChannelDataResult`	`sampleChannelData(SampleChannelDataRequest request)` Retrieves a sample of messages from the specified channel ingested during the specified timeframe.
`StartPipelineReprocessingResult`	`startPipelineReprocessing(StartPipelineReprocessingRequest request)` Starts the reprocessing of raw message data through the pipeline.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Adds to or modifies the tags of the given resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes the given tags (metadata) from the resource.
`UpdateChannelResult`	`updateChannel(UpdateChannelRequest request)` Updates the settings of a channel.
`UpdateDatasetResult`	`updateDataset(UpdateDatasetRequest request)` Updates the settings of a data set.
`UpdateDatastoreResult`	`updateDatastore(UpdateDatastoreRequest request)` Updates the settings of a data store.
`UpdatePipelineResult`	`updatePipeline(UpdatePipelineRequest request)` Updates the settings of a pipeline.

Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.iotanalytics.AWSIoTAnalytics
shutdown

- Field Detail
  - configFactory
```
protected static final ClientConfigurationFactory configFactory
```
    Client configuration factory providing ClientConfigurations tailored to this client
- Method Detail
  - builder
```
public static AWSIoTAnalyticsClientBuilder builder()
```
  - batchPutMessage
```
public BatchPutMessageResult batchPutMessage(BatchPutMessageRequest request)
```
    Sends messages to a channel.
    
    Specified by:
    
    batchPutMessage in interface AWSIoTAnalytics
    
    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
```
public CancelPipelineReprocessingResult cancelPipelineReprocessing(CancelPipelineReprocessingRequest request)
```
    Cancels the reprocessing of data through the pipeline.
    
    Specified by:
    
    cancelPipelineReprocessing in interface AWSIoTAnalytics
    
    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
```
public CreateChannelResult createChannel(CreateChannelRequest request)
```
    Creates a channel. A channel collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline.
    
    Specified by:
    
    createChannel in interface AWSIoTAnalytics
    
    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
```
public CreateDatasetResult createDataset(CreateDatasetRequest request)
```
    Creates a data set. A data set 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 data set. The data set can be populated manually by calling "CreateDatasetContent" or automatically according to a "trigger" you specify.
    
    Specified by:
    
    createDataset in interface AWSIoTAnalytics
    
    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
```
public CreateDatasetContentResult createDatasetContent(CreateDatasetContentRequest request)
```
    Creates the content of a data set by applying a "queryAction" (a SQL query) or a "containerAction" (executing a containerized application).
    
    Specified by:
    
    createDatasetContent in interface AWSIoTAnalytics
    
    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
```
public CreateDatastoreResult createDatastore(CreateDatastoreRequest request)
```
    Creates a data store, which is a repository for messages.
    
    Specified by:
    
    createDatastore in interface AWSIoTAnalytics
    
    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
```
public CreatePipelineResult createPipeline(CreatePipelineRequest request)
```
    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. You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array.
    
    Specified by:
    
    createPipeline in interface AWSIoTAnalytics
    
    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
```
public DeleteChannelResult deleteChannel(DeleteChannelRequest request)
```
    Deletes the specified channel.
    
    Specified by:
    
    deleteChannel in interface AWSIoTAnalytics
    
    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
```
public DeleteDatasetResult deleteDataset(DeleteDatasetRequest request)
```
    Deletes the specified data set.
    
    You do not have to delete the content of the data set before you perform this operation.
    
    Specified by:
    
    deleteDataset in interface AWSIoTAnalytics
    
    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
```
public DeleteDatasetContentResult deleteDatasetContent(DeleteDatasetContentRequest request)
```
    Deletes the content of the specified data set.
    
    Specified by:
    
    deleteDatasetContent in interface AWSIoTAnalytics
    
    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
```
public DeleteDatastoreResult deleteDatastore(DeleteDatastoreRequest request)
```
    Deletes the specified data store.
    
    Specified by:
    
    deleteDatastore in interface AWSIoTAnalytics
    
    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
```
public DeletePipelineResult deletePipeline(DeletePipelineRequest request)
```
    Deletes the specified pipeline.
    
    Specified by:
    
    deletePipeline in interface AWSIoTAnalytics
    
    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
```
public DescribeChannelResult describeChannel(DescribeChannelRequest request)
```
    Retrieves information about a channel.
    
    Specified by:
    
    describeChannel in interface AWSIoTAnalytics
    
    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
```
public DescribeDatasetResult describeDataset(DescribeDatasetRequest request)
```
    Retrieves information about a data set.
    
    Specified by:
    
    describeDataset in interface AWSIoTAnalytics
    
    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
```
public DescribeDatastoreResult describeDatastore(DescribeDatastoreRequest request)
```
    Retrieves information about a data store.
    
    Specified by:
    
    describeDatastore in interface AWSIoTAnalytics
    
    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
```
public DescribeLoggingOptionsResult describeLoggingOptions(DescribeLoggingOptionsRequest request)
```
    Retrieves the current settings of the AWS IoT Analytics logging options.
    
    Specified by:
    
    describeLoggingOptions in interface AWSIoTAnalytics
    
    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
```
public DescribePipelineResult describePipeline(DescribePipelineRequest request)
```
    Retrieves information about a pipeline.
    
    Specified by:
    
    describePipeline in interface AWSIoTAnalytics
    
    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
```
public GetDatasetContentResult getDatasetContent(GetDatasetContentRequest request)
```
    Retrieves the contents of a data set as pre-signed URIs.
    
    Specified by:
    
    getDatasetContent in interface AWSIoTAnalytics
    
    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
```
public ListChannelsResult listChannels(ListChannelsRequest request)
```
    Retrieves a list of channels.
    
    Specified by:
    
    listChannels in interface AWSIoTAnalytics
    
    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
  - listDatasetContents
```
public ListDatasetContentsResult listDatasetContents(ListDatasetContentsRequest request)
```
    Lists information about data set contents that have been created.
    
    Specified by:
    
    listDatasetContents in interface AWSIoTAnalytics
    
    Parameters:
    
    listDatasetContentsRequest -
    
    Returns:
    
    Result of the ListDatasetContents 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.
    
    ResourceNotFoundException - A resource with the specified name could not be found.
    
    See Also:
    
    AWS API Documentation
  - listDatasets
```
public ListDatasetsResult listDatasets(ListDatasetsRequest request)
```
    Retrieves information about data sets.
    
    Specified by:
    
    listDatasets in interface AWSIoTAnalytics
    
    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
```
public ListDatastoresResult listDatastores(ListDatastoresRequest request)
```
    Retrieves a list of data stores.
    
    Specified by:
    
    listDatastores in interface AWSIoTAnalytics
    
    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
```
public ListPipelinesResult listPipelines(ListPipelinesRequest request)
```
    Retrieves a list of pipelines.
    
    Specified by:
    
    listPipelines in interface AWSIoTAnalytics
    
    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
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Lists the tags (metadata) which you have assigned to the resource.
    
    Specified by:
    
    listTagsForResource in interface AWSIoTAnalytics
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource 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.
    
    LimitExceededException - The command caused an internal limit to be exceeded.
    
    ResourceNotFoundException - A resource with the specified name could not be found.
    
    See Also:
    
    AWS API Documentation
  - putLoggingOptions
```
public PutLoggingOptionsResult putLoggingOptions(PutLoggingOptionsRequest request)
```
    Sets or updates the AWS IoT Analytics logging options.
    
    Note that 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 5 minutes for that change to take effect.
    
    Specified by:
    
    putLoggingOptions in interface AWSIoTAnalytics
    
    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
```
public RunPipelineActivityResult runPipelineActivity(RunPipelineActivityRequest request)
```
    Simulates the results of running a pipeline activity on a message payload.
    
    Specified by:
    
    runPipelineActivity in interface AWSIoTAnalytics
    
    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
```
public SampleChannelDataResult sampleChannelData(SampleChannelDataRequest request)
```
    Retrieves a sample of messages from the specified channel ingested during the specified timeframe. Up to 10 messages can be retrieved.
    
    Specified by:
    
    sampleChannelData in interface AWSIoTAnalytics
    
    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
```
public StartPipelineReprocessingResult startPipelineReprocessing(StartPipelineReprocessingRequest request)
```
    Starts the reprocessing of raw message data through the pipeline.
    
    Specified by:
    
    startPipelineReprocessing in interface AWSIoTAnalytics
    
    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
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.
    
    Specified by:
    
    tagResource in interface AWSIoTAnalytics
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource 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.
    
    LimitExceededException - The command caused an internal limit to be exceeded.
    
    ResourceNotFoundException - A resource with the specified name could not be found.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Removes the given tags (metadata) from the resource.
    
    Specified by:
    
    untagResource in interface AWSIoTAnalytics
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource 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.
    
    LimitExceededException - The command caused an internal limit to be exceeded.
    
    ResourceNotFoundException - A resource with the specified name could not be found.
    
    See Also:
    
    AWS API Documentation
  - updateChannel
```
public UpdateChannelResult updateChannel(UpdateChannelRequest request)
```
    Updates the settings of a channel.
    
    Specified by:
    
    updateChannel in interface AWSIoTAnalytics
    
    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
```
public UpdateDatasetResult updateDataset(UpdateDatasetRequest request)
```
    Updates the settings of a data set.
    
    Specified by:
    
    updateDataset in interface AWSIoTAnalytics
    
    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
```
public UpdateDatastoreResult updateDatastore(UpdateDatastoreRequest request)
```
    Updates the settings of a data store.
    
    Specified by:
    
    updateDatastore in interface AWSIoTAnalytics
    
    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
```
public UpdatePipelineResult updatePipeline(UpdatePipelineRequest request)
```
    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.
    
    Specified by:
    
    updatePipeline in interface AWSIoTAnalytics
    
    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
  - getCachedResponseMetadata
```
public 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 the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSIoTAnalytics
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Class AWSIoTAnalyticsClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.iotanalytics.AWSIoTAnalytics

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Methods inherited from interface com.amazonaws.services.iotanalytics.AWSIoTAnalytics

Field Detail

configFactory

Method Detail

builder

batchPutMessage

cancelPipelineReprocessing

createChannel

createDataset

createDatasetContent

createDatastore

createPipeline

deleteChannel

deleteDataset

deleteDatasetContent

deleteDatastore

deletePipeline

describeChannel

describeDataset

describeDatastore

describeLoggingOptions

describePipeline

getDatasetContent

listChannels

listDatasetContents

listDatasets

listDatastores

listPipelines

listTagsForResource

putLoggingOptions

runPipelineActivity

sampleChannelData

startPipelineReprocessing

tagResource

untagResource

updateChannel

updateDataset

updateDatastore

updatePipeline

getCachedResponseMetadata