/*
* 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.Threading;
using System.Threading.Tasks;
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
{
///
/// Paginators for the service
///
IIoTDeviceAdvisorPaginatorFactory Paginators { get; }
#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);
///
/// Creates a Device Advisor test suite.
///
///
///
/// Requires permission to access the CreateSuiteDefinition
/// action.
///
///
/// Container for the necessary parameters to execute the CreateSuiteDefinition service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task CreateSuiteDefinitionAsync(CreateSuiteDefinitionRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Deletes a Device Advisor test suite.
///
///
///
/// Requires permission to access the DeleteSuiteDefinition
/// action.
///
///
/// Container for the necessary parameters to execute the DeleteSuiteDefinition service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DeleteSuiteDefinitionAsync(DeleteSuiteDefinitionRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Gets information about an Device Advisor endpoint.
///
/// Container for the necessary parameters to execute the GetEndpoint service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task GetEndpointAsync(GetEndpointRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task GetSuiteDefinitionAsync(GetSuiteDefinitionRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task GetSuiteRunAsync(GetSuiteRunRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task GetSuiteRunReportAsync(GetSuiteRunReportRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ListSuiteDefinitionsAsync(ListSuiteDefinitionsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ListSuiteRunsAsync(ListSuiteRunsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// 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 IoTDeviceAdvisor.
///
/// Sends an Internal Failure exception.
///
///
/// Sends a Resource Not Found exception.
///
///
/// Sends a validation exception.
///
/// REST API Reference for ListTagsForResource Operation
Task ListTagsForResourceAsync(ListTagsForResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task StartSuiteRunAsync(StartSuiteRunRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task StopSuiteRunAsync(StopSuiteRunRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// 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 IoTDeviceAdvisor.
///
/// Sends an Internal Failure exception.
///
///
/// Sends a Resource Not Found exception.
///
///
/// Sends a validation exception.
///
/// REST API Reference for TagResource Operation
Task TagResourceAsync(TagResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// 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 IoTDeviceAdvisor.
///
/// Sends an Internal Failure exception.
///
///
/// Sends a Resource Not Found exception.
///
///
/// Sends a validation exception.
///
/// REST API Reference for UntagResource Operation
Task UntagResourceAsync(UntagResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Updates a Device Advisor test suite.
///
///
///
/// Requires permission to access the UpdateSuiteDefinition
/// action.
///
///
/// Container for the necessary parameters to execute the UpdateSuiteDefinition service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task UpdateSuiteDefinitionAsync(UpdateSuiteDefinitionRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
}
}