com.amazonaws.services.snowdevicemanagement

Class AWSSnowDeviceManagementAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.snowdevicemanagement.AWSSnowDeviceManagementClient

com.amazonaws.services.snowdevicemanagement.AWSSnowDeviceManagementAsyncClient

All Implemented Interfaces:

AWSSnowDeviceManagement, AWSSnowDeviceManagementAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSSnowDeviceManagementAsyncClient
extends AWSSnowDeviceManagementClient
implements AWSSnowDeviceManagementAsync

Client for accessing AWS Snow Device Management asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

Amazon Web Services Snow Device Management documentation.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.snowdevicemanagement.AWSSnowDeviceManagement

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSSnowDeviceManagementAsyncClientBuilder	asyncBuilder()
Future<CancelTaskResult>	cancelTaskAsync(CancelTaskRequest request) Sends a cancel request for a specified task.
Future<CancelTaskResult>	cancelTaskAsync(CancelTaskRequest request, AsyncHandler<CancelTaskRequest,CancelTaskResult> asyncHandler) Sends a cancel request for a specified task.
Future<CreateTaskResult>	createTaskAsync(CreateTaskRequest request) Instructs one or more devices to start a task, such as unlocking or rebooting.
Future<CreateTaskResult>	createTaskAsync(CreateTaskRequest request, AsyncHandler<CreateTaskRequest,CreateTaskResult> asyncHandler) Instructs one or more devices to start a task, such as unlocking or rebooting.
Future<DescribeDeviceResult>	describeDeviceAsync(DescribeDeviceRequest request) Checks device-specific information, such as the device type, software version, IP addresses, and lock status.
Future<DescribeDeviceResult>	describeDeviceAsync(DescribeDeviceRequest request, AsyncHandler<DescribeDeviceRequest,DescribeDeviceResult> asyncHandler) Checks device-specific information, such as the device type, software version, IP addresses, and lock status.
Future<DescribeDeviceEc2InstancesResult>	describeDeviceEc2InstancesAsync(DescribeDeviceEc2InstancesRequest request) Checks the current state of the Amazon EC2 instances.
Future<DescribeDeviceEc2InstancesResult>	describeDeviceEc2InstancesAsync(DescribeDeviceEc2InstancesRequest request, AsyncHandler<DescribeDeviceEc2InstancesRequest,DescribeDeviceEc2InstancesResult> asyncHandler) Checks the current state of the Amazon EC2 instances.
Future<DescribeExecutionResult>	describeExecutionAsync(DescribeExecutionRequest request) Checks the status of a remote task running on one or more target devices.
Future<DescribeExecutionResult>	describeExecutionAsync(DescribeExecutionRequest request, AsyncHandler<DescribeExecutionRequest,DescribeExecutionResult> asyncHandler) Checks the status of a remote task running on one or more target devices.
Future<DescribeTaskResult>	describeTaskAsync(DescribeTaskRequest request) Checks the metadata for a given task on a device.
Future<DescribeTaskResult>	describeTaskAsync(DescribeTaskRequest request, AsyncHandler<DescribeTaskRequest,DescribeTaskResult> asyncHandler) Checks the metadata for a given task on a device.
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<ListDeviceResourcesResult>	listDeviceResourcesAsync(ListDeviceResourcesRequest request) Returns a list of the Amazon Web Services resources available for a device.
Future<ListDeviceResourcesResult>	listDeviceResourcesAsync(ListDeviceResourcesRequest request, AsyncHandler<ListDeviceResourcesRequest,ListDeviceResourcesResult> asyncHandler) Returns a list of the Amazon Web Services resources available for a device.
Future<ListDevicesResult>	listDevicesAsync(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.
Future<ListDevicesResult>	listDevicesAsync(ListDevicesRequest request, AsyncHandler<ListDevicesRequest,ListDevicesResult> 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.
Future<ListExecutionsResult>	listExecutionsAsync(ListExecutionsRequest request) Returns the status of tasks for one or more target devices.
Future<ListExecutionsResult>	listExecutionsAsync(ListExecutionsRequest request, AsyncHandler<ListExecutionsRequest,ListExecutionsResult> asyncHandler) Returns the status of tasks for one or more target devices.
Future<ListTagsForResourceResult>	listTagsForResourceAsync(ListTagsForResourceRequest request) Returns a list of tags for a managed device or task.
Future<ListTagsForResourceResult>	listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler) Returns a list of tags for a managed device or task.
Future<ListTasksResult>	listTasksAsync(ListTasksRequest request) Returns a list of tasks that can be filtered by state.
Future<ListTasksResult>	listTasksAsync(ListTasksRequest request, AsyncHandler<ListTasksRequest,ListTasksResult> asyncHandler) Returns a list of tasks that can be filtered by state.
void	shutdown() Shuts down the client, releasing all managed resources.
Future<TagResourceResult>	tagResourceAsync(TagResourceRequest request) Adds or replaces tags on a device or task.
Future<TagResourceResult>	tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler) Adds or replaces tags on a device or task.
Future<UntagResourceResult>	untagResourceAsync(UntagResourceRequest request) Removes a tag from a device or task.
Future<UntagResourceResult>	untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler) Removes a tag from a device or task.

