Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

IoTAnalytics

import { IoTAnalytics } from "https://aws-api.deno.dev/v0.3/services/iotanalytics.ts?docs=full";
class IoTAnalytics {
constructor(apiFactory: client.ApiFactory);
async batchPutMessage(params: BatchPutMessageRequest, opts?: client.RequestOptions): Promise<BatchPutMessageResponse>;
async cancelPipelineReprocessing(params: CancelPipelineReprocessingRequest, opts?: client.RequestOptions): Promise<void>;
async createChannel(params: CreateChannelRequest, opts?: client.RequestOptions): Promise<CreateChannelResponse>;
async createDataset(params: CreateDatasetRequest, opts?: client.RequestOptions): Promise<CreateDatasetResponse>;
async createDatasetContent(params: CreateDatasetContentRequest, opts?: client.RequestOptions): Promise<CreateDatasetContentResponse>;
async createDatastore(params: CreateDatastoreRequest, opts?: client.RequestOptions): Promise<CreateDatastoreResponse>;
async createPipeline(params: CreatePipelineRequest, opts?: client.RequestOptions): Promise<CreatePipelineResponse>;
async deleteChannel(params: DeleteChannelRequest, opts?: client.RequestOptions): Promise<void>;
async deleteDataset(params: DeleteDatasetRequest, opts?: client.RequestOptions): Promise<void>;
async deleteDatasetContent(params: DeleteDatasetContentRequest, opts?: client.RequestOptions): Promise<void>;
async deleteDatastore(params: DeleteDatastoreRequest, opts?: client.RequestOptions): Promise<void>;
async deletePipeline(params: DeletePipelineRequest, opts?: client.RequestOptions): Promise<void>;
async describeChannel(params: DescribeChannelRequest, opts?: client.RequestOptions): Promise<DescribeChannelResponse>;
async describeDataset(params: DescribeDatasetRequest, opts?: client.RequestOptions): Promise<DescribeDatasetResponse>;
async describeDatastore(params: DescribeDatastoreRequest, opts?: client.RequestOptions): Promise<DescribeDatastoreResponse>;
async describeLoggingOptions(opts?: client.RequestOptions): Promise<DescribeLoggingOptionsResponse>;
async describePipeline(params: DescribePipelineRequest, opts?: client.RequestOptions): Promise<DescribePipelineResponse>;
async getDatasetContent(params: GetDatasetContentRequest, opts?: client.RequestOptions): Promise<GetDatasetContentResponse>;
async listChannels(params?: ListChannelsRequest, opts?: client.RequestOptions): Promise<ListChannelsResponse>;
async listDatasetContents(params: ListDatasetContentsRequest, opts?: client.RequestOptions): Promise<ListDatasetContentsResponse>;
async listDatasets(params?: ListDatasetsRequest, opts?: client.RequestOptions): Promise<ListDatasetsResponse>;
async listDatastores(params?: ListDatastoresRequest, opts?: client.RequestOptions): Promise<ListDatastoresResponse>;
async listPipelines(params?: ListPipelinesRequest, opts?: client.RequestOptions): Promise<ListPipelinesResponse>;
async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;
async putLoggingOptions(params: PutLoggingOptionsRequest, opts?: client.RequestOptions): Promise<void>;
async runPipelineActivity(params: RunPipelineActivityRequest, opts?: client.RequestOptions): Promise<RunPipelineActivityResponse>;
async sampleChannelData(params: SampleChannelDataRequest, opts?: client.RequestOptions): Promise<SampleChannelDataResponse>;
async startPipelineReprocessing(params: StartPipelineReprocessingRequest, opts?: client.RequestOptions): Promise<StartPipelineReprocessingResponse>;
async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async updateChannel(params: UpdateChannelRequest, opts?: client.RequestOptions): Promise<void>;
async updateDataset(params: UpdateDatasetRequest, opts?: client.RequestOptions): Promise<void>;
async updateDatastore(params: UpdateDatastoreRequest, opts?: client.RequestOptions): Promise<void>;
async updatePipeline(params: UpdatePipelineRequest, opts?: client.RequestOptions): Promise<void>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

§
new IoTAnalytics(apiFactory: client.ApiFactory)
[src]

§Methods

§
batchPutMessage(params: BatchPutMessageRequest, opts?: client.RequestOptions): Promise<BatchPutMessageResponse>
[src]

Sends messages to a channel.

§
cancelPipelineReprocessing(params: CancelPipelineReprocessingRequest, opts?: client.RequestOptions): Promise<void>
[src]

Cancels the reprocessing of data through the pipeline.

§
createChannel(params: CreateChannelRequest, opts?: client.RequestOptions): Promise<CreateChannelResponse>
[src]

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(params: CreateDatasetRequest, opts?: client.RequestOptions): Promise<CreateDatasetResponse>
[src]

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(params: CreateDatasetContentRequest, opts?: client.RequestOptions): Promise<CreateDatasetContentResponse>
[src]

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

§
createDatastore(params: CreateDatastoreRequest, opts?: client.RequestOptions): Promise<CreateDatastoreResponse>
[src]

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

§
createPipeline(params: CreatePipelineRequest, opts?: client.RequestOptions): Promise<CreatePipelineResponse>
[src]

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(params: DeleteChannelRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes the specified channel.

§
deleteDataset(params: DeleteDatasetRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes the specified dataset.

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

§
deleteDatasetContent(params: DeleteDatasetContentRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes the content of the specified dataset.

§
deleteDatastore(params: DeleteDatastoreRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes the specified data store.

§
deletePipeline(params: DeletePipelineRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes the specified pipeline.

§
describeChannel(params: DescribeChannelRequest, opts?: client.RequestOptions): Promise<DescribeChannelResponse>
[src]

Retrieves information about a channel.

§
describeDataset(params: DescribeDatasetRequest, opts?: client.RequestOptions): Promise<DescribeDatasetResponse>
[src]

Retrieves information about a dataset.

§
describeDatastore(params: DescribeDatastoreRequest, opts?: client.RequestOptions): Promise<DescribeDatastoreResponse>
[src]

Retrieves information about a data store.

§
describeLoggingOptions(opts?: client.RequestOptions): Promise<DescribeLoggingOptionsResponse>
[src]

Retrieves the current settings of the IoT Analytics logging options.

§
describePipeline(params: DescribePipelineRequest, opts?: client.RequestOptions): Promise<DescribePipelineResponse>
[src]

Retrieves information about a pipeline.

§
getDatasetContent(params: GetDatasetContentRequest, opts?: client.RequestOptions): Promise<GetDatasetContentResponse>
[src]

Retrieves the contents of a dataset as presigned URIs.

§
listChannels(params?: ListChannelsRequest, opts?: client.RequestOptions): Promise<ListChannelsResponse>
[src]

Retrieves a list of channels.

§
listDatasetContents(params: ListDatasetContentsRequest, opts?: client.RequestOptions): Promise<ListDatasetContentsResponse>
[src]

Lists information about dataset contents that have been created.

§
listDatasets(params?: ListDatasetsRequest, opts?: client.RequestOptions): Promise<ListDatasetsResponse>
[src]

Retrieves information about datasets.

§
listDatastores(params?: ListDatastoresRequest, opts?: client.RequestOptions): Promise<ListDatastoresResponse>
[src]

Retrieves a list of data stores.

§
listPipelines(params?: ListPipelinesRequest, opts?: client.RequestOptions): Promise<ListPipelinesResponse>
[src]

Retrieves a list of pipelines.

§
listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>
[src]

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

§
putLoggingOptions(params: PutLoggingOptionsRequest, opts?: client.RequestOptions): Promise<void>
[src]

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.

§
runPipelineActivity(params: RunPipelineActivityRequest, opts?: client.RequestOptions): Promise<RunPipelineActivityResponse>
[src]

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

§
sampleChannelData(params: SampleChannelDataRequest, opts?: client.RequestOptions): Promise<SampleChannelDataResponse>
[src]

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

§
startPipelineReprocessing(params: StartPipelineReprocessingRequest, opts?: client.RequestOptions): Promise<StartPipelineReprocessingResponse>
[src]

Starts the reprocessing of raw message data through the pipeline.

§
tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

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

§
untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

Removes the given tags (metadata) from the resource.

§
updateChannel(params: UpdateChannelRequest, opts?: client.RequestOptions): Promise<void>
[src]

Used to update the settings of a channel.

§
updateDataset(params: UpdateDatasetRequest, opts?: client.RequestOptions): Promise<void>
[src]

Updates the settings of a dataset.

§
updateDatastore(params: UpdateDatastoreRequest, opts?: client.RequestOptions): Promise<void>
[src]

Used to update the settings of a data store.

§
updatePipeline(params: UpdatePipelineRequest, opts?: client.RequestOptions): Promise<void>
[src]

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.

§Static Properties