/*
* 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 snow-device-management-2021-08-04.normal.json service model.
*/
using System;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.SnowDeviceManagement.Model;
namespace Amazon.SnowDeviceManagement
{
///
/// Interface for accessing SnowDeviceManagement
///
/// Amazon Web Services Snow Device Management documentation.
///
public partial interface IAmazonSnowDeviceManagement : IAmazonService, IDisposable
{
#if BCL45 || AWS_ASYNC_ENUMERABLES_API
///
/// Paginators for the service
///
ISnowDeviceManagementPaginatorFactory Paginators { get; }
#endif
#region CancelTask
///
/// Sends a cancel request for a specified task. You can cancel a task only if it's still
/// in a QUEUED
state. Tasks that are already running can't be cancelled.
///
///
///
/// A task might still run if it's processed from the queue before the CancelTask
/// operation changes the task's state.
///
///
///
/// Container for the necessary parameters to execute the CancelTask service method.
///
/// The response from the CancelTask service method, as returned by SnowDeviceManagement.
///
/// You don't have sufficient access to perform this action.
///
///
/// An unexpected error occurred while processing the request.
///
///
/// The request references a resource that doesn't exist.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for CancelTask Operation
CancelTaskResponse CancelTask(CancelTaskRequest request);
///
/// Initiates the asynchronous execution of the CancelTask operation.
///
///
/// Container for the necessary parameters to execute the CancelTask operation on AmazonSnowDeviceManagementClient.
/// 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 EndCancelTask
/// operation.
/// REST API Reference for CancelTask Operation
IAsyncResult BeginCancelTask(CancelTaskRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the CancelTask operation.
///
///
/// The IAsyncResult returned by the call to BeginCancelTask.
///
/// Returns a CancelTaskResult from SnowDeviceManagement.
/// REST API Reference for CancelTask Operation
CancelTaskResponse EndCancelTask(IAsyncResult asyncResult);
#endregion
#region CreateTask
///
/// Instructs one or more devices to start a task, such as unlocking or rebooting.
///
/// Container for the necessary parameters to execute the CreateTask service method.
///
/// The response from the CreateTask service method, as returned by SnowDeviceManagement.
///
/// You don't have sufficient access to perform this action.
///
///
/// An unexpected error occurred while processing the request.
///
///
/// The request references a resource that doesn't exist.
///
///
/// The request would cause a service quota to be exceeded.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for CreateTask Operation
CreateTaskResponse CreateTask(CreateTaskRequest request);
///
/// Initiates the asynchronous execution of the CreateTask operation.
///
///
/// Container for the necessary parameters to execute the CreateTask operation on AmazonSnowDeviceManagementClient.
/// 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 EndCreateTask
/// operation.
/// REST API Reference for CreateTask Operation
IAsyncResult BeginCreateTask(CreateTaskRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the CreateTask operation.
///
///
/// The IAsyncResult returned by the call to BeginCreateTask.
///
/// Returns a CreateTaskResult from SnowDeviceManagement.
/// REST API Reference for CreateTask Operation
CreateTaskResponse EndCreateTask(IAsyncResult asyncResult);
#endregion
#region DescribeDevice
///
/// Checks device-specific information, such as the device type, software version, IP
/// addresses, and lock status.
///
/// Container for the necessary parameters to execute the DescribeDevice service method.
///
/// The response from the DescribeDevice service method, as returned by SnowDeviceManagement.
///
/// You don't have sufficient access to perform this action.
///
///
/// An unexpected error occurred while processing the request.
///
///
/// The request references a resource that doesn't exist.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for DescribeDevice Operation
DescribeDeviceResponse DescribeDevice(DescribeDeviceRequest request);
///
/// Initiates the asynchronous execution of the DescribeDevice operation.
///
///
/// Container for the necessary parameters to execute the DescribeDevice operation on AmazonSnowDeviceManagementClient.
/// 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 EndDescribeDevice
/// operation.
/// REST API Reference for DescribeDevice Operation
IAsyncResult BeginDescribeDevice(DescribeDeviceRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DescribeDevice operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeDevice.
///
/// Returns a DescribeDeviceResult from SnowDeviceManagement.
/// REST API Reference for DescribeDevice Operation
DescribeDeviceResponse EndDescribeDevice(IAsyncResult asyncResult);
#endregion
#region DescribeDeviceEc2Instances
///
/// Checks the current state of the Amazon EC2 instances. The output is similar to describeDevice
,
/// but the results are sourced from the device cache in the Amazon Web Services Cloud
/// and include a subset of the available fields.
///
/// Container for the necessary parameters to execute the DescribeDeviceEc2Instances service method.
///
/// The response from the DescribeDeviceEc2Instances service method, as returned by SnowDeviceManagement.
///
/// You don't have sufficient access to perform this action.
///
///
/// An unexpected error occurred while processing the request.
///
///
/// The request references a resource that doesn't exist.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for DescribeDeviceEc2Instances Operation
DescribeDeviceEc2InstancesResponse DescribeDeviceEc2Instances(DescribeDeviceEc2InstancesRequest request);
///
/// Initiates the asynchronous execution of the DescribeDeviceEc2Instances operation.
///
///
/// Container for the necessary parameters to execute the DescribeDeviceEc2Instances operation on AmazonSnowDeviceManagementClient.
/// 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 EndDescribeDeviceEc2Instances
/// operation.
/// REST API Reference for DescribeDeviceEc2Instances Operation
IAsyncResult BeginDescribeDeviceEc2Instances(DescribeDeviceEc2InstancesRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DescribeDeviceEc2Instances operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeDeviceEc2Instances.
///
/// Returns a DescribeDeviceEc2InstancesResult from SnowDeviceManagement.
/// REST API Reference for DescribeDeviceEc2Instances Operation
DescribeDeviceEc2InstancesResponse EndDescribeDeviceEc2Instances(IAsyncResult asyncResult);
#endregion
#region DescribeExecution
///
/// Checks the status of a remote task running on one or more target devices.
///
/// Container for the necessary parameters to execute the DescribeExecution service method.
///
/// The response from the DescribeExecution service method, as returned by SnowDeviceManagement.
///
/// You don't have sufficient access to perform this action.
///
///
/// An unexpected error occurred while processing the request.
///
///
/// The request references a resource that doesn't exist.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for DescribeExecution Operation
DescribeExecutionResponse DescribeExecution(DescribeExecutionRequest request);
///
/// Initiates the asynchronous execution of the DescribeExecution operation.
///
///
/// Container for the necessary parameters to execute the DescribeExecution operation on AmazonSnowDeviceManagementClient.
/// 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 EndDescribeExecution
/// operation.
/// REST API Reference for DescribeExecution Operation
IAsyncResult BeginDescribeExecution(DescribeExecutionRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DescribeExecution operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeExecution.
///
/// Returns a DescribeExecutionResult from SnowDeviceManagement.
/// REST API Reference for DescribeExecution Operation
DescribeExecutionResponse EndDescribeExecution(IAsyncResult asyncResult);
#endregion
#region DescribeTask
///
/// Checks the metadata for a given task on a device.
///
/// Container for the necessary parameters to execute the DescribeTask service method.
///
/// The response from the DescribeTask service method, as returned by SnowDeviceManagement.
///
/// You don't have sufficient access to perform this action.
///
///
/// An unexpected error occurred while processing the request.
///
///
/// The request references a resource that doesn't exist.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for DescribeTask Operation
DescribeTaskResponse DescribeTask(DescribeTaskRequest request);
///
/// Initiates the asynchronous execution of the DescribeTask operation.
///
///
/// Container for the necessary parameters to execute the DescribeTask operation on AmazonSnowDeviceManagementClient.
/// 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 EndDescribeTask
/// operation.
/// REST API Reference for DescribeTask Operation
IAsyncResult BeginDescribeTask(DescribeTaskRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DescribeTask operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeTask.
///
/// Returns a DescribeTaskResult from SnowDeviceManagement.
/// REST API Reference for DescribeTask Operation
DescribeTaskResponse EndDescribeTask(IAsyncResult asyncResult);
#endregion
#region ListDeviceResources
///
/// Returns a list of the Amazon Web Services resources available for a device. Currently,
/// Amazon EC2 instances are the only supported resource type.
///
/// Container for the necessary parameters to execute the ListDeviceResources service method.
///
/// The response from the ListDeviceResources service method, as returned by SnowDeviceManagement.
///
/// You don't have sufficient access to perform this action.
///
///
/// An unexpected error occurred while processing the request.
///
///
/// The request references a resource that doesn't exist.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for ListDeviceResources Operation
ListDeviceResourcesResponse ListDeviceResources(ListDeviceResourcesRequest request);
///
/// Initiates the asynchronous execution of the ListDeviceResources operation.
///
///
/// Container for the necessary parameters to execute the ListDeviceResources operation on AmazonSnowDeviceManagementClient.
/// 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 EndListDeviceResources
/// operation.
/// REST API Reference for ListDeviceResources Operation
IAsyncResult BeginListDeviceResources(ListDeviceResourcesRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListDeviceResources operation.
///
///
/// The IAsyncResult returned by the call to BeginListDeviceResources.
///
/// Returns a ListDeviceResourcesResult from SnowDeviceManagement.
/// REST API Reference for ListDeviceResources Operation
ListDeviceResourcesResponse EndListDeviceResources(IAsyncResult asyncResult);
#endregion
#region ListDevices
///
/// Returns a list of all devices on your Amazon Web Services account that have Amazon
/// Web Services Snow Device Management enabled in the Amazon Web Services Region where
/// the command is run.
///
/// Container for the necessary parameters to execute the ListDevices service method.
///
/// The response from the ListDevices service method, as returned by SnowDeviceManagement.
///
/// You don't have sufficient access to perform this action.
///
///
/// An unexpected error occurred while processing the request.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for ListDevices Operation
ListDevicesResponse ListDevices(ListDevicesRequest request);
///
/// Initiates the asynchronous execution of the ListDevices operation.
///
///
/// Container for the necessary parameters to execute the ListDevices operation on AmazonSnowDeviceManagementClient.
/// 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 EndListDevices
/// operation.
/// REST API Reference for ListDevices Operation
IAsyncResult BeginListDevices(ListDevicesRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListDevices operation.
///
///
/// The IAsyncResult returned by the call to BeginListDevices.
///
/// Returns a ListDevicesResult from SnowDeviceManagement.
/// REST API Reference for ListDevices Operation
ListDevicesResponse EndListDevices(IAsyncResult asyncResult);
#endregion
#region ListExecutions
///
/// Returns the status of tasks for one or more target devices.
///
/// Container for the necessary parameters to execute the ListExecutions service method.
///
/// The response from the ListExecutions service method, as returned by SnowDeviceManagement.
///
/// You don't have sufficient access to perform this action.
///
///
/// An unexpected error occurred while processing the request.
///
///
/// The request references a resource that doesn't exist.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for ListExecutions Operation
ListExecutionsResponse ListExecutions(ListExecutionsRequest request);
///
/// Initiates the asynchronous execution of the ListExecutions operation.
///
///
/// Container for the necessary parameters to execute the ListExecutions operation on AmazonSnowDeviceManagementClient.
/// 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 EndListExecutions
/// operation.
/// REST API Reference for ListExecutions Operation
IAsyncResult BeginListExecutions(ListExecutionsRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListExecutions operation.
///
///
/// The IAsyncResult returned by the call to BeginListExecutions.
///
/// Returns a ListExecutionsResult from SnowDeviceManagement.
/// REST API Reference for ListExecutions Operation
ListExecutionsResponse EndListExecutions(IAsyncResult asyncResult);
#endregion
#region ListTagsForResource
///
/// Returns a list of tags for a managed device or task.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// The response from the ListTagsForResource service method, as returned by SnowDeviceManagement.
///
/// An unexpected error occurred while processing the request.
///
///
/// The request references a resource that doesn't exist.
///
///
/// The input fails to satisfy the constraints specified by an Amazon Web Services service.
///
/// 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 AmazonSnowDeviceManagementClient.
/// 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 SnowDeviceManagement.
/// REST API Reference for ListTagsForResource Operation
ListTagsForResourceResponse EndListTagsForResource(IAsyncResult asyncResult);
#endregion
#region ListTasks
///
/// Returns a list of tasks that can be filtered by state.
///
/// Container for the necessary parameters to execute the ListTasks service method.
///
/// The response from the ListTasks service method, as returned by SnowDeviceManagement.
///
/// You don't have sufficient access to perform this action.
///
///
/// An unexpected error occurred while processing the request.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for ListTasks Operation
ListTasksResponse ListTasks(ListTasksRequest request);
///
/// Initiates the asynchronous execution of the ListTasks operation.
///
///
/// Container for the necessary parameters to execute the ListTasks operation on AmazonSnowDeviceManagementClient.
/// 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 EndListTasks
/// operation.
/// REST API Reference for ListTasks Operation
IAsyncResult BeginListTasks(ListTasksRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListTasks operation.
///
///
/// The IAsyncResult returned by the call to BeginListTasks.
///
/// Returns a ListTasksResult from SnowDeviceManagement.
/// REST API Reference for ListTasks Operation
ListTasksResponse EndListTasks(IAsyncResult asyncResult);
#endregion
#region TagResource
///
/// Adds or replaces tags on a device or task.
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// The response from the TagResource service method, as returned by SnowDeviceManagement.
///
/// An unexpected error occurred while processing the request.
///
///
/// The request references a resource that doesn't exist.
///
///
/// The input fails to satisfy the constraints specified by an Amazon Web Services service.
///
/// 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 AmazonSnowDeviceManagementClient.
/// 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 SnowDeviceManagement.
/// REST API Reference for TagResource Operation
TagResourceResponse EndTagResource(IAsyncResult asyncResult);
#endregion
#region UntagResource
///
/// Removes a tag from a device or task.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// The response from the UntagResource service method, as returned by SnowDeviceManagement.
///
/// An unexpected error occurred while processing the request.
///
///
/// The request references a resource that doesn't exist.
///
///
/// The input fails to satisfy the constraints specified by an Amazon Web Services service.
///
/// 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 AmazonSnowDeviceManagementClient.
/// 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 SnowDeviceManagement.
/// REST API Reference for UntagResource Operation
UntagResourceResponse EndUntagResource(IAsyncResult asyncResult);
#endregion
}
}