Methods inherited from class com.amazonaws.services.snowdevicemanagement.AWSSnowDeviceManagementClient

builder, cancelTask, createTask, describeDevice, describeDeviceEc2Instances, describeExecution, describeTask, getCachedResponseMetadata, listDeviceResources, listDevices, listExecutions, listTagsForResource, listTasks, tagResource, untagResource

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.snowdevicemanagement.AWSSnowDeviceManagement

cancelTask, createTask, describeDevice, describeDeviceEc2Instances, describeExecution, describeTask, getCachedResponseMetadata, listDeviceResources, listDevices, listExecutions, listTagsForResource, listTasks, tagResource, untagResource

Method Detail

asyncBuilder

public static AWSSnowDeviceManagementAsyncClientBuilder asyncBuilder()

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

cancelTaskAsync

public Future<CancelTaskResult> cancelTaskAsync(CancelTaskRequest request)

Description copied from interface: AWSSnowDeviceManagementAsync

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.

Specified by:

cancelTaskAsync in interface AWSSnowDeviceManagementAsync

Returns:

A Java Future containing the result of the CancelTask operation returned by the service.

See Also:

AWS API Documentation

cancelTaskAsync

public Future<CancelTaskResult> cancelTaskAsync(CancelTaskRequest request,
                                                AsyncHandler<CancelTaskRequest,CancelTaskResult> asyncHandler)

Description copied from interface: AWSSnowDeviceManagementAsync

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.

Specified by:

cancelTaskAsync in interface AWSSnowDeviceManagementAsync

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.

Returns:

A Java Future containing the result of the CancelTask operation returned by the service.

See Also:

AWS API Documentation

createTaskAsync

public Future<CreateTaskResult> createTaskAsync(CreateTaskRequest request)

Description copied from interface: AWSSnowDeviceManagementAsync

Instructs one or more devices to start a task, such as unlocking or rebooting.

Specified by:

createTaskAsync in interface AWSSnowDeviceManagementAsync

Returns:

A Java Future containing the result of the CreateTask operation returned by the service.

See Also:

AWS API Documentation

createTaskAsync

public Future<CreateTaskResult> createTaskAsync(CreateTaskRequest request,
                                                AsyncHandler<CreateTaskRequest,CreateTaskResult> asyncHandler)

Description copied from interface: AWSSnowDeviceManagementAsync

Instructs one or more devices to start a task, such as unlocking or rebooting.

Specified by:

createTaskAsync in interface AWSSnowDeviceManagementAsync

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.

Returns:

A Java Future containing the result of the CreateTask operation returned by the service.

See Also:

AWS API Documentation

describeDeviceAsync

public Future<DescribeDeviceResult> describeDeviceAsync(DescribeDeviceRequest request)

Description copied from interface: AWSSnowDeviceManagementAsync

Checks device-specific information, such as the device type, software version, IP addresses, and lock status.

Specified by:

describeDeviceAsync in interface AWSSnowDeviceManagementAsync

Returns:

A Java Future containing the result of the DescribeDevice operation returned by the service.

See Also:

AWS API Documentation

describeDeviceAsync

public Future<DescribeDeviceResult> describeDeviceAsync(DescribeDeviceRequest request,
                                                        AsyncHandler<DescribeDeviceRequest,DescribeDeviceResult> asyncHandler)

Description copied from interface: AWSSnowDeviceManagementAsync

Checks device-specific information, such as the device type, software version, IP addresses, and lock status.

Specified by:

describeDeviceAsync in interface AWSSnowDeviceManagementAsync

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.

Returns:

A Java Future containing the result of the DescribeDevice operation returned by the service.

