Interface IoTAnalyticsClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface IoTAnalyticsClient
extends AwsClient

Service client for accessing AWS IoT Analytics. This can be created using the static builder() method.

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

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default BatchPutMessageResponse	batchPutMessage(Consumer<BatchPutMessageRequest.Builder> batchPutMessageRequest)	Sends messages to a channel.
default BatchPutMessageResponse	batchPutMessage(BatchPutMessageRequest batchPutMessageRequest)	Sends messages to a channel.
static IoTAnalyticsClientBuilder	builder()	Create a builder that can be used to configure and create a IoTAnalyticsClient.
default CancelPipelineReprocessingResponse	cancelPipelineReprocessing(Consumer<CancelPipelineReprocessingRequest.Builder> cancelPipelineReprocessingRequest)	Cancels the reprocessing of data through the pipeline.
default CancelPipelineReprocessingResponse	cancelPipelineReprocessing(CancelPipelineReprocessingRequest cancelPipelineReprocessingRequest)	Cancels the reprocessing of data through the pipeline.
static IoTAnalyticsClient	create()	Create a IoTAnalyticsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateChannelResponse	createChannel(Consumer<CreateChannelRequest.Builder> createChannelRequest)	Used to create a channel.
default CreateChannelResponse	createChannel(CreateChannelRequest createChannelRequest)	Used to create a channel.
default CreateDatasetResponse	createDataset(Consumer<CreateDatasetRequest.Builder> createDatasetRequest)	Used to create a dataset.
default CreateDatasetResponse	createDataset(CreateDatasetRequest createDatasetRequest)	Used to create a dataset.
default CreateDatasetContentResponse	createDatasetContent(Consumer<CreateDatasetContentRequest.Builder> createDatasetContentRequest)	Creates the content of a dataset by applying a queryAction (a SQL query) or a containerAction (executing a containerized application).
default CreateDatasetContentResponse	createDatasetContent(CreateDatasetContentRequest createDatasetContentRequest)	Creates the content of a dataset by applying a queryAction (a SQL query) or a containerAction (executing a containerized application).
default CreateDatastoreResponse	createDatastore(Consumer<CreateDatastoreRequest.Builder> createDatastoreRequest)	Creates a data store, which is a repository for messages.
default CreateDatastoreResponse	createDatastore(CreateDatastoreRequest createDatastoreRequest)	Creates a data store, which is a repository for messages.
default CreatePipelineResponse	createPipeline(Consumer<CreatePipelineRequest.Builder> createPipelineRequest)	Creates a pipeline.
default CreatePipelineResponse	createPipeline(CreatePipelineRequest createPipelineRequest)	Creates a pipeline.
default DeleteChannelResponse	deleteChannel(Consumer<DeleteChannelRequest.Builder> deleteChannelRequest)	Deletes the specified channel.
default DeleteChannelResponse	deleteChannel(DeleteChannelRequest deleteChannelRequest)	Deletes the specified channel.
default DeleteDatasetResponse	deleteDataset(Consumer<DeleteDatasetRequest.Builder> deleteDatasetRequest)	Deletes the specified dataset.
default DeleteDatasetResponse	deleteDataset(DeleteDatasetRequest deleteDatasetRequest)	Deletes the specified dataset.
default DeleteDatasetContentResponse	deleteDatasetContent(Consumer<DeleteDatasetContentRequest.Builder> deleteDatasetContentRequest)	Deletes the content of the specified dataset.
default DeleteDatasetContentResponse	deleteDatasetContent(DeleteDatasetContentRequest deleteDatasetContentRequest)	Deletes the content of the specified dataset.
default DeleteDatastoreResponse	deleteDatastore(Consumer<DeleteDatastoreRequest.Builder> deleteDatastoreRequest)	Deletes the specified data store.
default DeleteDatastoreResponse	deleteDatastore(DeleteDatastoreRequest deleteDatastoreRequest)	Deletes the specified data store.
default DeletePipelineResponse	deletePipeline(Consumer<DeletePipelineRequest.Builder> deletePipelineRequest)	Deletes the specified pipeline.
default DeletePipelineResponse	deletePipeline(DeletePipelineRequest deletePipelineRequest)	Deletes the specified pipeline.
default DescribeChannelResponse	describeChannel(Consumer<DescribeChannelRequest.Builder> describeChannelRequest)	Retrieves information about a channel.
default DescribeChannelResponse	describeChannel(DescribeChannelRequest describeChannelRequest)	Retrieves information about a channel.
default DescribeDatasetResponse	describeDataset(Consumer<DescribeDatasetRequest.Builder> describeDatasetRequest)	Retrieves information about a dataset.
default DescribeDatasetResponse	describeDataset(DescribeDatasetRequest describeDatasetRequest)	Retrieves information about a dataset.
default DescribeDatastoreResponse	describeDatastore(Consumer<DescribeDatastoreRequest.Builder> describeDatastoreRequest)	Retrieves information about a data store.
default DescribeDatastoreResponse	describeDatastore(DescribeDatastoreRequest describeDatastoreRequest)	Retrieves information about a data store.
default DescribeLoggingOptionsResponse	describeLoggingOptions(Consumer<DescribeLoggingOptionsRequest.Builder> describeLoggingOptionsRequest)	Retrieves the current settings of the IoT Analytics logging options.
default DescribeLoggingOptionsResponse	describeLoggingOptions(DescribeLoggingOptionsRequest describeLoggingOptionsRequest)	Retrieves the current settings of the IoT Analytics logging options.
default DescribePipelineResponse	describePipeline(Consumer<DescribePipelineRequest.Builder> describePipelineRequest)	Retrieves information about a pipeline.
default DescribePipelineResponse	describePipeline(DescribePipelineRequest describePipelineRequest)	Retrieves information about a pipeline.
default GetDatasetContentResponse	getDatasetContent(Consumer<GetDatasetContentRequest.Builder> getDatasetContentRequest)	Retrieves the contents of a dataset as presigned URIs.
default GetDatasetContentResponse	getDatasetContent(GetDatasetContentRequest getDatasetContentRequest)	Retrieves the contents of a dataset as presigned URIs.
default ListChannelsResponse	listChannels()	Retrieves a list of channels.
default ListChannelsResponse	listChannels(Consumer<ListChannelsRequest.Builder> listChannelsRequest)	Retrieves a list of channels.
default ListChannelsResponse	listChannels(ListChannelsRequest listChannelsRequest)	Retrieves a list of channels.
default ListChannelsIterable	listChannelsPaginator()	This is a variant of listChannels(software.amazon.awssdk.services.iotanalytics.model.ListChannelsRequest) operation.
default ListChannelsIterable	listChannelsPaginator(Consumer<ListChannelsRequest.Builder> listChannelsRequest)	This is a variant of listChannels(software.amazon.awssdk.services.iotanalytics.model.ListChannelsRequest) operation.
default ListChannelsIterable	listChannelsPaginator(ListChannelsRequest listChannelsRequest)	This is a variant of listChannels(software.amazon.awssdk.services.iotanalytics.model.ListChannelsRequest) operation.
default ListDatasetContentsResponse	listDatasetContents(Consumer<ListDatasetContentsRequest.Builder> listDatasetContentsRequest)	Lists information about dataset contents that have been created.
default ListDatasetContentsResponse	listDatasetContents(ListDatasetContentsRequest listDatasetContentsRequest)	Lists information about dataset contents that have been created.
default ListDatasetContentsIterable	listDatasetContentsPaginator(Consumer<ListDatasetContentsRequest.Builder> listDatasetContentsRequest)	This is a variant of listDatasetContents(software.amazon.awssdk.services.iotanalytics.model.ListDatasetContentsRequest) operation.
default ListDatasetContentsIterable	listDatasetContentsPaginator(ListDatasetContentsRequest listDatasetContentsRequest)	This is a variant of listDatasetContents(software.amazon.awssdk.services.iotanalytics.model.ListDatasetContentsRequest) operation.
default ListDatasetsResponse	listDatasets()	Retrieves information about datasets.
default ListDatasetsResponse	listDatasets(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest)	Retrieves information about datasets.
default ListDatasetsResponse	listDatasets(ListDatasetsRequest listDatasetsRequest)	Retrieves information about datasets.
default ListDatasetsIterable	listDatasetsPaginator()	This is a variant of listDatasets(software.amazon.awssdk.services.iotanalytics.model.ListDatasetsRequest) operation.
default ListDatasetsIterable	listDatasetsPaginator(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest)	This is a variant of listDatasets(software.amazon.awssdk.services.iotanalytics.model.ListDatasetsRequest) operation.
default ListDatasetsIterable	listDatasetsPaginator(ListDatasetsRequest listDatasetsRequest)	This is a variant of listDatasets(software.amazon.awssdk.services.iotanalytics.model.ListDatasetsRequest) operation.
default ListDatastoresResponse	listDatastores()	Retrieves a list of data stores.
default ListDatastoresResponse	listDatastores(Consumer<ListDatastoresRequest.Builder> listDatastoresRequest)	Retrieves a list of data stores.
default ListDatastoresResponse	listDatastores(ListDatastoresRequest listDatastoresRequest)	Retrieves a list of data stores.
default ListDatastoresIterable	listDatastoresPaginator()	This is a variant of listDatastores(software.amazon.awssdk.services.iotanalytics.model.ListDatastoresRequest) operation.
default ListDatastoresIterable	listDatastoresPaginator(Consumer<ListDatastoresRequest.Builder> listDatastoresRequest)	This is a variant of listDatastores(software.amazon.awssdk.services.iotanalytics.model.ListDatastoresRequest) operation.
default ListDatastoresIterable	listDatastoresPaginator(ListDatastoresRequest listDatastoresRequest)	This is a variant of listDatastores(software.amazon.awssdk.services.iotanalytics.model.ListDatastoresRequest) operation.
default ListPipelinesResponse	listPipelines()	Retrieves a list of pipelines.
default ListPipelinesResponse	listPipelines(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest)	Retrieves a list of pipelines.
default ListPipelinesResponse	listPipelines(ListPipelinesRequest listPipelinesRequest)	Retrieves a list of pipelines.
default ListPipelinesIterable	listPipelinesPaginator()	This is a variant of listPipelines(software.amazon.awssdk.services.iotanalytics.model.ListPipelinesRequest) operation.
default ListPipelinesIterable	listPipelinesPaginator(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest)	This is a variant of listPipelines(software.amazon.awssdk.services.iotanalytics.model.ListPipelinesRequest) operation.
default ListPipelinesIterable	listPipelinesPaginator(ListPipelinesRequest listPipelinesRequest)	This is a variant of listPipelines(software.amazon.awssdk.services.iotanalytics.model.ListPipelinesRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Lists the tags (metadata) that you have assigned to the resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists the tags (metadata) that you have assigned to the resource.
default PutLoggingOptionsResponse	putLoggingOptions(Consumer<PutLoggingOptionsRequest.Builder> putLoggingOptionsRequest)	Sets or updates the IoT Analytics logging options.
default PutLoggingOptionsResponse	putLoggingOptions(PutLoggingOptionsRequest putLoggingOptionsRequest)	Sets or updates the IoT Analytics logging options.
default RunPipelineActivityResponse	runPipelineActivity(Consumer<RunPipelineActivityRequest.Builder> runPipelineActivityRequest)	Simulates the results of running a pipeline activity on a message payload.
default RunPipelineActivityResponse	runPipelineActivity(RunPipelineActivityRequest runPipelineActivityRequest)	Simulates the results of running a pipeline activity on a message payload.
default SampleChannelDataResponse	sampleChannelData(Consumer<SampleChannelDataRequest.Builder> sampleChannelDataRequest)	Retrieves a sample of messages from the specified channel ingested during the specified timeframe.
default SampleChannelDataResponse	sampleChannelData(SampleChannelDataRequest sampleChannelDataRequest)	Retrieves a sample of messages from the specified channel ingested during the specified timeframe.
default IoTAnalyticsServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default StartPipelineReprocessingResponse	startPipelineReprocessing(Consumer<StartPipelineReprocessingRequest.Builder> startPipelineReprocessingRequest)	Starts the reprocessing of raw message data through the pipeline.
default StartPipelineReprocessingResponse	startPipelineReprocessing(StartPipelineReprocessingRequest startPipelineReprocessingRequest)	Starts the reprocessing of raw message data through the pipeline.
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Adds to or modifies the tags of the given resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Adds to or modifies the tags of the given resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes the given tags (metadata) from the resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes the given tags (metadata) from the resource.
default UpdateChannelResponse	updateChannel(Consumer<UpdateChannelRequest.Builder> updateChannelRequest)	Used to update the settings of a channel.
default UpdateChannelResponse	updateChannel(UpdateChannelRequest updateChannelRequest)	Used to update the settings of a channel.
default UpdateDatasetResponse	updateDataset(Consumer<UpdateDatasetRequest.Builder> updateDatasetRequest)	Updates the settings of a dataset.
default UpdateDatasetResponse	updateDataset(UpdateDatasetRequest updateDatasetRequest)	Updates the settings of a dataset.
default UpdateDatastoreResponse	updateDatastore(Consumer<UpdateDatastoreRequest.Builder> updateDatastoreRequest)	Used to update the settings of a data store.
default UpdateDatastoreResponse	updateDatastore(UpdateDatastoreRequest updateDatastoreRequest)	Used to update the settings of a data store.
default UpdatePipelineResponse	updatePipeline(Consumer<UpdatePipelineRequest.Builder> updatePipelineRequest)	Updates the settings of a pipeline.
default 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

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

batchPutMessage

default BatchPutMessageResponse batchPutMessage(BatchPutMessageRequest batchPutMessageRequest)
                                         throws ResourceNotFoundException,
InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Sends messages to a channel.

Parameters:

batchPutMessageRequest -

Returns:

Result of the BatchPutMessage operation returned by the service.

See Also:

• AWS API Documentation

batchPutMessage

default BatchPutMessageResponse batchPutMessage(Consumer<BatchPutMessageRequest.Builder> batchPutMessageRequest)
                                         throws ResourceNotFoundException,
InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Sends messages to a channel.

This is a convenience which creates an instance of the BatchPutMessageRequest.Builder avoiding the need to create one manually via BatchPutMessageRequest.builder()

Parameters:

batchPutMessageRequest - A Consumer that will call methods on BatchPutMessageRequest.Builder to create a request.

Returns:

Result of the BatchPutMessage operation returned by the service.

See Also:

• AWS API Documentation

cancelPipelineReprocessing

default CancelPipelineReprocessingResponse cancelPipelineReprocessing(CancelPipelineReprocessingRequest cancelPipelineReprocessingRequest)
                                                               throws ResourceNotFoundException,
InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Cancels the reprocessing of data through the pipeline.

Parameters:

cancelPipelineReprocessingRequest -

Returns:

Result of the CancelPipelineReprocessing operation returned by the service.

See Also:

• AWS API Documentation

cancelPipelineReprocessing

default CancelPipelineReprocessingResponse cancelPipelineReprocessing(Consumer<CancelPipelineReprocessingRequest.Builder> cancelPipelineReprocessingRequest)
                                                               throws ResourceNotFoundException,
InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

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 via CancelPipelineReprocessingRequest.builder()

Parameters:

cancelPipelineReprocessingRequest - A Consumer that will call methods on CancelPipelineReprocessingRequest.Builder to create a request.

Returns:

Result of the CancelPipelineReprocessing operation returned by the service.

See Also:

• AWS API Documentation

createChannel

default CreateChannelResponse createChannel(CreateChannelRequest createChannelRequest)
                                     throws InvalidRequestException,
ResourceAlreadyExistsException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

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:

Result of the CreateChannel operation returned by the service.

See Also:

• AWS API Documentation

createChannel

default CreateChannelResponse createChannel(Consumer<CreateChannelRequest.Builder> createChannelRequest)
                                     throws InvalidRequestException,
ResourceAlreadyExistsException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

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 via CreateChannelRequest.builder()

Parameters:

createChannelRequest - A Consumer that will call methods on CreateChannelRequest.Builder to create a request.

Returns:

Result of the CreateChannel operation returned by the service.

See Also:

• AWS API Documentation

createDataset

default CreateDatasetResponse createDataset(CreateDatasetRequest createDatasetRequest)
                                     throws InvalidRequestException,
ResourceAlreadyExistsException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Used to create a dataset. A dataset stores data retrieved from a data store by applying a queryAction (a SQL query) or a containerAction (executing a containerized application). This operation creates the skeleton of a dataset. The dataset can be populated manually by calling CreateDatasetContent or automatically according to a trigger you specify.

Parameters:

createDatasetRequest -

Returns:

Result of the CreateDataset operation returned by the service.

See Also:

• AWS API Documentation

createDataset

default CreateDatasetResponse createDataset(Consumer<CreateDatasetRequest.Builder> createDatasetRequest)
                                     throws InvalidRequestException,
ResourceAlreadyExistsException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Used to create a dataset. A dataset stores data retrieved from a data store by applying a queryAction (a SQL query) or a containerAction (executing a containerized application). This operation creates the skeleton of a dataset. The dataset can be populated manually by calling CreateDatasetContent or automatically according to a trigger you specify.

This is a convenience which creates an instance of the CreateDatasetRequest.Builder avoiding the need to create one manually via CreateDatasetRequest.builder()

Parameters:

createDatasetRequest - A Consumer that will call methods on CreateDatasetRequest.Builder to create a request.

Returns:

Result of the CreateDataset operation returned by the service.

See Also:

• AWS API Documentation

createDatasetContent

default CreateDatasetContentResponse createDatasetContent(CreateDatasetContentRequest createDatasetContentRequest)
                                                   throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Creates the content of a dataset by applying a queryAction (a SQL query) or a containerAction (executing a containerized application).

Parameters:

createDatasetContentRequest -

Returns:

Result of the CreateDatasetContent operation returned by the service.

See Also:

• AWS API Documentation

createDatasetContent

default CreateDatasetContentResponse createDatasetContent(Consumer<CreateDatasetContentRequest.Builder> createDatasetContentRequest)
                                                   throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Creates the content of a dataset by applying a queryAction (a SQL query) or a containerAction (executing a containerized application).

This is a convenience which creates an instance of the CreateDatasetContentRequest.Builder avoiding the need to create one manually via CreateDatasetContentRequest.builder()

Parameters:

createDatasetContentRequest - A Consumer that will call methods on CreateDatasetContentRequest.Builder to create a request.

Returns:

Result of the CreateDatasetContent operation returned by the service.

See Also:

• AWS API Documentation

createDatastore

default CreateDatastoreResponse createDatastore(CreateDatastoreRequest createDatastoreRequest)
                                         throws InvalidRequestException,
ResourceAlreadyExistsException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

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

Parameters:

createDatastoreRequest -

Returns:

Result of the CreateDatastore operation returned by the service.

See Also:

• AWS API Documentation

createDatastore

default CreateDatastoreResponse createDatastore(Consumer<CreateDatastoreRequest.Builder> createDatastoreRequest)
                                         throws InvalidRequestException,
ResourceAlreadyExistsException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

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 via CreateDatastoreRequest.builder()

Parameters:

createDatastoreRequest - A Consumer that will call methods on CreateDatastoreRequest.Builder to create a request.

Returns:

Result of the CreateDatastore operation returned by the service.

See Also:

• AWS API Documentation

createPipeline

default CreatePipelineResponse createPipeline(CreatePipelineRequest createPipelineRequest)
                                       throws InvalidRequestException,
ResourceAlreadyExistsException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Creates a pipeline. A pipeline consumes messages from a channel and allows you to process the messages before storing them in a data store. You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array.

Parameters:

createPipelineRequest -

Returns:

Result of the CreatePipeline operation returned by the service.

See Also:

• AWS API Documentation

createPipeline

default CreatePipelineResponse createPipeline(Consumer<CreatePipelineRequest.Builder> createPipelineRequest)
                                       throws InvalidRequestException,
ResourceAlreadyExistsException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Creates a pipeline. A pipeline consumes messages from a channel and allows you to process the messages before storing them in a data store. You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array.

This is a convenience which creates an instance of the CreatePipelineRequest.Builder avoiding the need to create one manually via CreatePipelineRequest.builder()

Parameters:

createPipelineRequest - A Consumer that will call methods on CreatePipelineRequest.Builder to create a request.

Returns:

Result of the CreatePipeline operation returned by the service.

See Also:

• AWS API Documentation

deleteChannel

default DeleteChannelResponse deleteChannel(DeleteChannelRequest deleteChannelRequest)
                                     throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Deletes the specified channel.

Parameters:

deleteChannelRequest -

Returns:

Result of the DeleteChannel operation returned by the service.

See Also:

• AWS API Documentation

deleteChannel

default DeleteChannelResponse deleteChannel(Consumer<DeleteChannelRequest.Builder> deleteChannelRequest)
                                     throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Deletes the specified channel.

This is a convenience which creates an instance of the DeleteChannelRequest.Builder avoiding the need to create one manually via DeleteChannelRequest.builder()

Parameters:

deleteChannelRequest - A Consumer that will call methods on DeleteChannelRequest.Builder to create a request.

Returns:

Result of the DeleteChannel operation returned by the service.

See Also:

• AWS API Documentation

deleteDataset

default DeleteDatasetResponse deleteDataset(DeleteDatasetRequest deleteDatasetRequest)
                                     throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Deletes the specified dataset.

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

Parameters:

deleteDatasetRequest -

Returns:

Result of the DeleteDataset operation returned by the service.

See Also:

• AWS API Documentation

deleteDataset

default DeleteDatasetResponse deleteDataset(Consumer<DeleteDatasetRequest.Builder> deleteDatasetRequest)
                                     throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

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 via DeleteDatasetRequest.builder()

Parameters:

deleteDatasetRequest - A Consumer that will call methods on DeleteDatasetRequest.Builder to create a request.

Returns:

Result of the DeleteDataset operation returned by the service.

See Also:

• AWS API Documentation

deleteDatasetContent

default DeleteDatasetContentResponse deleteDatasetContent(DeleteDatasetContentRequest deleteDatasetContentRequest)
                                                   throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Deletes the content of the specified dataset.

Parameters:

deleteDatasetContentRequest -

Returns:

Result of the DeleteDatasetContent operation returned by the service.

See Also:

• AWS API Documentation

deleteDatasetContent

default DeleteDatasetContentResponse deleteDatasetContent(Consumer<DeleteDatasetContentRequest.Builder> deleteDatasetContentRequest)
                                                   throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

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 via DeleteDatasetContentRequest.builder()

Parameters:

deleteDatasetContentRequest - A Consumer that will call methods on DeleteDatasetContentRequest.Builder to create a request.

Returns:

Result of the DeleteDatasetContent operation returned by the service.

See Also:

• AWS API Documentation

deleteDatastore

default DeleteDatastoreResponse deleteDatastore(DeleteDatastoreRequest deleteDatastoreRequest)
                                         throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Deletes the specified data store.

Parameters:

deleteDatastoreRequest -

Returns:

Result of the DeleteDatastore operation returned by the service.

See Also:

• AWS API Documentation

deleteDatastore

default DeleteDatastoreResponse deleteDatastore(Consumer<DeleteDatastoreRequest.Builder> deleteDatastoreRequest)
                                         throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Deletes the specified data store.

This is a convenience which creates an instance of the DeleteDatastoreRequest.Builder avoiding the need to create one manually via DeleteDatastoreRequest.builder()

Parameters:

deleteDatastoreRequest - A Consumer that will call methods on DeleteDatastoreRequest.Builder to create a request.

Returns:

Result of the DeleteDatastore operation returned by the service.

See Also:

• AWS API Documentation

deletePipeline

default DeletePipelineResponse deletePipeline(DeletePipelineRequest deletePipelineRequest)
                                       throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Deletes the specified pipeline.

Parameters:

deletePipelineRequest -

Returns:

Result of the DeletePipeline operation returned by the service.

See Also:

• AWS API Documentation

deletePipeline

default DeletePipelineResponse deletePipeline(Consumer<DeletePipelineRequest.Builder> deletePipelineRequest)
                                       throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Deletes the specified pipeline.

This is a convenience which creates an instance of the DeletePipelineRequest.Builder avoiding the need to create one manually via DeletePipelineRequest.builder()

Parameters:

deletePipelineRequest - A Consumer that will call methods on DeletePipelineRequest.Builder to create a request.

Returns:

Result of the DeletePipeline operation returned by the service.

See Also:

• AWS API Documentation

describeChannel

default DescribeChannelResponse describeChannel(DescribeChannelRequest describeChannelRequest)
                                         throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Retrieves information about a channel.

Parameters:

describeChannelRequest -

Returns:

Result of the DescribeChannel operation returned by the service.

See Also:

• AWS API Documentation

describeChannel

default DescribeChannelResponse describeChannel(Consumer<DescribeChannelRequest.Builder> describeChannelRequest)
                                         throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Retrieves information about a channel.

This is a convenience which creates an instance of the DescribeChannelRequest.Builder avoiding the need to create one manually via DescribeChannelRequest.builder()

Parameters:

describeChannelRequest - A Consumer that will call methods on DescribeChannelRequest.Builder to create a request.

Returns:

Result of the DescribeChannel operation returned by the service.

See Also:

• AWS API Documentation

describeDataset

default DescribeDatasetResponse describeDataset(DescribeDatasetRequest describeDatasetRequest)
                                         throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Retrieves information about a dataset.

Parameters:

describeDatasetRequest -

Returns:

Result of the DescribeDataset operation returned by the service.

See Also:

• AWS API Documentation

describeDataset

default DescribeDatasetResponse describeDataset(Consumer<DescribeDatasetRequest.Builder> describeDatasetRequest)
                                         throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Retrieves information about a dataset.

This is a convenience which creates an instance of the DescribeDatasetRequest.Builder avoiding the need to create one manually via DescribeDatasetRequest.builder()

Parameters:

describeDatasetRequest - A Consumer that will call methods on DescribeDatasetRequest.Builder to create a request.

Returns:

Result of the DescribeDataset operation returned by the service.

See Also:

• AWS API Documentation

describeDatastore

default DescribeDatastoreResponse describeDatastore(DescribeDatastoreRequest describeDatastoreRequest)
                                             throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Retrieves information about a data store.

Parameters:

describeDatastoreRequest -

Returns:

Result of the DescribeDatastore operation returned by the service.

See Also:

• AWS API Documentation

describeDatastore

default DescribeDatastoreResponse describeDatastore(Consumer<DescribeDatastoreRequest.Builder> describeDatastoreRequest)
                                             throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

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 via DescribeDatastoreRequest.builder()

Parameters:

describeDatastoreRequest - A Consumer that will call methods on DescribeDatastoreRequest.Builder to create a request.

Returns:

Result of the DescribeDatastore operation returned by the service.

See Also:

• AWS API Documentation

describeLoggingOptions

default DescribeLoggingOptionsResponse describeLoggingOptions(DescribeLoggingOptionsRequest describeLoggingOptionsRequest)
                                                       throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Retrieves the current settings of the IoT Analytics logging options.

Parameters:

describeLoggingOptionsRequest -

Returns:

Result of the DescribeLoggingOptions operation returned by the service.

See Also:

• AWS API Documentation

describeLoggingOptions

default DescribeLoggingOptionsResponse describeLoggingOptions(Consumer<DescribeLoggingOptionsRequest.Builder> describeLoggingOptionsRequest)
                                                       throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

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 via DescribeLoggingOptionsRequest.builder()

Parameters:

describeLoggingOptionsRequest - A Consumer that will call methods on DescribeLoggingOptionsRequest.Builder to create a request.

Returns:

Result of the DescribeLoggingOptions operation returned by the service.

See Also:

• AWS API Documentation

describePipeline

default DescribePipelineResponse describePipeline(DescribePipelineRequest describePipelineRequest)
                                           throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Retrieves information about a pipeline.

Parameters:

describePipelineRequest -

Returns:

Result of the DescribePipeline operation returned by the service.

See Also:

• AWS API Documentation

describePipeline

default DescribePipelineResponse describePipeline(Consumer<DescribePipelineRequest.Builder> describePipelineRequest)
                                           throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Retrieves information about a pipeline.

This is a convenience which creates an instance of the DescribePipelineRequest.Builder avoiding the need to create one manually via DescribePipelineRequest.builder()

Parameters:

describePipelineRequest - A Consumer that will call methods on DescribePipelineRequest.Builder to create a request.

Returns:

Result of the DescribePipeline operation returned by the service.

See Also:

• AWS API Documentation

getDatasetContent

default GetDatasetContentResponse getDatasetContent(GetDatasetContentRequest getDatasetContentRequest)
                                             throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Retrieves the contents of a dataset as presigned URIs.

Parameters:

getDatasetContentRequest -

Returns:

Result of the GetDatasetContent operation returned by the service.

See Also:

• AWS API Documentation

getDatasetContent

default GetDatasetContentResponse getDatasetContent(Consumer<GetDatasetContentRequest.Builder> getDatasetContentRequest)
                                             throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

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 via GetDatasetContentRequest.builder()

Parameters:

getDatasetContentRequest - A Consumer that will call methods on GetDatasetContentRequest.Builder to create a request.

Returns:

Result of the GetDatasetContent operation returned by the service.

See Also:

• AWS API Documentation

listChannels

default ListChannelsResponse listChannels(ListChannelsRequest listChannelsRequest)
                                   throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Retrieves a list of channels.

Parameters:

listChannelsRequest -

Returns:

Result of the ListChannels operation returned by the service.

See Also:

• AWS API Documentation

listChannels

default ListChannelsResponse listChannels(Consumer<ListChannelsRequest.Builder> listChannelsRequest)
                                   throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Retrieves a list of channels.

This is a convenience which creates an instance of the ListChannelsRequest.Builder avoiding the need to create one manually via ListChannelsRequest.builder()

Parameters:

listChannelsRequest - A Consumer that will call methods on ListChannelsRequest.Builder to create a request.

Returns:

Result of the ListChannels operation returned by the service.

See Also:

• AWS API Documentation

listChannels

default ListChannelsResponse listChannels()
                                   throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Retrieves a list of channels.

Returns:

Result of the ListChannels operation returned by the service.

See Also:

• listChannels(ListChannelsRequest)
• AWS API Documentation

listChannelsPaginator

default ListChannelsIterable listChannelsPaginator()
                                            throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

This is a variant of listChannels(software.amazon.awssdk.services.iotanalytics.model.ListChannelsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotanalytics.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotanalytics.paginators.ListChannelsIterable responses = client
             .listChannelsPaginator(request);
     for (software.amazon.awssdk.services.iotanalytics.model.ListChannelsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotanalytics.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• listChannelsPaginator(ListChannelsRequest)
• AWS API Documentation

listChannelsPaginator

default ListChannelsIterable listChannelsPaginator(ListChannelsRequest listChannelsRequest)
                                            throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

This is a variant of listChannels(software.amazon.awssdk.services.iotanalytics.model.ListChannelsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotanalytics.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotanalytics.paginators.ListChannelsIterable responses = client
             .listChannelsPaginator(request);
     for (software.amazon.awssdk.services.iotanalytics.model.ListChannelsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotanalytics.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listChannelsPaginator

default ListChannelsIterable listChannelsPaginator(Consumer<ListChannelsRequest.Builder> listChannelsRequest)
                                            throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

This is a variant of listChannels(software.amazon.awssdk.services.iotanalytics.model.ListChannelsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotanalytics.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotanalytics.paginators.ListChannelsIterable responses = client
             .listChannelsPaginator(request);
     for (software.amazon.awssdk.services.iotanalytics.model.ListChannelsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotanalytics.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 via ListChannelsRequest.builder()

Parameters:

listChannelsRequest - A Consumer that will call methods on ListChannelsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDatasetContents

default ListDatasetContentsResponse listDatasetContents(ListDatasetContentsRequest listDatasetContentsRequest)
                                                 throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Lists information about dataset contents that have been created.

Parameters:

listDatasetContentsRequest -

Returns:

Result of the ListDatasetContents operation returned by the service.

See Also:

• AWS API Documentation

listDatasetContents

default ListDatasetContentsResponse listDatasetContents(Consumer<ListDatasetContentsRequest.Builder> listDatasetContentsRequest)
                                                 throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

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 via ListDatasetContentsRequest.builder()

Parameters:

listDatasetContentsRequest - A Consumer that will call methods on ListDatasetContentsRequest.Builder to create a request.

Returns:

Result of the ListDatasetContents operation returned by the service.

See Also:

• AWS API Documentation

listDatasetContentsPaginator

default ListDatasetContentsIterable listDatasetContentsPaginator(ListDatasetContentsRequest listDatasetContentsRequest)
                                                          throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

This is a variant of listDatasetContents(software.amazon.awssdk.services.iotanalytics.model.ListDatasetContentsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotanalytics.paginators.ListDatasetContentsIterable responses = client.listDatasetContentsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotanalytics.paginators.ListDatasetContentsIterable responses = client
             .listDatasetContentsPaginator(request);
     for (software.amazon.awssdk.services.iotanalytics.model.ListDatasetContentsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotanalytics.paginators.ListDatasetContentsIterable responses = client.listDatasetContentsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDatasetContentsPaginator

default ListDatasetContentsIterable listDatasetContentsPaginator(Consumer<ListDatasetContentsRequest.Builder> listDatasetContentsRequest)
                                                          throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

This is a variant of listDatasetContents(software.amazon.awssdk.services.iotanalytics.model.ListDatasetContentsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotanalytics.paginators.ListDatasetContentsIterable responses = client.listDatasetContentsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotanalytics.paginators.ListDatasetContentsIterable responses = client
             .listDatasetContentsPaginator(request);
     for (software.amazon.awssdk.services.iotanalytics.model.ListDatasetContentsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotanalytics.paginators.ListDatasetContentsIterable responses = client.listDatasetContentsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 via ListDatasetContentsRequest.builder()

Parameters:

listDatasetContentsRequest - A Consumer that will call methods on ListDatasetContentsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDatasets

default ListDatasetsResponse listDatasets(ListDatasetsRequest listDatasetsRequest)
                                   throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Retrieves information about datasets.

Parameters:

listDatasetsRequest -

Returns:

Result of the ListDatasets operation returned by the service.

See Also:

• AWS API Documentation

listDatasets

default ListDatasetsResponse listDatasets(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest)
                                   throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Retrieves information about datasets.

This is a convenience which creates an instance of the ListDatasetsRequest.Builder avoiding the need to create one manually via ListDatasetsRequest.builder()

Parameters:

listDatasetsRequest - A Consumer that will call methods on ListDatasetsRequest.Builder to create a request.

Returns:

Result of the ListDatasets operation returned by the service.

See Also:

• AWS API Documentation

listDatasets

default ListDatasetsResponse listDatasets()
                                   throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Retrieves information about datasets.

Returns:

Result of the ListDatasets operation returned by the service.

See Also:

• listDatasets(ListDatasetsRequest)
• AWS API Documentation

listDatasetsPaginator

default ListDatasetsIterable listDatasetsPaginator()
                                            throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

This is a variant of listDatasets(software.amazon.awssdk.services.iotanalytics.model.ListDatasetsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotanalytics.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotanalytics.paginators.ListDatasetsIterable responses = client
             .listDatasetsPaginator(request);
     for (software.amazon.awssdk.services.iotanalytics.model.ListDatasetsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotanalytics.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• listDatasetsPaginator(ListDatasetsRequest)
• AWS API Documentation

listDatasetsPaginator

default ListDatasetsIterable listDatasetsPaginator(ListDatasetsRequest listDatasetsRequest)
                                            throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

This is a variant of listDatasets(software.amazon.awssdk.services.iotanalytics.model.ListDatasetsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotanalytics.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotanalytics.paginators.ListDatasetsIterable responses = client
             .listDatasetsPaginator(request);
     for (software.amazon.awssdk.services.iotanalytics.model.ListDatasetsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotanalytics.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDatasetsPaginator

default ListDatasetsIterable listDatasetsPaginator(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest)
                                            throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

This is a variant of listDatasets(software.amazon.awssdk.services.iotanalytics.model.ListDatasetsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotanalytics.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotanalytics.paginators.ListDatasetsIterable responses = client
             .listDatasetsPaginator(request);
     for (software.amazon.awssdk.services.iotanalytics.model.ListDatasetsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotanalytics.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 via ListDatasetsRequest.builder()

Parameters:

listDatasetsRequest - A Consumer that will call methods on ListDatasetsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDatastores

default ListDatastoresResponse listDatastores(ListDatastoresRequest listDatastoresRequest)
                                       throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Retrieves a list of data stores.

Parameters:

listDatastoresRequest -

Returns:

Result of the ListDatastores operation returned by the service.

See Also:

• AWS API Documentation

listDatastores

default ListDatastoresResponse listDatastores(Consumer<ListDatastoresRequest.Builder> listDatastoresRequest)
                                       throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

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 via ListDatastoresRequest.builder()

Parameters:

listDatastoresRequest - A Consumer that will call methods on ListDatastoresRequest.Builder to create a request.

Returns:

Result of the ListDatastores operation returned by the service.

See Also:

• AWS API Documentation

listDatastores

default ListDatastoresResponse listDatastores()
                                       throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Retrieves a list of data stores.

Returns:

Result of the ListDatastores operation returned by the service.

See Also:

• listDatastores(ListDatastoresRequest)
• AWS API Documentation

listDatastoresPaginator

default ListDatastoresIterable listDatastoresPaginator()
                                                throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

This is a variant of listDatastores(software.amazon.awssdk.services.iotanalytics.model.ListDatastoresRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotanalytics.paginators.ListDatastoresIterable responses = client.listDatastoresPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotanalytics.paginators.ListDatastoresIterable responses = client
             .listDatastoresPaginator(request);
     for (software.amazon.awssdk.services.iotanalytics.model.ListDatastoresResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotanalytics.paginators.ListDatastoresIterable responses = client.listDatastoresPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• listDatastoresPaginator(ListDatastoresRequest)
• AWS API Documentation

listDatastoresPaginator

default ListDatastoresIterable listDatastoresPaginator(ListDatastoresRequest listDatastoresRequest)
                                                throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

This is a variant of listDatastores(software.amazon.awssdk.services.iotanalytics.model.ListDatastoresRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotanalytics.paginators.ListDatastoresIterable responses = client.listDatastoresPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotanalytics.paginators.ListDatastoresIterable responses = client
             .listDatastoresPaginator(request);
     for (software.amazon.awssdk.services.iotanalytics.model.ListDatastoresResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotanalytics.paginators.ListDatastoresIterable responses = client.listDatastoresPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDatastoresPaginator

default ListDatastoresIterable listDatastoresPaginator(Consumer<ListDatastoresRequest.Builder> listDatastoresRequest)
                                                throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

This is a variant of listDatastores(software.amazon.awssdk.services.iotanalytics.model.ListDatastoresRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotanalytics.paginators.ListDatastoresIterable responses = client.listDatastoresPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotanalytics.paginators.ListDatastoresIterable responses = client
             .listDatastoresPaginator(request);
     for (software.amazon.awssdk.services.iotanalytics.model.ListDatastoresResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotanalytics.paginators.ListDatastoresIterable responses = client.listDatastoresPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 via ListDatastoresRequest.builder()

Parameters:

listDatastoresRequest - A Consumer that will call methods on ListDatastoresRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listPipelines

default ListPipelinesResponse listPipelines(ListPipelinesRequest listPipelinesRequest)
                                     throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Retrieves a list of pipelines.

Parameters:

listPipelinesRequest -

Returns:

Result of the ListPipelines operation returned by the service.

See Also:

• AWS API Documentation

listPipelines

default ListPipelinesResponse listPipelines(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest)
                                     throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Retrieves a list of pipelines.

This is a convenience which creates an instance of the ListPipelinesRequest.Builder avoiding the need to create one manually via ListPipelinesRequest.builder()

Parameters:

listPipelinesRequest - A Consumer that will call methods on ListPipelinesRequest.Builder to create a request.

Returns:

Result of the ListPipelines operation returned by the service.

See Also:

• AWS API Documentation

listPipelines

default ListPipelinesResponse listPipelines()
                                     throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Retrieves a list of pipelines.

Returns:

Result of the ListPipelines operation returned by the service.

See Also:

• listPipelines(ListPipelinesRequest)
• AWS API Documentation

listPipelinesPaginator

default ListPipelinesIterable listPipelinesPaginator()
                                              throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

This is a variant of listPipelines(software.amazon.awssdk.services.iotanalytics.model.ListPipelinesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotanalytics.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotanalytics.paginators.ListPipelinesIterable responses = client
             .listPipelinesPaginator(request);
     for (software.amazon.awssdk.services.iotanalytics.model.ListPipelinesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotanalytics.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• listPipelinesPaginator(ListPipelinesRequest)
• AWS API Documentation

listPipelinesPaginator

default ListPipelinesIterable listPipelinesPaginator(ListPipelinesRequest listPipelinesRequest)
                                              throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

This is a variant of listPipelines(software.amazon.awssdk.services.iotanalytics.model.ListPipelinesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotanalytics.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotanalytics.paginators.ListPipelinesIterable responses = client
             .listPipelinesPaginator(request);
     for (software.amazon.awssdk.services.iotanalytics.model.ListPipelinesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotanalytics.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listPipelinesPaginator

default ListPipelinesIterable listPipelinesPaginator(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest)
                                              throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

This is a variant of listPipelines(software.amazon.awssdk.services.iotanalytics.model.ListPipelinesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.iotanalytics.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iotanalytics.paginators.ListPipelinesIterable responses = client
             .listPipelinesPaginator(request);
     for (software.amazon.awssdk.services.iotanalytics.model.ListPipelinesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iotanalytics.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 via ListPipelinesRequest.builder()

Parameters:

listPipelinesRequest - A Consumer that will call methods on ListPipelinesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
LimitExceededException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Lists the tags (metadata) that you have assigned to the resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
LimitExceededException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

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 via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

putLoggingOptions

default PutLoggingOptionsResponse putLoggingOptions(PutLoggingOptionsRequest putLoggingOptionsRequest)
                                             throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Sets or updates the IoT Analytics logging options.

If you update the value of any loggingOptions field, it takes up to one minute for the change to take effect. Also, if you change the policy attached to the role you specified in the roleArn field (for example, to correct an invalid policy), it takes up to five minutes for that change to take effect.

Parameters:

putLoggingOptionsRequest -

Returns:

Result of the PutLoggingOptions operation returned by the service.

See Also:

• AWS API Documentation

putLoggingOptions

default PutLoggingOptionsResponse putLoggingOptions(Consumer<PutLoggingOptionsRequest.Builder> putLoggingOptionsRequest)
                                             throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Sets or updates the IoT Analytics logging options.

If you update the value of any loggingOptions field, it takes up to one minute for the change to take effect. Also, if you change the policy attached to the role you specified in the roleArn field (for example, to correct an invalid policy), it takes up to five minutes for that change to take effect.

This is a convenience which creates an instance of the PutLoggingOptionsRequest.Builder avoiding the need to create one manually via PutLoggingOptionsRequest.builder()

Parameters:

putLoggingOptionsRequest - A Consumer that will call methods on PutLoggingOptionsRequest.Builder to create a request.

Returns:

Result of the PutLoggingOptions operation returned by the service.

See Also:

• AWS API Documentation

runPipelineActivity

default RunPipelineActivityResponse runPipelineActivity(RunPipelineActivityRequest runPipelineActivityRequest)
                                                 throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

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

Parameters:

runPipelineActivityRequest -

Returns:

Result of the RunPipelineActivity operation returned by the service.

See Also:

• AWS API Documentation

runPipelineActivity

default RunPipelineActivityResponse runPipelineActivity(Consumer<RunPipelineActivityRequest.Builder> runPipelineActivityRequest)
                                                 throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

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 via RunPipelineActivityRequest.builder()

Parameters:

runPipelineActivityRequest - A Consumer that will call methods on RunPipelineActivityRequest.Builder to create a request.

Returns:

Result of the RunPipelineActivity operation returned by the service.

See Also:

• AWS API Documentation

sampleChannelData

default SampleChannelDataResponse sampleChannelData(SampleChannelDataRequest sampleChannelDataRequest)
                                             throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

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

Parameters:

sampleChannelDataRequest -

Returns:

Result of the SampleChannelData operation returned by the service.

See Also:

• AWS API Documentation

sampleChannelData

default SampleChannelDataResponse sampleChannelData(Consumer<SampleChannelDataRequest.Builder> sampleChannelDataRequest)
                                             throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

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 via SampleChannelDataRequest.builder()

Parameters:

sampleChannelDataRequest - A Consumer that will call methods on SampleChannelDataRequest.Builder to create a request.

Returns:

Result of the SampleChannelData operation returned by the service.

See Also:

• AWS API Documentation

startPipelineReprocessing

default StartPipelineReprocessingResponse startPipelineReprocessing(StartPipelineReprocessingRequest startPipelineReprocessingRequest)
                                                             throws ResourceNotFoundException,
ResourceAlreadyExistsException,
InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Starts the reprocessing of raw message data through the pipeline.

Parameters:

startPipelineReprocessingRequest -

Returns:

Result of the StartPipelineReprocessing operation returned by the service.

See Also:

• AWS API Documentation

startPipelineReprocessing

default StartPipelineReprocessingResponse startPipelineReprocessing(Consumer<StartPipelineReprocessingRequest.Builder> startPipelineReprocessingRequest)
                                                             throws ResourceNotFoundException,
ResourceAlreadyExistsException,
InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

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 via StartPipelineReprocessingRequest.builder()

Parameters:

startPipelineReprocessingRequest - A Consumer that will call methods on StartPipelineReprocessingRequest.Builder to create a request.

Returns:

Result of the StartPipelineReprocessing operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
LimitExceededException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
LimitExceededException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

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 via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
LimitExceededException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Removes the given tags (metadata) from the resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws InvalidRequestException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
LimitExceededException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

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 via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateChannel

default UpdateChannelResponse updateChannel(UpdateChannelRequest updateChannelRequest)
                                     throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Used to update the settings of a channel.

Parameters:

updateChannelRequest -

Returns:

Result of the UpdateChannel operation returned by the service.

See Also:

• AWS API Documentation

updateChannel

default UpdateChannelResponse updateChannel(Consumer<UpdateChannelRequest.Builder> updateChannelRequest)
                                     throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

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 via UpdateChannelRequest.builder()

Parameters:

updateChannelRequest - A Consumer that will call methods on UpdateChannelRequest.Builder to create a request.

Returns:

Result of the UpdateChannel operation returned by the service.

See Also:

• AWS API Documentation

updateDataset

default UpdateDatasetResponse updateDataset(UpdateDatasetRequest updateDatasetRequest)
                                     throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Updates the settings of a dataset.

Parameters:

updateDatasetRequest -

Returns:

Result of the UpdateDataset operation returned by the service.

See Also:

• AWS API Documentation

updateDataset

default UpdateDatasetResponse updateDataset(Consumer<UpdateDatasetRequest.Builder> updateDatasetRequest)
                                     throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

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 via UpdateDatasetRequest.builder()

Parameters:

updateDatasetRequest - A Consumer that will call methods on UpdateDatasetRequest.Builder to create a request.

Returns:

Result of the UpdateDataset operation returned by the service.

See Also:

• AWS API Documentation

updateDatastore

default UpdateDatastoreResponse updateDatastore(UpdateDatastoreRequest updateDatastoreRequest)
                                         throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Used to update the settings of a data store.

Parameters:

updateDatastoreRequest -

Returns:

Result of the UpdateDatastore operation returned by the service.

See Also:

• AWS API Documentation

updateDatastore

default UpdateDatastoreResponse updateDatastore(Consumer<UpdateDatastoreRequest.Builder> updateDatastoreRequest)
                                         throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

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 via UpdateDatastoreRequest.builder()

Parameters:

updateDatastoreRequest - A Consumer that will call methods on UpdateDatastoreRequest.Builder to create a request.

Returns:

Result of the UpdateDatastore operation returned by the service.

See Also:

• AWS API Documentation

updatePipeline

default UpdatePipelineResponse updatePipeline(UpdatePipelineRequest updatePipelineRequest)
                                       throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Updates the settings of a pipeline. You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array.

Parameters:

updatePipelineRequest -

Returns:

Result of the UpdatePipeline operation returned by the service.

See Also:

• AWS API Documentation

updatePipeline

default UpdatePipelineResponse updatePipeline(Consumer<UpdatePipelineRequest.Builder> updatePipelineRequest)
                                       throws InvalidRequestException,
ResourceNotFoundException,
InternalFailureException,
ServiceUnavailableException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
IoTAnalyticsException

Updates the settings of a pipeline. You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array.

This is a convenience which creates an instance of the UpdatePipelineRequest.Builder avoiding the need to create one manually via UpdatePipelineRequest.builder()

Parameters:

updatePipelineRequest - A Consumer that will call methods on UpdatePipelineRequest.Builder to create a request.

Returns:

Result of the UpdatePipeline operation returned by the service.

See Also:

• AWS API Documentation

create

static IoTAnalyticsClient create()

Create a IoTAnalyticsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static IoTAnalyticsClientBuilder builder()

Create a builder that can be used to configure and create a IoTAnalyticsClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default IoTAnalyticsServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration