com.amazonaws.services.snowdevicemanagement.AWSSnowDeviceManagement Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-snowdevicemanagement Show documentation
Show all versions of aws-java-sdk-snowdevicemanagement Show documentation
The AWS Java SDK for AWS Snow Device Management module holds the client classes that are used for communicating with AWS Snow Device Management Service
/*
* 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.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.snowdevicemanagement.model.*;
/**
* Interface for accessing AWS Snow Device Management.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.snowdevicemanagement.AbstractAWSSnowDeviceManagement} instead.
*
*
*
* Amazon Web Services Snow Device Management documentation.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSSnowDeviceManagement {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "snow-device-management";
/**
*
* 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 Result of the CancelTask operation returned by the service.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws InternalServerException
* An unexpected error occurred while processing the request.
* @throws ResourceNotFoundException
* The request references a resource that doesn't exist.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @throws AccessDeniedException
* You don't have sufficient access to perform this action.
* @sample AWSSnowDeviceManagement.CancelTask
* @see AWS API Documentation
*/
CancelTaskResult cancelTask(CancelTaskRequest cancelTaskRequest);
/**
*
* Instructs one or more devices to start a task, such as unlocking or rebooting.
*
*
* @param createTaskRequest
* @return Result of the CreateTask operation returned by the service.
* @throws ServiceQuotaExceededException
* The request would cause a service quota to be exceeded.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws InternalServerException
* An unexpected error occurred while processing the request.
* @throws ResourceNotFoundException
* The request references a resource that doesn't exist.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @throws AccessDeniedException
* You don't have sufficient access to perform this action.
* @sample AWSSnowDeviceManagement.CreateTask
* @see AWS API Documentation
*/
CreateTaskResult createTask(CreateTaskRequest createTaskRequest);
/**
*
* Checks device-specific information, such as the device type, software version, IP addresses, and lock status.
*
*
* @param describeDeviceRequest
* @return Result of the DescribeDevice operation returned by the service.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws InternalServerException
* An unexpected error occurred while processing the request.
* @throws ResourceNotFoundException
* The request references a resource that doesn't exist.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @throws AccessDeniedException
* You don't have sufficient access to perform this action.
* @sample AWSSnowDeviceManagement.DescribeDevice
* @see AWS API Documentation
*/
DescribeDeviceResult describeDevice(DescribeDeviceRequest describeDeviceRequest);
/**
*
* 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 Result of the DescribeDeviceEc2Instances operation returned by the service.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws InternalServerException
* An unexpected error occurred while processing the request.
* @throws ResourceNotFoundException
* The request references a resource that doesn't exist.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @throws AccessDeniedException
* You don't have sufficient access to perform this action.
* @sample AWSSnowDeviceManagement.DescribeDeviceEc2Instances
* @see AWS API Documentation
*/
DescribeDeviceEc2InstancesResult describeDeviceEc2Instances(DescribeDeviceEc2InstancesRequest describeDeviceEc2InstancesRequest);
/**
*
* Checks the status of a remote task running on one or more target devices.
*
*
* @param describeExecutionRequest
* @return Result of the DescribeExecution operation returned by the service.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws InternalServerException
* An unexpected error occurred while processing the request.
* @throws ResourceNotFoundException
* The request references a resource that doesn't exist.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @throws AccessDeniedException
* You don't have sufficient access to perform this action.
* @sample AWSSnowDeviceManagement.DescribeExecution
* @see AWS API Documentation
*/
DescribeExecutionResult describeExecution(DescribeExecutionRequest describeExecutionRequest);
/**
*
* Checks the metadata for a given task on a device.
*
*
* @param describeTaskRequest
* @return Result of the DescribeTask operation returned by the service.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws InternalServerException
* An unexpected error occurred while processing the request.
* @throws ResourceNotFoundException
* The request references a resource that doesn't exist.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @throws AccessDeniedException
* You don't have sufficient access to perform this action.
* @sample AWSSnowDeviceManagement.DescribeTask
* @see AWS API Documentation
*/
DescribeTaskResult describeTask(DescribeTaskRequest describeTaskRequest);
/**
*
* 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 Result of the ListDeviceResources operation returned by the service.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws InternalServerException
* An unexpected error occurred while processing the request.
* @throws ResourceNotFoundException
* The request references a resource that doesn't exist.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @throws AccessDeniedException
* You don't have sufficient access to perform this action.
* @sample AWSSnowDeviceManagement.ListDeviceResources
* @see AWS API Documentation
*/
ListDeviceResourcesResult listDeviceResources(ListDeviceResourcesRequest listDeviceResourcesRequest);
/**
*
* 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 Result of the ListDevices operation returned by the service.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws InternalServerException
* An unexpected error occurred while processing the request.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @throws AccessDeniedException
* You don't have sufficient access to perform this action.
* @sample AWSSnowDeviceManagement.ListDevices
* @see AWS API Documentation
*/
ListDevicesResult listDevices(ListDevicesRequest listDevicesRequest);
/**
*
* Returns the status of tasks for one or more target devices.
*
*
* @param listExecutionsRequest
* @return Result of the ListExecutions operation returned by the service.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws InternalServerException
* An unexpected error occurred while processing the request.
* @throws ResourceNotFoundException
* The request references a resource that doesn't exist.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @throws AccessDeniedException
* You don't have sufficient access to perform this action.
* @sample AWSSnowDeviceManagement.ListExecutions
* @see AWS API Documentation
*/
ListExecutionsResult listExecutions(ListExecutionsRequest listExecutionsRequest);
/**
*
* Returns a list of tags for a managed device or task.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws InternalServerException
* An unexpected error occurred while processing the request.
* @throws ResourceNotFoundException
* The request references a resource that doesn't exist.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @sample AWSSnowDeviceManagement.ListTagsForResource
* @see AWS API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Returns a list of tasks that can be filtered by state.
*
*
* @param listTasksRequest
* @return Result of the ListTasks operation returned by the service.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws InternalServerException
* An unexpected error occurred while processing the request.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @throws AccessDeniedException
* You don't have sufficient access to perform this action.
* @sample AWSSnowDeviceManagement.ListTasks
* @see AWS API Documentation
*/
ListTasksResult listTasks(ListTasksRequest listTasksRequest);
/**
*
* Adds or replaces tags on a device or task.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws InternalServerException
* An unexpected error occurred while processing the request.
* @throws ResourceNotFoundException
* The request references a resource that doesn't exist.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @sample AWSSnowDeviceManagement.TagResource
* @see AWS API Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Removes a tag from a device or task.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws InternalServerException
* An unexpected error occurred while processing the request.
* @throws ResourceNotFoundException
* The request references a resource that doesn't exist.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @sample AWSSnowDeviceManagement.UntagResource
* @see AWS API Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}