/* * 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 iotdeviceadvisor-2020-09-18.normal.json service model. */ using System; using System.Collections.Generic; using Amazon.Runtime; using Amazon.IoTDeviceAdvisor.Model; namespace Amazon.IoTDeviceAdvisor { /// /// Interface for accessing IoTDeviceAdvisor /// /// Amazon Web Services IoT Core Device Advisor is a cloud-based, fully managed test capability /// for validating IoT devices during device software development. Device Advisor provides /// pre-built tests that you can use to validate IoT devices for reliable and secure connectivity /// with Amazon Web Services IoT Core before deploying devices to production. By using /// Device Advisor, you can confirm that your devices can connect to Amazon Web Services /// IoT Core, follow security best practices and, if applicable, receive software updates /// from IoT Device Management. You can also download signed qualification reports to /// submit to the Amazon Web Services Partner Network to get your device qualified for /// the Amazon Web Services Partner Device Catalog without the need to send your device /// in and wait for it to be tested. /// public partial interface IAmazonIoTDeviceAdvisor : IAmazonService, IDisposable { #if BCL45 || AWS_ASYNC_ENUMERABLES_API /// /// Paginators for the service /// IIoTDeviceAdvisorPaginatorFactory Paginators { get; } #endif #region CreateSuiteDefinition /// /// Creates a Device Advisor test suite. /// /// /// /// Requires permission to access the CreateSuiteDefinition /// action. /// /// /// Container for the necessary parameters to execute the CreateSuiteDefinition service method. /// /// The response from the CreateSuiteDefinition service method, as returned by IoTDeviceAdvisor. /// /// Sends an Internal Failure exception. /// /// /// Sends a validation exception. /// /// REST API Reference for CreateSuiteDefinition Operation CreateSuiteDefinitionResponse CreateSuiteDefinition(CreateSuiteDefinitionRequest request); /// /// Initiates the asynchronous execution of the CreateSuiteDefinition operation. /// /// /// Container for the necessary parameters to execute the CreateSuiteDefinition operation on AmazonIoTDeviceAdvisorClient. /// 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 EndCreateSuiteDefinition /// operation. /// REST API Reference for CreateSuiteDefinition Operation IAsyncResult BeginCreateSuiteDefinition(CreateSuiteDefinitionRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CreateSuiteDefinition operation. /// /// /// The IAsyncResult returned by the call to BeginCreateSuiteDefinition. /// /// Returns a CreateSuiteDefinitionResult from IoTDeviceAdvisor. /// REST API Reference for CreateSuiteDefinition Operation CreateSuiteDefinitionResponse EndCreateSuiteDefinition(IAsyncResult asyncResult); #endregion #region DeleteSuiteDefinition /// /// Deletes a Device Advisor test suite. /// /// /// /// Requires permission to access the DeleteSuiteDefinition /// action. /// /// /// Container for the necessary parameters to execute the DeleteSuiteDefinition service method. /// /// The response from the DeleteSuiteDefinition service method, as returned by IoTDeviceAdvisor. /// /// Sends an Internal Failure exception. /// /// /// Sends a validation exception. /// /// REST API Reference for DeleteSuiteDefinition Operation DeleteSuiteDefinitionResponse DeleteSuiteDefinition(DeleteSuiteDefinitionRequest request); /// /// Initiates the asynchronous execution of the DeleteSuiteDefinition operation. /// /// /// Container for the necessary parameters to execute the DeleteSuiteDefinition operation on AmazonIoTDeviceAdvisorClient. /// 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 EndDeleteSuiteDefinition /// operation. /// REST API Reference for DeleteSuiteDefinition Operation IAsyncResult BeginDeleteSuiteDefinition(DeleteSuiteDefinitionRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DeleteSuiteDefinition operation. /// /// /// The IAsyncResult returned by the call to BeginDeleteSuiteDefinition. /// /// Returns a DeleteSuiteDefinitionResult from IoTDeviceAdvisor. /// REST API Reference for DeleteSuiteDefinition Operation DeleteSuiteDefinitionResponse EndDeleteSuiteDefinition(IAsyncResult asyncResult); #endregion #region GetEndpoint /// /// Gets information about an Device Advisor endpoint. /// /// Container for the necessary parameters to execute the GetEndpoint service method. /// /// The response from the GetEndpoint service method, as returned by IoTDeviceAdvisor. /// /// Sends an Internal Failure exception. /// /// /// Sends a Resource Not Found exception. /// /// /// Sends a validation exception. /// /// REST API Reference for GetEndpoint Operation GetEndpointResponse GetEndpoint(GetEndpointRequest request); /// /// Initiates the asynchronous execution of the GetEndpoint operation. /// /// /// Container for the necessary parameters to execute the GetEndpoint operation on AmazonIoTDeviceAdvisorClient. /// 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 EndGetEndpoint /// operation. /// REST API Reference for GetEndpoint Operation IAsyncResult BeginGetEndpoint(GetEndpointRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the GetEndpoint operation. /// /// /// The IAsyncResult returned by the call to BeginGetEndpoint. /// /// Returns a GetEndpointResult from IoTDeviceAdvisor. /// REST API Reference for GetEndpoint Operation GetEndpointResponse EndGetEndpoint(IAsyncResult asyncResult); #endregion #region GetSuiteDefinition /// /// Gets information about a Device Advisor test suite. /// /// /// /// Requires permission to access the GetSuiteDefinition /// action. /// /// /// Container for the necessary parameters to execute the GetSuiteDefinition service method. /// /// The response from the GetSuiteDefinition service method, as returned by IoTDeviceAdvisor. /// /// Sends an Internal Failure exception. /// /// /// Sends a Resource Not Found exception. /// /// /// Sends a validation exception. /// /// REST API Reference for GetSuiteDefinition Operation GetSuiteDefinitionResponse GetSuiteDefinition(GetSuiteDefinitionRequest request); /// /// Initiates the asynchronous execution of the GetSuiteDefinition operation. /// /// /// Container for the necessary parameters to execute the GetSuiteDefinition operation on AmazonIoTDeviceAdvisorClient. /// 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 EndGetSuiteDefinition /// operation. /// REST API Reference for GetSuiteDefinition Operation IAsyncResult BeginGetSuiteDefinition(GetSuiteDefinitionRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the GetSuiteDefinition operation. /// /// /// The IAsyncResult returned by the call to BeginGetSuiteDefinition. /// /// Returns a GetSuiteDefinitionResult from IoTDeviceAdvisor. /// REST API Reference for GetSuiteDefinition Operation GetSuiteDefinitionResponse EndGetSuiteDefinition(IAsyncResult asyncResult); #endregion #region GetSuiteRun /// /// Gets information about a Device Advisor test suite run. /// /// /// /// Requires permission to access the GetSuiteRun /// action. /// /// /// Container for the necessary parameters to execute the GetSuiteRun service method. /// /// The response from the GetSuiteRun service method, as returned by IoTDeviceAdvisor. /// /// Sends an Internal Failure exception. /// /// /// Sends a Resource Not Found exception. /// /// /// Sends a validation exception. /// /// REST API Reference for GetSuiteRun Operation GetSuiteRunResponse GetSuiteRun(GetSuiteRunRequest request); /// /// Initiates the asynchronous execution of the GetSuiteRun operation. /// /// /// Container for the necessary parameters to execute the GetSuiteRun operation on AmazonIoTDeviceAdvisorClient. /// 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 EndGetSuiteRun /// operation. /// REST API Reference for GetSuiteRun Operation IAsyncResult BeginGetSuiteRun(GetSuiteRunRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the GetSuiteRun operation. /// /// /// The IAsyncResult returned by the call to BeginGetSuiteRun. /// /// Returns a GetSuiteRunResult from IoTDeviceAdvisor. /// REST API Reference for GetSuiteRun Operation GetSuiteRunResponse EndGetSuiteRun(IAsyncResult asyncResult); #endregion #region GetSuiteRunReport /// /// Gets a report download link for a successful Device Advisor qualifying test suite /// run. /// /// /// /// Requires permission to access the GetSuiteRunReport /// action. /// /// /// Container for the necessary parameters to execute the GetSuiteRunReport service method. /// /// The response from the GetSuiteRunReport service method, as returned by IoTDeviceAdvisor. /// /// Sends an Internal Failure exception. /// /// /// Sends a Resource Not Found exception. /// /// /// Sends a validation exception. /// /// REST API Reference for GetSuiteRunReport Operation GetSuiteRunReportResponse GetSuiteRunReport(GetSuiteRunReportRequest request); /// /// Initiates the asynchronous execution of the GetSuiteRunReport operation. /// /// /// Container for the necessary parameters to execute the GetSuiteRunReport operation on AmazonIoTDeviceAdvisorClient. /// 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 EndGetSuiteRunReport /// operation. /// REST API Reference for GetSuiteRunReport Operation IAsyncResult BeginGetSuiteRunReport(GetSuiteRunReportRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the GetSuiteRunReport operation. /// /// /// The IAsyncResult returned by the call to BeginGetSuiteRunReport. /// /// Returns a GetSuiteRunReportResult from IoTDeviceAdvisor. /// REST API Reference for GetSuiteRunReport Operation GetSuiteRunReportResponse EndGetSuiteRunReport(IAsyncResult asyncResult); #endregion #region ListSuiteDefinitions /// /// Lists the Device Advisor test suites you have created. /// /// /// /// Requires permission to access the ListSuiteDefinitions /// action. /// /// /// Container for the necessary parameters to execute the ListSuiteDefinitions service method. /// /// The response from the ListSuiteDefinitions service method, as returned by IoTDeviceAdvisor. /// /// Sends an Internal Failure exception. /// /// /// Sends a validation exception. /// /// REST API Reference for ListSuiteDefinitions Operation ListSuiteDefinitionsResponse ListSuiteDefinitions(ListSuiteDefinitionsRequest request); /// /// Initiates the asynchronous execution of the ListSuiteDefinitions operation. /// /// /// Container for the necessary parameters to execute the ListSuiteDefinitions operation on AmazonIoTDeviceAdvisorClient. /// 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 EndListSuiteDefinitions /// operation. /// REST API Reference for ListSuiteDefinitions Operation IAsyncResult BeginListSuiteDefinitions(ListSuiteDefinitionsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListSuiteDefinitions operation. /// /// /// The IAsyncResult returned by the call to BeginListSuiteDefinitions. /// /// Returns a ListSuiteDefinitionsResult from IoTDeviceAdvisor. /// REST API Reference for ListSuiteDefinitions Operation ListSuiteDefinitionsResponse EndListSuiteDefinitions(IAsyncResult asyncResult); #endregion #region ListSuiteRuns /// /// Lists runs of the specified Device Advisor test suite. You can list all runs of the /// test suite, or the runs of a specific version of the test suite. /// /// /// /// Requires permission to access the ListSuiteRuns /// action. /// /// /// Container for the necessary parameters to execute the ListSuiteRuns service method. /// /// The response from the ListSuiteRuns service method, as returned by IoTDeviceAdvisor. /// /// Sends an Internal Failure exception. /// /// /// Sends a validation exception. /// /// REST API Reference for ListSuiteRuns Operation ListSuiteRunsResponse ListSuiteRuns(ListSuiteRunsRequest request); /// /// Initiates the asynchronous execution of the ListSuiteRuns operation. /// /// /// Container for the necessary parameters to execute the ListSuiteRuns operation on AmazonIoTDeviceAdvisorClient. /// 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 EndListSuiteRuns /// operation. /// REST API Reference for ListSuiteRuns Operation IAsyncResult BeginListSuiteRuns(ListSuiteRunsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListSuiteRuns operation. /// /// /// The IAsyncResult returned by the call to BeginListSuiteRuns. /// /// Returns a ListSuiteRunsResult from IoTDeviceAdvisor. /// REST API Reference for ListSuiteRuns Operation ListSuiteRunsResponse EndListSuiteRuns(IAsyncResult asyncResult); #endregion #region ListTagsForResource /// /// Lists the tags attached to an IoT Device Advisor resource. /// /// /// /// Requires permission to access the ListTagsForResource /// action. /// /// /// Container for the necessary parameters to execute the ListTagsForResource service method. /// /// The response from the ListTagsForResource service method, as returned by IoTDeviceAdvisor. /// /// Sends an Internal Failure exception. /// /// /// Sends a Resource Not Found exception. /// /// /// Sends a validation exception. /// /// REST API Reference for ListTagsForResource Operation ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request); /// /// Initiates the asynchronous execution of the ListTagsForResource operation. /// /// /// Container for the necessary parameters to execute the ListTagsForResource operation on AmazonIoTDeviceAdvisorClient. /// 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 EndListTagsForResource /// operation. /// REST API Reference for ListTagsForResource Operation IAsyncResult BeginListTagsForResource(ListTagsForResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListTagsForResource operation. /// /// /// The IAsyncResult returned by the call to BeginListTagsForResource. /// /// Returns a ListTagsForResourceResult from IoTDeviceAdvisor. /// REST API Reference for ListTagsForResource Operation ListTagsForResourceResponse EndListTagsForResource(IAsyncResult asyncResult); #endregion #region StartSuiteRun /// /// Starts a Device Advisor test suite run. /// /// /// /// Requires permission to access the StartSuiteRun /// action. /// /// /// Container for the necessary parameters to execute the StartSuiteRun service method. /// /// The response from the StartSuiteRun service method, as returned by IoTDeviceAdvisor. /// /// Sends a Conflict Exception. /// /// /// Sends an Internal Failure exception. /// /// /// Sends a validation exception. /// /// REST API Reference for StartSuiteRun Operation StartSuiteRunResponse StartSuiteRun(StartSuiteRunRequest request); /// /// Initiates the asynchronous execution of the StartSuiteRun operation. /// /// /// Container for the necessary parameters to execute the StartSuiteRun operation on AmazonIoTDeviceAdvisorClient. /// 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 EndStartSuiteRun /// operation. /// REST API Reference for StartSuiteRun Operation IAsyncResult BeginStartSuiteRun(StartSuiteRunRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the StartSuiteRun operation. /// /// /// The IAsyncResult returned by the call to BeginStartSuiteRun. /// /// Returns a StartSuiteRunResult from IoTDeviceAdvisor. /// REST API Reference for StartSuiteRun Operation StartSuiteRunResponse EndStartSuiteRun(IAsyncResult asyncResult); #endregion #region StopSuiteRun /// /// Stops a Device Advisor test suite run that is currently running. /// /// /// /// Requires permission to access the StopSuiteRun /// action. /// /// /// Container for the necessary parameters to execute the StopSuiteRun service method. /// /// The response from the StopSuiteRun service method, as returned by IoTDeviceAdvisor. /// /// Sends an Internal Failure exception. /// /// /// Sends a Resource Not Found exception. /// /// /// Sends a validation exception. /// /// REST API Reference for StopSuiteRun Operation StopSuiteRunResponse StopSuiteRun(StopSuiteRunRequest request); /// /// Initiates the asynchronous execution of the StopSuiteRun operation. /// /// /// Container for the necessary parameters to execute the StopSuiteRun operation on AmazonIoTDeviceAdvisorClient. /// 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 EndStopSuiteRun /// operation. /// REST API Reference for StopSuiteRun Operation IAsyncResult BeginStopSuiteRun(StopSuiteRunRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the StopSuiteRun operation. /// /// /// The IAsyncResult returned by the call to BeginStopSuiteRun. /// /// Returns a StopSuiteRunResult from IoTDeviceAdvisor. /// REST API Reference for StopSuiteRun Operation StopSuiteRunResponse EndStopSuiteRun(IAsyncResult asyncResult); #endregion #region TagResource /// /// Adds to and modifies existing tags of an IoT Device Advisor resource. /// /// /// /// Requires permission to access the TagResource /// action. /// /// /// Container for the necessary parameters to execute the TagResource service method. /// /// The response from the TagResource service method, as returned by IoTDeviceAdvisor. /// /// Sends an Internal Failure exception. /// /// /// Sends a Resource Not Found exception. /// /// /// Sends a validation exception. /// /// REST API Reference for TagResource Operation TagResourceResponse TagResource(TagResourceRequest request); /// /// Initiates the asynchronous execution of the TagResource operation. /// /// /// Container for the necessary parameters to execute the TagResource operation on AmazonIoTDeviceAdvisorClient. /// 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 EndTagResource /// operation. /// REST API Reference for TagResource Operation IAsyncResult BeginTagResource(TagResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the TagResource operation. /// /// /// The IAsyncResult returned by the call to BeginTagResource. /// /// Returns a TagResourceResult from IoTDeviceAdvisor. /// REST API Reference for TagResource Operation TagResourceResponse EndTagResource(IAsyncResult asyncResult); #endregion #region UntagResource /// /// Removes tags from an IoT Device Advisor resource. /// /// /// /// Requires permission to access the UntagResource /// action. /// /// /// Container for the necessary parameters to execute the UntagResource service method. /// /// The response from the UntagResource service method, as returned by IoTDeviceAdvisor. /// /// Sends an Internal Failure exception. /// /// /// Sends a Resource Not Found exception. /// /// /// Sends a validation exception. /// /// REST API Reference for UntagResource Operation UntagResourceResponse UntagResource(UntagResourceRequest request); /// /// Initiates the asynchronous execution of the UntagResource operation. /// /// /// Container for the necessary parameters to execute the UntagResource operation on AmazonIoTDeviceAdvisorClient. /// 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 EndUntagResource /// operation. /// REST API Reference for UntagResource Operation IAsyncResult BeginUntagResource(UntagResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UntagResource operation. /// /// /// The IAsyncResult returned by the call to BeginUntagResource. /// /// Returns a UntagResourceResult from IoTDeviceAdvisor. /// REST API Reference for UntagResource Operation UntagResourceResponse EndUntagResource(IAsyncResult asyncResult); #endregion #region UpdateSuiteDefinition /// /// Updates a Device Advisor test suite. /// /// /// /// Requires permission to access the UpdateSuiteDefinition /// action. /// /// /// Container for the necessary parameters to execute the UpdateSuiteDefinition service method. /// /// The response from the UpdateSuiteDefinition service method, as returned by IoTDeviceAdvisor. /// /// Sends an Internal Failure exception. /// /// /// Sends a validation exception. /// /// REST API Reference for UpdateSuiteDefinition Operation UpdateSuiteDefinitionResponse UpdateSuiteDefinition(UpdateSuiteDefinitionRequest request); /// /// Initiates the asynchronous execution of the UpdateSuiteDefinition operation. /// /// /// Container for the necessary parameters to execute the UpdateSuiteDefinition operation on AmazonIoTDeviceAdvisorClient. /// 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 EndUpdateSuiteDefinition /// operation. /// REST API Reference for UpdateSuiteDefinition Operation IAsyncResult BeginUpdateSuiteDefinition(UpdateSuiteDefinitionRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UpdateSuiteDefinition operation. /// /// /// The IAsyncResult returned by the call to BeginUpdateSuiteDefinition. /// /// Returns a UpdateSuiteDefinitionResult from IoTDeviceAdvisor. /// REST API Reference for UpdateSuiteDefinition Operation UpdateSuiteDefinitionResponse EndUpdateSuiteDefinition(IAsyncResult asyncResult); #endregion } }