/* * 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 iotfleethub-2020-11-03.normal.json service model. */ using System; using System.Collections.Generic; using Amazon.Runtime; using Amazon.IoTFleetHub.Model; namespace Amazon.IoTFleetHub { /// <summary> /// Interface for accessing IoTFleetHub /// /// With Fleet Hub for AWS IoT Device Management you can build stand-alone web applications /// for monitoring the health of your device fleets. /// /// <note> /// <para> /// Fleet Hub for AWS IoT Device Management is in public preview and is subject to change. /// </para> /// </note> /// </summary> public partial interface IAmazonIoTFleetHub : IAmazonService, IDisposable { #if BCL45 || AWS_ASYNC_ENUMERABLES_API /// <summary> /// Paginators for the service /// </summary> IIoTFleetHubPaginatorFactory Paginators { get; } #endif #region CreateApplication /// <summary> /// Creates a Fleet Hub for AWS IoT Device Management web application. /// /// <note> /// <para> /// Fleet Hub for AWS IoT Device Management is in public preview and is subject to change. /// </para> /// </note> /// </summary> /// <param name="request">Container for the necessary parameters to execute the CreateApplication service method.</param> /// /// <returns>The response from the CreateApplication service method, as returned by IoTFleetHub.</returns> /// <exception cref="Amazon.IoTFleetHub.Model.InternalFailureException"> /// An unexpected error has occurred. /// </exception> /// <exception cref="Amazon.IoTFleetHub.Model.InvalidRequestException"> /// The request is not valid. /// </exception> /// <exception cref="Amazon.IoTFleetHub.Model.LimitExceededException"> /// A limit has been exceeded. /// </exception> /// <exception cref="Amazon.IoTFleetHub.Model.ThrottlingException"> /// The rate exceeds the limit. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/CreateApplication">REST API Reference for CreateApplication Operation</seealso> CreateApplicationResponse CreateApplication(CreateApplicationRequest request); /// <summary> /// Initiates the asynchronous execution of the CreateApplication operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the CreateApplication operation on AmazonIoTFleetHubClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateApplication /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/CreateApplication">REST API Reference for CreateApplication Operation</seealso> IAsyncResult BeginCreateApplication(CreateApplicationRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the CreateApplication operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateApplication.</param> /// /// <returns>Returns a CreateApplicationResult from IoTFleetHub.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/CreateApplication">REST API Reference for CreateApplication Operation</seealso> CreateApplicationResponse EndCreateApplication(IAsyncResult asyncResult); #endregion #region DeleteApplication /// <summary> /// Deletes a Fleet Hub for AWS IoT Device Management web application. /// /// <note> /// <para> /// Fleet Hub for AWS IoT Device Management is in public preview and is subject to change. /// </para> /// </note> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DeleteApplication service method.</param> /// /// <returns>The response from the DeleteApplication service method, as returned by IoTFleetHub.</returns> /// <exception cref="Amazon.IoTFleetHub.Model.InternalFailureException"> /// An unexpected error has occurred. /// </exception> /// <exception cref="Amazon.IoTFleetHub.Model.InvalidRequestException"> /// The request is not valid. /// </exception> /// <exception cref="Amazon.IoTFleetHub.Model.ResourceNotFoundException"> /// The specified resource does not exist. /// </exception> /// <exception cref="Amazon.IoTFleetHub.Model.ThrottlingException"> /// The rate exceeds the limit. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/DeleteApplication">REST API Reference for DeleteApplication Operation</seealso> DeleteApplicationResponse DeleteApplication(DeleteApplicationRequest request); /// <summary> /// Initiates the asynchronous execution of the DeleteApplication operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DeleteApplication operation on AmazonIoTFleetHubClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteApplication /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/DeleteApplication">REST API Reference for DeleteApplication Operation</seealso> IAsyncResult BeginDeleteApplication(DeleteApplicationRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DeleteApplication operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteApplication.</param> /// /// <returns>Returns a DeleteApplicationResult from IoTFleetHub.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/DeleteApplication">REST API Reference for DeleteApplication Operation</seealso> DeleteApplicationResponse EndDeleteApplication(IAsyncResult asyncResult); #endregion #region DescribeApplication /// <summary> /// Gets information about a Fleet Hub for AWS IoT Device Management web application. /// /// <note> /// <para> /// Fleet Hub for AWS IoT Device Management is in public preview and is subject to change. /// </para> /// </note> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DescribeApplication service method.</param> /// /// <returns>The response from the DescribeApplication service method, as returned by IoTFleetHub.</returns> /// <exception cref="Amazon.IoTFleetHub.Model.InternalFailureException"> /// An unexpected error has occurred. /// </exception> /// <exception cref="Amazon.IoTFleetHub.Model.InvalidRequestException"> /// The request is not valid. /// </exception> /// <exception cref="Amazon.IoTFleetHub.Model.ResourceNotFoundException"> /// The specified resource does not exist. /// </exception> /// <exception cref="Amazon.IoTFleetHub.Model.ThrottlingException"> /// The rate exceeds the limit. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/DescribeApplication">REST API Reference for DescribeApplication Operation</seealso> DescribeApplicationResponse DescribeApplication(DescribeApplicationRequest request); /// <summary> /// Initiates the asynchronous execution of the DescribeApplication operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DescribeApplication operation on AmazonIoTFleetHubClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeApplication /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/DescribeApplication">REST API Reference for DescribeApplication Operation</seealso> IAsyncResult BeginDescribeApplication(DescribeApplicationRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DescribeApplication operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeApplication.</param> /// /// <returns>Returns a DescribeApplicationResult from IoTFleetHub.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/DescribeApplication">REST API Reference for DescribeApplication Operation</seealso> DescribeApplicationResponse EndDescribeApplication(IAsyncResult asyncResult); #endregion #region ListApplications /// <summary> /// Gets a list of Fleet Hub for AWS IoT Device Management web applications for the current /// account. /// /// <note> /// <para> /// Fleet Hub for AWS IoT Device Management is in public preview and is subject to change. /// </para> /// </note> /// </summary> /// <param name="request">Container for the necessary parameters to execute the ListApplications service method.</param> /// /// <returns>The response from the ListApplications service method, as returned by IoTFleetHub.</returns> /// <exception cref="Amazon.IoTFleetHub.Model.InternalFailureException"> /// An unexpected error has occurred. /// </exception> /// <exception cref="Amazon.IoTFleetHub.Model.InvalidRequestException"> /// The request is not valid. /// </exception> /// <exception cref="Amazon.IoTFleetHub.Model.ThrottlingException"> /// The rate exceeds the limit. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/ListApplications">REST API Reference for ListApplications Operation</seealso> ListApplicationsResponse ListApplications(ListApplicationsRequest request); /// <summary> /// Initiates the asynchronous execution of the ListApplications operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the ListApplications operation on AmazonIoTFleetHubClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListApplications /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/ListApplications">REST API Reference for ListApplications Operation</seealso> IAsyncResult BeginListApplications(ListApplicationsRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the ListApplications operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginListApplications.</param> /// /// <returns>Returns a ListApplicationsResult from IoTFleetHub.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/ListApplications">REST API Reference for ListApplications Operation</seealso> ListApplicationsResponse EndListApplications(IAsyncResult asyncResult); #endregion #region ListTagsForResource /// <summary> /// Lists the tags for the specified resource. /// /// <note> /// <para> /// Fleet Hub for AWS IoT Device Management is in public preview and is subject to change. /// </para> /// </note> /// </summary> /// <param name="request">Container for the necessary parameters to execute the ListTagsForResource service method.</param> /// /// <returns>The response from the ListTagsForResource service method, as returned by IoTFleetHub.</returns> /// <exception cref="Amazon.IoTFleetHub.Model.InternalFailureException"> /// An unexpected error has occurred. /// </exception> /// <exception cref="Amazon.IoTFleetHub.Model.InvalidRequestException"> /// The request is not valid. /// </exception> /// <exception cref="Amazon.IoTFleetHub.Model.ResourceNotFoundException"> /// The specified resource does not exist. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/ListTagsForResource">REST API Reference for ListTagsForResource Operation</seealso> ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request); /// <summary> /// Initiates the asynchronous execution of the ListTagsForResource operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the ListTagsForResource operation on AmazonIoTFleetHubClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTagsForResource /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/ListTagsForResource">REST API Reference for ListTagsForResource Operation</seealso> IAsyncResult BeginListTagsForResource(ListTagsForResourceRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the ListTagsForResource operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginListTagsForResource.</param> /// /// <returns>Returns a ListTagsForResourceResult from IoTFleetHub.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/ListTagsForResource">REST API Reference for ListTagsForResource Operation</seealso> ListTagsForResourceResponse EndListTagsForResource(IAsyncResult asyncResult); #endregion #region TagResource /// <summary> /// Adds to or modifies the tags of the specified resource. Tags are metadata which can /// be used to manage a resource. /// /// <note> /// <para> /// Fleet Hub for AWS IoT Device Management is in public preview and is subject to change. /// </para> /// </note> /// </summary> /// <param name="request">Container for the necessary parameters to execute the TagResource service method.</param> /// /// <returns>The response from the TagResource service method, as returned by IoTFleetHub.</returns> /// <exception cref="Amazon.IoTFleetHub.Model.InternalFailureException"> /// An unexpected error has occurred. /// </exception> /// <exception cref="Amazon.IoTFleetHub.Model.InvalidRequestException"> /// The request is not valid. /// </exception> /// <exception cref="Amazon.IoTFleetHub.Model.ResourceNotFoundException"> /// The specified resource does not exist. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/TagResource">REST API Reference for TagResource Operation</seealso> TagResourceResponse TagResource(TagResourceRequest request); /// <summary> /// Initiates the asynchronous execution of the TagResource operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the TagResource operation on AmazonIoTFleetHubClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTagResource /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/TagResource">REST API Reference for TagResource Operation</seealso> IAsyncResult BeginTagResource(TagResourceRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the TagResource operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginTagResource.</param> /// /// <returns>Returns a TagResourceResult from IoTFleetHub.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/TagResource">REST API Reference for TagResource Operation</seealso> TagResourceResponse EndTagResource(IAsyncResult asyncResult); #endregion #region UntagResource /// <summary> /// Removes the specified tags (metadata) from the resource. /// /// <note> /// <para> /// Fleet Hub for AWS IoT Device Management is in public preview and is subject to change. /// </para> /// </note> /// </summary> /// <param name="request">Container for the necessary parameters to execute the UntagResource service method.</param> /// /// <returns>The response from the UntagResource service method, as returned by IoTFleetHub.</returns> /// <exception cref="Amazon.IoTFleetHub.Model.InternalFailureException"> /// An unexpected error has occurred. /// </exception> /// <exception cref="Amazon.IoTFleetHub.Model.InvalidRequestException"> /// The request is not valid. /// </exception> /// <exception cref="Amazon.IoTFleetHub.Model.ResourceNotFoundException"> /// The specified resource does not exist. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/UntagResource">REST API Reference for UntagResource Operation</seealso> UntagResourceResponse UntagResource(UntagResourceRequest request); /// <summary> /// Initiates the asynchronous execution of the UntagResource operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the UntagResource operation on AmazonIoTFleetHubClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUntagResource /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/UntagResource">REST API Reference for UntagResource Operation</seealso> IAsyncResult BeginUntagResource(UntagResourceRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the UntagResource operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginUntagResource.</param> /// /// <returns>Returns a UntagResourceResult from IoTFleetHub.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/UntagResource">REST API Reference for UntagResource Operation</seealso> UntagResourceResponse EndUntagResource(IAsyncResult asyncResult); #endregion #region UpdateApplication /// <summary> /// Updates information about a Fleet Hub for a AWS IoT Device Management web application. /// /// <note> /// <para> /// Fleet Hub for AWS IoT Device Management is in public preview and is subject to change. /// </para> /// </note> /// </summary> /// <param name="request">Container for the necessary parameters to execute the UpdateApplication service method.</param> /// /// <returns>The response from the UpdateApplication service method, as returned by IoTFleetHub.</returns> /// <exception cref="Amazon.IoTFleetHub.Model.ConflictException"> /// The request conflicts with the current state of the resource. /// </exception> /// <exception cref="Amazon.IoTFleetHub.Model.InternalFailureException"> /// An unexpected error has occurred. /// </exception> /// <exception cref="Amazon.IoTFleetHub.Model.InvalidRequestException"> /// The request is not valid. /// </exception> /// <exception cref="Amazon.IoTFleetHub.Model.ResourceNotFoundException"> /// The specified resource does not exist. /// </exception> /// <exception cref="Amazon.IoTFleetHub.Model.ThrottlingException"> /// The rate exceeds the limit. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/UpdateApplication">REST API Reference for UpdateApplication Operation</seealso> UpdateApplicationResponse UpdateApplication(UpdateApplicationRequest request); /// <summary> /// Initiates the asynchronous execution of the UpdateApplication operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the UpdateApplication operation on AmazonIoTFleetHubClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateApplication /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/UpdateApplication">REST API Reference for UpdateApplication Operation</seealso> IAsyncResult BeginUpdateApplication(UpdateApplicationRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the UpdateApplication operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateApplication.</param> /// /// <returns>Returns a UpdateApplicationResult from IoTFleetHub.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/UpdateApplication">REST API Reference for UpdateApplication Operation</seealso> UpdateApplicationResponse EndUpdateApplication(IAsyncResult asyncResult); #endregion } }