com.amazonaws.services.iotanalytics.AWSIoTAnalytics Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-iotanalytics Show documentation
Show all versions of aws-java-sdk-iotanalytics Show documentation
The AWS Java SDK for AWS IoT Analytics module holds the client classes that are used for communicating with AWS IoT Analytics Service
/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.iotanalytics;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.iotanalytics.model.*;
/**
* Interface for accessing AWS IoT Analytics.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.iotanalytics.AbstractAWSIoTAnalytics} instead.
*
*
*
* 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. 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.
*
*
* IoT Analytics automates the steps required to analyze data from IoT devices. 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. 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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSIoTAnalytics {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "iotanalytics";
/**
*
* Sends messages to a channel.
*
*
* @param batchPutMessageRequest
* @return Result of the BatchPutMessage operation returned by the service.
* @throws ResourceNotFoundException
* A resource with the specified name could not be found.
* @throws InvalidRequestException
* The request was not valid.
* @throws InternalFailureException
* There was an internal failure.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSIoTAnalytics.BatchPutMessage
* @see AWS
* API Documentation
*/
BatchPutMessageResult batchPutMessage(BatchPutMessageRequest batchPutMessageRequest);
/**
*
* Cancels the reprocessing of data through the pipeline.
*
*
* @param cancelPipelineReprocessingRequest
* @return Result of the CancelPipelineReprocessing operation returned by the service.
* @throws ResourceNotFoundException
* A resource with the specified name could not be found.
* @throws InvalidRequestException
* The request was not valid.
* @throws InternalFailureException
* There was an internal failure.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSIoTAnalytics.CancelPipelineReprocessing
* @see AWS API Documentation
*/
CancelPipelineReprocessingResult cancelPipelineReprocessing(CancelPipelineReprocessingRequest cancelPipelineReprocessingRequest);
/**
*
* 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.
*
*
* @param createChannelRequest
* @return Result of the CreateChannel operation returned by the service.
* @throws InvalidRequestException
* The request was not valid.
* @throws ResourceAlreadyExistsException
* A resource with the same name already exists.
* @throws InternalFailureException
* There was an internal failure.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws LimitExceededException
* The command caused an internal limit to be exceeded.
* @sample AWSIoTAnalytics.CreateChannel
* @see AWS API
* Documentation
*/
CreateChannelResult createChannel(CreateChannelRequest createChannelRequest);
/**
*
* 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.
*
*
* @param createDatasetRequest
* @return Result of the CreateDataset operation returned by the service.
* @throws InvalidRequestException
* The request was not valid.
* @throws ResourceAlreadyExistsException
* A resource with the same name already exists.
* @throws InternalFailureException
* There was an internal failure.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws LimitExceededException
* The command caused an internal limit to be exceeded.
* @sample AWSIoTAnalytics.CreateDataset
* @see AWS API
* Documentation
*/
CreateDatasetResult createDataset(CreateDatasetRequest createDatasetRequest);
/**
*
* Creates the content of a dataset by applying a queryAction (a SQL query) or a
* containerAction (executing a containerized application).
*
*
* @param createDatasetContentRequest
* @return Result of the CreateDatasetContent operation returned by the service.
* @throws InvalidRequestException
* The request was not valid.
* @throws ResourceNotFoundException
* A resource with the specified name could not be found.
* @throws InternalFailureException
* There was an internal failure.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSIoTAnalytics.CreateDatasetContent
* @see AWS API Documentation
*/
CreateDatasetContentResult createDatasetContent(CreateDatasetContentRequest createDatasetContentRequest);
/**
*
* Creates a data store, which is a repository for messages.
*
*
* @param createDatastoreRequest
* @return Result of the CreateDatastore operation returned by the service.
* @throws InvalidRequestException
* The request was not valid.
* @throws ResourceAlreadyExistsException
* A resource with the same name already exists.
* @throws InternalFailureException
* There was an internal failure.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws LimitExceededException
* The command caused an internal limit to be exceeded.
* @sample AWSIoTAnalytics.CreateDatastore
* @see AWS
* API Documentation
*/
CreateDatastoreResult createDatastore(CreateDatastoreRequest createDatastoreRequest);
/**
*
* 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.
*
*
* @param createPipelineRequest
* @return Result of the CreatePipeline operation returned by the service.
* @throws InvalidRequestException
* The request was not valid.
* @throws ResourceAlreadyExistsException
* A resource with the same name already exists.
* @throws InternalFailureException
* There was an internal failure.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws LimitExceededException
* The command caused an internal limit to be exceeded.
* @sample AWSIoTAnalytics.CreatePipeline
* @see AWS
* API Documentation
*/
CreatePipelineResult createPipeline(CreatePipelineRequest createPipelineRequest);
/**
*
* Deletes the specified channel.
*
*
* @param deleteChannelRequest
* @return Result of the DeleteChannel operation returned by the service.
* @throws InvalidRequestException
* The request was not valid.
* @throws ResourceNotFoundException
* A resource with the specified name could not be found.
* @throws InternalFailureException
* There was an internal failure.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSIoTAnalytics.DeleteChannel
* @see AWS API
* Documentation
*/
DeleteChannelResult deleteChannel(DeleteChannelRequest deleteChannelRequest);
/**
*
* Deletes the specified dataset.
*
*
* You do not have to delete the content of the dataset before you perform this operation.
*
*
* @param deleteDatasetRequest
* @return Result of the DeleteDataset operation returned by the service.
* @throws InvalidRequestException
* The request was not valid.
* @throws ResourceNotFoundException
* A resource with the specified name could not be found.
* @throws InternalFailureException
* There was an internal failure.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSIoTAnalytics.DeleteDataset
* @see AWS API
* Documentation
*/
DeleteDatasetResult deleteDataset(DeleteDatasetRequest deleteDatasetRequest);
/**
*
* Deletes the content of the specified dataset.
*
*
* @param deleteDatasetContentRequest
* @return Result of the DeleteDatasetContent operation returned by the service.
* @throws InvalidRequestException
* The request was not valid.
* @throws ResourceNotFoundException
* A resource with the specified name could not be found.
* @throws InternalFailureException
* There was an internal failure.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSIoTAnalytics.DeleteDatasetContent
* @see AWS API Documentation
*/
DeleteDatasetContentResult deleteDatasetContent(DeleteDatasetContentRequest deleteDatasetContentRequest);
/**
*
* Deletes the specified data store.
*
*
* @param deleteDatastoreRequest
* @return Result of the DeleteDatastore operation returned by the service.
* @throws InvalidRequestException
* The request was not valid.
* @throws ResourceNotFoundException
* A resource with the specified name could not be found.
* @throws InternalFailureException
* There was an internal failure.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSIoTAnalytics.DeleteDatastore
* @see AWS
* API Documentation
*/
DeleteDatastoreResult deleteDatastore(DeleteDatastoreRequest deleteDatastoreRequest);
/**
*
* Deletes the specified pipeline.
*
*
* @param deletePipelineRequest
* @return Result of the DeletePipeline operation returned by the service.
* @throws InvalidRequestException
* The request was not valid.
* @throws ResourceNotFoundException
* A resource with the specified name could not be found.
* @throws InternalFailureException
* There was an internal failure.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSIoTAnalytics.DeletePipeline
* @see AWS
* API Documentation
*/
DeletePipelineResult deletePipeline(DeletePipelineRequest deletePipelineRequest);
/**
*
* Retrieves information about a channel.
*
*
* @param describeChannelRequest
* @return Result of the DescribeChannel operation returned by the service.
* @throws InvalidRequestException
* The request was not valid.
* @throws ResourceNotFoundException
* A resource with the specified name could not be found.
* @throws InternalFailureException
* There was an internal failure.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSIoTAnalytics.DescribeChannel
* @see AWS
* API Documentation
*/
DescribeChannelResult describeChannel(DescribeChannelRequest describeChannelRequest);
/**
*
* Retrieves information about a dataset.
*
*
* @param describeDatasetRequest
* @return Result of the DescribeDataset operation returned by the service.
* @throws InvalidRequestException
* The request was not valid.
* @throws ResourceNotFoundException
* A resource with the specified name could not be found.
* @throws InternalFailureException
* There was an internal failure.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSIoTAnalytics.DescribeDataset
* @see AWS
* API Documentation
*/
DescribeDatasetResult describeDataset(DescribeDatasetRequest describeDatasetRequest);
/**
*
* Retrieves information about a data store.
*
*
* @param describeDatastoreRequest
* @return Result of the DescribeDatastore operation returned by the service.
* @throws InvalidRequestException
* The request was not valid.
* @throws ResourceNotFoundException
* A resource with the specified name could not be found.
* @throws InternalFailureException
* There was an internal failure.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSIoTAnalytics.DescribeDatastore
* @see AWS
* API Documentation
*/
DescribeDatastoreResult describeDatastore(DescribeDatastoreRequest describeDatastoreRequest);
/**
*
* Retrieves the current settings of the IoT Analytics logging options.
*
*
* @param describeLoggingOptionsRequest
* @return Result of the DescribeLoggingOptions operation returned by the service.
* @throws InvalidRequestException
* The request was not valid.
* @throws ResourceNotFoundException
* A resource with the specified name could not be found.
* @throws InternalFailureException
* There was an internal failure.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSIoTAnalytics.DescribeLoggingOptions
* @see AWS API Documentation
*/
DescribeLoggingOptionsResult describeLoggingOptions(DescribeLoggingOptionsRequest describeLoggingOptionsRequest);
/**
*
* Retrieves information about a pipeline.
*
*
* @param describePipelineRequest
* @return Result of the DescribePipeline operation returned by the service.
* @throws InvalidRequestException
* The request was not valid.
* @throws ResourceNotFoundException
* A resource with the specified name could not be found.
* @throws InternalFailureException
* There was an internal failure.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSIoTAnalytics.DescribePipeline
* @see AWS
* API Documentation
*/
DescribePipelineResult describePipeline(DescribePipelineRequest describePipelineRequest);
/**
*
* Retrieves the contents of a dataset as presigned URIs.
*
*
* @param getDatasetContentRequest
* @return Result of the GetDatasetContent operation returned by the service.
* @throws InvalidRequestException
* The request was not valid.
* @throws ResourceNotFoundException
* A resource with the specified name could not be found.
* @throws InternalFailureException
* There was an internal failure.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSIoTAnalytics.GetDatasetContent
* @see AWS
* API Documentation
*/
GetDatasetContentResult getDatasetContent(GetDatasetContentRequest getDatasetContentRequest);
/**
*
* Retrieves a list of channels.
*
*
* @param listChannelsRequest
* @return Result of the ListChannels operation returned by the service.
* @throws InvalidRequestException
* The request was not valid.
* @throws InternalFailureException
* There was an internal failure.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSIoTAnalytics.ListChannels
* @see AWS API
* Documentation
*/
ListChannelsResult listChannels(ListChannelsRequest listChannelsRequest);
/**
*
* Lists information about dataset contents that have been created.
*
*
* @param listDatasetContentsRequest
* @return Result of the ListDatasetContents operation returned by the service.
* @throws InvalidRequestException
* The request was not valid.
* @throws InternalFailureException
* There was an internal failure.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ResourceNotFoundException
* A resource with the specified name could not be found.
* @sample AWSIoTAnalytics.ListDatasetContents
* @see AWS API Documentation
*/
ListDatasetContentsResult listDatasetContents(ListDatasetContentsRequest listDatasetContentsRequest);
/**
*
* Retrieves information about datasets.
*
*
* @param listDatasetsRequest
* @return Result of the ListDatasets operation returned by the service.
* @throws InvalidRequestException
* The request was not valid.
* @throws InternalFailureException
* There was an internal failure.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSIoTAnalytics.ListDatasets
* @see AWS API
* Documentation
*/
ListDatasetsResult listDatasets(ListDatasetsRequest listDatasetsRequest);
/**
*
* Retrieves a list of data stores.
*
*
* @param listDatastoresRequest
* @return Result of the ListDatastores operation returned by the service.
* @throws InvalidRequestException
* The request was not valid.
* @throws InternalFailureException
* There was an internal failure.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSIoTAnalytics.ListDatastores
* @see AWS
* API Documentation
*/
ListDatastoresResult listDatastores(ListDatastoresRequest listDatastoresRequest);
/**
*
* Retrieves a list of pipelines.
*
*
* @param listPipelinesRequest
* @return Result of the ListPipelines operation returned by the service.
* @throws InvalidRequestException
* The request was not valid.
* @throws InternalFailureException
* There was an internal failure.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSIoTAnalytics.ListPipelines
* @see AWS API
* Documentation
*/
ListPipelinesResult listPipelines(ListPipelinesRequest listPipelinesRequest);
/**
*
* Lists the tags (metadata) that you have assigned to the resource.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws InvalidRequestException
* The request was not valid.
* @throws InternalFailureException
* There was an internal failure.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws LimitExceededException
* The command caused an internal limit to be exceeded.
* @throws ResourceNotFoundException
* A resource with the specified name could not be found.
* @sample AWSIoTAnalytics.ListTagsForResource
* @see AWS API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* 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.
*
*
* @param putLoggingOptionsRequest
* @return Result of the PutLoggingOptions operation returned by the service.
* @throws InvalidRequestException
* The request was not valid.
* @throws InternalFailureException
* There was an internal failure.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSIoTAnalytics.PutLoggingOptions
* @see AWS
* API Documentation
*/
PutLoggingOptionsResult putLoggingOptions(PutLoggingOptionsRequest putLoggingOptionsRequest);
/**
*
* Simulates the results of running a pipeline activity on a message payload.
*
*
* @param runPipelineActivityRequest
* @return Result of the RunPipelineActivity operation returned by the service.
* @throws InvalidRequestException
* The request was not valid.
* @throws InternalFailureException
* There was an internal failure.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSIoTAnalytics.RunPipelineActivity
* @see AWS API Documentation
*/
RunPipelineActivityResult runPipelineActivity(RunPipelineActivityRequest runPipelineActivityRequest);
/**
*
* Retrieves a sample of messages from the specified channel ingested during the specified timeframe. Up to 10
* messages can be retrieved.
*
*
* @param sampleChannelDataRequest
* @return Result of the SampleChannelData operation returned by the service.
* @throws InvalidRequestException
* The request was not valid.
* @throws ResourceNotFoundException
* A resource with the specified name could not be found.
* @throws InternalFailureException
* There was an internal failure.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSIoTAnalytics.SampleChannelData
* @see AWS
* API Documentation
*/
SampleChannelDataResult sampleChannelData(SampleChannelDataRequest sampleChannelDataRequest);
/**
*
* Starts the reprocessing of raw message data through the pipeline.
*
*
* @param startPipelineReprocessingRequest
* @return Result of the StartPipelineReprocessing operation returned by the service.
* @throws ResourceNotFoundException
* A resource with the specified name could not be found.
* @throws ResourceAlreadyExistsException
* A resource with the same name already exists.
* @throws InvalidRequestException
* The request was not valid.
* @throws InternalFailureException
* There was an internal failure.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSIoTAnalytics.StartPipelineReprocessing
* @see AWS API Documentation
*/
StartPipelineReprocessingResult startPipelineReprocessing(StartPipelineReprocessingRequest startPipelineReprocessingRequest);
/**
*
* Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws InvalidRequestException
* The request was not valid.
* @throws InternalFailureException
* There was an internal failure.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws LimitExceededException
* The command caused an internal limit to be exceeded.
* @throws ResourceNotFoundException
* A resource with the specified name could not be found.
* @sample AWSIoTAnalytics.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Removes the given tags (metadata) from the resource.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws InvalidRequestException
* The request was not valid.
* @throws InternalFailureException
* There was an internal failure.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws LimitExceededException
* The command caused an internal limit to be exceeded.
* @throws ResourceNotFoundException
* A resource with the specified name could not be found.
* @sample AWSIoTAnalytics.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Used to update the settings of a channel.
*
*
* @param updateChannelRequest
* @return Result of the UpdateChannel operation returned by the service.
* @throws InvalidRequestException
* The request was not valid.
* @throws ResourceNotFoundException
* A resource with the specified name could not be found.
* @throws InternalFailureException
* There was an internal failure.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSIoTAnalytics.UpdateChannel
* @see AWS API
* Documentation
*/
UpdateChannelResult updateChannel(UpdateChannelRequest updateChannelRequest);
/**
*
* Updates the settings of a dataset.
*
*
* @param updateDatasetRequest
* @return Result of the UpdateDataset operation returned by the service.
* @throws InvalidRequestException
* The request was not valid.
* @throws ResourceNotFoundException
* A resource with the specified name could not be found.
* @throws InternalFailureException
* There was an internal failure.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSIoTAnalytics.UpdateDataset
* @see AWS API
* Documentation
*/
UpdateDatasetResult updateDataset(UpdateDatasetRequest updateDatasetRequest);
/**
*
* Used to update the settings of a data store.
*
*
* @param updateDatastoreRequest
* @return Result of the UpdateDatastore operation returned by the service.
* @throws InvalidRequestException
* The request was not valid.
* @throws ResourceNotFoundException
* A resource with the specified name could not be found.
* @throws InternalFailureException
* There was an internal failure.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSIoTAnalytics.UpdateDatastore
* @see AWS
* API Documentation
*/
UpdateDatastoreResult updateDatastore(UpdateDatastoreRequest updateDatastoreRequest);
/**
*
* 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.
*
*
* @param updatePipelineRequest
* @return Result of the UpdatePipeline operation returned by the service.
* @throws InvalidRequestException
* The request was not valid.
* @throws ResourceNotFoundException
* A resource with the specified name could not be found.
* @throws InternalFailureException
* There was an internal failure.
* @throws ServiceUnavailableException
* The service is temporarily unavailable.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws LimitExceededException
* The command caused an internal limit to be exceeded.
* @sample AWSIoTAnalytics.UpdatePipeline
* @see AWS
* API Documentation
*/
UpdatePipelineResult updatePipeline(UpdatePipelineRequest updatePipelineRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy