AWSSnowDeviceManagement (AWS Java SDK for AWS Snow Device Management 1.12.540 API)

All Known Subinterfaces:

AWSSnowDeviceManagementAsync

All Known Implementing Classes:

AbstractAWSSnowDeviceManagement, AbstractAWSSnowDeviceManagementAsync, AWSSnowDeviceManagementAsyncClient, AWSSnowDeviceManagementClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSSnowDeviceManagement
```
Interface for accessing AWS Snow Device Management.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSSnowDeviceManagement instead.

Amazon Web Services Snow Device Management documentation.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CancelTaskResult`	`cancelTask(CancelTaskRequest cancelTaskRequest)` Sends a cancel request for a specified task.
`CreateTaskResult`	`createTask(CreateTaskRequest createTaskRequest)` Instructs one or more devices to start a task, such as unlocking or rebooting.
`DescribeDeviceResult`	`describeDevice(DescribeDeviceRequest describeDeviceRequest)` Checks device-specific information, such as the device type, software version, IP addresses, and lock status.
`DescribeDeviceEc2InstancesResult`	`describeDeviceEc2Instances(DescribeDeviceEc2InstancesRequest describeDeviceEc2InstancesRequest)` Checks the current state of the Amazon EC2 instances.
`DescribeExecutionResult`	`describeExecution(DescribeExecutionRequest describeExecutionRequest)` Checks the status of a remote task running on one or more target devices.
`DescribeTaskResult`	`describeTask(DescribeTaskRequest describeTaskRequest)` Checks the metadata for a given task on a device.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`ListDeviceResourcesResult`	`listDeviceResources(ListDeviceResourcesRequest listDeviceResourcesRequest)` Returns a list of the Amazon Web Services resources available for a device.
`ListDevicesResult`	`listDevices(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.
`ListExecutionsResult`	`listExecutions(ListExecutionsRequest listExecutionsRequest)` Returns the status of tasks for one or more target devices.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` Returns a list of tags for a managed device or task.
`ListTasksResult`	`listTasks(ListTasksRequest listTasksRequest)` Returns a list of tasks that can be filtered by state.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` Adds or replaces tags on a device or task.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Removes a tag from a device or task.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - cancelTask
```
CancelTaskResult cancelTask(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.
    
    Parameters:
    
    cancelTaskRequest -
    
    Returns:
    
    Result of the CancelTask operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied due to request throttling.
    
    InternalServerException - An unexpected error occurred while processing the request.
    
    ResourceNotFoundException - The request references a resource that doesn't exist.
    
    ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
    
    AccessDeniedException - You don't have sufficient access to perform this action.
    
    See Also:
    
    AWS API Documentation
  - createTask
```
CreateTaskResult createTask(CreateTaskRequest createTaskRequest)
```
    Instructs one or more devices to start a task, such as unlocking or rebooting.
    
    Parameters:
    
    createTaskRequest -
    
    Returns:
    
    Result of the CreateTask operation returned by the service.
    
    Throws:
    
    ServiceQuotaExceededException - The request would cause a service quota to be exceeded.
    
    ThrottlingException - The request was denied due to request throttling.
    
    InternalServerException - An unexpected error occurred while processing the request.
    
    ResourceNotFoundException - The request references a resource that doesn't exist.
    
    ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
    
    AccessDeniedException - You don't have sufficient access to perform this action.
    
    See Also:
    
    AWS API Documentation
  - describeDevice
```
DescribeDeviceResult describeDevice(DescribeDeviceRequest describeDeviceRequest)
```
    Checks device-specific information, such as the device type, software version, IP addresses, and lock status.
    
    Parameters:
    
    describeDeviceRequest -
    
    Returns:
    
    Result of the DescribeDevice operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied due to request throttling.
    
    InternalServerException - An unexpected error occurred while processing the request.
    
    ResourceNotFoundException - The request references a resource that doesn't exist.
    
    ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
    
    AccessDeniedException - You don't have sufficient access to perform this action.
    
    See Also:
    
    AWS API Documentation
  - describeDeviceEc2Instances
```
DescribeDeviceEc2InstancesResult describeDeviceEc2Instances(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.
    
    Parameters:
    
    describeDeviceEc2InstancesRequest -
    
    Returns:
    
    Result of the DescribeDeviceEc2Instances operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied due to request throttling.
    
    InternalServerException - An unexpected error occurred while processing the request.
    
    ResourceNotFoundException - The request references a resource that doesn't exist.
    
    ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
    
    AccessDeniedException - You don't have sufficient access to perform this action.
    
    See Also:
    
    AWS API Documentation
  - describeExecution
```
DescribeExecutionResult describeExecution(DescribeExecutionRequest describeExecutionRequest)
```
    Checks the status of a remote task running on one or more target devices.
    
    Parameters:
    
    describeExecutionRequest -
    
    Returns:
    
    Result of the DescribeExecution operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied due to request throttling.
    
    InternalServerException - An unexpected error occurred while processing the request.
    
    ResourceNotFoundException - The request references a resource that doesn't exist.
    
    ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
    
    AccessDeniedException - You don't have sufficient access to perform this action.
    
    See Also:
    
    AWS API Documentation
  - describeTask
```
DescribeTaskResult describeTask(DescribeTaskRequest describeTaskRequest)
```
    Checks the metadata for a given task on a device.
    
    Parameters:
    
    describeTaskRequest -
    
    Returns:
    
    Result of the DescribeTask operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied due to request throttling.
    
    InternalServerException - An unexpected error occurred while processing the request.
    
    ResourceNotFoundException - The request references a resource that doesn't exist.
    
    ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
    
    AccessDeniedException - You don't have sufficient access to perform this action.
    
    See Also:
    
    AWS API Documentation
  - listDeviceResources
```
ListDeviceResourcesResult listDeviceResources(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.
    
    Parameters:
    
    listDeviceResourcesRequest -
    
    Returns:
    
    Result of the ListDeviceResources operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied due to request throttling.
    
    InternalServerException - An unexpected error occurred while processing the request.
    
    ResourceNotFoundException - The request references a resource that doesn't exist.
    
    ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
    
    AccessDeniedException - You don't have sufficient access to perform this action.
    
    See Also:
    
    AWS API Documentation
  - listDevices
```
ListDevicesResult listDevices(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.
    
    Parameters:
    
    listDevicesRequest -
    
    Returns:
    
    Result of the ListDevices operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied due to request throttling.
    
    InternalServerException - An unexpected error occurred while processing the request.
    
    ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
    
    AccessDeniedException - You don't have sufficient access to perform this action.
    
    See Also:
    
    AWS API Documentation
  - listExecutions
```
ListExecutionsResult listExecutions(ListExecutionsRequest listExecutionsRequest)
```
    Returns the status of tasks for one or more target devices.
    
    Parameters:
    
    listExecutionsRequest -
    
    Returns:
    
    Result of the ListExecutions operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied due to request throttling.
    
    InternalServerException - An unexpected error occurred while processing the request.
    
    ResourceNotFoundException - The request references a resource that doesn't exist.
    
    ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
    
    AccessDeniedException - You don't have sufficient access to perform this action.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Returns a list of tags for a managed device or task.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error occurred while processing the request.
    
    ResourceNotFoundException - The request references a resource that doesn't exist.
    
    ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
    
    See Also:
    
    AWS API Documentation
  - listTasks
```
ListTasksResult listTasks(ListTasksRequest listTasksRequest)
```
    Returns a list of tasks that can be filtered by state.
    
    Parameters:
    
    listTasksRequest -
    
    Returns:
    
    Result of the ListTasks operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied due to request throttling.
    
    InternalServerException - An unexpected error occurred while processing the request.
    
    ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
    
    AccessDeniedException - You don't have sufficient access to perform this action.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    Adds or replaces tags on a device or task.
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error occurred while processing the request.
    
    ResourceNotFoundException - The request references a resource that doesn't exist.
    
    ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    Removes a tag from a device or task.
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    InternalServerException - An unexpected error occurred while processing the request.
    
    ResourceNotFoundException - The request references a resource that doesn't exist.
    
    ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Interface AWSSnowDeviceManagement

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

cancelTask

createTask

describeDevice

describeDeviceEc2Instances

describeExecution

describeTask

listDeviceResources

listDevices

listExecutions

listTagsForResource

listTasks

tagResource

untagResource

shutdown

getCachedResponseMetadata