/*
* 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.Threading;
using System.Threading.Tasks;
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
{
///
/// Paginators for the service
///
ISnowDeviceManagementPaginatorFactory Paginators { get; }
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task CancelTaskAsync(CancelTaskRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task CreateTaskAsync(CreateTaskRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DescribeDeviceAsync(DescribeDeviceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DescribeDeviceEc2InstancesAsync(DescribeDeviceEc2InstancesRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DescribeExecutionAsync(DescribeExecutionRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Checks the metadata for a given task on a device.
///
/// Container for the necessary parameters to execute the DescribeTask service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DescribeTaskAsync(DescribeTaskRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ListDeviceResourcesAsync(ListDeviceResourcesRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ListDevicesAsync(ListDevicesRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Returns the status of tasks for one or more target devices.
///
/// Container for the necessary parameters to execute the ListExecutions service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ListExecutionsAsync(ListExecutionsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Returns a list of tags for a managed device or task.
///
/// 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 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
Task ListTagsForResourceAsync(ListTagsForResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Returns a list of tasks that can be filtered by state.
///
/// Container for the necessary parameters to execute the ListTasks service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ListTasksAsync(ListTasksRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Adds or replaces tags on a device or task.
///
/// 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 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
Task TagResourceAsync(TagResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Removes a tag from a device or task.
///
/// 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 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
Task UntagResourceAsync(UntagResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
}
}