Interface SnowDeviceManagementClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Amazon Web Services Snow Device Management documentation.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aSnowDeviceManagementClient
.default CancelTaskResponse
cancelTask
(Consumer<CancelTaskRequest.Builder> cancelTaskRequest) Sends a cancel request for a specified task.default CancelTaskResponse
cancelTask
(CancelTaskRequest cancelTaskRequest) Sends a cancel request for a specified task.static SnowDeviceManagementClient
create()
Create aSnowDeviceManagementClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.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.describeDeviceEc2Instances
(Consumer<DescribeDeviceEc2InstancesRequest.Builder> describeDeviceEc2InstancesRequest) Checks the current state of the Amazon EC2 instances.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) This is a variant oflistDeviceResources(software.amazon.awssdk.services.snowdevicemanagement.model.ListDeviceResourcesRequest)
operation.default ListDeviceResourcesIterable
listDeviceResourcesPaginator
(ListDeviceResourcesRequest listDeviceResourcesRequest) This is a variant oflistDeviceResources(software.amazon.awssdk.services.snowdevicemanagement.model.ListDeviceResourcesRequest)
operation.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) This is a variant oflistDevices(software.amazon.awssdk.services.snowdevicemanagement.model.ListDevicesRequest)
operation.default ListDevicesIterable
listDevicesPaginator
(ListDevicesRequest listDevicesRequest) This is a variant oflistDevices(software.amazon.awssdk.services.snowdevicemanagement.model.ListDevicesRequest)
operation.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) This is a variant oflistExecutions(software.amazon.awssdk.services.snowdevicemanagement.model.ListExecutionsRequest)
operation.default ListExecutionsIterable
listExecutionsPaginator
(ListExecutionsRequest listExecutionsRequest) This is a variant oflistExecutions(software.amazon.awssdk.services.snowdevicemanagement.model.ListExecutionsRequest)
operation.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) This is a variant oflistTasks(software.amazon.awssdk.services.snowdevicemanagement.model.ListTasksRequest)
operation.default ListTasksIterable
listTasksPaginator
(ListTasksRequest listTasksRequest) This is a variant oflistTasks(software.amazon.awssdk.services.snowdevicemanagement.model.ListTasksRequest)
operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic 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.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
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
QUEUED
state. Tasks that are already running can't be cancelled.A task might still run if it's processed from the queue before the
CancelTask
operation changes the task's state.- Parameters:
cancelTaskRequest
-- Returns:
- Result of the CancelTask operation returned by the service.
- See Also:
-
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
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 viaCancelTaskRequest.builder()
- Parameters:
cancelTaskRequest
- AConsumer
that will call methods onCancelTaskRequest.Builder
to create a request.- Returns:
- Result of the CancelTask operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaCreateTaskRequest.builder()
- Parameters:
createTaskRequest
- AConsumer
that will call methods onCreateTaskRequest.Builder
to create a request.- Returns:
- Result of the CreateTask operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaDescribeDeviceRequest.builder()
- Parameters:
describeDeviceRequest
- AConsumer
that will call methods onDescribeDeviceRequest.Builder
to create a request.- Returns:
- Result of the DescribeDevice operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaDescribeDeviceEc2InstancesRequest.builder()
- Parameters:
describeDeviceEc2InstancesRequest
- AConsumer
that will call methods onDescribeDeviceEc2InstancesRequest.Builder
to create a request.- Returns:
- Result of the DescribeDeviceEc2Instances operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaDescribeExecutionRequest.builder()
- Parameters:
describeExecutionRequest
- AConsumer
that will call methods onDescribeExecutionRequest.Builder
to create a request.- Returns:
- Result of the DescribeExecution operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaDescribeTaskRequest.builder()
- Parameters:
describeTaskRequest
- AConsumer
that will call methods onDescribeTaskRequest.Builder
to create a request.- Returns:
- Result of the DescribeTask operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaListDeviceResourcesRequest.builder()
- Parameters:
listDeviceResourcesRequest
- AConsumer
that will call methods onListDeviceResourcesRequest.Builder
to create a request.- Returns:
- Result of the ListDeviceResources operation returned by the service.
- See Also:
-
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 Streamsoftware.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.
- See Also:
-
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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListDeviceResourcesRequest.builder()
- Parameters:
listDeviceResourcesRequest
- AConsumer
that will call methods onListDeviceResourcesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaListDevicesRequest.builder()
- Parameters:
listDevicesRequest
- AConsumer
that will call methods onListDevicesRequest.Builder
to create a request.- Returns:
- Result of the ListDevices operation returned by the service.
- See Also:
-
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 Streamsoftware.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.
- See Also:
-
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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListDevicesRequest.builder()
- Parameters:
listDevicesRequest
- AConsumer
that will call methods onListDevicesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaListExecutionsRequest.builder()
- Parameters:
listExecutionsRequest
- AConsumer
that will call methods onListExecutionsRequest.Builder
to create a request.- Returns:
- Result of the ListExecutions operation returned by the service.
- See Also:
-
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 Streamsoftware.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.
- See Also:
-
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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListExecutionsRequest.builder()
- Parameters:
listExecutionsRequest
- AConsumer
that will call methods onListExecutionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaListTasksRequest.builder()
- Parameters:
listTasksRequest
- AConsumer
that will call methods onListTasksRequest.Builder
to create a request.- Returns:
- Result of the ListTasks operation returned by the service.
- See Also:
-
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 Streamsoftware.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.
- See Also:
-
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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListTasksRequest.builder()
- Parameters:
listTasksRequest
- AConsumer
that will call methods onListTasksRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
create
Create aSnowDeviceManagementClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aSnowDeviceManagementClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-