IoTAnalytics
public struct IoTAnalytics
Client object for interacting with AWS IoTAnalytics service.
AWS 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. AWS 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. AWS IoT Analytics automates the steps required to analyze data from IoT devices. AWS 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. AWS 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.
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the IoTAnalytics client
Declaration
Swift
public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)
Parameters
accessKeyId
Public access key provided by AWS
secretAccessKey
Private access key provided by AWS
sessionToken
Token provided by STS.AssumeRole() which allows access to another AWS account
region
Region of server you want to communicate with
endpoint
Custom endpoint URL to use instead of standard AWS servers
middlewares
Array of middlewares to apply to requests and responses
eventLoopGroupProvider
EventLoopGroup to use. Use
useAWSClientShared
if the client shall manage its own EventLoopGroup.
-
Sends messages to a channel.
Declaration
Swift
public func batchPutMessage(_ input: BatchPutMessageRequest) -> EventLoopFuture<BatchPutMessageResponse>
-
Cancels the reprocessing of data through the pipeline.
Declaration
Swift
public func cancelPipelineReprocessing(_ input: CancelPipelineReprocessingRequest) -> EventLoopFuture<CancelPipelineReprocessingResponse>
-
Creates a channel. A channel collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline.
Declaration
Swift
public func createChannel(_ input: CreateChannelRequest) -> EventLoopFuture<CreateChannelResponse>
-
Creates a data set. A data set 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 data set. The data set can be populated manually by calling “CreateDatasetContent” or automatically according to a “trigger” you specify.
Declaration
Swift
public func createDataset(_ input: CreateDatasetRequest) -> EventLoopFuture<CreateDatasetResponse>
-
Creates the content of a data set by applying a “queryAction” (a SQL query) or a “containerAction” (executing a containerized application).
Declaration
Swift
public func createDatasetContent(_ input: CreateDatasetContentRequest) -> EventLoopFuture<CreateDatasetContentResponse>
-
Creates a data store, which is a repository for messages.
Declaration
Swift
public func createDatastore(_ input: CreateDatastoreRequest) -> EventLoopFuture<CreateDatastoreResponse>
-
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.
Declaration
Swift
public func createPipeline(_ input: CreatePipelineRequest) -> EventLoopFuture<CreatePipelineResponse>
-
Deletes the specified channel.
Declaration
Swift
@discardableResult public func deleteChannel(_ input: DeleteChannelRequest) -> EventLoopFuture<Void>
-
Deletes the specified data set. You do not have to delete the content of the data set before you perform this operation.
Declaration
Swift
@discardableResult public func deleteDataset(_ input: DeleteDatasetRequest) -> EventLoopFuture<Void>
-
Deletes the content of the specified data set.
Declaration
Swift
@discardableResult public func deleteDatasetContent(_ input: DeleteDatasetContentRequest) -> EventLoopFuture<Void>
-
Deletes the specified data store.
Declaration
Swift
@discardableResult public func deleteDatastore(_ input: DeleteDatastoreRequest) -> EventLoopFuture<Void>
-
Deletes the specified pipeline.
Declaration
Swift
@discardableResult public func deletePipeline(_ input: DeletePipelineRequest) -> EventLoopFuture<Void>
-
Retrieves information about a channel.
Declaration
Swift
public func describeChannel(_ input: DescribeChannelRequest) -> EventLoopFuture<DescribeChannelResponse>
-
Retrieves information about a data set.
Declaration
Swift
public func describeDataset(_ input: DescribeDatasetRequest) -> EventLoopFuture<DescribeDatasetResponse>
-
Retrieves information about a data store.
Declaration
Swift
public func describeDatastore(_ input: DescribeDatastoreRequest) -> EventLoopFuture<DescribeDatastoreResponse>
-
Retrieves the current settings of the AWS IoT Analytics logging options.
Declaration
Swift
public func describeLoggingOptions(_ input: DescribeLoggingOptionsRequest) -> EventLoopFuture<DescribeLoggingOptionsResponse>
-
Retrieves information about a pipeline.
Declaration
Swift
public func describePipeline(_ input: DescribePipelineRequest) -> EventLoopFuture<DescribePipelineResponse>
-
Retrieves the contents of a data set as pre-signed URIs.
Declaration
Swift
public func getDatasetContent(_ input: GetDatasetContentRequest) -> EventLoopFuture<GetDatasetContentResponse>
-
Retrieves a list of channels.
Declaration
Swift
public func listChannels(_ input: ListChannelsRequest) -> EventLoopFuture<ListChannelsResponse>
-
Lists information about data set contents that have been created.
Declaration
Swift
public func listDatasetContents(_ input: ListDatasetContentsRequest) -> EventLoopFuture<ListDatasetContentsResponse>
-
Retrieves information about data sets.
Declaration
Swift
public func listDatasets(_ input: ListDatasetsRequest) -> EventLoopFuture<ListDatasetsResponse>
-
Retrieves a list of data stores.
Declaration
Swift
public func listDatastores(_ input: ListDatastoresRequest) -> EventLoopFuture<ListDatastoresResponse>
-
Retrieves a list of pipelines.
Declaration
Swift
public func listPipelines(_ input: ListPipelinesRequest) -> EventLoopFuture<ListPipelinesResponse>
-
Lists the tags (metadata) which you have assigned to the resource.
Declaration
Swift
public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse>
-
Sets or updates the AWS IoT Analytics logging options. Note that 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 5 minutes for that change to take effect.
Declaration
Swift
@discardableResult public func putLoggingOptions(_ input: PutLoggingOptionsRequest) -> EventLoopFuture<Void>
-
Simulates the results of running a pipeline activity on a message payload.
Declaration
Swift
public func runPipelineActivity(_ input: RunPipelineActivityRequest) -> EventLoopFuture<RunPipelineActivityResponse>
-
Retrieves a sample of messages from the specified channel ingested during the specified timeframe. Up to 10 messages can be retrieved.
Declaration
Swift
public func sampleChannelData(_ input: SampleChannelDataRequest) -> EventLoopFuture<SampleChannelDataResponse>
-
Starts the reprocessing of raw message data through the pipeline.
Declaration
Swift
public func startPipelineReprocessing(_ input: StartPipelineReprocessingRequest) -> EventLoopFuture<StartPipelineReprocessingResponse>
-
Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.
Declaration
Swift
public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<TagResourceResponse>
-
Removes the given tags (metadata) from the resource.
Declaration
Swift
public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<UntagResourceResponse>
-
Updates the settings of a channel.
Declaration
Swift
@discardableResult public func updateChannel(_ input: UpdateChannelRequest) -> EventLoopFuture<Void>
-
Updates the settings of a data set.
Declaration
Swift
@discardableResult public func updateDataset(_ input: UpdateDatasetRequest) -> EventLoopFuture<Void>
-
Updates the settings of a data store.
Declaration
Swift
@discardableResult public func updateDatastore(_ input: UpdateDatastoreRequest) -> EventLoopFuture<Void>
-
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.
Declaration
Swift
@discardableResult public func updatePipeline(_ input: UpdatePipelineRequest) -> EventLoopFuture<Void>
-
Retrieves a list of channels.
Declaration
Swift
public func listChannelsPaginator(_ input: ListChannelsRequest, onPage: @escaping (ListChannelsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Lists information about data set contents that have been created.
Declaration
Swift
public func listDatasetContentsPaginator(_ input: ListDatasetContentsRequest, onPage: @escaping (ListDatasetContentsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Retrieves information about data sets.
Declaration
Swift
public func listDatasetsPaginator(_ input: ListDatasetsRequest, onPage: @escaping (ListDatasetsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Retrieves a list of data stores.
Declaration
Swift
public func listDatastoresPaginator(_ input: ListDatastoresRequest, onPage: @escaping (ListDatastoresResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Retrieves a list of pipelines.
Declaration
Swift
public func listPipelinesPaginator(_ input: ListPipelinesRequest, onPage: @escaping (ListPipelinesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Undocumented
See moreDeclaration
Swift
public struct ListChannelsRequest : AWSShape
extension IoTAnalytics.ListChannelsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListDatasetContentsRequest : AWSShape
extension IoTAnalytics.ListDatasetContentsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListDatasetsRequest : AWSShape
extension IoTAnalytics.ListDatasetsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListDatastoresRequest : AWSShape
extension IoTAnalytics.ListDatastoresRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListPipelinesRequest : AWSShape
extension IoTAnalytics.ListPipelinesRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public enum ChannelStatus : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ComputeType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum DatasetActionType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum DatasetContentState : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum DatasetStatus : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum DatastoreStatus : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum LoggingLevel : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ReprocessingStatus : String, CustomStringConvertible, Codable