See Also:

AWS API Documentation

describeDeviceEc2InstancesAsync

public Future<DescribeDeviceEc2InstancesResult> describeDeviceEc2InstancesAsync(DescribeDeviceEc2InstancesRequest request)

Description copied from interface: AWSSnowDeviceManagementAsync

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.

Specified by:

describeDeviceEc2InstancesAsync in interface AWSSnowDeviceManagementAsync

Returns:

A Java Future containing the result of the DescribeDeviceEc2Instances operation returned by the service.

See Also:

AWS API Documentation

describeDeviceEc2InstancesAsync

public Future<DescribeDeviceEc2InstancesResult> describeDeviceEc2InstancesAsync(DescribeDeviceEc2InstancesRequest request,
                                                                                AsyncHandler<DescribeDeviceEc2InstancesRequest,DescribeDeviceEc2InstancesResult> asyncHandler)

Description copied from interface: AWSSnowDeviceManagementAsync

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.

Specified by:

describeDeviceEc2InstancesAsync in interface AWSSnowDeviceManagementAsync

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.

Returns:

A Java Future containing the result of the DescribeDeviceEc2Instances operation returned by the service.

See Also:

AWS API Documentation

describeExecutionAsync

public Future<DescribeExecutionResult> describeExecutionAsync(DescribeExecutionRequest request)

Description copied from interface: AWSSnowDeviceManagementAsync

Checks the status of a remote task running on one or more target devices.

Specified by:

describeExecutionAsync in interface AWSSnowDeviceManagementAsync

Returns:

A Java Future containing the result of the DescribeExecution operation returned by the service.

See Also:

AWS API Documentation

describeExecutionAsync

public Future<DescribeExecutionResult> describeExecutionAsync(DescribeExecutionRequest request,
                                                              AsyncHandler<DescribeExecutionRequest,DescribeExecutionResult> asyncHandler)

Description copied from interface: AWSSnowDeviceManagementAsync

Checks the status of a remote task running on one or more target devices.

Specified by:

describeExecutionAsync in interface AWSSnowDeviceManagementAsync

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.

Returns:

A Java Future containing the result of the DescribeExecution operation returned by the service.

See Also:

AWS API Documentation

describeTaskAsync

public Future<DescribeTaskResult> describeTaskAsync(DescribeTaskRequest request)

Description copied from interface: AWSSnowDeviceManagementAsync

Checks the metadata for a given task on a device.

Specified by:

describeTaskAsync in interface AWSSnowDeviceManagementAsync

Returns:

A Java Future containing the result of the DescribeTask operation returned by the service.

See Also:

AWS API Documentation

describeTaskAsync

public Future<DescribeTaskResult> describeTaskAsync(DescribeTaskRequest request,
                                                    AsyncHandler<DescribeTaskRequest,DescribeTaskResult> asyncHandler)

Description copied from interface: AWSSnowDeviceManagementAsync

Checks the metadata for a given task on a device.

Specified by:

describeTaskAsync in interface AWSSnowDeviceManagementAsync

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.

Returns:

A Java Future containing the result of the DescribeTask operation returned by the service.

See Also:

AWS API Documentation

listDeviceResourcesAsync

public Future<ListDeviceResourcesResult> listDeviceResourcesAsync(ListDeviceResourcesRequest request)

Description copied from interface: AWSSnowDeviceManagementAsync

Returns a list of the Amazon Web Services resources available for a device. Currently, Amazon EC2 instances are the only supported resource type.

Specified by:

listDeviceResourcesAsync in interface AWSSnowDeviceManagementAsync

Returns:

A Java Future containing the result of the ListDeviceResources operation returned by the service.

See Also:

AWS API Documentation

listDeviceResourcesAsync

public Future<ListDeviceResourcesResult> listDeviceResourcesAsync(ListDeviceResourcesRequest request,
                                                                  AsyncHandler<ListDeviceResourcesRequest,ListDeviceResourcesResult> asyncHandler)

Description copied from interface: AWSSnowDeviceManagementAsync

Returns a list of the Amazon Web Services resources available for a device. Currently, Amazon EC2 instances are the only supported resource type.

Specified by:

listDeviceResourcesAsync in interface AWSSnowDeviceManagementAsync

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.

Returns:

A Java Future containing the result of the ListDeviceResources operation returned by the service.

See Also:

AWS API Documentation

listDevicesAsync

public Future<ListDevicesResult> listDevicesAsync(ListDevicesRequest request)

