IotEventsClient
public class IotEventsClient
Inheritance
Initializers
init(config:)
public init(config: AWSClientRuntime.AWSClientConfiguration)
init(region:)
public convenience init(region: Swift.String? = nil) throws
Properties
clientName
public static let clientName = "IotEventsClient"
Methods
createAlarmModel(input:completion:)
Creates an alarm model to monitor an AWS IoT Events input attribute. You can use the alarm to get notified when the value is outside a specified range. For more information, see Create an alarm model in the AWS IoT Events Developer Guide.
public func createAlarmModel(input: CreateAlarmModelInput, completion: @escaping (ClientRuntime.SdkResult<CreateAlarmModelOutputResponse, CreateAlarmModelOutputError>) -> Void)
createDetectorModel(input:completion:)
Creates a detector model.
public func createDetectorModel(input: CreateDetectorModelInput, completion: @escaping (ClientRuntime.SdkResult<CreateDetectorModelOutputResponse, CreateDetectorModelOutputError>) -> Void)
createInput(input:completion:)
Creates an input.
public func createInput(input: CreateInputInput, completion: @escaping (ClientRuntime.SdkResult<CreateInputOutputResponse, CreateInputOutputError>) -> Void)
deleteAlarmModel(input:completion:)
Deletes an alarm model. Any alarm instances that were created based on this alarm model are also deleted. This action can’t be undone.
public func deleteAlarmModel(input: DeleteAlarmModelInput, completion: @escaping (ClientRuntime.SdkResult<DeleteAlarmModelOutputResponse, DeleteAlarmModelOutputError>) -> Void)
deleteDetectorModel(input:completion:)
Deletes a detector model. Any active instances of the detector model are also deleted.
public func deleteDetectorModel(input: DeleteDetectorModelInput, completion: @escaping (ClientRuntime.SdkResult<DeleteDetectorModelOutputResponse, DeleteDetectorModelOutputError>) -> Void)
deleteInput(input:completion:)
Deletes an input.
public func deleteInput(input: DeleteInputInput, completion: @escaping (ClientRuntime.SdkResult<DeleteInputOutputResponse, DeleteInputOutputError>) -> Void)
describeAlarmModel(input:completion:)
Retrieves information about an alarm model. If you don’t specify a value for the alarmModelVersion parameter, the latest version is returned.
public func describeAlarmModel(input: DescribeAlarmModelInput, completion: @escaping (ClientRuntime.SdkResult<DescribeAlarmModelOutputResponse, DescribeAlarmModelOutputError>) -> Void)
describeDetectorModel(input:completion:)
Describes a detector model. If the version parameter is not specified, information about the latest version is returned.
public func describeDetectorModel(input: DescribeDetectorModelInput, completion: @escaping (ClientRuntime.SdkResult<DescribeDetectorModelOutputResponse, DescribeDetectorModelOutputError>) -> Void)
describeDetectorModelAnalysis(input:completion:)
Retrieves runtime information about a detector model analysis. After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.
public func describeDetectorModelAnalysis(input: DescribeDetectorModelAnalysisInput, completion: @escaping (ClientRuntime.SdkResult<DescribeDetectorModelAnalysisOutputResponse, DescribeDetectorModelAnalysisOutputError>) -> Void)
describeInput(input:completion:)
Describes an input.
public func describeInput(input: DescribeInputInput, completion: @escaping (ClientRuntime.SdkResult<DescribeInputOutputResponse, DescribeInputOutputError>) -> Void)
describeLoggingOptions(input:completion:)
Retrieves the current settings of the AWS IoT Events logging options.
public func describeLoggingOptions(input: DescribeLoggingOptionsInput, completion: @escaping (ClientRuntime.SdkResult<DescribeLoggingOptionsOutputResponse, DescribeLoggingOptionsOutputError>) -> Void)
getDetectorModelAnalysisResults(input:completion:)
Retrieves one or more analysis results of the detector model. After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.
public func getDetectorModelAnalysisResults(input: GetDetectorModelAnalysisResultsInput, completion: @escaping (ClientRuntime.SdkResult<GetDetectorModelAnalysisResultsOutputResponse, GetDetectorModelAnalysisResultsOutputError>) -> Void)
listAlarmModelVersions(input:completion:)
Lists all the versions of an alarm model. The operation returns only the metadata associated with each alarm model version.
public func listAlarmModelVersions(input: ListAlarmModelVersionsInput, completion: @escaping (ClientRuntime.SdkResult<ListAlarmModelVersionsOutputResponse, ListAlarmModelVersionsOutputError>) -> Void)
listAlarmModels(input:completion:)
Lists the alarm models that you created. The operation returns only the metadata associated with each alarm model.
public func listAlarmModels(input: ListAlarmModelsInput, completion: @escaping (ClientRuntime.SdkResult<ListAlarmModelsOutputResponse, ListAlarmModelsOutputError>) -> Void)
listDetectorModelVersions(input:completion:)
Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned.
public func listDetectorModelVersions(input: ListDetectorModelVersionsInput, completion: @escaping (ClientRuntime.SdkResult<ListDetectorModelVersionsOutputResponse, ListDetectorModelVersionsOutputError>) -> Void)
listDetectorModels(input:completion:)
Lists the detector models you have created. Only the metadata associated with each detector model is returned.
public func listDetectorModels(input: ListDetectorModelsInput, completion: @escaping (ClientRuntime.SdkResult<ListDetectorModelsOutputResponse, ListDetectorModelsOutputError>) -> Void)
listInputRoutings(input:completion:)
Lists one or more input routings.
public func listInputRoutings(input: ListInputRoutingsInput, completion: @escaping (ClientRuntime.SdkResult<ListInputRoutingsOutputResponse, ListInputRoutingsOutputError>) -> Void)
listInputs(input:completion:)
Lists the inputs you have created.
public func listInputs(input: ListInputsInput, completion: @escaping (ClientRuntime.SdkResult<ListInputsOutputResponse, ListInputsOutputError>) -> Void)
listTagsForResource(input:completion:)
Lists the tags (metadata) you have assigned to the resource.
public func listTagsForResource(input: ListTagsForResourceInput, completion: @escaping (ClientRuntime.SdkResult<ListTagsForResourceOutputResponse, ListTagsForResourceOutputError>) -> Void)
putLoggingOptions(input:completion:)
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.
public func putLoggingOptions(input: PutLoggingOptionsInput, completion: @escaping (ClientRuntime.SdkResult<PutLoggingOptionsOutputResponse, PutLoggingOptionsOutputError>) -> Void)
startDetectorModelAnalysis(input:completion:)
Performs an analysis of your detector model. For more information, see Troubleshooting a detector model in the AWS IoT Events Developer Guide.
public func startDetectorModelAnalysis(input: StartDetectorModelAnalysisInput, completion: @escaping (ClientRuntime.SdkResult<StartDetectorModelAnalysisOutputResponse, StartDetectorModelAnalysisOutputError>) -> Void)
tagResource(input:completion:)
Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
public func tagResource(input: TagResourceInput, completion: @escaping (ClientRuntime.SdkResult<TagResourceOutputResponse, TagResourceOutputError>) -> Void)
untagResource(input:completion:)
Removes the given tags (metadata) from the resource.
public func untagResource(input: UntagResourceInput, completion: @escaping (ClientRuntime.SdkResult<UntagResourceOutputResponse, UntagResourceOutputError>) -> Void)
updateAlarmModel(input:completion:)
Updates an alarm model. Any alarms that were created based on the previous version are deleted and then created again as new data arrives.
public func updateAlarmModel(input: UpdateAlarmModelInput, completion: @escaping (ClientRuntime.SdkResult<UpdateAlarmModelOutputResponse, UpdateAlarmModelOutputError>) -> Void)
updateDetectorModel(input:completion:)
Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive.
public func updateDetectorModel(input: UpdateDetectorModelInput, completion: @escaping (ClientRuntime.SdkResult<UpdateDetectorModelOutputResponse, UpdateDetectorModelOutputError>) -> Void)
updateInput(input:completion:)
Updates an input.
public func updateInput(input: UpdateInputInput, completion: @escaping (ClientRuntime.SdkResult<UpdateInputOutputResponse, UpdateInputOutputError>) -> Void)