View on GitHub
IoTEvents Structure Reference
IoTEvents
public struct IoTEventsClient object for interacting with AWS IoTEvents service.
AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. You can use AWS IoT Events API operations to create, read, update, and delete inputs and detector models, and to list their versions.
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the IoTEvents 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.
-
Creates a detector model.
Declaration
Swift
public func createDetectorModel(_ input: CreateDetectorModelRequest) -> EventLoopFuture<CreateDetectorModelResponse> -
Creates an input.
Declaration
Swift
public func createInput(_ input: CreateInputRequest) -> EventLoopFuture<CreateInputResponse> -
Deletes a detector model. Any active instances of the detector model are also deleted.
Declaration
Swift
public func deleteDetectorModel(_ input: DeleteDetectorModelRequest) -> EventLoopFuture<DeleteDetectorModelResponse> -
Deletes an input.
Declaration
Swift
public func deleteInput(_ input: DeleteInputRequest) -> EventLoopFuture<DeleteInputResponse> -
Describes a detector model. If the version parameter is not specified, information about the latest version is returned.
Declaration
Swift
public func describeDetectorModel(_ input: DescribeDetectorModelRequest) -> EventLoopFuture<DescribeDetectorModelResponse> -
Describes an input.
Declaration
Swift
public func describeInput(_ input: DescribeInputRequest) -> EventLoopFuture<DescribeInputResponse> -
Retrieves the current settings of the AWS IoT Events logging options.
Declaration
Swift
public func describeLoggingOptions(_ input: DescribeLoggingOptionsRequest) -> EventLoopFuture<DescribeLoggingOptionsResponse> -
Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned.
Declaration
Swift
public func listDetectorModelVersions(_ input: ListDetectorModelVersionsRequest) -> EventLoopFuture<ListDetectorModelVersionsResponse> -
Lists the detector models you have created. Only the metadata associated with each detector model is returned.
Declaration
Swift
public func listDetectorModels(_ input: ListDetectorModelsRequest) -> EventLoopFuture<ListDetectorModelsResponse> -
Lists the inputs you have created.
Declaration
Swift
public func listInputs(_ input: ListInputsRequest) -> EventLoopFuture<ListInputsResponse> -
Lists the tags (metadata) you have assigned to the resource.
Declaration
Swift
public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse> -
Sets or updates the AWS IoT Events logging options. If you update the value of any loggingOptions field, it takes up to one minute for the change to take effect. 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.
Declaration
Swift
@discardableResult public func putLoggingOptions(_ input: PutLoggingOptionsRequest) -> EventLoopFuture<Void> -
Adds to or modifies the tags of the given resource. Tags are metadata that 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 a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive.
Declaration
Swift
public func updateDetectorModel(_ input: UpdateDetectorModelRequest) -> EventLoopFuture<UpdateDetectorModelResponse> -
Updates an input.
Declaration
Swift
public func updateInput(_ input: UpdateInputRequest) -> EventLoopFuture<UpdateInputResponse>
-
Undocumented
See moreDeclaration
Swift
public enum DetectorModelVersionStatus : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum EvaluationMethod : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum InputStatus : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum LoggingLevel : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum PayloadType : String, CustomStringConvertible, Codable