IAmazonIoTEvents Interface | AWS SDK for .NET V3

Interface for accessing IoTEvents

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.

Inheritance Hierarchy

Amazon.IoTEvents.IAmazonIoTEvents

Namespace: Amazon.IoTEvents
Assembly: AWSSDK.IoTEvents.dll
Version: 3.x.y.z

Syntax

public interface IAmazonIoTEvents
         IAmazonService, IDisposable

The IAmazonIoTEvents type exposes the following members

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

	Name	Description
	CreateAlarmModel(CreateAlarmModelRequest)	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.
	CreateAlarmModelAsync(CreateAlarmModelRequest, CancellationToken)	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.
	CreateDetectorModel(CreateDetectorModelRequest)	Creates a detector model.
	CreateDetectorModelAsync(CreateDetectorModelRequest, CancellationToken)	Creates a detector model.
	CreateInput(CreateInputRequest)	Creates an input.
	CreateInputAsync(CreateInputRequest, CancellationToken)	Creates an input.
	DeleteAlarmModel(DeleteAlarmModelRequest)	Deletes an alarm model. Any alarm instances that were created based on this alarm model are also deleted. This action can't be undone.
	DeleteAlarmModelAsync(DeleteAlarmModelRequest, CancellationToken)	Deletes an alarm model. Any alarm instances that were created based on this alarm model are also deleted. This action can't be undone.
	DeleteDetectorModel(DeleteDetectorModelRequest)	Deletes a detector model. Any active instances of the detector model are also deleted.
	DeleteDetectorModelAsync(DeleteDetectorModelRequest, CancellationToken)	Deletes a detector model. Any active instances of the detector model are also deleted.
	DeleteInput(DeleteInputRequest)	Deletes an input.
	DeleteInputAsync(DeleteInputRequest, CancellationToken)	Deletes an input.
	DescribeAlarmModel(DescribeAlarmModelRequest)	Retrieves information about an alarm model. If you don't specify a value for the `alarmModelVersion` parameter, the latest version is returned.
	DescribeAlarmModelAsync(DescribeAlarmModelRequest, CancellationToken)	Retrieves information about an alarm model. If you don't specify a value for the `alarmModelVersion` parameter, the latest version is returned.
	DescribeDetectorModel(DescribeDetectorModelRequest)	Describes a detector model. If the `version` parameter is not specified, information about the latest version is returned.
	DescribeDetectorModelAnalysis(DescribeDetectorModelAnalysisRequest)	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.
	DescribeDetectorModelAnalysisAsync(DescribeDetectorModelAnalysisRequest, CancellationToken)	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.
	DescribeDetectorModelAsync(DescribeDetectorModelRequest, CancellationToken)	Describes a detector model. If the `version` parameter is not specified, information about the latest version is returned.
	DescribeInput(DescribeInputRequest)	Describes an input.
	DescribeInputAsync(DescribeInputRequest, CancellationToken)	Describes an input.
	DescribeLoggingOptions(DescribeLoggingOptionsRequest)	Retrieves the current settings of the AWS IoT Events logging options.
	DescribeLoggingOptionsAsync(DescribeLoggingOptionsRequest, CancellationToken)	Retrieves the current settings of the AWS IoT Events logging options.
	DetermineServiceOperationEndpoint(AmazonWebServiceRequest)	Returns the endpoint that will be used for a particular request.
	GetDetectorModelAnalysisResults(GetDetectorModelAnalysisResultsRequest)	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.
	GetDetectorModelAnalysisResultsAsync(GetDetectorModelAnalysisResultsRequest, CancellationToken)	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.
	ListAlarmModels(ListAlarmModelsRequest)	Lists the alarm models that you created. The operation returns only the metadata associated with each alarm model.
	ListAlarmModelsAsync(ListAlarmModelsRequest, CancellationToken)	Lists the alarm models that you created. The operation returns only the metadata associated with each alarm model.
	ListAlarmModelVersions(ListAlarmModelVersionsRequest)	Lists all the versions of an alarm model. The operation returns only the metadata associated with each alarm model version.
	ListAlarmModelVersionsAsync(ListAlarmModelVersionsRequest, CancellationToken)	Lists all the versions of an alarm model. The operation returns only the metadata associated with each alarm model version.
	ListDetectorModels(ListDetectorModelsRequest)	Lists the detector models you have created. Only the metadata associated with each detector model is returned.
	ListDetectorModelsAsync(ListDetectorModelsRequest, CancellationToken)	Lists the detector models you have created. Only the metadata associated with each detector model is returned.
	ListDetectorModelVersions(ListDetectorModelVersionsRequest)	Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned.
	ListDetectorModelVersionsAsync(ListDetectorModelVersionsRequest, CancellationToken)	Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned.
	ListInputRoutings(ListInputRoutingsRequest)	Lists one or more input routings.
	ListInputRoutingsAsync(ListInputRoutingsRequest, CancellationToken)	Lists one or more input routings.
	ListInputs(ListInputsRequest)	Lists the inputs you have created.
	ListInputsAsync(ListInputsRequest, CancellationToken)	Lists the inputs you have created.
	ListTagsForResource(ListTagsForResourceRequest)	Lists the tags (metadata) you have assigned to the resource.
	ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)	Lists the tags (metadata) you have assigned to the resource.
	PutLoggingOptions(PutLoggingOptionsRequest)	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.
	PutLoggingOptionsAsync(PutLoggingOptionsRequest, CancellationToken)	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.
	StartDetectorModelAnalysis(StartDetectorModelAnalysisRequest)	Performs an analysis of your detector model. For more information, see Troubleshooting a detector model in the AWS IoT Events Developer Guide.
	StartDetectorModelAnalysisAsync(StartDetectorModelAnalysisRequest, CancellationToken)	Performs an analysis of your detector model. For more information, see Troubleshooting a detector model in the AWS IoT Events Developer Guide.
	TagResource(TagResourceRequest)	Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
	TagResourceAsync(TagResourceRequest, CancellationToken)	Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
	UntagResource(UntagResourceRequest)	Removes the given tags (metadata) from the resource.
	UntagResourceAsync(UntagResourceRequest, CancellationToken)	Removes the given tags (metadata) from the resource.
	UpdateAlarmModel(UpdateAlarmModelRequest)	Updates an alarm model. Any alarms that were created based on the previous version are deleted and then created again as new data arrives.
	UpdateAlarmModelAsync(UpdateAlarmModelRequest, CancellationToken)	Updates an alarm model. Any alarms that were created based on the previous version are deleted and then created again as new data arrives.
	UpdateDetectorModel(UpdateDetectorModelRequest)	Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive.
	UpdateDetectorModelAsync(UpdateDetectorModelRequest, CancellationToken)	Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive.
	UpdateInput(UpdateInputRequest)	Updates an input.
	UpdateInputAsync(UpdateInputRequest, CancellationToken)	Updates an input.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5