Description copied from interface: AWSSnowDeviceManagementAsync

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.

Specified by:

listDevicesAsync in interface AWSSnowDeviceManagementAsync

Returns:

A Java Future containing the result of the ListDevices operation returned by the service.

See Also:

AWS API Documentation

listDevicesAsync

public Future<ListDevicesResult> listDevicesAsync(ListDevicesRequest request,
                                                  AsyncHandler<ListDevicesRequest,ListDevicesResult> asyncHandler)

Description copied from interface: AWSSnowDeviceManagementAsync

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.

Specified by:

listDevicesAsync in interface AWSSnowDeviceManagementAsync

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.

Returns:

A Java Future containing the result of the ListDevices operation returned by the service.

See Also:

AWS API Documentation

listExecutionsAsync

public Future<ListExecutionsResult> listExecutionsAsync(ListExecutionsRequest request)

Description copied from interface: AWSSnowDeviceManagementAsync

Returns the status of tasks for one or more target devices.

Specified by:

listExecutionsAsync in interface AWSSnowDeviceManagementAsync

Returns:

A Java Future containing the result of the ListExecutions operation returned by the service.

See Also:

AWS API Documentation

listExecutionsAsync

public Future<ListExecutionsResult> listExecutionsAsync(ListExecutionsRequest request,
                                                        AsyncHandler<ListExecutionsRequest,ListExecutionsResult> asyncHandler)

Description copied from interface: AWSSnowDeviceManagementAsync

Returns the status of tasks for one or more target devices.

Specified by:

listExecutionsAsync in interface AWSSnowDeviceManagementAsync

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.

Returns:

A Java Future containing the result of the ListExecutions operation returned by the service.

See Also:

AWS API Documentation

listTagsForResourceAsync

public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)

Description copied from interface: AWSSnowDeviceManagementAsync

Returns a list of tags for a managed device or task.

Specified by:

listTagsForResourceAsync in interface AWSSnowDeviceManagementAsync

Returns:

A Java Future containing the result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

listTagsForResourceAsync

public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request,
                                                                  AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)

Description copied from interface: AWSSnowDeviceManagementAsync

Returns a list of tags for a managed device or task.

Specified by:

listTagsForResourceAsync in interface AWSSnowDeviceManagementAsync

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.

Returns:

A Java Future containing the result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

listTasksAsync

public Future<ListTasksResult> listTasksAsync(ListTasksRequest request)

Description copied from interface: AWSSnowDeviceManagementAsync

Returns a list of tasks that can be filtered by state.

Specified by:

listTasksAsync in interface AWSSnowDeviceManagementAsync

Returns:

A Java Future containing the result of the ListTasks operation returned by the service.

See Also:

AWS API Documentation

listTasksAsync

public Future<ListTasksResult> listTasksAsync(ListTasksRequest request,
                                              AsyncHandler<ListTasksRequest,ListTasksResult> asyncHandler)

Description copied from interface: AWSSnowDeviceManagementAsync

Returns a list of tasks that can be filtered by state.

Specified by:

listTasksAsync in interface AWSSnowDeviceManagementAsync

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.

Returns:

A Java Future containing the result of the ListTasks operation returned by the service.

See Also:

AWS API Documentation

tagResourceAsync

public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)

Description copied from interface: AWSSnowDeviceManagementAsync

Adds or replaces tags on a device or task.

Specified by:

tagResourceAsync in interface AWSSnowDeviceManagementAsync

Returns:

A Java Future containing the result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

tagResourceAsync

public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request,
                                                  AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)

Description copied from interface: AWSSnowDeviceManagementAsync

Adds or replaces tags on a device or task.

Specified by:

tagResourceAsync in interface AWSSnowDeviceManagementAsync

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.

Returns:

A Java Future containing the result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

untagResourceAsync

public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)

Description copied from interface: AWSSnowDeviceManagementAsync

Removes a tag from a device or task.

Specified by:

untagResourceAsync in interface AWSSnowDeviceManagementAsync

Returns:

A Java Future containing the result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

untagResourceAsync

public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request,
                                                      AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)

Description copied from interface: AWSSnowDeviceManagementAsync

Removes a tag from a device or task.

Specified by:

untagResourceAsync in interface AWSSnowDeviceManagementAsync

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.

Returns:

A Java Future containing the result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AWSSnowDeviceManagement

Overrides:

shutdown in class AWSSnowDeviceManagementClient