/*
* 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.Threading;
using System.Threading.Tasks;
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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task BatchAcknowledgeAlarmAsync(BatchAcknowledgeAlarmRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task BatchDeleteDetectorAsync(BatchDeleteDetectorRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task BatchDisableAlarmAsync(BatchDisableAlarmRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task BatchEnableAlarmAsync(BatchEnableAlarmRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task BatchPutMessageAsync(BatchPutMessageRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task BatchResetAlarmAsync(BatchResetAlarmRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task BatchSnoozeAlarmAsync(BatchSnoozeAlarmRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task BatchUpdateDetectorAsync(BatchUpdateDetectorRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Retrieves information about an alarm.
///
/// Container for the necessary parameters to execute the DescribeAlarm service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DescribeAlarmAsync(DescribeAlarmRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Returns information about the specified detector (instance).
///
/// Container for the necessary parameters to execute the DescribeDetector service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DescribeDetectorAsync(DescribeDetectorRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ListAlarmsAsync(ListAlarmsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Lists detectors (the instances of a detector model).
///
/// Container for the necessary parameters to execute the ListDetectors service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ListDetectorsAsync(ListDetectorsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
}
}