View on GitHub
IoTEventsData Structure Reference
IoTEventsData
public struct IoTEventsDataClient object for interacting with AWS IoTEventsData service.
AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. AWS IoT Events Data API commands enable you to send inputs to detectors, list detectors, and view or update a detector’s status.
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the IoTEventsData 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
accessKeyIdPublic access key provided by AWS
secretAccessKeyPrivate access key provided by AWS
sessionTokenToken provided by STS.AssumeRole() which allows access to another AWS account
regionRegion of server you want to communicate with
endpointCustom endpoint URL to use instead of standard AWS servers
middlewaresArray of middlewares to apply to requests and responses
eventLoopGroupProviderEventLoopGroup to use. Use
useAWSClientSharedif the client shall manage its own EventLoopGroup.
-
Sends a set of messages to the AWS IoT Events system. Each message payload is transformed into the input you specify (“inputName”) and ingested into any detectors that monitor that input. If multiple messages are sent, the order in which the messages are processed isn’t guaranteed. To guarantee ordering, you must send messages one at a time and wait for a successful response.
Declaration
Swift
public func batchPutMessage(_ input: BatchPutMessageRequest) -> EventLoopFuture<BatchPutMessageResponse> -
Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.
Declaration
Swift
public func batchUpdateDetector(_ input: BatchUpdateDetectorRequest) -> EventLoopFuture<BatchUpdateDetectorResponse> -
Returns information about the specified detector (instance).
Declaration
Swift
public func describeDetector(_ input: DescribeDetectorRequest) -> EventLoopFuture<DescribeDetectorResponse> -
Lists detectors (the instances of a detector model).
Declaration
Swift
public func listDetectors(_ input: ListDetectorsRequest) -> EventLoopFuture<ListDetectorsResponse>
-
Undocumented
See moreDeclaration
Swift
public enum ErrorCode : String, CustomStringConvertible, Codable