@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface SnowDeviceManagementClient extends AwsClient
builder()
method.
Amazon Web Services Snow Device Management documentation.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static SnowDeviceManagementClientBuilder |
builder()
Create a builder that can be used to configure and create a
SnowDeviceManagementClient. |
default CancelTaskResponse |
cancelTask(CancelTaskRequest cancelTaskRequest)
Sends a cancel request for a specified task.
|
default CancelTaskResponse |
cancelTask(Consumer<CancelTaskRequest.Builder> cancelTaskRequest)
Sends a cancel request for a specified task.
|
static SnowDeviceManagementClient |
create()
Create a
SnowDeviceManagementClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateTaskResponse |
createTask(Consumer<CreateTaskRequest.Builder> createTaskRequest)
Instructs one or more devices to start a task, such as unlocking or rebooting.
|
default CreateTaskResponse |
createTask(CreateTaskRequest createTaskRequest)
Instructs one or more devices to start a task, such as unlocking or rebooting.
|
default DescribeDeviceResponse |
describeDevice(Consumer<DescribeDeviceRequest.Builder> describeDeviceRequest)
Checks device-specific information, such as the device type, software version, IP addresses, and lock status.
|
default DescribeDeviceResponse |
describeDevice(DescribeDeviceRequest describeDeviceRequest)
Checks device-specific information, such as the device type, software version, IP addresses, and lock status.
|
default DescribeDeviceEc2InstancesResponse |
describeDeviceEc2Instances(Consumer<DescribeDeviceEc2InstancesRequest.Builder> describeDeviceEc2InstancesRequest)
Checks the current state of the Amazon EC2 instances.
|
default DescribeDeviceEc2InstancesResponse |
describeDeviceEc2Instances(DescribeDeviceEc2InstancesRequest describeDeviceEc2InstancesRequest)
Checks the current state of the Amazon EC2 instances.
|
default DescribeExecutionResponse |
describeExecution(Consumer<DescribeExecutionRequest.Builder> describeExecutionRequest)
Checks the status of a remote task running on one or more target devices.
|
default DescribeExecutionResponse |
describeExecution(DescribeExecutionRequest describeExecutionRequest)
Checks the status of a remote task running on one or more target devices.
|
default DescribeTaskResponse |
describeTask(Consumer<DescribeTaskRequest.Builder> describeTaskRequest)
Checks the metadata for a given task on a device.
|
default DescribeTaskResponse |
describeTask(DescribeTaskRequest describeTaskRequest)
Checks the metadata for a given task on a device.
|
default ListDeviceResourcesResponse |
listDeviceResources(Consumer<ListDeviceResourcesRequest.Builder> listDeviceResourcesRequest)
Returns a list of the Amazon Web Services resources available for a device.
|
default ListDeviceResourcesResponse |
listDeviceResources(ListDeviceResourcesRequest listDeviceResourcesRequest)
Returns a list of the Amazon Web Services resources available for a device.
|
default ListDeviceResourcesIterable |
listDeviceResourcesPaginator(Consumer<ListDeviceResourcesRequest.Builder> listDeviceResourcesRequest)
Returns a list of the Amazon Web Services resources available for a device.
|
default ListDeviceResourcesIterable |
listDeviceResourcesPaginator(ListDeviceResourcesRequest listDeviceResourcesRequest)
Returns a list of the Amazon Web Services resources available for a device.
|
default ListDevicesResponse |
listDevices(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 ListDevicesResponse |
listDevices(ListDevicesRequest listDevicesRequest)
Returns a list of all devices on your Amazon Web Services account that have Amazon Web Services Snow Device
Management enabled in the Amazon Web Services Region where the command is run.
|
default ListDevicesIterable |
listDevicesPaginator(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 ListDevicesIterable |
listDevicesPaginator(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 ListExecutionsResponse |
listExecutions(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)
Returns the status of tasks for one or more target devices.
|
default ListExecutionsResponse |
listExecutions(ListExecutionsRequest listExecutionsRequest)
Returns the status of tasks for one or more target devices.
|
default ListExecutionsIterable |
listExecutionsPaginator(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)
Returns the status of tasks for one or more target devices.
|
default ListExecutionsIterable |
listExecutionsPaginator(ListExecutionsRequest listExecutionsRequest)
Returns the status of tasks for one or more target devices.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns a list of tags for a managed device or task.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of tags for a managed device or task.
|
default ListTasksResponse |
listTasks(Consumer<ListTasksRequest.Builder> listTasksRequest)
Returns a list of tasks that can be filtered by state.
|
default ListTasksResponse |
listTasks(ListTasksRequest listTasksRequest)
Returns a list of tasks that can be filtered by state.
|
default ListTasksIterable |
listTasksPaginator(Consumer<ListTasksRequest.Builder> listTasksRequest)
Returns a list of tasks that can be filtered by state.
|
default ListTasksIterable |
listTasksPaginator(ListTasksRequest listTasksRequest)
Returns a list of tasks that can be filtered by state.
|
default SnowDeviceManagementServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
serviceMetadata() |
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds or replaces tags on a device or task.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Adds or replaces tags on a device or task.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes a tag from a device or task.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from a device or task.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.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 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.
cancelTaskRequest - 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.AwsServiceExceptiondefault 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 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.
This is a convenience which creates an instance of the CancelTaskRequest.Builder avoiding the need to
create one manually via CancelTaskRequest.builder()
cancelTaskRequest - A Consumer that will call methods on CancelTaskInput.Builder to create a request.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.AwsServiceExceptiondefault 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.
createTaskRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via CreateTaskRequest.builder()
createTaskRequest - A Consumer that will call methods on CreateTaskInput.Builder to create a request.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.AwsServiceExceptiondefault 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.
describeDeviceRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via DescribeDeviceRequest.builder()
describeDeviceRequest - A Consumer that will call methods on DescribeDeviceInput.Builder to create a request.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.AwsServiceExceptiondefault 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.
describeDeviceEc2InstancesRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via DescribeDeviceEc2InstancesRequest.builder()
describeDeviceEc2InstancesRequest - A Consumer that will call methods on DescribeDeviceEc2Input.Builder to create a request.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.AwsServiceExceptiondefault 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.
describeExecutionRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via DescribeExecutionRequest.builder()
describeExecutionRequest - A Consumer that will call methods on DescribeExecutionInput.Builder to create a request.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.AwsServiceExceptiondefault DescribeTaskResponse describeTask(DescribeTaskRequest describeTaskRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, SnowDeviceManagementException
Checks the metadata for a given task on a device.
describeTaskRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via DescribeTaskRequest.builder()
describeTaskRequest - A Consumer that will call methods on DescribeTaskInput.Builder to create a request.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.AwsServiceExceptiondefault 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.
listDeviceResourcesRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via ListDeviceResourcesRequest.builder()
listDeviceResourcesRequest - A Consumer that will call methods on ListDeviceResourcesInput.Builder to create a request.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.AwsServiceExceptiondefault ListDeviceResourcesIterable listDeviceResourcesPaginator(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.
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
software.amazon.awssdk.services.snowdevicemanagement.paginators.ListDeviceResourcesIterable responses = client.listDeviceResourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listDeviceResourcesRequest - 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.AwsServiceExceptiondefault ListDeviceResourcesIterable listDeviceResourcesPaginator(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 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
software.amazon.awssdk.services.snowdevicemanagement.paginators.ListDeviceResourcesIterable responses = client.listDeviceResourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the
need to create one manually via ListDeviceResourcesRequest.builder()
listDeviceResourcesRequest - A Consumer that will call methods on ListDeviceResourcesInput.Builder to create a request.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.AwsServiceExceptiondefault 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.
listDevicesRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via ListDevicesRequest.builder()
listDevicesRequest - A Consumer that will call methods on ListDevicesInput.Builder to create a request.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.AwsServiceExceptiondefault ListDevicesIterable listDevicesPaginator(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.
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
software.amazon.awssdk.services.snowdevicemanagement.paginators.ListDevicesIterable responses = client.listDevicesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listDevicesRequest - 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.AwsServiceExceptiondefault ListDevicesIterable listDevicesPaginator(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 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
software.amazon.awssdk.services.snowdevicemanagement.paginators.ListDevicesIterable responses = client.listDevicesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the need to
create one manually via ListDevicesRequest.builder()
listDevicesRequest - A Consumer that will call methods on ListDevicesInput.Builder to create a request.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.AwsServiceExceptiondefault ListExecutionsResponse listExecutions(ListExecutionsRequest listExecutionsRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, SnowDeviceManagementException
Returns the status of tasks for one or more target devices.
listExecutionsRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via ListExecutionsRequest.builder()
listExecutionsRequest - A Consumer that will call methods on ListExecutionsInput.Builder to create a request.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.AwsServiceExceptiondefault ListExecutionsIterable listExecutionsPaginator(ListExecutionsRequest listExecutionsRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, SnowDeviceManagementException
Returns the status of tasks for one or more target devices.
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
software.amazon.awssdk.services.snowdevicemanagement.paginators.ListExecutionsIterable responses = client.listExecutionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listExecutionsRequest - 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.AwsServiceExceptiondefault ListExecutionsIterable listExecutionsPaginator(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 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
software.amazon.awssdk.services.snowdevicemanagement.paginators.ListExecutionsIterable responses = client.listExecutionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the need to
create one manually via ListExecutionsRequest.builder()
listExecutionsRequest - A Consumer that will call methods on ListExecutionsInput.Builder to create a request.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.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, SnowDeviceManagementException
Returns a list of tags for a managed device or task.
listTagsForResourceRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceInput.Builder to create a request.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.AwsServiceExceptiondefault ListTasksResponse listTasks(ListTasksRequest listTasksRequest) throws ThrottlingException, InternalServerException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, SnowDeviceManagementException
Returns a list of tasks that can be filtered by state.
listTasksRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via ListTasksRequest.builder()
listTasksRequest - A Consumer that will call methods on ListTasksInput.Builder to create a request.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.AwsServiceExceptiondefault ListTasksIterable listTasksPaginator(ListTasksRequest listTasksRequest) throws ThrottlingException, InternalServerException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, SnowDeviceManagementException
Returns a list of tasks that can be filtered by state.
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
software.amazon.awssdk.services.snowdevicemanagement.paginators.ListTasksIterable responses = client.listTasksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listTasksRequest - 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.AwsServiceExceptiondefault ListTasksIterable listTasksPaginator(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 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
software.amazon.awssdk.services.snowdevicemanagement.paginators.ListTasksIterable responses = client.listTasksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the need to
create one manually via ListTasksRequest.builder()
listTasksRequest - A Consumer that will call methods on ListTasksInput.Builder to create a request.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.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, SnowDeviceManagementException
Adds or replaces tags on a device or task.
tagResourceRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceInput.Builder to create a request.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.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, SnowDeviceManagementException
Removes a tag from a device or task.
untagResourceRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceInput.Builder to create a request.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.AwsServiceExceptionstatic SnowDeviceManagementClient create()
SnowDeviceManagementClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static SnowDeviceManagementClientBuilder builder()
SnowDeviceManagementClient.static ServiceMetadata serviceMetadata()
default SnowDeviceManagementServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.