/*
* 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-2018-07-27.normal.json service model.
*/
using System;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.IoTEvents.Model;
namespace Amazon.IoTEvents
{
///
/// 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.
///
public partial interface IAmazonIoTEvents : IAmazonService, IDisposable
{
#region CreateAlarmModel
///
/// 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.
///
/// Container for the necessary parameters to execute the CreateAlarmModel service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateAlarmModel service method, as returned by IoTEvents.
///
/// An internal failure occurred.
///
///
/// The request was invalid.
///
///
/// A limit was exceeded.
///
///
/// The resource already exists.
///
///
/// The resource is in use.
///
///
/// The service is currently unavailable.
///
///
/// The request could not be completed due to throttling.
///
/// REST API Reference for CreateAlarmModel Operation
Task CreateAlarmModelAsync(CreateAlarmModelRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateDetectorModel
///
/// Creates a detector model.
///
/// Container for the necessary parameters to execute the CreateDetectorModel service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateDetectorModel service method, as returned by IoTEvents.
///
/// An internal failure occurred.
///
///
/// The request was invalid.
///
///
/// A limit was exceeded.
///
///
/// The resource already exists.
///
///
/// The resource is in use.
///
///
/// The service is currently unavailable.
///
///
/// The request could not be completed due to throttling.
///
/// REST API Reference for CreateDetectorModel Operation
Task CreateDetectorModelAsync(CreateDetectorModelRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateInput
///
/// Creates an input.
///
/// Container for the necessary parameters to execute the CreateInput service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateInput service method, as returned by IoTEvents.
///
/// An internal failure occurred.
///
///
/// The request was invalid.
///
///
/// The resource already exists.
///
///
/// The service is currently unavailable.
///
///
/// The request could not be completed due to throttling.
///
/// REST API Reference for CreateInput Operation
Task CreateInputAsync(CreateInputRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteAlarmModel
///
/// Deletes an alarm model. Any alarm instances that were created based on this alarm
/// model are also deleted. This action can't be undone.
///
/// Container for the necessary parameters to execute the DeleteAlarmModel service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteAlarmModel service method, as returned by IoTEvents.
///
/// An internal failure occurred.
///
///
/// The request was invalid.
///
///
/// The resource is in use.
///
///
/// The resource was not found.
///
///
/// The service is currently unavailable.
///
///
/// The request could not be completed due to throttling.
///
/// REST API Reference for DeleteAlarmModel Operation
Task DeleteAlarmModelAsync(DeleteAlarmModelRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteDetectorModel
///
/// Deletes a detector model. Any active instances of the detector model are also deleted.
///
/// Container for the necessary parameters to execute the DeleteDetectorModel service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteDetectorModel service method, as returned by IoTEvents.
///
/// An internal failure occurred.
///
///
/// The request was invalid.
///
///
/// The resource is in use.
///
///
/// The resource was not found.
///
///
/// The service is currently unavailable.
///
///
/// The request could not be completed due to throttling.
///
/// REST API Reference for DeleteDetectorModel Operation
Task DeleteDetectorModelAsync(DeleteDetectorModelRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteInput
///
/// Deletes an input.
///
/// Container for the necessary parameters to execute the DeleteInput service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteInput service method, as returned by IoTEvents.
///
/// An internal failure occurred.
///
///
/// The request was invalid.
///
///
/// The resource is in use.
///
///
/// The resource was not found.
///
///
/// The service is currently unavailable.
///
///
/// The request could not be completed due to throttling.
///
/// REST API Reference for DeleteInput Operation
Task DeleteInputAsync(DeleteInputRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeAlarmModel
///
/// Retrieves information about an alarm model. If you don't specify a value for the alarmModelVersion
/// parameter, the latest version is returned.
///
/// Container for the necessary parameters to execute the DescribeAlarmModel service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeAlarmModel service method, as returned by IoTEvents.
///
/// 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 DescribeAlarmModel Operation
Task DescribeAlarmModelAsync(DescribeAlarmModelRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeDetectorModel
///
/// Describes a detector model. If the version parameter is not specified,
/// information about the latest version is returned.
///
/// Container for the necessary parameters to execute the DescribeDetectorModel service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeDetectorModel service method, as returned by IoTEvents.
///
/// 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 DescribeDetectorModel Operation
Task DescribeDetectorModelAsync(DescribeDetectorModelRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeDetectorModelAnalysis
///
/// 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.
///
///
///
/// Container for the necessary parameters to execute the DescribeDetectorModelAnalysis service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeDetectorModelAnalysis service method, as returned by IoTEvents.
///
/// 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 DescribeDetectorModelAnalysis Operation
Task DescribeDetectorModelAnalysisAsync(DescribeDetectorModelAnalysisRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeInput
///
/// Describes an input.
///
/// Container for the necessary parameters to execute the DescribeInput service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeInput service method, as returned by IoTEvents.
///
/// 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 DescribeInput Operation
Task DescribeInputAsync(DescribeInputRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeLoggingOptions
///
/// Retrieves the current settings of the AWS IoT Events logging options.
///
/// Container for the necessary parameters to execute the DescribeLoggingOptions service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeLoggingOptions service method, as returned by IoTEvents.
///
/// 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.
///
///
/// The requested operation is not supported.
///
/// REST API Reference for DescribeLoggingOptions Operation
Task DescribeLoggingOptionsAsync(DescribeLoggingOptionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetDetectorModelAnalysisResults
///
/// 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.
///
///
///
/// Container for the necessary parameters to execute the GetDetectorModelAnalysisResults service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetDetectorModelAnalysisResults service method, as returned by IoTEvents.
///
/// 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 GetDetectorModelAnalysisResults Operation
Task GetDetectorModelAnalysisResultsAsync(GetDetectorModelAnalysisResultsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListAlarmModels
///
/// Lists the alarm models that you created. The operation returns only the metadata associated
/// with each alarm model.
///
/// Container for the necessary parameters to execute the ListAlarmModels service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListAlarmModels service method, as returned by IoTEvents.
///
/// 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 ListAlarmModels Operation
Task ListAlarmModelsAsync(ListAlarmModelsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListAlarmModelVersions
///
/// Lists all the versions of an alarm model. The operation returns only the metadata
/// associated with each alarm model version.
///
/// Container for the necessary parameters to execute the ListAlarmModelVersions service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListAlarmModelVersions service method, as returned by IoTEvents.
///
/// 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 ListAlarmModelVersions Operation
Task ListAlarmModelVersionsAsync(ListAlarmModelVersionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListDetectorModels
///
/// Lists the detector models you have created. Only the metadata associated with each
/// detector model is returned.
///
/// Container for the necessary parameters to execute the ListDetectorModels service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListDetectorModels service method, as returned by IoTEvents.
///
/// 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 ListDetectorModels Operation
Task ListDetectorModelsAsync(ListDetectorModelsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListDetectorModelVersions
///
/// Lists all the versions of a detector model. Only the metadata associated with each
/// detector model version is returned.
///
/// Container for the necessary parameters to execute the ListDetectorModelVersions service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListDetectorModelVersions service method, as returned by IoTEvents.
///
/// 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 ListDetectorModelVersions Operation
Task ListDetectorModelVersionsAsync(ListDetectorModelVersionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListInputRoutings
///
/// Lists one or more input routings.
///
/// Container for the necessary parameters to execute the ListInputRoutings service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListInputRoutings service method, as returned by IoTEvents.
///
/// 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 ListInputRoutings Operation
Task ListInputRoutingsAsync(ListInputRoutingsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListInputs
///
/// Lists the inputs you have created.
///
/// Container for the necessary parameters to execute the ListInputs service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListInputs service method, as returned by IoTEvents.
///
/// 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 ListInputs Operation
Task ListInputsAsync(ListInputsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListTagsForResource
///
/// Lists the tags (metadata) you have assigned to the resource.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListTagsForResource service method, as returned by IoTEvents.
///
/// An internal failure occurred.
///
///
/// The request was invalid.
///
///
/// The resource is in use.
///
///
/// The resource was not found.
///
///
/// The request could not be completed due to throttling.
///
/// REST API Reference for ListTagsForResource Operation
Task ListTagsForResourceAsync(ListTagsForResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region PutLoggingOptions
///
/// 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.
///
///
/// Container for the necessary parameters to execute the PutLoggingOptions service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the PutLoggingOptions service method, as returned by IoTEvents.
///
/// An internal failure occurred.
///
///
/// The request was invalid.
///
///
/// The resource is in use.
///
///
/// The service is currently unavailable.
///
///
/// The request could not be completed due to throttling.
///
///
/// The requested operation is not supported.
///
/// REST API Reference for PutLoggingOptions Operation
Task PutLoggingOptionsAsync(PutLoggingOptionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region StartDetectorModelAnalysis
///
/// Performs an analysis of your detector model. For more information, see Troubleshooting
/// a detector model in the AWS IoT Events Developer Guide.
///
/// Container for the necessary parameters to execute the StartDetectorModelAnalysis service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the StartDetectorModelAnalysis service method, as returned by IoTEvents.
///
/// An internal failure occurred.
///
///
/// The request was invalid.
///
///
/// A limit was exceeded.
///
///
/// The service is currently unavailable.
///
///
/// The request could not be completed due to throttling.
///
/// REST API Reference for StartDetectorModelAnalysis Operation
Task StartDetectorModelAnalysisAsync(StartDetectorModelAnalysisRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region TagResource
///
/// Adds to or modifies the tags of the given resource. Tags are metadata that can be
/// used to manage a resource.
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the TagResource service method, as returned by IoTEvents.
///
/// An internal failure occurred.
///
///
/// The request was invalid.
///
///
/// A limit was exceeded.
///
///
/// The resource is in use.
///
///
/// The resource was not found.
///
///
/// The request could not be completed due to throttling.
///
/// REST API Reference for TagResource Operation
Task TagResourceAsync(TagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UntagResource
///
/// Removes the given tags (metadata) from the resource.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UntagResource service method, as returned by IoTEvents.
///
/// An internal failure occurred.
///
///
/// The request was invalid.
///
///
/// The resource is in use.
///
///
/// The resource was not found.
///
///
/// The request could not be completed due to throttling.
///
/// REST API Reference for UntagResource Operation
Task UntagResourceAsync(UntagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateAlarmModel
///
/// Updates an alarm model. Any alarms that were created based on the previous version
/// are deleted and then created again as new data arrives.
///
/// Container for the necessary parameters to execute the UpdateAlarmModel service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateAlarmModel service method, as returned by IoTEvents.
///
/// An internal failure occurred.
///
///
/// The request was invalid.
///
///
/// The resource is in use.
///
///
/// The resource was not found.
///
///
/// The service is currently unavailable.
///
///
/// The request could not be completed due to throttling.
///
/// REST API Reference for UpdateAlarmModel Operation
Task UpdateAlarmModelAsync(UpdateAlarmModelRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateDetectorModel
///
/// Updates a detector model. Detectors (instances) spawned by the previous version are
/// deleted and then re-created as new inputs arrive.
///
/// Container for the necessary parameters to execute the UpdateDetectorModel service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateDetectorModel service method, as returned by IoTEvents.
///
/// An internal failure occurred.
///
///
/// The request was invalid.
///
///
/// The resource is in use.
///
///
/// The resource was not found.
///
///
/// The service is currently unavailable.
///
///
/// The request could not be completed due to throttling.
///
/// REST API Reference for UpdateDetectorModel Operation
Task UpdateDetectorModelAsync(UpdateDetectorModelRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateInput
///
/// Updates an input.
///
/// Container for the necessary parameters to execute the UpdateInput service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateInput service method, as returned by IoTEvents.
///
/// An internal failure occurred.
///
///
/// The request was invalid.
///
///
/// The resource is in use.
///
///
/// The resource was not found.
///
///
/// The service is currently unavailable.
///
///
/// The request could not be completed due to throttling.
///
/// REST API Reference for UpdateInput Operation
Task UpdateInputAsync(UpdateInputRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
}
}