Interface IoTAnalyticsAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may
perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
call.
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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptiondefault CompletableFuture
<BatchPutMessageResponse> batchPutMessage
(Consumer<BatchPutMessageRequest.Builder> batchPutMessageRequest) Sends messages to a channel.default CompletableFuture
<BatchPutMessageResponse> batchPutMessage
(BatchPutMessageRequest batchPutMessageRequest) Sends messages to a channel.builder()
Create a builder that can be used to configure and create aIoTAnalyticsAsyncClient
.cancelPipelineReprocessing
(Consumer<CancelPipelineReprocessingRequest.Builder> cancelPipelineReprocessingRequest) Cancels the reprocessing of data through the pipeline.cancelPipelineReprocessing
(CancelPipelineReprocessingRequest cancelPipelineReprocessingRequest) Cancels the reprocessing of data through the pipeline.static IoTAnalyticsAsyncClient
create()
Create aIoTAnalyticsAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateChannelResponse> createChannel
(Consumer<CreateChannelRequest.Builder> createChannelRequest) Used to create a channel.default CompletableFuture
<CreateChannelResponse> createChannel
(CreateChannelRequest createChannelRequest) Used to create a channel.default CompletableFuture
<CreateDatasetResponse> createDataset
(Consumer<CreateDatasetRequest.Builder> createDatasetRequest) Used to create a dataset.default CompletableFuture
<CreateDatasetResponse> createDataset
(CreateDatasetRequest createDatasetRequest) Used to create a dataset.createDatasetContent
(Consumer<CreateDatasetContentRequest.Builder> createDatasetContentRequest) Creates the content of a dataset by applying aqueryAction
(a SQL query) or acontainerAction
(executing a containerized application).createDatasetContent
(CreateDatasetContentRequest createDatasetContentRequest) Creates the content of a dataset by applying aqueryAction
(a SQL query) or acontainerAction
(executing a containerized application).default CompletableFuture
<CreateDatastoreResponse> createDatastore
(Consumer<CreateDatastoreRequest.Builder> createDatastoreRequest) Creates a data store, which is a repository for messages.default CompletableFuture
<CreateDatastoreResponse> createDatastore
(CreateDatastoreRequest createDatastoreRequest) Creates a data store, which is a repository for messages.default CompletableFuture
<CreatePipelineResponse> createPipeline
(Consumer<CreatePipelineRequest.Builder> createPipelineRequest) Creates a pipeline.default CompletableFuture
<CreatePipelineResponse> createPipeline
(CreatePipelineRequest createPipelineRequest) Creates a pipeline.default CompletableFuture
<DeleteChannelResponse> deleteChannel
(Consumer<DeleteChannelRequest.Builder> deleteChannelRequest) Deletes the specified channel.default CompletableFuture
<DeleteChannelResponse> deleteChannel
(DeleteChannelRequest deleteChannelRequest) Deletes the specified channel.default CompletableFuture
<DeleteDatasetResponse> deleteDataset
(Consumer<DeleteDatasetRequest.Builder> deleteDatasetRequest) Deletes the specified dataset.default CompletableFuture
<DeleteDatasetResponse> deleteDataset
(DeleteDatasetRequest deleteDatasetRequest) Deletes the specified dataset.deleteDatasetContent
(Consumer<DeleteDatasetContentRequest.Builder> deleteDatasetContentRequest) Deletes the content of the specified dataset.deleteDatasetContent
(DeleteDatasetContentRequest deleteDatasetContentRequest) Deletes the content of the specified dataset.default CompletableFuture
<DeleteDatastoreResponse> deleteDatastore
(Consumer<DeleteDatastoreRequest.Builder> deleteDatastoreRequest) Deletes the specified data store.default CompletableFuture
<DeleteDatastoreResponse> deleteDatastore
(DeleteDatastoreRequest deleteDatastoreRequest) Deletes the specified data store.default CompletableFuture
<DeletePipelineResponse> deletePipeline
(Consumer<DeletePipelineRequest.Builder> deletePipelineRequest) Deletes the specified pipeline.default CompletableFuture
<DeletePipelineResponse> deletePipeline
(DeletePipelineRequest deletePipelineRequest) Deletes the specified pipeline.default CompletableFuture
<DescribeChannelResponse> describeChannel
(Consumer<DescribeChannelRequest.Builder> describeChannelRequest) Retrieves information about a channel.default CompletableFuture
<DescribeChannelResponse> describeChannel
(DescribeChannelRequest describeChannelRequest) Retrieves information about a channel.default CompletableFuture
<DescribeDatasetResponse> describeDataset
(Consumer<DescribeDatasetRequest.Builder> describeDatasetRequest) Retrieves information about a dataset.default CompletableFuture
<DescribeDatasetResponse> describeDataset
(DescribeDatasetRequest describeDatasetRequest) Retrieves information about a dataset.describeDatastore
(Consumer<DescribeDatastoreRequest.Builder> describeDatastoreRequest) Retrieves information about a data store.describeDatastore
(DescribeDatastoreRequest describeDatastoreRequest) Retrieves information about a data store.describeLoggingOptions
(Consumer<DescribeLoggingOptionsRequest.Builder> describeLoggingOptionsRequest) Retrieves the current settings of the IoT Analytics logging options.describeLoggingOptions
(DescribeLoggingOptionsRequest describeLoggingOptionsRequest) Retrieves the current settings of the IoT Analytics logging options.describePipeline
(Consumer<DescribePipelineRequest.Builder> describePipelineRequest) Retrieves information about a pipeline.describePipeline
(DescribePipelineRequest describePipelineRequest) Retrieves information about a pipeline.getDatasetContent
(Consumer<GetDatasetContentRequest.Builder> getDatasetContentRequest) Retrieves the contents of a dataset as presigned URIs.getDatasetContent
(GetDatasetContentRequest getDatasetContentRequest) Retrieves the contents of a dataset as presigned URIs.default CompletableFuture
<ListChannelsResponse> Retrieves a list of channels.default CompletableFuture
<ListChannelsResponse> listChannels
(Consumer<ListChannelsRequest.Builder> listChannelsRequest) Retrieves a list of channels.default CompletableFuture
<ListChannelsResponse> listChannels
(ListChannelsRequest listChannelsRequest) Retrieves a list of channels.default ListChannelsPublisher
This is a variant oflistChannels(software.amazon.awssdk.services.iotanalytics.model.ListChannelsRequest)
operation.default ListChannelsPublisher
listChannelsPaginator
(Consumer<ListChannelsRequest.Builder> listChannelsRequest) This is a variant oflistChannels(software.amazon.awssdk.services.iotanalytics.model.ListChannelsRequest)
operation.default ListChannelsPublisher
listChannelsPaginator
(ListChannelsRequest listChannelsRequest) This is a variant oflistChannels(software.amazon.awssdk.services.iotanalytics.model.ListChannelsRequest)
operation.listDatasetContents
(Consumer<ListDatasetContentsRequest.Builder> listDatasetContentsRequest) Lists information about dataset contents that have been created.listDatasetContents
(ListDatasetContentsRequest listDatasetContentsRequest) Lists information about dataset contents that have been created.default ListDatasetContentsPublisher
listDatasetContentsPaginator
(Consumer<ListDatasetContentsRequest.Builder> listDatasetContentsRequest) This is a variant oflistDatasetContents(software.amazon.awssdk.services.iotanalytics.model.ListDatasetContentsRequest)
operation.default ListDatasetContentsPublisher
listDatasetContentsPaginator
(ListDatasetContentsRequest listDatasetContentsRequest) This is a variant oflistDatasetContents(software.amazon.awssdk.services.iotanalytics.model.ListDatasetContentsRequest)
operation.default CompletableFuture
<ListDatasetsResponse> Retrieves information about datasets.default CompletableFuture
<ListDatasetsResponse> listDatasets
(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest) Retrieves information about datasets.default CompletableFuture
<ListDatasetsResponse> listDatasets
(ListDatasetsRequest listDatasetsRequest) Retrieves information about datasets.default ListDatasetsPublisher
This is a variant oflistDatasets(software.amazon.awssdk.services.iotanalytics.model.ListDatasetsRequest)
operation.default ListDatasetsPublisher
listDatasetsPaginator
(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest) This is a variant oflistDatasets(software.amazon.awssdk.services.iotanalytics.model.ListDatasetsRequest)
operation.default ListDatasetsPublisher
listDatasetsPaginator
(ListDatasetsRequest listDatasetsRequest) This is a variant oflistDatasets(software.amazon.awssdk.services.iotanalytics.model.ListDatasetsRequest)
operation.default CompletableFuture
<ListDatastoresResponse> Retrieves a list of data stores.default CompletableFuture
<ListDatastoresResponse> listDatastores
(Consumer<ListDatastoresRequest.Builder> listDatastoresRequest) Retrieves a list of data stores.default CompletableFuture
<ListDatastoresResponse> listDatastores
(ListDatastoresRequest listDatastoresRequest) Retrieves a list of data stores.default ListDatastoresPublisher
This is a variant oflistDatastores(software.amazon.awssdk.services.iotanalytics.model.ListDatastoresRequest)
operation.default ListDatastoresPublisher
listDatastoresPaginator
(Consumer<ListDatastoresRequest.Builder> listDatastoresRequest) This is a variant oflistDatastores(software.amazon.awssdk.services.iotanalytics.model.ListDatastoresRequest)
operation.default ListDatastoresPublisher
listDatastoresPaginator
(ListDatastoresRequest listDatastoresRequest) This is a variant oflistDatastores(software.amazon.awssdk.services.iotanalytics.model.ListDatastoresRequest)
operation.default CompletableFuture
<ListPipelinesResponse> Retrieves a list of pipelines.default CompletableFuture
<ListPipelinesResponse> listPipelines
(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest) Retrieves a list of pipelines.default CompletableFuture
<ListPipelinesResponse> listPipelines
(ListPipelinesRequest listPipelinesRequest) Retrieves a list of pipelines.default ListPipelinesPublisher
This is a variant oflistPipelines(software.amazon.awssdk.services.iotanalytics.model.ListPipelinesRequest)
operation.default ListPipelinesPublisher
listPipelinesPaginator
(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest) This is a variant oflistPipelines(software.amazon.awssdk.services.iotanalytics.model.ListPipelinesRequest)
operation.default ListPipelinesPublisher
listPipelinesPaginator
(ListPipelinesRequest listPipelinesRequest) This is a variant oflistPipelines(software.amazon.awssdk.services.iotanalytics.model.ListPipelinesRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags (metadata) that you have assigned to the resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags (metadata) that you have assigned to the resource.putLoggingOptions
(Consumer<PutLoggingOptionsRequest.Builder> putLoggingOptionsRequest) Sets or updates the IoT Analytics logging options.putLoggingOptions
(PutLoggingOptionsRequest putLoggingOptionsRequest) Sets or updates the IoT Analytics logging options.runPipelineActivity
(Consumer<RunPipelineActivityRequest.Builder> runPipelineActivityRequest) Simulates the results of running a pipeline activity on a message payload.runPipelineActivity
(RunPipelineActivityRequest runPipelineActivityRequest) Simulates the results of running a pipeline activity on a message payload.sampleChannelData
(Consumer<SampleChannelDataRequest.Builder> sampleChannelDataRequest) Retrieves a sample of messages from the specified channel ingested during the specified timeframe.sampleChannelData
(SampleChannelDataRequest sampleChannelDataRequest) Retrieves a sample of messages from the specified channel ingested during the specified timeframe.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartPipelineReprocessing
(Consumer<StartPipelineReprocessingRequest.Builder> startPipelineReprocessingRequest) Starts the reprocessing of raw message data through the pipeline.startPipelineReprocessing
(StartPipelineReprocessingRequest startPipelineReprocessingRequest) Starts the reprocessing of raw message data through the pipeline.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds to or modifies the tags of the given resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Adds to or modifies the tags of the given resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the given tags (metadata) from the resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes the given tags (metadata) from the resource.default CompletableFuture
<UpdateChannelResponse> updateChannel
(Consumer<UpdateChannelRequest.Builder> updateChannelRequest) Used to update the settings of a channel.default CompletableFuture
<UpdateChannelResponse> updateChannel
(UpdateChannelRequest updateChannelRequest) Used to update the settings of a channel.default CompletableFuture
<UpdateDatasetResponse> updateDataset
(Consumer<UpdateDatasetRequest.Builder> updateDatasetRequest) Updates the settings of a dataset.default CompletableFuture
<UpdateDatasetResponse> updateDataset
(UpdateDatasetRequest updateDatasetRequest) Updates the settings of a dataset.default CompletableFuture
<UpdateDatastoreResponse> updateDatastore
(Consumer<UpdateDatastoreRequest.Builder> updateDatastoreRequest) Used to update the settings of a data store.default CompletableFuture
<UpdateDatastoreResponse> updateDatastore
(UpdateDatastoreRequest updateDatastoreRequest) Used to update the settings of a data store.default CompletableFuture
<UpdatePipelineResponse> updatePipeline
(Consumer<UpdatePipelineRequest.Builder> updatePipelineRequest) Updates the settings of a pipeline.default CompletableFuture
<UpdatePipelineResponse> updatePipeline
(UpdatePipelineRequest updatePipelineRequest) Updates the settings of a pipeline.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
batchPutMessage
default CompletableFuture<BatchPutMessageResponse> batchPutMessage(BatchPutMessageRequest batchPutMessageRequest) Sends messages to a channel.
- Parameters:
batchPutMessageRequest
-- Returns:
- A Java Future containing the result of the BatchPutMessage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchPutMessage
default CompletableFuture<BatchPutMessageResponse> batchPutMessage(Consumer<BatchPutMessageRequest.Builder> batchPutMessageRequest) Sends messages to a channel.
This is a convenience which creates an instance of the
BatchPutMessageRequest.Builder
avoiding the need to create one manually viaBatchPutMessageRequest.builder()
- Parameters:
batchPutMessageRequest
- AConsumer
that will call methods onBatchPutMessageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchPutMessage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelPipelineReprocessing
default CompletableFuture<CancelPipelineReprocessingResponse> cancelPipelineReprocessing(CancelPipelineReprocessingRequest cancelPipelineReprocessingRequest) Cancels the reprocessing of data through the pipeline.
- Parameters:
cancelPipelineReprocessingRequest
-- Returns:
- A Java Future containing the result of the CancelPipelineReprocessing operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelPipelineReprocessing
default CompletableFuture<CancelPipelineReprocessingResponse> cancelPipelineReprocessing(Consumer<CancelPipelineReprocessingRequest.Builder> cancelPipelineReprocessingRequest) Cancels the reprocessing of data through the pipeline.
This is a convenience which creates an instance of the
CancelPipelineReprocessingRequest.Builder
avoiding the need to create one manually viaCancelPipelineReprocessingRequest.builder()
- Parameters:
cancelPipelineReprocessingRequest
- AConsumer
that will call methods onCancelPipelineReprocessingRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CancelPipelineReprocessing operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createChannel
default CompletableFuture<CreateChannelResponse> createChannel(CreateChannelRequest createChannelRequest) 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.
- Parameters:
createChannelRequest
-- Returns:
- A Java Future containing the result of the CreateChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createChannel
default CompletableFuture<CreateChannelResponse> createChannel(Consumer<CreateChannelRequest.Builder> createChannelRequest) 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.
This is a convenience which creates an instance of the
CreateChannelRequest.Builder
avoiding the need to create one manually viaCreateChannelRequest.builder()
- Parameters:
createChannelRequest
- AConsumer
that will call methods onCreateChannelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDataset
default CompletableFuture<CreateDatasetResponse> createDataset(CreateDatasetRequest createDatasetRequest) Used to create a dataset. A dataset stores data retrieved from a data store by applying a
queryAction
(a SQL query) or acontainerAction
(executing a containerized application). This operation creates the skeleton of a dataset. The dataset can be populated manually by callingCreateDatasetContent
or automatically according to a trigger you specify.- Parameters:
createDatasetRequest
-- Returns:
- A Java Future containing the result of the CreateDataset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDataset
default CompletableFuture<CreateDatasetResponse> createDataset(Consumer<CreateDatasetRequest.Builder> createDatasetRequest) Used to create a dataset. A dataset stores data retrieved from a data store by applying a
queryAction
(a SQL query) or acontainerAction
(executing a containerized application). This operation creates the skeleton of a dataset. The dataset can be populated manually by callingCreateDatasetContent
or automatically according to a trigger you specify.
This is a convenience which creates an instance of the
CreateDatasetRequest.Builder
avoiding the need to create one manually viaCreateDatasetRequest.builder()
- Parameters:
createDatasetRequest
- AConsumer
that will call methods onCreateDatasetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDataset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDatasetContent
default CompletableFuture<CreateDatasetContentResponse> createDatasetContent(CreateDatasetContentRequest createDatasetContentRequest) Creates the content of a dataset by applying a
queryAction
(a SQL query) or acontainerAction
(executing a containerized application).- Parameters:
createDatasetContentRequest
-- Returns:
- A Java Future containing the result of the CreateDatasetContent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDatasetContent
default CompletableFuture<CreateDatasetContentResponse> createDatasetContent(Consumer<CreateDatasetContentRequest.Builder> createDatasetContentRequest) Creates the content of a dataset by applying a
queryAction
(a SQL query) or acontainerAction
(executing a containerized application).
This is a convenience which creates an instance of the
CreateDatasetContentRequest.Builder
avoiding the need to create one manually viaCreateDatasetContentRequest.builder()
- Parameters:
createDatasetContentRequest
- AConsumer
that will call methods onCreateDatasetContentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDatasetContent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDatastore
default CompletableFuture<CreateDatastoreResponse> createDatastore(CreateDatastoreRequest createDatastoreRequest) Creates a data store, which is a repository for messages.
- Parameters:
createDatastoreRequest
-- Returns:
- A Java Future containing the result of the CreateDatastore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDatastore
default CompletableFuture<CreateDatastoreResponse> createDatastore(Consumer<CreateDatastoreRequest.Builder> createDatastoreRequest) Creates a data store, which is a repository for messages.
This is a convenience which creates an instance of the
CreateDatastoreRequest.Builder
avoiding the need to create one manually viaCreateDatastoreRequest.builder()
- Parameters:
createDatastoreRequest
- AConsumer
that will call methods onCreateDatastoreRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDatastore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPipeline
default CompletableFuture<CreatePipelineResponse> createPipeline(CreatePipelineRequest createPipelineRequest) 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 adatastore
activity and, optionally, as many as 23 additional activities in thepipelineActivities
array.- Parameters:
createPipelineRequest
-- Returns:
- A Java Future containing the result of the CreatePipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPipeline
default CompletableFuture<CreatePipelineResponse> createPipeline(Consumer<CreatePipelineRequest.Builder> createPipelineRequest) 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 adatastore
activity and, optionally, as many as 23 additional activities in thepipelineActivities
array.
This is a convenience which creates an instance of the
CreatePipelineRequest.Builder
avoiding the need to create one manually viaCreatePipelineRequest.builder()
- Parameters:
createPipelineRequest
- AConsumer
that will call methods onCreatePipelineRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreatePipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteChannel
default CompletableFuture<DeleteChannelResponse> deleteChannel(DeleteChannelRequest deleteChannelRequest) Deletes the specified channel.
- Parameters:
deleteChannelRequest
-- Returns:
- A Java Future containing the result of the DeleteChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteChannel
default CompletableFuture<DeleteChannelResponse> deleteChannel(Consumer<DeleteChannelRequest.Builder> deleteChannelRequest) Deletes the specified channel.
This is a convenience which creates an instance of the
DeleteChannelRequest.Builder
avoiding the need to create one manually viaDeleteChannelRequest.builder()
- Parameters:
deleteChannelRequest
- AConsumer
that will call methods onDeleteChannelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDataset
default CompletableFuture<DeleteDatasetResponse> deleteDataset(DeleteDatasetRequest deleteDatasetRequest) Deletes the specified dataset.
You do not have to delete the content of the dataset before you perform this operation.
- Parameters:
deleteDatasetRequest
-- Returns:
- A Java Future containing the result of the DeleteDataset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDataset
default CompletableFuture<DeleteDatasetResponse> deleteDataset(Consumer<DeleteDatasetRequest.Builder> deleteDatasetRequest) Deletes the specified dataset.
You do not have to delete the content of the dataset before you perform this operation.
This is a convenience which creates an instance of the
DeleteDatasetRequest.Builder
avoiding the need to create one manually viaDeleteDatasetRequest.builder()
- Parameters:
deleteDatasetRequest
- AConsumer
that will call methods onDeleteDatasetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDataset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDatasetContent
default CompletableFuture<DeleteDatasetContentResponse> deleteDatasetContent(DeleteDatasetContentRequest deleteDatasetContentRequest) Deletes the content of the specified dataset.
- Parameters:
deleteDatasetContentRequest
-- Returns:
- A Java Future containing the result of the DeleteDatasetContent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDatasetContent
default CompletableFuture<DeleteDatasetContentResponse> deleteDatasetContent(Consumer<DeleteDatasetContentRequest.Builder> deleteDatasetContentRequest) Deletes the content of the specified dataset.
This is a convenience which creates an instance of the
DeleteDatasetContentRequest.Builder
avoiding the need to create one manually viaDeleteDatasetContentRequest.builder()
- Parameters:
deleteDatasetContentRequest
- AConsumer
that will call methods onDeleteDatasetContentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDatasetContent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDatastore
default CompletableFuture<DeleteDatastoreResponse> deleteDatastore(DeleteDatastoreRequest deleteDatastoreRequest) Deletes the specified data store.
- Parameters:
deleteDatastoreRequest
-- Returns:
- A Java Future containing the result of the DeleteDatastore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDatastore
default CompletableFuture<DeleteDatastoreResponse> deleteDatastore(Consumer<DeleteDatastoreRequest.Builder> deleteDatastoreRequest) Deletes the specified data store.
This is a convenience which creates an instance of the
DeleteDatastoreRequest.Builder
avoiding the need to create one manually viaDeleteDatastoreRequest.builder()
- Parameters:
deleteDatastoreRequest
- AConsumer
that will call methods onDeleteDatastoreRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDatastore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePipeline
default CompletableFuture<DeletePipelineResponse> deletePipeline(DeletePipelineRequest deletePipelineRequest) Deletes the specified pipeline.
- Parameters:
deletePipelineRequest
-- Returns:
- A Java Future containing the result of the DeletePipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePipeline
default CompletableFuture<DeletePipelineResponse> deletePipeline(Consumer<DeletePipelineRequest.Builder> deletePipelineRequest) Deletes the specified pipeline.
This is a convenience which creates an instance of the
DeletePipelineRequest.Builder
avoiding the need to create one manually viaDeletePipelineRequest.builder()
- Parameters:
deletePipelineRequest
- AConsumer
that will call methods onDeletePipelineRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeletePipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeChannel
default CompletableFuture<DescribeChannelResponse> describeChannel(DescribeChannelRequest describeChannelRequest) Retrieves information about a channel.
- Parameters:
describeChannelRequest
-- Returns:
- A Java Future containing the result of the DescribeChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeChannel
default CompletableFuture<DescribeChannelResponse> describeChannel(Consumer<DescribeChannelRequest.Builder> describeChannelRequest) Retrieves information about a channel.
This is a convenience which creates an instance of the
DescribeChannelRequest.Builder
avoiding the need to create one manually viaDescribeChannelRequest.builder()
- Parameters:
describeChannelRequest
- AConsumer
that will call methods onDescribeChannelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDataset
default CompletableFuture<DescribeDatasetResponse> describeDataset(DescribeDatasetRequest describeDatasetRequest) Retrieves information about a dataset.
- Parameters:
describeDatasetRequest
-- Returns:
- A Java Future containing the result of the DescribeDataset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDataset
default CompletableFuture<DescribeDatasetResponse> describeDataset(Consumer<DescribeDatasetRequest.Builder> describeDatasetRequest) Retrieves information about a dataset.
This is a convenience which creates an instance of the
DescribeDatasetRequest.Builder
avoiding the need to create one manually viaDescribeDatasetRequest.builder()
- Parameters:
describeDatasetRequest
- AConsumer
that will call methods onDescribeDatasetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDataset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDatastore
default CompletableFuture<DescribeDatastoreResponse> describeDatastore(DescribeDatastoreRequest describeDatastoreRequest) Retrieves information about a data store.
- Parameters:
describeDatastoreRequest
-- Returns:
- A Java Future containing the result of the DescribeDatastore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDatastore
default CompletableFuture<DescribeDatastoreResponse> describeDatastore(Consumer<DescribeDatastoreRequest.Builder> describeDatastoreRequest) Retrieves information about a data store.
This is a convenience which creates an instance of the
DescribeDatastoreRequest.Builder
avoiding the need to create one manually viaDescribeDatastoreRequest.builder()
- Parameters:
describeDatastoreRequest
- AConsumer
that will call methods onDescribeDatastoreRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDatastore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeLoggingOptions
default CompletableFuture<DescribeLoggingOptionsResponse> describeLoggingOptions(DescribeLoggingOptionsRequest describeLoggingOptionsRequest) Retrieves the current settings of the IoT Analytics logging options.
- Parameters:
describeLoggingOptionsRequest
-- Returns:
- A Java Future containing the result of the DescribeLoggingOptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeLoggingOptions
default CompletableFuture<DescribeLoggingOptionsResponse> describeLoggingOptions(Consumer<DescribeLoggingOptionsRequest.Builder> describeLoggingOptionsRequest) Retrieves the current settings of the IoT Analytics logging options.
This is a convenience which creates an instance of the
DescribeLoggingOptionsRequest.Builder
avoiding the need to create one manually viaDescribeLoggingOptionsRequest.builder()
- Parameters:
describeLoggingOptionsRequest
- AConsumer
that will call methods onDescribeLoggingOptionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeLoggingOptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePipeline
default CompletableFuture<DescribePipelineResponse> describePipeline(DescribePipelineRequest describePipelineRequest) Retrieves information about a pipeline.
- Parameters:
describePipelineRequest
-- Returns:
- A Java Future containing the result of the DescribePipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePipeline
default CompletableFuture<DescribePipelineResponse> describePipeline(Consumer<DescribePipelineRequest.Builder> describePipelineRequest) Retrieves information about a pipeline.
This is a convenience which creates an instance of the
DescribePipelineRequest.Builder
avoiding the need to create one manually viaDescribePipelineRequest.builder()
- Parameters:
describePipelineRequest
- AConsumer
that will call methods onDescribePipelineRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribePipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDatasetContent
default CompletableFuture<GetDatasetContentResponse> getDatasetContent(GetDatasetContentRequest getDatasetContentRequest) Retrieves the contents of a dataset as presigned URIs.
- Parameters:
getDatasetContentRequest
-- Returns:
- A Java Future containing the result of the GetDatasetContent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDatasetContent
default CompletableFuture<GetDatasetContentResponse> getDatasetContent(Consumer<GetDatasetContentRequest.Builder> getDatasetContentRequest) Retrieves the contents of a dataset as presigned URIs.
This is a convenience which creates an instance of the
GetDatasetContentRequest.Builder
avoiding the need to create one manually viaGetDatasetContentRequest.builder()
- Parameters:
getDatasetContentRequest
- AConsumer
that will call methods onGetDatasetContentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetDatasetContent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannels
default CompletableFuture<ListChannelsResponse> listChannels(ListChannelsRequest listChannelsRequest) Retrieves a list of channels.
- Parameters:
listChannelsRequest
-- Returns:
- A Java Future containing the result of the ListChannels operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannels
default CompletableFuture<ListChannelsResponse> listChannels(Consumer<ListChannelsRequest.Builder> listChannelsRequest) Retrieves a list of channels.
This is a convenience which creates an instance of the
ListChannelsRequest.Builder
avoiding the need to create one manually viaListChannelsRequest.builder()
- Parameters:
listChannelsRequest
- AConsumer
that will call methods onListChannelsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListChannels operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannels
Retrieves a list of channels.
- Returns:
- A Java Future containing the result of the ListChannels operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelsPaginator
This is a variant of
listChannels(software.amazon.awssdk.services.iotanalytics.model.ListChannelsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iotanalytics.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iotanalytics.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotanalytics.model.ListChannelsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iotanalytics.model.ListChannelsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannels(software.amazon.awssdk.services.iotanalytics.model.ListChannelsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelsPaginator
This is a variant of
listChannels(software.amazon.awssdk.services.iotanalytics.model.ListChannelsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iotanalytics.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iotanalytics.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotanalytics.model.ListChannelsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iotanalytics.model.ListChannelsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannels(software.amazon.awssdk.services.iotanalytics.model.ListChannelsRequest)
operation.- Parameters:
listChannelsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelsPaginator
default ListChannelsPublisher listChannelsPaginator(Consumer<ListChannelsRequest.Builder> listChannelsRequest) This is a variant of
listChannels(software.amazon.awssdk.services.iotanalytics.model.ListChannelsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iotanalytics.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iotanalytics.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotanalytics.model.ListChannelsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iotanalytics.model.ListChannelsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannels(software.amazon.awssdk.services.iotanalytics.model.ListChannelsRequest)
operation.
This is a convenience which creates an instance of the
ListChannelsRequest.Builder
avoiding the need to create one manually viaListChannelsRequest.builder()
- Parameters:
listChannelsRequest
- AConsumer
that will call methods onListChannelsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDatasetContents
default CompletableFuture<ListDatasetContentsResponse> listDatasetContents(ListDatasetContentsRequest listDatasetContentsRequest) Lists information about dataset contents that have been created.
- Parameters:
listDatasetContentsRequest
-- Returns:
- A Java Future containing the result of the ListDatasetContents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDatasetContents
default CompletableFuture<ListDatasetContentsResponse> listDatasetContents(Consumer<ListDatasetContentsRequest.Builder> listDatasetContentsRequest) Lists information about dataset contents that have been created.
This is a convenience which creates an instance of the
ListDatasetContentsRequest.Builder
avoiding the need to create one manually viaListDatasetContentsRequest.builder()
- Parameters:
listDatasetContentsRequest
- AConsumer
that will call methods onListDatasetContentsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListDatasetContents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDatasetContentsPaginator
default ListDatasetContentsPublisher listDatasetContentsPaginator(ListDatasetContentsRequest listDatasetContentsRequest) This is a variant of
listDatasetContents(software.amazon.awssdk.services.iotanalytics.model.ListDatasetContentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iotanalytics.paginators.ListDatasetContentsPublisher publisher = client.listDatasetContentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iotanalytics.paginators.ListDatasetContentsPublisher publisher = client.listDatasetContentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotanalytics.model.ListDatasetContentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iotanalytics.model.ListDatasetContentsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasetContents(software.amazon.awssdk.services.iotanalytics.model.ListDatasetContentsRequest)
operation.- Parameters:
listDatasetContentsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDatasetContentsPaginator
default ListDatasetContentsPublisher listDatasetContentsPaginator(Consumer<ListDatasetContentsRequest.Builder> listDatasetContentsRequest) This is a variant of
listDatasetContents(software.amazon.awssdk.services.iotanalytics.model.ListDatasetContentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iotanalytics.paginators.ListDatasetContentsPublisher publisher = client.listDatasetContentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iotanalytics.paginators.ListDatasetContentsPublisher publisher = client.listDatasetContentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotanalytics.model.ListDatasetContentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iotanalytics.model.ListDatasetContentsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasetContents(software.amazon.awssdk.services.iotanalytics.model.ListDatasetContentsRequest)
operation.
This is a convenience which creates an instance of the
ListDatasetContentsRequest.Builder
avoiding the need to create one manually viaListDatasetContentsRequest.builder()
- Parameters:
listDatasetContentsRequest
- AConsumer
that will call methods onListDatasetContentsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDatasets
default CompletableFuture<ListDatasetsResponse> listDatasets(ListDatasetsRequest listDatasetsRequest) Retrieves information about datasets.
- Parameters:
listDatasetsRequest
-- Returns:
- A Java Future containing the result of the ListDatasets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDatasets
default CompletableFuture<ListDatasetsResponse> listDatasets(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest) Retrieves information about datasets.
This is a convenience which creates an instance of the
ListDatasetsRequest.Builder
avoiding the need to create one manually viaListDatasetsRequest.builder()
- Parameters:
listDatasetsRequest
- AConsumer
that will call methods onListDatasetsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListDatasets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDatasets
Retrieves information about datasets.
- Returns:
- A Java Future containing the result of the ListDatasets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDatasetsPaginator
This is a variant of
listDatasets(software.amazon.awssdk.services.iotanalytics.model.ListDatasetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iotanalytics.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iotanalytics.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotanalytics.model.ListDatasetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iotanalytics.model.ListDatasetsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasets(software.amazon.awssdk.services.iotanalytics.model.ListDatasetsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDatasetsPaginator
This is a variant of
listDatasets(software.amazon.awssdk.services.iotanalytics.model.ListDatasetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iotanalytics.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iotanalytics.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotanalytics.model.ListDatasetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iotanalytics.model.ListDatasetsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasets(software.amazon.awssdk.services.iotanalytics.model.ListDatasetsRequest)
operation.- Parameters:
listDatasetsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDatasetsPaginator
default ListDatasetsPublisher listDatasetsPaginator(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest) This is a variant of
listDatasets(software.amazon.awssdk.services.iotanalytics.model.ListDatasetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iotanalytics.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iotanalytics.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotanalytics.model.ListDatasetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iotanalytics.model.ListDatasetsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasets(software.amazon.awssdk.services.iotanalytics.model.ListDatasetsRequest)
operation.
This is a convenience which creates an instance of the
ListDatasetsRequest.Builder
avoiding the need to create one manually viaListDatasetsRequest.builder()
- Parameters:
listDatasetsRequest
- AConsumer
that will call methods onListDatasetsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDatastores
default CompletableFuture<ListDatastoresResponse> listDatastores(ListDatastoresRequest listDatastoresRequest) Retrieves a list of data stores.
- Parameters:
listDatastoresRequest
-- Returns:
- A Java Future containing the result of the ListDatastores operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDatastores
default CompletableFuture<ListDatastoresResponse> listDatastores(Consumer<ListDatastoresRequest.Builder> listDatastoresRequest) Retrieves a list of data stores.
This is a convenience which creates an instance of the
ListDatastoresRequest.Builder
avoiding the need to create one manually viaListDatastoresRequest.builder()
- Parameters:
listDatastoresRequest
- AConsumer
that will call methods onListDatastoresRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListDatastores operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDatastores
Retrieves a list of data stores.
- Returns:
- A Java Future containing the result of the ListDatastores operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDatastoresPaginator
This is a variant of
listDatastores(software.amazon.awssdk.services.iotanalytics.model.ListDatastoresRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iotanalytics.paginators.ListDatastoresPublisher publisher = client.listDatastoresPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iotanalytics.paginators.ListDatastoresPublisher publisher = client.listDatastoresPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotanalytics.model.ListDatastoresResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iotanalytics.model.ListDatastoresResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatastores(software.amazon.awssdk.services.iotanalytics.model.ListDatastoresRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDatastoresPaginator
default ListDatastoresPublisher listDatastoresPaginator(ListDatastoresRequest listDatastoresRequest) This is a variant of
listDatastores(software.amazon.awssdk.services.iotanalytics.model.ListDatastoresRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iotanalytics.paginators.ListDatastoresPublisher publisher = client.listDatastoresPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iotanalytics.paginators.ListDatastoresPublisher publisher = client.listDatastoresPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotanalytics.model.ListDatastoresResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iotanalytics.model.ListDatastoresResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatastores(software.amazon.awssdk.services.iotanalytics.model.ListDatastoresRequest)
operation.- Parameters:
listDatastoresRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDatastoresPaginator
default ListDatastoresPublisher listDatastoresPaginator(Consumer<ListDatastoresRequest.Builder> listDatastoresRequest) This is a variant of
listDatastores(software.amazon.awssdk.services.iotanalytics.model.ListDatastoresRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iotanalytics.paginators.ListDatastoresPublisher publisher = client.listDatastoresPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iotanalytics.paginators.ListDatastoresPublisher publisher = client.listDatastoresPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotanalytics.model.ListDatastoresResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iotanalytics.model.ListDatastoresResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatastores(software.amazon.awssdk.services.iotanalytics.model.ListDatastoresRequest)
operation.
This is a convenience which creates an instance of the
ListDatastoresRequest.Builder
avoiding the need to create one manually viaListDatastoresRequest.builder()
- Parameters:
listDatastoresRequest
- AConsumer
that will call methods onListDatastoresRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPipelines
default CompletableFuture<ListPipelinesResponse> listPipelines(ListPipelinesRequest listPipelinesRequest) Retrieves a list of pipelines.
- Parameters:
listPipelinesRequest
-- Returns:
- A Java Future containing the result of the ListPipelines operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPipelines
default CompletableFuture<ListPipelinesResponse> listPipelines(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest) Retrieves a list of pipelines.
This is a convenience which creates an instance of the
ListPipelinesRequest.Builder
avoiding the need to create one manually viaListPipelinesRequest.builder()
- Parameters:
listPipelinesRequest
- AConsumer
that will call methods onListPipelinesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPipelines operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPipelines
Retrieves a list of pipelines.
- Returns:
- A Java Future containing the result of the ListPipelines operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPipelinesPaginator
This is a variant of
listPipelines(software.amazon.awssdk.services.iotanalytics.model.ListPipelinesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iotanalytics.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iotanalytics.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotanalytics.model.ListPipelinesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iotanalytics.model.ListPipelinesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPipelines(software.amazon.awssdk.services.iotanalytics.model.ListPipelinesRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPipelinesPaginator
This is a variant of
listPipelines(software.amazon.awssdk.services.iotanalytics.model.ListPipelinesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iotanalytics.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iotanalytics.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotanalytics.model.ListPipelinesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iotanalytics.model.ListPipelinesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPipelines(software.amazon.awssdk.services.iotanalytics.model.ListPipelinesRequest)
operation.- Parameters:
listPipelinesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPipelinesPaginator
default ListPipelinesPublisher listPipelinesPaginator(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest) This is a variant of
listPipelines(software.amazon.awssdk.services.iotanalytics.model.ListPipelinesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iotanalytics.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iotanalytics.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotanalytics.model.ListPipelinesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iotanalytics.model.ListPipelinesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPipelines(software.amazon.awssdk.services.iotanalytics.model.ListPipelinesRequest)
operation.
This is a convenience which creates an instance of the
ListPipelinesRequest.Builder
avoiding the need to create one manually viaListPipelinesRequest.builder()
- Parameters:
listPipelinesRequest
- AConsumer
that will call methods onListPipelinesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags (metadata) that you have assigned to the resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags (metadata) that you have assigned to the resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putLoggingOptions
default CompletableFuture<PutLoggingOptionsResponse> putLoggingOptions(PutLoggingOptionsRequest putLoggingOptionsRequest) 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 theroleArn
field (for example, to correct an invalid policy), it takes up to five minutes for that change to take effect.- Parameters:
putLoggingOptionsRequest
-- Returns:
- A Java Future containing the result of the PutLoggingOptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putLoggingOptions
default CompletableFuture<PutLoggingOptionsResponse> putLoggingOptions(Consumer<PutLoggingOptionsRequest.Builder> putLoggingOptionsRequest) 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 theroleArn
field (for example, to correct an invalid policy), it takes up to five minutes for that change to take effect.
This is a convenience which creates an instance of the
PutLoggingOptionsRequest.Builder
avoiding the need to create one manually viaPutLoggingOptionsRequest.builder()
- Parameters:
putLoggingOptionsRequest
- AConsumer
that will call methods onPutLoggingOptionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutLoggingOptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
runPipelineActivity
default CompletableFuture<RunPipelineActivityResponse> runPipelineActivity(RunPipelineActivityRequest runPipelineActivityRequest) Simulates the results of running a pipeline activity on a message payload.
- Parameters:
runPipelineActivityRequest
-- Returns:
- A Java Future containing the result of the RunPipelineActivity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
runPipelineActivity
default CompletableFuture<RunPipelineActivityResponse> runPipelineActivity(Consumer<RunPipelineActivityRequest.Builder> runPipelineActivityRequest) Simulates the results of running a pipeline activity on a message payload.
This is a convenience which creates an instance of the
RunPipelineActivityRequest.Builder
avoiding the need to create one manually viaRunPipelineActivityRequest.builder()
- Parameters:
runPipelineActivityRequest
- AConsumer
that will call methods onRunPipelineActivityRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RunPipelineActivity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
sampleChannelData
default CompletableFuture<SampleChannelDataResponse> sampleChannelData(SampleChannelDataRequest sampleChannelDataRequest) Retrieves a sample of messages from the specified channel ingested during the specified timeframe. Up to 10 messages can be retrieved.
- Parameters:
sampleChannelDataRequest
-- Returns:
- A Java Future containing the result of the SampleChannelData operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
sampleChannelData
default CompletableFuture<SampleChannelDataResponse> sampleChannelData(Consumer<SampleChannelDataRequest.Builder> sampleChannelDataRequest) Retrieves a sample of messages from the specified channel ingested during the specified timeframe. Up to 10 messages can be retrieved.
This is a convenience which creates an instance of the
SampleChannelDataRequest.Builder
avoiding the need to create one manually viaSampleChannelDataRequest.builder()
- Parameters:
sampleChannelDataRequest
- AConsumer
that will call methods onSampleChannelDataRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SampleChannelData operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startPipelineReprocessing
default CompletableFuture<StartPipelineReprocessingResponse> startPipelineReprocessing(StartPipelineReprocessingRequest startPipelineReprocessingRequest) Starts the reprocessing of raw message data through the pipeline.
- Parameters:
startPipelineReprocessingRequest
-- Returns:
- A Java Future containing the result of the StartPipelineReprocessing operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startPipelineReprocessing
default CompletableFuture<StartPipelineReprocessingResponse> startPipelineReprocessing(Consumer<StartPipelineReprocessingRequest.Builder> startPipelineReprocessingRequest) Starts the reprocessing of raw message data through the pipeline.
This is a convenience which creates an instance of the
StartPipelineReprocessingRequest.Builder
avoiding the need to create one manually viaStartPipelineReprocessingRequest.builder()
- Parameters:
startPipelineReprocessingRequest
- AConsumer
that will call methods onStartPipelineReprocessingRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartPipelineReprocessing operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes the given tags (metadata) from the resource.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the given tags (metadata) from the resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateChannel
default CompletableFuture<UpdateChannelResponse> updateChannel(UpdateChannelRequest updateChannelRequest) Used to update the settings of a channel.
- Parameters:
updateChannelRequest
-- Returns:
- A Java Future containing the result of the UpdateChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateChannel
default CompletableFuture<UpdateChannelResponse> updateChannel(Consumer<UpdateChannelRequest.Builder> updateChannelRequest) Used to update the settings of a channel.
This is a convenience which creates an instance of the
UpdateChannelRequest.Builder
avoiding the need to create one manually viaUpdateChannelRequest.builder()
- Parameters:
updateChannelRequest
- AConsumer
that will call methods onUpdateChannelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDataset
default CompletableFuture<UpdateDatasetResponse> updateDataset(UpdateDatasetRequest updateDatasetRequest) Updates the settings of a dataset.
- Parameters:
updateDatasetRequest
-- Returns:
- A Java Future containing the result of the UpdateDataset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDataset
default CompletableFuture<UpdateDatasetResponse> updateDataset(Consumer<UpdateDatasetRequest.Builder> updateDatasetRequest) Updates the settings of a dataset.
This is a convenience which creates an instance of the
UpdateDatasetRequest.Builder
avoiding the need to create one manually viaUpdateDatasetRequest.builder()
- Parameters:
updateDatasetRequest
- AConsumer
that will call methods onUpdateDatasetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateDataset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDatastore
default CompletableFuture<UpdateDatastoreResponse> updateDatastore(UpdateDatastoreRequest updateDatastoreRequest) Used to update the settings of a data store.
- Parameters:
updateDatastoreRequest
-- Returns:
- A Java Future containing the result of the UpdateDatastore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDatastore
default CompletableFuture<UpdateDatastoreResponse> updateDatastore(Consumer<UpdateDatastoreRequest.Builder> updateDatastoreRequest) Used to update the settings of a data store.
This is a convenience which creates an instance of the
UpdateDatastoreRequest.Builder
avoiding the need to create one manually viaUpdateDatastoreRequest.builder()
- Parameters:
updateDatastoreRequest
- AConsumer
that will call methods onUpdateDatastoreRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateDatastore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updatePipeline
default CompletableFuture<UpdatePipelineResponse> updatePipeline(UpdatePipelineRequest updatePipelineRequest) Updates the settings of a pipeline. You must specify both a
channel
and adatastore
activity and, optionally, as many as 23 additional activities in thepipelineActivities
array.- Parameters:
updatePipelineRequest
-- Returns:
- A Java Future containing the result of the UpdatePipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updatePipeline
default CompletableFuture<UpdatePipelineResponse> updatePipeline(Consumer<UpdatePipelineRequest.Builder> updatePipelineRequest) Updates the settings of a pipeline. You must specify both a
channel
and adatastore
activity and, optionally, as many as 23 additional activities in thepipelineActivities
array.
This is a convenience which creates an instance of the
UpdatePipelineRequest.Builder
avoiding the need to create one manually viaUpdatePipelineRequest.builder()
- Parameters:
updatePipelineRequest
- AConsumer
that will call methods onUpdatePipelineRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdatePipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aIoTAnalyticsAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aIoTAnalyticsAsyncClient
.
-