com.amazonaws.services.snowdevicemanagement.AWSSnowDeviceManagementAsync Maven / Gradle / Ivy
/*
* Copyright 2019-2024 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.
*/
package com.amazonaws.services.snowdevicemanagement;
import javax.annotation.Generated;
import com.amazonaws.services.snowdevicemanagement.model.*;
/**
* Interface for accessing AWS Snow Device Management asynchronously. Each asynchronous method will return a Java Future
* object representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive
* notification when an asynchronous operation completes.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.snowdevicemanagement.AbstractAWSSnowDeviceManagementAsync} instead.
*
*
*
* Amazon Web Services Snow Device Management documentation.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSSnowDeviceManagementAsync extends AWSSnowDeviceManagement {
/**
*
* 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.
*
*
*
* @param cancelTaskRequest
* @return A Java Future containing the result of the CancelTask operation returned by the service.
* @sample AWSSnowDeviceManagementAsync.CancelTask
* @see AWS API Documentation
*/
java.util.concurrent.Future cancelTaskAsync(CancelTaskRequest cancelTaskRequest);
/**
*
* 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.
*
*
*
* @param cancelTaskRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CancelTask operation returned by the service.
* @sample AWSSnowDeviceManagementAsyncHandler.CancelTask
* @see AWS API Documentation
*/
java.util.concurrent.Future cancelTaskAsync(CancelTaskRequest cancelTaskRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Instructs one or more devices to start a task, such as unlocking or rebooting.
*
*
* @param createTaskRequest
* @return A Java Future containing the result of the CreateTask operation returned by the service.
* @sample AWSSnowDeviceManagementAsync.CreateTask
* @see AWS API Documentation
*/
java.util.concurrent.Future createTaskAsync(CreateTaskRequest createTaskRequest);
/**
*
* Instructs one or more devices to start a task, such as unlocking or rebooting.
*
*
* @param createTaskRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateTask operation returned by the service.
* @sample AWSSnowDeviceManagementAsyncHandler.CreateTask
* @see AWS API Documentation
*/
java.util.concurrent.Future createTaskAsync(CreateTaskRequest createTaskRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Checks device-specific information, such as the device type, software version, IP addresses, and lock status.
*
*
* @param describeDeviceRequest
* @return A Java Future containing the result of the DescribeDevice operation returned by the service.
* @sample AWSSnowDeviceManagementAsync.DescribeDevice
* @see AWS API Documentation
*/
java.util.concurrent.Future describeDeviceAsync(DescribeDeviceRequest describeDeviceRequest);
/**
*
* Checks device-specific information, such as the device type, software version, IP addresses, and lock status.
*
*
* @param describeDeviceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeDevice operation returned by the service.
* @sample AWSSnowDeviceManagementAsyncHandler.DescribeDevice
* @see AWS API Documentation
*/
java.util.concurrent.Future describeDeviceAsync(DescribeDeviceRequest describeDeviceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param describeDeviceEc2InstancesRequest
* @return A Java Future containing the result of the DescribeDeviceEc2Instances operation returned by the service.
* @sample AWSSnowDeviceManagementAsync.DescribeDeviceEc2Instances
* @see AWS API Documentation
*/
java.util.concurrent.Future describeDeviceEc2InstancesAsync(
DescribeDeviceEc2InstancesRequest describeDeviceEc2InstancesRequest);
/**
*
* 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.
*
*
* @param describeDeviceEc2InstancesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeDeviceEc2Instances operation returned by the service.
* @sample AWSSnowDeviceManagementAsyncHandler.DescribeDeviceEc2Instances
* @see AWS API Documentation
*/
java.util.concurrent.Future describeDeviceEc2InstancesAsync(
DescribeDeviceEc2InstancesRequest describeDeviceEc2InstancesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Checks the status of a remote task running on one or more target devices.
*
*
* @param describeExecutionRequest
* @return A Java Future containing the result of the DescribeExecution operation returned by the service.
* @sample AWSSnowDeviceManagementAsync.DescribeExecution
* @see AWS API Documentation
*/
java.util.concurrent.Future describeExecutionAsync(DescribeExecutionRequest describeExecutionRequest);
/**
*
* Checks the status of a remote task running on one or more target devices.
*
*
* @param describeExecutionRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeExecution operation returned by the service.
* @sample AWSSnowDeviceManagementAsyncHandler.DescribeExecution
* @see AWS API Documentation
*/
java.util.concurrent.Future describeExecutionAsync(DescribeExecutionRequest describeExecutionRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Checks the metadata for a given task on a device.
*
*
* @param describeTaskRequest
* @return A Java Future containing the result of the DescribeTask operation returned by the service.
* @sample AWSSnowDeviceManagementAsync.DescribeTask
* @see AWS API Documentation
*/
java.util.concurrent.Future describeTaskAsync(DescribeTaskRequest describeTaskRequest);
/**
*
* Checks the metadata for a given task on a device.
*
*
* @param describeTaskRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeTask operation returned by the service.
* @sample AWSSnowDeviceManagementAsyncHandler.DescribeTask
* @see AWS API Documentation
*/
java.util.concurrent.Future describeTaskAsync(DescribeTaskRequest describeTaskRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns a list of the Amazon Web Services resources available for a device. Currently, Amazon EC2 instances are
* the only supported resource type.
*
*
* @param listDeviceResourcesRequest
* @return A Java Future containing the result of the ListDeviceResources operation returned by the service.
* @sample AWSSnowDeviceManagementAsync.ListDeviceResources
* @see AWS API Documentation
*/
java.util.concurrent.Future listDeviceResourcesAsync(ListDeviceResourcesRequest listDeviceResourcesRequest);
/**
*
* Returns a list of the Amazon Web Services resources available for a device. Currently, Amazon EC2 instances are
* the only supported resource type.
*
*
* @param listDeviceResourcesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListDeviceResources operation returned by the service.
* @sample AWSSnowDeviceManagementAsyncHandler.ListDeviceResources
* @see AWS API Documentation
*/
java.util.concurrent.Future listDeviceResourcesAsync(ListDeviceResourcesRequest listDeviceResourcesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param listDevicesRequest
* @return A Java Future containing the result of the ListDevices operation returned by the service.
* @sample AWSSnowDeviceManagementAsync.ListDevices
* @see AWS API Documentation
*/
java.util.concurrent.Future listDevicesAsync(ListDevicesRequest listDevicesRequest);
/**
*
* 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.
*
*
* @param listDevicesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListDevices operation returned by the service.
* @sample AWSSnowDeviceManagementAsyncHandler.ListDevices
* @see AWS API Documentation
*/
java.util.concurrent.Future listDevicesAsync(ListDevicesRequest listDevicesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns the status of tasks for one or more target devices.
*
*
* @param listExecutionsRequest
* @return A Java Future containing the result of the ListExecutions operation returned by the service.
* @sample AWSSnowDeviceManagementAsync.ListExecutions
* @see AWS API Documentation
*/
java.util.concurrent.Future listExecutionsAsync(ListExecutionsRequest listExecutionsRequest);
/**
*
* Returns the status of tasks for one or more target devices.
*
*
* @param listExecutionsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListExecutions operation returned by the service.
* @sample AWSSnowDeviceManagementAsyncHandler.ListExecutions
* @see AWS API Documentation
*/
java.util.concurrent.Future listExecutionsAsync(ListExecutionsRequest listExecutionsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns a list of tags for a managed device or task.
*
*
* @param listTagsForResourceRequest
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* @sample AWSSnowDeviceManagementAsync.ListTagsForResource
* @see AWS API Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Returns a list of tags for a managed device or task.
*
*
* @param listTagsForResourceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* @sample AWSSnowDeviceManagementAsyncHandler.ListTagsForResource
* @see AWS API Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns a list of tasks that can be filtered by state.
*
*
* @param listTasksRequest
* @return A Java Future containing the result of the ListTasks operation returned by the service.
* @sample AWSSnowDeviceManagementAsync.ListTasks
* @see AWS API Documentation
*/
java.util.concurrent.Future listTasksAsync(ListTasksRequest listTasksRequest);
/**
*
* Returns a list of tasks that can be filtered by state.
*
*
* @param listTasksRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListTasks operation returned by the service.
* @sample AWSSnowDeviceManagementAsyncHandler.ListTasks
* @see AWS API Documentation
*/
java.util.concurrent.Future listTasksAsync(ListTasksRequest listTasksRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Adds or replaces tags on a device or task.
*
*
* @param tagResourceRequest
* @return A Java Future containing the result of the TagResource operation returned by the service.
* @sample AWSSnowDeviceManagementAsync.TagResource
* @see AWS API Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest);
/**
*
* Adds or replaces tags on a device or task.
*
*
* @param tagResourceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the TagResource operation returned by the service.
* @sample AWSSnowDeviceManagementAsyncHandler.TagResource
* @see AWS API Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Removes a tag from a device or task.
*
*
* @param untagResourceRequest
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* @sample AWSSnowDeviceManagementAsync.UntagResource
* @see AWS API Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest);
/**
*
* Removes a tag from a device or task.
*
*
* @param untagResourceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* @sample AWSSnowDeviceManagementAsyncHandler.UntagResource
* @see AWS API Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}