/* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ /* * Do not modify this file. This file is generated from the iotevents-data-2018-10-23.normal.json service model. */ using System; using System.Collections.Generic; using Amazon.Runtime; using Amazon.IoTEventsData.Model; namespace Amazon.IoTEventsData { /// /// Interface for accessing IoTEventsData /// /// IoT Events monitors your equipment or device fleets for failures or changes in operation, /// and triggers actions when such events occur. You can use IoT Events Data API commands /// to send inputs to detectors, list detectors, and view or update a detector's status. /// /// /// /// For more information, see What /// is IoT Events? in the IoT Events Developer Guide. /// /// public partial interface IAmazonIoTEventsData : IAmazonService, IDisposable { #region BatchAcknowledgeAlarm /// /// Acknowledges one or more alarms. The alarms change to the ACKNOWLEDGED /// state after you acknowledge them. /// /// Container for the necessary parameters to execute the BatchAcknowledgeAlarm service method. /// /// The response from the BatchAcknowledgeAlarm service method, as returned by IoTEventsData. /// /// An internal failure occurred. /// /// /// The request was invalid. /// /// /// The service is currently unavailable. /// /// /// The request could not be completed due to throttling. /// /// REST API Reference for BatchAcknowledgeAlarm Operation BatchAcknowledgeAlarmResponse BatchAcknowledgeAlarm(BatchAcknowledgeAlarmRequest request); /// /// Initiates the asynchronous execution of the BatchAcknowledgeAlarm operation. /// /// /// Container for the necessary parameters to execute the BatchAcknowledgeAlarm operation on AmazonIoTEventsDataClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBatchAcknowledgeAlarm /// operation. /// REST API Reference for BatchAcknowledgeAlarm Operation IAsyncResult BeginBatchAcknowledgeAlarm(BatchAcknowledgeAlarmRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the BatchAcknowledgeAlarm operation. /// /// /// The IAsyncResult returned by the call to BeginBatchAcknowledgeAlarm. /// /// Returns a BatchAcknowledgeAlarmResult from IoTEventsData. /// REST API Reference for BatchAcknowledgeAlarm Operation BatchAcknowledgeAlarmResponse EndBatchAcknowledgeAlarm(IAsyncResult asyncResult); #endregion #region BatchDeleteDetector /// /// Deletes one or more detectors that were created. When a detector is deleted, its state /// will be cleared and the detector will be removed from the list of detectors. The deleted /// detector will no longer appear if referenced in the ListDetectors /// API call. /// /// Container for the necessary parameters to execute the BatchDeleteDetector service method. /// /// The response from the BatchDeleteDetector service method, as returned by IoTEventsData. /// /// An internal failure occurred. /// /// /// The request was invalid. /// /// /// The service is currently unavailable. /// /// /// The request could not be completed due to throttling. /// /// REST API Reference for BatchDeleteDetector Operation BatchDeleteDetectorResponse BatchDeleteDetector(BatchDeleteDetectorRequest request); /// /// Initiates the asynchronous execution of the BatchDeleteDetector operation. /// /// /// Container for the necessary parameters to execute the BatchDeleteDetector operation on AmazonIoTEventsDataClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBatchDeleteDetector /// operation. /// REST API Reference for BatchDeleteDetector Operation IAsyncResult BeginBatchDeleteDetector(BatchDeleteDetectorRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the BatchDeleteDetector operation. /// /// /// The IAsyncResult returned by the call to BeginBatchDeleteDetector. /// /// Returns a BatchDeleteDetectorResult from IoTEventsData. /// REST API Reference for BatchDeleteDetector Operation BatchDeleteDetectorResponse EndBatchDeleteDetector(IAsyncResult asyncResult); #endregion #region BatchDisableAlarm /// /// Disables one or more alarms. The alarms change to the DISABLED state /// after you disable them. /// /// Container for the necessary parameters to execute the BatchDisableAlarm service method. /// /// The response from the BatchDisableAlarm service method, as returned by IoTEventsData. /// /// An internal failure occurred. /// /// /// The request was invalid. /// /// /// The service is currently unavailable. /// /// /// The request could not be completed due to throttling. /// /// REST API Reference for BatchDisableAlarm Operation BatchDisableAlarmResponse BatchDisableAlarm(BatchDisableAlarmRequest request); /// /// Initiates the asynchronous execution of the BatchDisableAlarm operation. /// /// /// Container for the necessary parameters to execute the BatchDisableAlarm operation on AmazonIoTEventsDataClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBatchDisableAlarm /// operation. /// REST API Reference for BatchDisableAlarm Operation IAsyncResult BeginBatchDisableAlarm(BatchDisableAlarmRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the BatchDisableAlarm operation. /// /// /// The IAsyncResult returned by the call to BeginBatchDisableAlarm. /// /// Returns a BatchDisableAlarmResult from IoTEventsData. /// REST API Reference for BatchDisableAlarm Operation BatchDisableAlarmResponse EndBatchDisableAlarm(IAsyncResult asyncResult); #endregion #region BatchEnableAlarm /// /// Enables one or more alarms. The alarms change to the NORMAL state after /// you enable them. /// /// Container for the necessary parameters to execute the BatchEnableAlarm service method. /// /// The response from the BatchEnableAlarm service method, as returned by IoTEventsData. /// /// An internal failure occurred. /// /// /// The request was invalid. /// /// /// The service is currently unavailable. /// /// /// The request could not be completed due to throttling. /// /// REST API Reference for BatchEnableAlarm Operation BatchEnableAlarmResponse BatchEnableAlarm(BatchEnableAlarmRequest request); /// /// Initiates the asynchronous execution of the BatchEnableAlarm operation. /// /// /// Container for the necessary parameters to execute the BatchEnableAlarm operation on AmazonIoTEventsDataClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBatchEnableAlarm /// operation. /// REST API Reference for BatchEnableAlarm Operation IAsyncResult BeginBatchEnableAlarm(BatchEnableAlarmRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the BatchEnableAlarm operation. /// /// /// The IAsyncResult returned by the call to BeginBatchEnableAlarm. /// /// Returns a BatchEnableAlarmResult from IoTEventsData. /// REST API Reference for BatchEnableAlarm Operation BatchEnableAlarmResponse EndBatchEnableAlarm(IAsyncResult asyncResult); #endregion #region BatchPutMessage /// /// Sends a set of messages to the 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. /// /// Container for the necessary parameters to execute the BatchPutMessage service method. /// /// The response from the BatchPutMessage service method, as returned by IoTEventsData. /// /// An internal failure occurred. /// /// /// The request was invalid. /// /// /// The service is currently unavailable. /// /// /// The request could not be completed due to throttling. /// /// REST API Reference for BatchPutMessage Operation BatchPutMessageResponse BatchPutMessage(BatchPutMessageRequest request); /// /// Initiates the asynchronous execution of the BatchPutMessage operation. /// /// /// Container for the necessary parameters to execute the BatchPutMessage operation on AmazonIoTEventsDataClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBatchPutMessage /// operation. /// REST API Reference for BatchPutMessage Operation IAsyncResult BeginBatchPutMessage(BatchPutMessageRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the BatchPutMessage operation. /// /// /// The IAsyncResult returned by the call to BeginBatchPutMessage. /// /// Returns a BatchPutMessageResult from IoTEventsData. /// REST API Reference for BatchPutMessage Operation BatchPutMessageResponse EndBatchPutMessage(IAsyncResult asyncResult); #endregion #region BatchResetAlarm /// /// Resets one or more alarms. The alarms return to the NORMAL state after /// you reset them. /// /// Container for the necessary parameters to execute the BatchResetAlarm service method. /// /// The response from the BatchResetAlarm service method, as returned by IoTEventsData. /// /// An internal failure occurred. /// /// /// The request was invalid. /// /// /// The service is currently unavailable. /// /// /// The request could not be completed due to throttling. /// /// REST API Reference for BatchResetAlarm Operation BatchResetAlarmResponse BatchResetAlarm(BatchResetAlarmRequest request); /// /// Initiates the asynchronous execution of the BatchResetAlarm operation. /// /// /// Container for the necessary parameters to execute the BatchResetAlarm operation on AmazonIoTEventsDataClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBatchResetAlarm /// operation. /// REST API Reference for BatchResetAlarm Operation IAsyncResult BeginBatchResetAlarm(BatchResetAlarmRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the BatchResetAlarm operation. /// /// /// The IAsyncResult returned by the call to BeginBatchResetAlarm. /// /// Returns a BatchResetAlarmResult from IoTEventsData. /// REST API Reference for BatchResetAlarm Operation BatchResetAlarmResponse EndBatchResetAlarm(IAsyncResult asyncResult); #endregion #region BatchSnoozeAlarm /// /// Changes one or more alarms to the snooze mode. The alarms change to the SNOOZE_DISABLED /// state after you set them to the snooze mode. /// /// Container for the necessary parameters to execute the BatchSnoozeAlarm service method. /// /// The response from the BatchSnoozeAlarm service method, as returned by IoTEventsData. /// /// An internal failure occurred. /// /// /// The request was invalid. /// /// /// The service is currently unavailable. /// /// /// The request could not be completed due to throttling. /// /// REST API Reference for BatchSnoozeAlarm Operation BatchSnoozeAlarmResponse BatchSnoozeAlarm(BatchSnoozeAlarmRequest request); /// /// Initiates the asynchronous execution of the BatchSnoozeAlarm operation. /// /// /// Container for the necessary parameters to execute the BatchSnoozeAlarm operation on AmazonIoTEventsDataClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBatchSnoozeAlarm /// operation. /// REST API Reference for BatchSnoozeAlarm Operation IAsyncResult BeginBatchSnoozeAlarm(BatchSnoozeAlarmRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the BatchSnoozeAlarm operation. /// /// /// The IAsyncResult returned by the call to BeginBatchSnoozeAlarm. /// /// Returns a BatchSnoozeAlarmResult from IoTEventsData. /// REST API Reference for BatchSnoozeAlarm Operation BatchSnoozeAlarmResponse EndBatchSnoozeAlarm(IAsyncResult asyncResult); #endregion #region BatchUpdateDetector /// /// Updates the state, variable values, and timer settings of one or more detectors (instances) /// of a specified detector model. /// /// Container for the necessary parameters to execute the BatchUpdateDetector service method. /// /// The response from the BatchUpdateDetector service method, as returned by IoTEventsData. /// /// An internal failure occurred. /// /// /// The request was invalid. /// /// /// The service is currently unavailable. /// /// /// The request could not be completed due to throttling. /// /// REST API Reference for BatchUpdateDetector Operation BatchUpdateDetectorResponse BatchUpdateDetector(BatchUpdateDetectorRequest request); /// /// Initiates the asynchronous execution of the BatchUpdateDetector operation. /// /// /// Container for the necessary parameters to execute the BatchUpdateDetector operation on AmazonIoTEventsDataClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBatchUpdateDetector /// operation. /// REST API Reference for BatchUpdateDetector Operation IAsyncResult BeginBatchUpdateDetector(BatchUpdateDetectorRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the BatchUpdateDetector operation. /// /// /// The IAsyncResult returned by the call to BeginBatchUpdateDetector. /// /// Returns a BatchUpdateDetectorResult from IoTEventsData. /// REST API Reference for BatchUpdateDetector Operation BatchUpdateDetectorResponse EndBatchUpdateDetector(IAsyncResult asyncResult); #endregion #region DescribeAlarm /// /// Retrieves information about an alarm. /// /// Container for the necessary parameters to execute the DescribeAlarm service method. /// /// The response from the DescribeAlarm service method, as returned by IoTEventsData. /// /// An internal failure occurred. /// /// /// The request was invalid. /// /// /// The resource was not found. /// /// /// The service is currently unavailable. /// /// /// The request could not be completed due to throttling. /// /// REST API Reference for DescribeAlarm Operation DescribeAlarmResponse DescribeAlarm(DescribeAlarmRequest request); /// /// Initiates the asynchronous execution of the DescribeAlarm operation. /// /// /// Container for the necessary parameters to execute the DescribeAlarm operation on AmazonIoTEventsDataClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeAlarm /// operation. /// REST API Reference for DescribeAlarm Operation IAsyncResult BeginDescribeAlarm(DescribeAlarmRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribeAlarm operation. /// /// /// The IAsyncResult returned by the call to BeginDescribeAlarm. /// /// Returns a DescribeAlarmResult from IoTEventsData. /// REST API Reference for DescribeAlarm Operation DescribeAlarmResponse EndDescribeAlarm(IAsyncResult asyncResult); #endregion #region DescribeDetector /// /// Returns information about the specified detector (instance). /// /// Container for the necessary parameters to execute the DescribeDetector service method. /// /// The response from the DescribeDetector service method, as returned by IoTEventsData. /// /// An internal failure occurred. /// /// /// The request was invalid. /// /// /// The resource was not found. /// /// /// The service is currently unavailable. /// /// /// The request could not be completed due to throttling. /// /// REST API Reference for DescribeDetector Operation DescribeDetectorResponse DescribeDetector(DescribeDetectorRequest request); /// /// Initiates the asynchronous execution of the DescribeDetector operation. /// /// /// Container for the necessary parameters to execute the DescribeDetector operation on AmazonIoTEventsDataClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeDetector /// operation. /// REST API Reference for DescribeDetector Operation IAsyncResult BeginDescribeDetector(DescribeDetectorRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribeDetector operation. /// /// /// The IAsyncResult returned by the call to BeginDescribeDetector. /// /// Returns a DescribeDetectorResult from IoTEventsData. /// REST API Reference for DescribeDetector Operation DescribeDetectorResponse EndDescribeDetector(IAsyncResult asyncResult); #endregion #region ListAlarms /// /// Lists one or more alarms. The operation returns only the metadata associated with /// each alarm. /// /// Container for the necessary parameters to execute the ListAlarms service method. /// /// The response from the ListAlarms service method, as returned by IoTEventsData. /// /// An internal failure occurred. /// /// /// The request was invalid. /// /// /// The resource was not found. /// /// /// The service is currently unavailable. /// /// /// The request could not be completed due to throttling. /// /// REST API Reference for ListAlarms Operation ListAlarmsResponse ListAlarms(ListAlarmsRequest request); /// /// Initiates the asynchronous execution of the ListAlarms operation. /// /// /// Container for the necessary parameters to execute the ListAlarms operation on AmazonIoTEventsDataClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListAlarms /// operation. /// REST API Reference for ListAlarms Operation IAsyncResult BeginListAlarms(ListAlarmsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListAlarms operation. /// /// /// The IAsyncResult returned by the call to BeginListAlarms. /// /// Returns a ListAlarmsResult from IoTEventsData. /// REST API Reference for ListAlarms Operation ListAlarmsResponse EndListAlarms(IAsyncResult asyncResult); #endregion #region ListDetectors /// /// Lists detectors (the instances of a detector model). /// /// Container for the necessary parameters to execute the ListDetectors service method. /// /// The response from the ListDetectors service method, as returned by IoTEventsData. /// /// An internal failure occurred. /// /// /// The request was invalid. /// /// /// The resource was not found. /// /// /// The service is currently unavailable. /// /// /// The request could not be completed due to throttling. /// /// REST API Reference for ListDetectors Operation ListDetectorsResponse ListDetectors(ListDetectorsRequest request); /// /// Initiates the asynchronous execution of the ListDetectors operation. /// /// /// Container for the necessary parameters to execute the ListDetectors operation on AmazonIoTEventsDataClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListDetectors /// operation. /// REST API Reference for ListDetectors Operation IAsyncResult BeginListDetectors(ListDetectorsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListDetectors operation. /// /// /// The IAsyncResult returned by the call to BeginListDetectors. /// /// Returns a ListDetectorsResult from IoTEventsData. /// REST API Reference for ListDetectors Operation ListDetectorsResponse EndListDetectors(IAsyncResult asyncResult); #endregion } }