com.amazonaws.services.snowdevicemanagement

Class AWSSnowDeviceManagementClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.snowdevicemanagement.AWSSnowDeviceManagementClient

All Implemented Interfaces:

AWSSnowDeviceManagement

Direct Known Subclasses:

AWSSnowDeviceManagementAsyncClient

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

Client for accessing AWS Snow Device Management. All service calls made using this client are blocking, and will not return until the service call completes.

Amazon Web Services Snow Device Management documentation.

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSSnowDeviceManagementClientBuilder	builder()
CancelTaskResult	cancelTask(CancelTaskRequest request) Sends a cancel request for a specified task.
CreateTaskResult	createTask(CreateTaskRequest request) Instructs one or more devices to start a task, such as unlocking or rebooting.
DescribeDeviceResult	describeDevice(DescribeDeviceRequest request) Checks device-specific information, such as the device type, software version, IP addresses, and lock status.
DescribeDeviceEc2InstancesResult	describeDeviceEc2Instances(DescribeDeviceEc2InstancesRequest request) Checks the current state of the Amazon EC2 instances.
DescribeExecutionResult	describeExecution(DescribeExecutionRequest request) Checks the status of a remote task running on one or more target devices.
DescribeTaskResult	describeTask(DescribeTaskRequest request) 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 request) Returns a list of the Amazon Web Services resources available for a device.
ListDevicesResult	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.
ListExecutionsResult	listExecutions(ListExecutionsRequest request) Returns the status of tasks for one or more target devices.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Returns a list of tags for a managed device or task.
ListTasksResult	listTasks(ListTasksRequest request) 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 request) Adds or replaces tags on a device or task.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes a tag from a device or task.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AWSSnowDeviceManagementClientBuilder builder()

cancelTask

public CancelTaskResult 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.

Specified by:

cancelTask in interface AWSSnowDeviceManagement

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

public CreateTaskResult createTask(CreateTaskRequest request)

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

Specified by:

createTask in interface AWSSnowDeviceManagement

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

public DescribeDeviceResult describeDevice(DescribeDeviceRequest request)

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

Specified by:

describeDevice in interface AWSSnowDeviceManagement

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

public DescribeDeviceEc2InstancesResult 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.

Specified by:

describeDeviceEc2Instances in interface AWSSnowDeviceManagement

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

public DescribeExecutionResult describeExecution(DescribeExecutionRequest request)

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

Specified by:

describeExecution in interface AWSSnowDeviceManagement

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

public DescribeTaskResult describeTask(DescribeTaskRequest request)

Checks the metadata for a given task on a device.

Specified by:

describeTask in interface AWSSnowDeviceManagement

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

public ListDeviceResourcesResult 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.

Specified by:

listDeviceResources in interface AWSSnowDeviceManagement

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

public ListDevicesResult 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.

Specified by:

listDevices in interface AWSSnowDeviceManagement

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

public ListExecutionsResult listExecutions(ListExecutionsRequest request)

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

Specified by:

listExecutions in interface AWSSnowDeviceManagement

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

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

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

Specified by:

listTagsForResource in interface AWSSnowDeviceManagement

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

public ListTasksResult listTasks(ListTasksRequest request)

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

Specified by:

listTasks in interface AWSSnowDeviceManagement

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

public TagResourceResult tagResource(TagResourceRequest request)

Adds or replaces tags on a device or task.

Specified by:

tagResource in interface AWSSnowDeviceManagement

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

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes a tag from a device or task.

Specified by:

untagResource in interface AWSSnowDeviceManagement

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSSnowDeviceManagement

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from interface: AWSSnowDeviceManagement

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.

Specified by:

shutdown in interface AWSSnowDeviceManagement

Overrides:

shutdown in class AmazonWebServiceClient