AbstractAWSIoTAnalytics (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.iotanalytics

Class AbstractAWSIoTAnalytics

java.lang.Object
- com.amazonaws.services.iotanalytics.AbstractAWSIoTAnalytics

All Implemented Interfaces:

AWSIoTAnalytics

Direct Known Subclasses:

AbstractAWSIoTAnalyticsAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSIoTAnalytics
extends Object
implements AWSIoTAnalytics 
```
Abstract implementation of AWSIoTAnalytics. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.iotanalytics.AWSIoTAnalytics
  ENDPOINT_PREFIX

Method Summary

All Methods
Modifier and Type	Method and Description
`BatchPutMessageResult`	`batchPutMessage (BatchPutMessageRequest request)` Sends messages to a channel.
`CancelPipelineReprocessingResult`	`cancelPipelineReprocessing (CancelPipelineReprocessingRequest request)` Cancels the reprocessing of data through the pipeline.
`CreateChannelResult`	`createChannel (CreateChannelRequest request)` Used to create a channel.
`CreateDatasetResult`	`createDataset (CreateDatasetRequest request)` Used to create a dataset.
`CreateDatasetContentResult`	`createDatasetContent (CreateDatasetContentRequest request)` Creates the content of a dataset 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 dataset.
`DeleteDatasetContentResult`	`deleteDatasetContent (DeleteDatasetContentRequest request)` Deletes the content of the specified dataset.
`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 dataset.
`DescribeDatastoreResult`	`describeDatastore (DescribeDatastoreRequest request)` Retrieves information about a data store.
`DescribeLoggingOptionsResult`	`describeLoggingOptions (DescribeLoggingOptionsRequest request)` Retrieves the current settings of the 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 dataset as presigned URIs.
`ListChannelsResult`	`listChannels (ListChannelsRequest request)` Retrieves a list of channels.
`ListDatasetContentsResult`	`listDatasetContents (ListDatasetContentsRequest request)` Lists information about dataset contents that have been created.
`ListDatasetsResult`	`listDatasets (ListDatasetsRequest request)` Retrieves information about datasets.
`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) that you have assigned to the resource.
`PutLoggingOptionsResult`	`putLoggingOptions (PutLoggingOptionsRequest request)` Sets or updates the 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.
`void`	`shutdown ()` Shuts down this client object, releasing any resources that might be held open.
`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)` Used to update the settings of a channel.
`UpdateDatasetResult`	`updateDataset (UpdateDatasetRequest request)` Updates the settings of a dataset.
`UpdateDatastoreResult`	`updateDatastore (UpdateDatastoreRequest request)` Used to update the settings of a data store.
`UpdatePipelineResult`	`updatePipeline (UpdatePipelineRequest request)` Updates the settings of a pipeline.

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

- Method Detail
  - batchPutMessage
```
public BatchPutMessageResult batchPutMessage(BatchPutMessageRequest request)
```
    Description copied from interface: AWSIoTAnalytics
    
    Sends messages to a channel.
    
    Specified by:
    
    batchPutMessage in interface AWSIoTAnalytics
    
    Returns:
    
    Result of the BatchPutMessage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - cancelPipelineReprocessing
```
public CancelPipelineReprocessingResult cancelPipelineReprocessing(CancelPipelineReprocessingRequest request)
```
    Description copied from interface: AWSIoTAnalytics
    
    Cancels the reprocessing of data through the pipeline.
    
    Specified by:
    
    cancelPipelineReprocessing in interface AWSIoTAnalytics
    
    Returns:
    
    Result of the CancelPipelineReprocessing operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createChannel
```
public CreateChannelResult createChannel(CreateChannelRequest request)
```
    Description copied from interface: AWSIoTAnalytics
    
    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.
    
    Specified by:
    
    createChannel in interface AWSIoTAnalytics
    
    Returns:
    
    Result of the CreateChannel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createDataset
```
public CreateDatasetResult createDataset(CreateDatasetRequest request)
```
    Description copied from interface: AWSIoTAnalytics
    
    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.
    
    Specified by:
    
    createDataset in interface AWSIoTAnalytics
    
    Returns:
    
    Result of the CreateDataset operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createDatasetContent
```
public CreateDatasetContentResult createDatasetContent(CreateDatasetContentRequest request)
```
    Description copied from interface: AWSIoTAnalytics
    
    Creates the content of a dataset by applying a queryAction (a SQL query) or a containerAction (executing a containerized application).
    
    Specified by:
    
    createDatasetContent in interface AWSIoTAnalytics
    
    Returns:
    
    Result of the CreateDatasetContent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createDatastore
```
public CreateDatastoreResult createDatastore(CreateDatastoreRequest request)
```
    Description copied from interface: AWSIoTAnalytics
    
    Creates a data store, which is a repository for messages.
    
    Specified by:
    
    createDatastore in interface AWSIoTAnalytics
    
    Returns:
    
    Result of the CreateDatastore operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createPipeline
```
public CreatePipelineResult createPipeline(CreatePipelineRequest request)
```
    Description copied from interface: AWSIoTAnalytics
    
    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.
    
    Specified by:
    
    createPipeline in interface AWSIoTAnalytics
    
    Returns:
    
    Result of the CreatePipeline operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteChannel
```
public DeleteChannelResult deleteChannel(DeleteChannelRequest request)
```
    Description copied from interface: AWSIoTAnalytics
    
    Deletes the specified channel.
    
    Specified by:
    
    deleteChannel in interface AWSIoTAnalytics
    
    Returns:
    
    Result of the DeleteChannel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteDataset
```
public DeleteDatasetResult deleteDataset(DeleteDatasetRequest request)
```
    Description copied from interface: AWSIoTAnalytics
    
    Deletes the specified dataset.
    
    You do not have to delete the content of the dataset before you perform this operation.
    
    Specified by:
    
    deleteDataset in interface AWSIoTAnalytics
    
    Returns:
    
    Result of the DeleteDataset operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteDatasetContent
```
public DeleteDatasetContentResult deleteDatasetContent(DeleteDatasetContentRequest request)
```
    Description copied from interface: AWSIoTAnalytics
    
    Deletes the content of the specified dataset.
    
    Specified by:
    
    deleteDatasetContent in interface AWSIoTAnalytics
    
    Returns:
    
    Result of the DeleteDatasetContent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteDatastore
```
public DeleteDatastoreResult deleteDatastore(DeleteDatastoreRequest request)
```
    Description copied from interface: AWSIoTAnalytics
    
    Deletes the specified data store.
    
    Specified by:
    
    deleteDatastore in interface AWSIoTAnalytics
    
    Returns:
    
    Result of the DeleteDatastore operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deletePipeline
```
public DeletePipelineResult deletePipeline(DeletePipelineRequest request)
```
    Description copied from interface: AWSIoTAnalytics
    
    Deletes the specified pipeline.
    
    Specified by:
    
    deletePipeline in interface AWSIoTAnalytics
    
    Returns:
    
    Result of the DeletePipeline operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeChannel
```
public DescribeChannelResult describeChannel(DescribeChannelRequest request)
```
    Description copied from interface: AWSIoTAnalytics
    
    Retrieves information about a channel.
    
    Specified by:
    
    describeChannel in interface AWSIoTAnalytics
    
    Returns:
    
    Result of the DescribeChannel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeDataset
```
public DescribeDatasetResult describeDataset(DescribeDatasetRequest request)
```
    Description copied from interface: AWSIoTAnalytics
    
    Retrieves information about a dataset.
    
    Specified by:
    
    describeDataset in interface AWSIoTAnalytics
    
    Returns:
    
    Result of the DescribeDataset operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeDatastore
```
public DescribeDatastoreResult describeDatastore(DescribeDatastoreRequest request)
```
    Description copied from interface: AWSIoTAnalytics
    
    Retrieves information about a data store.
    
    Specified by:
    
    describeDatastore in interface AWSIoTAnalytics
    
    Returns:
    
    Result of the DescribeDatastore operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeLoggingOptions
```
public DescribeLoggingOptionsResult describeLoggingOptions(DescribeLoggingOptionsRequest request)
```
    Description copied from interface: AWSIoTAnalytics
    
    Retrieves the current settings of the IoT Analytics logging options.
    
    Specified by:
    
    describeLoggingOptions in interface AWSIoTAnalytics
    
    Returns:
    
    Result of the DescribeLoggingOptions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describePipeline
```
public DescribePipelineResult describePipeline(DescribePipelineRequest request)
```
    Description copied from interface: AWSIoTAnalytics
    
    Retrieves information about a pipeline.
    
    Specified by:
    
    describePipeline in interface AWSIoTAnalytics
    
    Returns:
    
    Result of the DescribePipeline operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDatasetContent
```
public GetDatasetContentResult getDatasetContent(GetDatasetContentRequest request)
```
    Description copied from interface: AWSIoTAnalytics
    
    Retrieves the contents of a dataset as presigned URIs.
    
    Specified by:
    
    getDatasetContent in interface AWSIoTAnalytics
    
    Returns:
    
    Result of the GetDatasetContent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listChannels
```
public ListChannelsResult listChannels(ListChannelsRequest request)
```
    Description copied from interface: AWSIoTAnalytics
    
    Retrieves a list of channels.
    
    Specified by:
    
    listChannels in interface AWSIoTAnalytics
    
    Returns:
    
    Result of the ListChannels operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDatasetContents
```
public ListDatasetContentsResult listDatasetContents(ListDatasetContentsRequest request)
```
    Description copied from interface: AWSIoTAnalytics
    
    Lists information about dataset contents that have been created.
    
    Specified by:
    
    listDatasetContents in interface AWSIoTAnalytics
    
    Returns:
    
    Result of the ListDatasetContents operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDatasets
```
public ListDatasetsResult listDatasets(ListDatasetsRequest request)
```
    Description copied from interface: AWSIoTAnalytics
    
    Retrieves information about datasets.
    
    Specified by:
    
    listDatasets in interface AWSIoTAnalytics
    
    Returns:
    
    Result of the ListDatasets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDatastores
```
public ListDatastoresResult listDatastores(ListDatastoresRequest request)
```
    Description copied from interface: AWSIoTAnalytics
    
    Retrieves a list of data stores.
    
    Specified by:
    
    listDatastores in interface AWSIoTAnalytics
    
    Returns:
    
    Result of the ListDatastores operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listPipelines
```
public ListPipelinesResult listPipelines(ListPipelinesRequest request)
```
    Description copied from interface: AWSIoTAnalytics
    
    Retrieves a list of pipelines.
    
    Specified by:
    
    listPipelines in interface AWSIoTAnalytics
    
    Returns:
    
    Result of the ListPipelines operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AWSIoTAnalytics
    
    Lists the tags (metadata) that you have assigned to the resource.
    
    Specified by:
    
    listTagsForResource in interface AWSIoTAnalytics
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putLoggingOptions
```
public PutLoggingOptionsResult putLoggingOptions(PutLoggingOptionsRequest request)
```
    Description copied from interface: AWSIoTAnalytics
    
    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.
    
    Specified by:
    
    putLoggingOptions in interface AWSIoTAnalytics
    
    Returns:
    
    Result of the PutLoggingOptions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - runPipelineActivity
```
public RunPipelineActivityResult runPipelineActivity(RunPipelineActivityRequest request)
```
    Description copied from interface: AWSIoTAnalytics
    
    Simulates the results of running a pipeline activity on a message payload.
    
    Specified by:
    
    runPipelineActivity in interface AWSIoTAnalytics
    
    Returns:
    
    Result of the RunPipelineActivity operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - sampleChannelData
```
public SampleChannelDataResult sampleChannelData(SampleChannelDataRequest request)
```
    Description copied from interface: AWSIoTAnalytics
    
    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
    
    Returns:
    
    Result of the SampleChannelData operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startPipelineReprocessing
```
public StartPipelineReprocessingResult startPipelineReprocessing(StartPipelineReprocessingRequest request)
```
    Description copied from interface: AWSIoTAnalytics
    
    Starts the reprocessing of raw message data through the pipeline.
    
    Specified by:
    
    startPipelineReprocessing in interface AWSIoTAnalytics
    
    Returns:
    
    Result of the StartPipelineReprocessing operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AWSIoTAnalytics
    
    Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
    
    Specified by:
    
    tagResource in interface AWSIoTAnalytics
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AWSIoTAnalytics
    
    Removes the given tags (metadata) from the resource.
    
    Specified by:
    
    untagResource in interface AWSIoTAnalytics
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateChannel
```
public UpdateChannelResult updateChannel(UpdateChannelRequest request)
```
    Description copied from interface: AWSIoTAnalytics
    
    Used to update the settings of a channel.
    
    Specified by:
    
    updateChannel in interface AWSIoTAnalytics
    
    Returns:
    
    Result of the UpdateChannel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateDataset
```
public UpdateDatasetResult updateDataset(UpdateDatasetRequest request)
```
    Description copied from interface: AWSIoTAnalytics
    
    Updates the settings of a dataset.
    
    Specified by:
    
    updateDataset in interface AWSIoTAnalytics
    
    Returns:
    
    Result of the UpdateDataset operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateDatastore
```
public UpdateDatastoreResult updateDatastore(UpdateDatastoreRequest request)
```
    Description copied from interface: AWSIoTAnalytics
    
    Used to update the settings of a data store.
    
    Specified by:
    
    updateDatastore in interface AWSIoTAnalytics
    
    Returns:
    
    Result of the UpdateDatastore operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updatePipeline
```
public UpdatePipelineResult updatePipeline(UpdatePipelineRequest request)
```
    Description copied from interface: AWSIoTAnalytics
    
    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
    
    Returns:
    
    Result of the UpdatePipeline operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSIoTAnalytics
    
    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.
    
    Specified by:
    
    shutdown in interface AWSIoTAnalytics
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSIoTAnalytics
    
    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.
    
    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.

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class AbstractAWSIoTAnalytics

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

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

shutdown

getCachedResponseMetadata