Interface SnowDeviceManagementClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface SnowDeviceManagementClient extends AwsClient
Service client for accessing AWS Snow Device Management. This can be created using the staticbuilder()method.Amazon Web Services Snow Device Management documentation.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static SnowDeviceManagementClientBuilderbuilder()Create a builder that can be used to configure and create aSnowDeviceManagementClient.default CancelTaskResponsecancelTask(Consumer<CancelTaskRequest.Builder> cancelTaskRequest)Sends a cancel request for a specified task.default CancelTaskResponsecancelTask(CancelTaskRequest cancelTaskRequest)Sends a cancel request for a specified task.static SnowDeviceManagementClientcreate()Create aSnowDeviceManagementClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateTaskResponsecreateTask(Consumer<CreateTaskRequest.Builder> createTaskRequest)Instructs one or more devices to start a task, such as unlocking or rebooting.default CreateTaskResponsecreateTask(CreateTaskRequest createTaskRequest)Instructs one or more devices to start a task, such as unlocking or rebooting.default DescribeDeviceResponsedescribeDevice(Consumer<DescribeDeviceRequest.Builder> describeDeviceRequest)Checks device-specific information, such as the device type, software version, IP addresses, and lock status.default DescribeDeviceResponsedescribeDevice(DescribeDeviceRequest describeDeviceRequest)Checks device-specific information, such as the device type, software version, IP addresses, and lock status.default DescribeDeviceEc2InstancesResponsedescribeDeviceEc2Instances(Consumer<DescribeDeviceEc2InstancesRequest.Builder> describeDeviceEc2InstancesRequest)Checks the current state of the Amazon EC2 instances.default DescribeDeviceEc2InstancesResponsedescribeDeviceEc2Instances(DescribeDeviceEc2InstancesRequest describeDeviceEc2InstancesRequest)Checks the current state of the Amazon EC2 instances.default DescribeExecutionResponsedescribeExecution(Consumer<DescribeExecutionRequest.Builder> describeExecutionRequest)Checks the status of a remote task running on one or more target devices.default DescribeExecutionResponsedescribeExecution(DescribeExecutionRequest describeExecutionRequest)Checks the status of a remote task running on one or more target devices.default DescribeTaskResponsedescribeTask(Consumer<DescribeTaskRequest.Builder> describeTaskRequest)Checks the metadata for a given task on a device.default DescribeTaskResponsedescribeTask(DescribeTaskRequest describeTaskRequest)Checks the metadata for a given task on a device.default ListDeviceResourcesResponselistDeviceResources(Consumer<ListDeviceResourcesRequest.Builder> listDeviceResourcesRequest)Returns a list of the Amazon Web Services resources available for a device.default ListDeviceResourcesResponselistDeviceResources(ListDeviceResourcesRequest listDeviceResourcesRequest)Returns a list of the Amazon Web Services resources available for a device.default ListDeviceResourcesIterablelistDeviceResourcesPaginator(Consumer<ListDeviceResourcesRequest.Builder> listDeviceResourcesRequest)This is a variant oflistDeviceResources(software.amazon.awssdk.services.snowdevicemanagement.model.ListDeviceResourcesRequest)operation.default ListDeviceResourcesIterablelistDeviceResourcesPaginator(ListDeviceResourcesRequest listDeviceResourcesRequest)This is a variant oflistDeviceResources(software.amazon.awssdk.services.snowdevicemanagement.model.ListDeviceResourcesRequest)operation.default ListDevicesResponselistDevices(Consumer<ListDevicesRequest.Builder> 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.default ListDevicesResponselistDevices(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.default ListDevicesIterablelistDevicesPaginator(Consumer<ListDevicesRequest.Builder> listDevicesRequest)This is a variant oflistDevices(software.amazon.awssdk.services.snowdevicemanagement.model.ListDevicesRequest)operation.default ListDevicesIterablelistDevicesPaginator(ListDevicesRequest listDevicesRequest)This is a variant oflistDevices(software.amazon.awssdk.services.snowdevicemanagement.model.ListDevicesRequest)operation.default ListExecutionsResponselistExecutions(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)Returns the status of tasks for one or more target devices.default ListExecutionsResponselistExecutions(ListExecutionsRequest listExecutionsRequest)Returns the status of tasks for one or more target devices.default ListExecutionsIterablelistExecutionsPaginator(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)This is a variant oflistExecutions(software.amazon.awssdk.services.snowdevicemanagement.model.ListExecutionsRequest)operation.default ListExecutionsIterablelistExecutionsPaginator(ListExecutionsRequest listExecutionsRequest)This is a variant oflistExecutions(software.amazon.awssdk.services.snowdevicemanagement.model.ListExecutionsRequest)operation.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)Returns a list of tags for a managed device or task.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)Returns a list of tags for a managed device or task.default ListTasksResponselistTasks(Consumer<ListTasksRequest.Builder> listTasksRequest)Returns a list of tasks that can be filtered by state.default ListTasksResponselistTasks(ListTasksRequest listTasksRequest)Returns a list of tasks that can be filtered by state.default ListTasksIterablelistTasksPaginator(Consumer<ListTasksRequest.Builder> listTasksRequest)This is a variant oflistTasks(software.amazon.awssdk.services.snowdevicemanagement.model.ListTasksRequest)operation.default ListTasksIterablelistTasksPaginator(ListTasksRequest listTasksRequest)This is a variant oflistTasks(software.amazon.awssdk.services.snowdevicemanagement.model.ListTasksRequest)operation.default SnowDeviceManagementServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)Adds or replaces tags on a device or task.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest)Adds or replaces tags on a device or task.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)Removes a tag from a device or task.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest)Removes a tag from a device or task.-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
cancelTask
default CancelTaskResponse cancelTask(CancelTaskRequest cancelTaskRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, SnowDeviceManagementException
Sends a cancel request for a specified task. You can cancel a task only if it's still in a
QUEUEDstate. Tasks that are already running can't be cancelled.A task might still run if it's processed from the queue before the
CancelTaskoperation 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowDeviceManagementException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
cancelTask
default CancelTaskResponse cancelTask(Consumer<CancelTaskRequest.Builder> cancelTaskRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, SnowDeviceManagementException
Sends a cancel request for a specified task. You can cancel a task only if it's still in a
QUEUEDstate. Tasks that are already running can't be cancelled.A task might still run if it's processed from the queue before the
CancelTaskoperation changes the task's state.
This is a convenience which creates an instance of the
CancelTaskRequest.Builderavoiding the need to create one manually viaCancelTaskRequest.builder()- Parameters:
cancelTaskRequest- AConsumerthat will call methods onCancelTaskRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowDeviceManagementException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createTask
default CreateTaskResponse createTask(CreateTaskRequest createTaskRequest) throws ServiceQuotaExceededException, ThrottlingException, InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, SnowDeviceManagementException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowDeviceManagementException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createTask
default CreateTaskResponse createTask(Consumer<CreateTaskRequest.Builder> createTaskRequest) throws ServiceQuotaExceededException, ThrottlingException, InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, SnowDeviceManagementException
Instructs one or more devices to start a task, such as unlocking or rebooting.
This is a convenience which creates an instance of the
CreateTaskRequest.Builderavoiding the need to create one manually viaCreateTaskRequest.builder()- Parameters:
createTaskRequest- AConsumerthat will call methods onCreateTaskRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowDeviceManagementException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDevice
default DescribeDeviceResponse describeDevice(DescribeDeviceRequest describeDeviceRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, SnowDeviceManagementException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowDeviceManagementException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDevice
default DescribeDeviceResponse describeDevice(Consumer<DescribeDeviceRequest.Builder> describeDeviceRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, SnowDeviceManagementException
Checks device-specific information, such as the device type, software version, IP addresses, and lock status.
This is a convenience which creates an instance of the
DescribeDeviceRequest.Builderavoiding the need to create one manually viaDescribeDeviceRequest.builder()- Parameters:
describeDeviceRequest- AConsumerthat will call methods onDescribeDeviceRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowDeviceManagementException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDeviceEc2Instances
default DescribeDeviceEc2InstancesResponse describeDeviceEc2Instances(DescribeDeviceEc2InstancesRequest describeDeviceEc2InstancesRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, SnowDeviceManagementException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowDeviceManagementException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDeviceEc2Instances
default DescribeDeviceEc2InstancesResponse describeDeviceEc2Instances(Consumer<DescribeDeviceEc2InstancesRequest.Builder> describeDeviceEc2InstancesRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, SnowDeviceManagementException
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.
This is a convenience which creates an instance of the
DescribeDeviceEc2InstancesRequest.Builderavoiding the need to create one manually viaDescribeDeviceEc2InstancesRequest.builder()- Parameters:
describeDeviceEc2InstancesRequest- AConsumerthat will call methods onDescribeDeviceEc2InstancesRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowDeviceManagementException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeExecution
default DescribeExecutionResponse describeExecution(DescribeExecutionRequest describeExecutionRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, SnowDeviceManagementException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowDeviceManagementException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeExecution
default DescribeExecutionResponse describeExecution(Consumer<DescribeExecutionRequest.Builder> describeExecutionRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, SnowDeviceManagementException
Checks the status of a remote task running on one or more target devices.
This is a convenience which creates an instance of the
DescribeExecutionRequest.Builderavoiding the need to create one manually viaDescribeExecutionRequest.builder()- Parameters:
describeExecutionRequest- AConsumerthat will call methods onDescribeExecutionRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowDeviceManagementException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeTask
default DescribeTaskResponse describeTask(DescribeTaskRequest describeTaskRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, SnowDeviceManagementException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowDeviceManagementException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeTask
default DescribeTaskResponse describeTask(Consumer<DescribeTaskRequest.Builder> describeTaskRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, SnowDeviceManagementException
Checks the metadata for a given task on a device.
This is a convenience which creates an instance of the
DescribeTaskRequest.Builderavoiding the need to create one manually viaDescribeTaskRequest.builder()- Parameters:
describeTaskRequest- AConsumerthat will call methods onDescribeTaskRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowDeviceManagementException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listDeviceResources
default ListDeviceResourcesResponse listDeviceResources(ListDeviceResourcesRequest listDeviceResourcesRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, SnowDeviceManagementException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowDeviceManagementException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listDeviceResources
default ListDeviceResourcesResponse listDeviceResources(Consumer<ListDeviceResourcesRequest.Builder> listDeviceResourcesRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, SnowDeviceManagementException
Returns a list of the Amazon Web Services resources available for a device. Currently, Amazon EC2 instances are the only supported resource type.
This is a convenience which creates an instance of the
ListDeviceResourcesRequest.Builderavoiding the need to create one manually viaListDeviceResourcesRequest.builder()- Parameters:
listDeviceResourcesRequest- AConsumerthat will call methods onListDeviceResourcesRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowDeviceManagementException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listDeviceResourcesPaginator
default ListDeviceResourcesIterable listDeviceResourcesPaginator(ListDeviceResourcesRequest listDeviceResourcesRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, SnowDeviceManagementException
This is a variant of
listDeviceResources(software.amazon.awssdk.services.snowdevicemanagement.model.ListDeviceResourcesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.snowdevicemanagement.paginators.ListDeviceResourcesIterable responses = client.listDeviceResourcesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.snowdevicemanagement.paginators.ListDeviceResourcesIterable responses = client .listDeviceResourcesPaginator(request); for (software.amazon.awssdk.services.snowdevicemanagement.model.ListDeviceResourcesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.snowdevicemanagement.paginators.ListDeviceResourcesIterable responses = client.listDeviceResourcesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDeviceResources(software.amazon.awssdk.services.snowdevicemanagement.model.ListDeviceResourcesRequest)operation.- Parameters:
listDeviceResourcesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowDeviceManagementException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listDeviceResourcesPaginator
default ListDeviceResourcesIterable listDeviceResourcesPaginator(Consumer<ListDeviceResourcesRequest.Builder> listDeviceResourcesRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, SnowDeviceManagementException
This is a variant of
listDeviceResources(software.amazon.awssdk.services.snowdevicemanagement.model.ListDeviceResourcesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.snowdevicemanagement.paginators.ListDeviceResourcesIterable responses = client.listDeviceResourcesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.snowdevicemanagement.paginators.ListDeviceResourcesIterable responses = client .listDeviceResourcesPaginator(request); for (software.amazon.awssdk.services.snowdevicemanagement.model.ListDeviceResourcesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.snowdevicemanagement.paginators.ListDeviceResourcesIterable responses = client.listDeviceResourcesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDeviceResources(software.amazon.awssdk.services.snowdevicemanagement.model.ListDeviceResourcesRequest)operation.
This is a convenience which creates an instance of the
ListDeviceResourcesRequest.Builderavoiding the need to create one manually viaListDeviceResourcesRequest.builder()- Parameters:
listDeviceResourcesRequest- AConsumerthat will call methods onListDeviceResourcesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowDeviceManagementException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listDevices
default ListDevicesResponse listDevices(ListDevicesRequest listDevicesRequest) throws ThrottlingException, InternalServerException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, SnowDeviceManagementException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowDeviceManagementException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listDevices
default ListDevicesResponse listDevices(Consumer<ListDevicesRequest.Builder> listDevicesRequest) throws ThrottlingException, InternalServerException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, SnowDeviceManagementException
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.
This is a convenience which creates an instance of the
ListDevicesRequest.Builderavoiding the need to create one manually viaListDevicesRequest.builder()- Parameters:
listDevicesRequest- AConsumerthat will call methods onListDevicesRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowDeviceManagementException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listDevicesPaginator
default ListDevicesIterable listDevicesPaginator(ListDevicesRequest listDevicesRequest) throws ThrottlingException, InternalServerException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, SnowDeviceManagementException
This is a variant of
listDevices(software.amazon.awssdk.services.snowdevicemanagement.model.ListDevicesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.snowdevicemanagement.paginators.ListDevicesIterable responses = client.listDevicesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.snowdevicemanagement.paginators.ListDevicesIterable responses = client .listDevicesPaginator(request); for (software.amazon.awssdk.services.snowdevicemanagement.model.ListDevicesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.snowdevicemanagement.paginators.ListDevicesIterable responses = client.listDevicesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDevices(software.amazon.awssdk.services.snowdevicemanagement.model.ListDevicesRequest)operation.- Parameters:
listDevicesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowDeviceManagementException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listDevicesPaginator
default ListDevicesIterable listDevicesPaginator(Consumer<ListDevicesRequest.Builder> listDevicesRequest) throws ThrottlingException, InternalServerException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, SnowDeviceManagementException
This is a variant of
listDevices(software.amazon.awssdk.services.snowdevicemanagement.model.ListDevicesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.snowdevicemanagement.paginators.ListDevicesIterable responses = client.listDevicesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.snowdevicemanagement.paginators.ListDevicesIterable responses = client .listDevicesPaginator(request); for (software.amazon.awssdk.services.snowdevicemanagement.model.ListDevicesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.snowdevicemanagement.paginators.ListDevicesIterable responses = client.listDevicesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDevices(software.amazon.awssdk.services.snowdevicemanagement.model.ListDevicesRequest)operation.
This is a convenience which creates an instance of the
ListDevicesRequest.Builderavoiding the need to create one manually viaListDevicesRequest.builder()- Parameters:
listDevicesRequest- AConsumerthat will call methods onListDevicesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowDeviceManagementException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listExecutions
default ListExecutionsResponse listExecutions(ListExecutionsRequest listExecutionsRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, SnowDeviceManagementException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowDeviceManagementException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listExecutions
default ListExecutionsResponse listExecutions(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, SnowDeviceManagementException
Returns the status of tasks for one or more target devices.
This is a convenience which creates an instance of the
ListExecutionsRequest.Builderavoiding the need to create one manually viaListExecutionsRequest.builder()- Parameters:
listExecutionsRequest- AConsumerthat will call methods onListExecutionsRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowDeviceManagementException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listExecutionsPaginator
default ListExecutionsIterable listExecutionsPaginator(ListExecutionsRequest listExecutionsRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, SnowDeviceManagementException
This is a variant of
listExecutions(software.amazon.awssdk.services.snowdevicemanagement.model.ListExecutionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.snowdevicemanagement.paginators.ListExecutionsIterable responses = client.listExecutionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.snowdevicemanagement.paginators.ListExecutionsIterable responses = client .listExecutionsPaginator(request); for (software.amazon.awssdk.services.snowdevicemanagement.model.ListExecutionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.snowdevicemanagement.paginators.ListExecutionsIterable responses = client.listExecutionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExecutions(software.amazon.awssdk.services.snowdevicemanagement.model.ListExecutionsRequest)operation.- Parameters:
listExecutionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowDeviceManagementException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listExecutionsPaginator
default ListExecutionsIterable listExecutionsPaginator(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, SnowDeviceManagementException
This is a variant of
listExecutions(software.amazon.awssdk.services.snowdevicemanagement.model.ListExecutionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.snowdevicemanagement.paginators.ListExecutionsIterable responses = client.listExecutionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.snowdevicemanagement.paginators.ListExecutionsIterable responses = client .listExecutionsPaginator(request); for (software.amazon.awssdk.services.snowdevicemanagement.model.ListExecutionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.snowdevicemanagement.paginators.ListExecutionsIterable responses = client.listExecutionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExecutions(software.amazon.awssdk.services.snowdevicemanagement.model.ListExecutionsRequest)operation.
This is a convenience which creates an instance of the
ListExecutionsRequest.Builderavoiding the need to create one manually viaListExecutionsRequest.builder()- Parameters:
listExecutionsRequest- AConsumerthat will call methods onListExecutionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowDeviceManagementException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, SnowDeviceManagementException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowDeviceManagementException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, SnowDeviceManagementException
Returns a list of tags for a managed device or task.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowDeviceManagementException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTasks
default ListTasksResponse listTasks(ListTasksRequest listTasksRequest) throws ThrottlingException, InternalServerException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, SnowDeviceManagementException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowDeviceManagementException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTasks
default ListTasksResponse listTasks(Consumer<ListTasksRequest.Builder> listTasksRequest) throws ThrottlingException, InternalServerException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, SnowDeviceManagementException
Returns a list of tasks that can be filtered by state.
This is a convenience which creates an instance of the
ListTasksRequest.Builderavoiding the need to create one manually viaListTasksRequest.builder()- Parameters:
listTasksRequest- AConsumerthat will call methods onListTasksRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowDeviceManagementException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTasksPaginator
default ListTasksIterable listTasksPaginator(ListTasksRequest listTasksRequest) throws ThrottlingException, InternalServerException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, SnowDeviceManagementException
This is a variant of
listTasks(software.amazon.awssdk.services.snowdevicemanagement.model.ListTasksRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.snowdevicemanagement.paginators.ListTasksIterable responses = client.listTasksPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.snowdevicemanagement.paginators.ListTasksIterable responses = client .listTasksPaginator(request); for (software.amazon.awssdk.services.snowdevicemanagement.model.ListTasksResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.snowdevicemanagement.paginators.ListTasksIterable responses = client.listTasksPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTasks(software.amazon.awssdk.services.snowdevicemanagement.model.ListTasksRequest)operation.- Parameters:
listTasksRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowDeviceManagementException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTasksPaginator
default ListTasksIterable listTasksPaginator(Consumer<ListTasksRequest.Builder> listTasksRequest) throws ThrottlingException, InternalServerException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, SnowDeviceManagementException
This is a variant of
listTasks(software.amazon.awssdk.services.snowdevicemanagement.model.ListTasksRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.snowdevicemanagement.paginators.ListTasksIterable responses = client.listTasksPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.snowdevicemanagement.paginators.ListTasksIterable responses = client .listTasksPaginator(request); for (software.amazon.awssdk.services.snowdevicemanagement.model.ListTasksResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.snowdevicemanagement.paginators.ListTasksIterable responses = client.listTasksPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTasks(software.amazon.awssdk.services.snowdevicemanagement.model.ListTasksRequest)operation.
This is a convenience which creates an instance of the
ListTasksRequest.Builderavoiding the need to create one manually viaListTasksRequest.builder()- Parameters:
listTasksRequest- AConsumerthat will call methods onListTasksRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowDeviceManagementException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, SnowDeviceManagementException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowDeviceManagementException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, SnowDeviceManagementException
Adds or replaces tags on a device or task.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowDeviceManagementException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, SnowDeviceManagementException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowDeviceManagementException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, SnowDeviceManagementException
Removes a tag from a device or task.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowDeviceManagementException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
create
static SnowDeviceManagementClient create()
Create aSnowDeviceManagementClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static SnowDeviceManagementClientBuilder builder()
Create a builder that can be used to configure and create aSnowDeviceManagementClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default SnowDeviceManagementServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-