iotanalytics/aws.sdk.kotlin.services.iotanalytics

Package-level declarations

Types

interface IotAnalyticsClient : SdkClient

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

batchPutMessage

inline suspend fun IotAnalyticsClient.batchPutMessage(crossinline block: BatchPutMessageRequest.Builder.() -> Unit): BatchPutMessageResponse

Sends messages to a channel.

cancelPipelineReprocessing

inline suspend fun IotAnalyticsClient.cancelPipelineReprocessing(crossinline block: CancelPipelineReprocessingRequest.Builder.() -> Unit): CancelPipelineReprocessingResponse

Cancels the reprocessing of data through the pipeline.

createChannel

inline suspend fun IotAnalyticsClient.createChannel(crossinline block: CreateChannelRequest.Builder.() -> Unit): CreateChannelResponse

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.

createDataset

inline suspend fun IotAnalyticsClient.createDataset(crossinline block: CreateDatasetRequest.Builder.() -> Unit): CreateDatasetResponse

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.

createDatasetContent

inline suspend fun IotAnalyticsClient.createDatasetContent(crossinline block: CreateDatasetContentRequest.Builder.() -> Unit): CreateDatasetContentResponse

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

createDatastore

inline suspend fun IotAnalyticsClient.createDatastore(crossinline block: CreateDatastoreRequest.Builder.() -> Unit): CreateDatastoreResponse

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

createPipeline

inline suspend fun IotAnalyticsClient.createPipeline(crossinline block: CreatePipelineRequest.Builder.() -> Unit): CreatePipelineResponse

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.

deleteChannel

inline suspend fun IotAnalyticsClient.deleteChannel(crossinline block: DeleteChannelRequest.Builder.() -> Unit): DeleteChannelResponse

Deletes the specified channel.

deleteDataset

inline suspend fun IotAnalyticsClient.deleteDataset(crossinline block: DeleteDatasetRequest.Builder.() -> Unit): DeleteDatasetResponse

Deletes the specified dataset.

deleteDatasetContent

inline suspend fun IotAnalyticsClient.deleteDatasetContent(crossinline block: DeleteDatasetContentRequest.Builder.() -> Unit): DeleteDatasetContentResponse

Deletes the content of the specified dataset.

deleteDatastore

inline suspend fun IotAnalyticsClient.deleteDatastore(crossinline block: DeleteDatastoreRequest.Builder.() -> Unit): DeleteDatastoreResponse

Deletes the specified data store.

deletePipeline

inline suspend fun IotAnalyticsClient.deletePipeline(crossinline block: DeletePipelineRequest.Builder.() -> Unit): DeletePipelineResponse

Deletes the specified pipeline.

describeChannel

inline suspend fun IotAnalyticsClient.describeChannel(crossinline block: DescribeChannelRequest.Builder.() -> Unit): DescribeChannelResponse

Retrieves information about a channel.

describeDataset

inline suspend fun IotAnalyticsClient.describeDataset(crossinline block: DescribeDatasetRequest.Builder.() -> Unit): DescribeDatasetResponse

Retrieves information about a dataset.

describeDatastore

inline suspend fun IotAnalyticsClient.describeDatastore(crossinline block: DescribeDatastoreRequest.Builder.() -> Unit): DescribeDatastoreResponse

Retrieves information about a data store.

describeLoggingOptions

inline suspend fun IotAnalyticsClient.describeLoggingOptions(crossinline block: DescribeLoggingOptionsRequest.Builder.() -> Unit): DescribeLoggingOptionsResponse

Retrieves the current settings of the IoT Analytics logging options.

describePipeline

inline suspend fun IotAnalyticsClient.describePipeline(crossinline block: DescribePipelineRequest.Builder.() -> Unit): DescribePipelineResponse

Retrieves information about a pipeline.

getDatasetContent

inline suspend fun IotAnalyticsClient.getDatasetContent(crossinline block: GetDatasetContentRequest.Builder.() -> Unit): GetDatasetContentResponse

Retrieves the contents of a dataset as presigned URIs.

listChannels

inline suspend fun IotAnalyticsClient.listChannels(crossinline block: ListChannelsRequest.Builder.() -> Unit): ListChannelsResponse

Retrieves a list of channels.

listDatasetContents

inline suspend fun IotAnalyticsClient.listDatasetContents(crossinline block: ListDatasetContentsRequest.Builder.() -> Unit): ListDatasetContentsResponse

Lists information about dataset contents that have been created.

listDatasets

inline suspend fun IotAnalyticsClient.listDatasets(crossinline block: ListDatasetsRequest.Builder.() -> Unit): ListDatasetsResponse

Retrieves information about datasets.

listDatastores

inline suspend fun IotAnalyticsClient.listDatastores(crossinline block: ListDatastoresRequest.Builder.() -> Unit): ListDatastoresResponse

Retrieves a list of data stores.

listPipelines

inline suspend fun IotAnalyticsClient.listPipelines(crossinline block: ListPipelinesRequest.Builder.() -> Unit): ListPipelinesResponse

Retrieves a list of pipelines.

listTagsForResource

inline suspend fun IotAnalyticsClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

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

putLoggingOptions

inline suspend fun IotAnalyticsClient.putLoggingOptions(crossinline block: PutLoggingOptionsRequest.Builder.() -> Unit): PutLoggingOptionsResponse

Sets or updates the IoT Analytics logging options.

runPipelineActivity

inline suspend fun IotAnalyticsClient.runPipelineActivity(crossinline block: RunPipelineActivityRequest.Builder.() -> Unit): RunPipelineActivityResponse

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

sampleChannelData

inline suspend fun IotAnalyticsClient.sampleChannelData(crossinline block: SampleChannelDataRequest.Builder.() -> Unit): SampleChannelDataResponse

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

startPipelineReprocessing

inline suspend fun IotAnalyticsClient.startPipelineReprocessing(crossinline block: StartPipelineReprocessingRequest.Builder.() -> Unit): StartPipelineReprocessingResponse

Starts the reprocessing of raw message data through the pipeline.

tagResource

inline suspend fun IotAnalyticsClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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

untagResource

inline suspend fun IotAnalyticsClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes the given tags (metadata) from the resource.

updateChannel

inline suspend fun IotAnalyticsClient.updateChannel(crossinline block: UpdateChannelRequest.Builder.() -> Unit): UpdateChannelResponse

Used to update the settings of a channel.

updateDataset

inline suspend fun IotAnalyticsClient.updateDataset(crossinline block: UpdateDatasetRequest.Builder.() -> Unit): UpdateDatasetResponse

Updates the settings of a dataset.

updateDatastore

inline suspend fun IotAnalyticsClient.updateDatastore(crossinline block: UpdateDatastoreRequest.Builder.() -> Unit): UpdateDatastoreResponse

Used to update the settings of a data store.

updatePipeline

inline suspend fun IotAnalyticsClient.updatePipeline(crossinline block: UpdatePipelineRequest.Builder.() -> Unit): UpdatePipelineResponse

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.

withConfig

fun IotAnalyticsClient.withConfig(block: IotAnalyticsClient.Config.Builder.() -> Unit): IotAnalyticsClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.