Package software.amazon.awssdk.services.snowball

Interface SnowballAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface SnowballAsyncClient extends AwsClient
Service client for accessing Amazon Snowball asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

The Amazon Web Services Snow Family provides a petabyte-scale data transport solution that uses secure devices to transfer large amounts of data between your on-premises data centers and Amazon Simple Storage Service (Amazon S3). The Snow Family commands described here provide access to the same functionality that is available in the Amazon Web Services Snow Family Management Console, which enables you to create and manage jobs for a Snow Family device. To transfer data locally with a Snow Family device, you'll need to use the Snowball Edge client or the Amazon S3 API Interface for Snowball or OpsHub for Snow Family. For more information, see the User Guide.

  • Field Details

  • Method Details

    • cancelCluster

      default CompletableFuture<CancelClusterResponse> cancelCluster(CancelClusterRequest cancelClusterRequest)

      Cancels a cluster job. You can only cancel a cluster job while it's in the AwaitingQuorum status. You'll have at least an hour after creating a cluster job to cancel it.

      Parameters:
      cancelClusterRequest -
      Returns:
      A Java Future containing the result of the CancelCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • KmsRequestFailedException The provided Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.
      • InvalidJobStateException The action can't be performed because the job's current state doesn't allow that action to be performed.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelCluster

      default CompletableFuture<CancelClusterResponse> cancelCluster(Consumer<CancelClusterRequest.Builder> cancelClusterRequest)

      Cancels a cluster job. You can only cancel a cluster job while it's in the AwaitingQuorum status. You'll have at least an hour after creating a cluster job to cancel it.


      This is a convenience which creates an instance of the CancelClusterRequest.Builder avoiding the need to create one manually via CancelClusterRequest.builder()

      Parameters:
      cancelClusterRequest - A Consumer that will call methods on CancelClusterRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CancelCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • KmsRequestFailedException The provided Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.
      • InvalidJobStateException The action can't be performed because the job's current state doesn't allow that action to be performed.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelJob

      default CompletableFuture<CancelJobResponse> cancelJob(CancelJobRequest cancelJobRequest)

      Cancels the specified job. You can only cancel a job before its JobState value changes to PreparingAppliance. Requesting the ListJobs or DescribeJob action returns a job's JobState as part of the response element data returned.

      Parameters:
      cancelJobRequest -
      Returns:
      A Java Future containing the result of the CancelJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • InvalidJobStateException The action can't be performed because the job's current state doesn't allow that action to be performed.
      • KmsRequestFailedException The provided Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelJob

      default CompletableFuture<CancelJobResponse> cancelJob(Consumer<CancelJobRequest.Builder> cancelJobRequest)

      Cancels the specified job. You can only cancel a job before its JobState value changes to PreparingAppliance. Requesting the ListJobs or DescribeJob action returns a job's JobState as part of the response element data returned.


      This is a convenience which creates an instance of the CancelJobRequest.Builder avoiding the need to create one manually via CancelJobRequest.builder()

      Parameters:
      cancelJobRequest - A Consumer that will call methods on CancelJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CancelJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • InvalidJobStateException The action can't be performed because the job's current state doesn't allow that action to be performed.
      • KmsRequestFailedException The provided Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAddress

      default CompletableFuture<CreateAddressResponse> createAddress(CreateAddressRequest createAddressRequest)

      Creates an address for a Snow device to be shipped to. In most regions, addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. If the address is invalid or unsupported, then an exception is thrown. If providing an address as a JSON file through the cli-input-json option, include the full file path. For example, --cli-input-json file://create-address.json.

      Parameters:
      createAddressRequest -
      Returns:
      A Java Future containing the result of the CreateAddress operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidAddressException The address provided was invalid. Check the address with your region's carrier, and try again.
      • UnsupportedAddressException The address is either outside the serviceable area for your region, or an error occurred. Check the address with your region's carrier and try again. If the issue persists, contact Amazon Web Services Support.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAddress

      default CompletableFuture<CreateAddressResponse> createAddress(Consumer<CreateAddressRequest.Builder> createAddressRequest)

      Creates an address for a Snow device to be shipped to. In most regions, addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. If the address is invalid or unsupported, then an exception is thrown. If providing an address as a JSON file through the cli-input-json option, include the full file path. For example, --cli-input-json file://create-address.json.


      This is a convenience which creates an instance of the CreateAddressRequest.Builder avoiding the need to create one manually via CreateAddressRequest.builder()

      Parameters:
      createAddressRequest - A Consumer that will call methods on CreateAddressRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAddress operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidAddressException The address provided was invalid. Check the address with your region's carrier, and try again.
      • UnsupportedAddressException The address is either outside the serviceable area for your region, or an error occurred. Check the address with your region's carrier and try again. If the issue persists, contact Amazon Web Services Support.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createCluster

      default CompletableFuture<CreateClusterResponse> createCluster(CreateClusterRequest createClusterRequest)

      Creates an empty cluster. Each cluster supports five nodes. You use the CreateJob action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created.

      Parameters:
      createClusterRequest -
      Returns:
      A Java Future containing the result of the CreateCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • KmsRequestFailedException The provided Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.
      • InvalidInputCombinationException Job or cluster creation failed. One or more inputs were invalid. Confirm that the CreateClusterRequestinvalid input: '&#36'SnowballType value supports your CreateJobRequestinvalid input: '&#36'JobType, and try again.
      • Ec2RequestFailedException Your user lacks the necessary Amazon EC2 permissions to perform the attempted 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createCluster

      default CompletableFuture<CreateClusterResponse> createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)

      Creates an empty cluster. Each cluster supports five nodes. You use the CreateJob action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created.


      This is a convenience which creates an instance of the CreateClusterRequest.Builder avoiding the need to create one manually via CreateClusterRequest.builder()

      Parameters:
      createClusterRequest - A Consumer that will call methods on CreateClusterRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • KmsRequestFailedException The provided Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.
      • InvalidInputCombinationException Job or cluster creation failed. One or more inputs were invalid. Confirm that the CreateClusterRequestinvalid input: '&#36'SnowballType value supports your CreateJobRequestinvalid input: '&#36'JobType, and try again.
      • Ec2RequestFailedException Your user lacks the necessary Amazon EC2 permissions to perform the attempted 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createJob

      default CompletableFuture<CreateJobResponse> createJob(CreateJobRequest createJobRequest)

      Creates a job to import or export data between Amazon S3 and your on-premises data center. Your Amazon Web Services account must have the right trust policies and permissions in place to create a job for a Snow device. If you're creating a job for a node in a cluster, you only need to provide the clusterId value; the other job attributes are inherited from the cluster.

      Only the Snowball; Edge device type is supported when ordering clustered jobs.

      The device capacity is optional.

      Availability of device types differ by Amazon Web Services Region. For more information about Region availability, see Amazon Web Services Regional Services.

      Snow Family devices and their capacities.

      • Device type: SNC1_SSD

        • Capacity: T14

        • Description: Snowcone

      • Device type: SNC1_HDD

        • Capacity: T8

        • Description: Snowcone

      • Device type: EDGE_S

        • Capacity: T98

        • Description: Snowball Edge Storage Optimized for data transfer only

      • Device type: EDGE_CG

        • Capacity: T42

        • Description: Snowball Edge Compute Optimized with GPU

      • Device type: EDGE_C

        • Capacity: T42

        • Description: Snowball Edge Compute Optimized without GPU

      • Device type: EDGE

        • Capacity: T100

        • Description: Snowball Edge Storage Optimized with EC2 Compute

        This device is replaced with T98.

      • Device type: STANDARD

        • Capacity: T50

        • Description: Original Snowball device

          This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region

      • Device type: STANDARD

        • Capacity: T80

        • Description: Original Snowball device

          This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region.

      • Snow Family device type: RACK_5U_C

        • Capacity: T13

        • Description: Snowblade.

      • Device type: V3_5S

        • Capacity: T240

        • Description: Snowball Edge Storage Optimized 210TB

      Parameters:
      createJobRequest -
      Returns:
      A Java Future containing the result of the CreateJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • KmsRequestFailedException The provided Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.
      • InvalidInputCombinationException Job or cluster creation failed. One or more inputs were invalid. Confirm that the CreateClusterRequestinvalid input: '&#36'SnowballType value supports your CreateJobRequestinvalid input: '&#36'JobType, and try again.
      • ClusterLimitExceededException Job creation failed. Currently, clusters support five nodes. If you have fewer than five nodes for your cluster and you have more nodes to create for this cluster, try again and create jobs until your cluster has exactly five nodes.
      • Ec2RequestFailedException Your user lacks the necessary Amazon EC2 permissions to perform the attempted 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createJob

      default CompletableFuture<CreateJobResponse> createJob(Consumer<CreateJobRequest.Builder> createJobRequest)

      Creates a job to import or export data between Amazon S3 and your on-premises data center. Your Amazon Web Services account must have the right trust policies and permissions in place to create a job for a Snow device. If you're creating a job for a node in a cluster, you only need to provide the clusterId value; the other job attributes are inherited from the cluster.

      Only the Snowball; Edge device type is supported when ordering clustered jobs.

      The device capacity is optional.

      Availability of device types differ by Amazon Web Services Region. For more information about Region availability, see Amazon Web Services Regional Services.

      Snow Family devices and their capacities.

      • Device type: SNC1_SSD

        • Capacity: T14

        • Description: Snowcone

      • Device type: SNC1_HDD

        • Capacity: T8

        • Description: Snowcone

      • Device type: EDGE_S

        • Capacity: T98

        • Description: Snowball Edge Storage Optimized for data transfer only

      • Device type: EDGE_CG

        • Capacity: T42

        • Description: Snowball Edge Compute Optimized with GPU

      • Device type: EDGE_C

        • Capacity: T42

        • Description: Snowball Edge Compute Optimized without GPU

      • Device type: EDGE

        • Capacity: T100

        • Description: Snowball Edge Storage Optimized with EC2 Compute

        This device is replaced with T98.

      • Device type: STANDARD

        • Capacity: T50

        • Description: Original Snowball device

          This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region

      • Device type: STANDARD

        • Capacity: T80

        • Description: Original Snowball device

          This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region.

      • Snow Family device type: RACK_5U_C

        • Capacity: T13

        • Description: Snowblade.

      • Device type: V3_5S

        • Capacity: T240

        • Description: Snowball Edge Storage Optimized 210TB


      This is a convenience which creates an instance of the CreateJobRequest.Builder avoiding the need to create one manually via CreateJobRequest.builder()

      Parameters:
      createJobRequest - A Consumer that will call methods on CreateJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • KmsRequestFailedException The provided Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.
      • InvalidInputCombinationException Job or cluster creation failed. One or more inputs were invalid. Confirm that the CreateClusterRequestinvalid input: '&#36'SnowballType value supports your CreateJobRequestinvalid input: '&#36'JobType, and try again.
      • ClusterLimitExceededException Job creation failed. Currently, clusters support five nodes. If you have fewer than five nodes for your cluster and you have more nodes to create for this cluster, try again and create jobs until your cluster has exactly five nodes.
      • Ec2RequestFailedException Your user lacks the necessary Amazon EC2 permissions to perform the attempted 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLongTermPricing

      default CompletableFuture<CreateLongTermPricingResponse> createLongTermPricing(CreateLongTermPricingRequest createLongTermPricingRequest)

      Creates a job with the long-term usage option for a device. The long-term usage is a 1-year or 3-year long-term pricing type for the device. You are billed upfront, and Amazon Web Services provides discounts for long-term pricing.

      Parameters:
      createLongTermPricingRequest -
      Returns:
      A Java Future containing the result of the CreateLongTermPricing operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLongTermPricing

      default CompletableFuture<CreateLongTermPricingResponse> createLongTermPricing(Consumer<CreateLongTermPricingRequest.Builder> createLongTermPricingRequest)

      Creates a job with the long-term usage option for a device. The long-term usage is a 1-year or 3-year long-term pricing type for the device. You are billed upfront, and Amazon Web Services provides discounts for long-term pricing.


      This is a convenience which creates an instance of the CreateLongTermPricingRequest.Builder avoiding the need to create one manually via CreateLongTermPricingRequest.builder()

      Parameters:
      createLongTermPricingRequest - A Consumer that will call methods on CreateLongTermPricingRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateLongTermPricing operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createReturnShippingLabel

      default CompletableFuture<CreateReturnShippingLabelResponse> createReturnShippingLabel(CreateReturnShippingLabelRequest createReturnShippingLabelRequest)

      Creates a shipping label that will be used to return the Snow device to Amazon Web Services.

      Parameters:
      createReturnShippingLabelRequest -
      Returns:
      A Java Future containing the result of the CreateReturnShippingLabel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • InvalidJobStateException The action can't be performed because the job's current state doesn't allow that action to be performed.
      • InvalidInputCombinationException Job or cluster creation failed. One or more inputs were invalid. Confirm that the CreateClusterRequestinvalid input: '&#36'SnowballType value supports your CreateJobRequestinvalid input: '&#36'JobType, and try again.
      • ConflictException You get this exception when you call CreateReturnShippingLabel more than once when other requests are not completed.
      • ReturnShippingLabelAlreadyExistsException You get this exception if you call CreateReturnShippingLabel and a valid return shipping label already exists. In this case, use DescribeReturnShippingLabel to get the URL.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createReturnShippingLabel

      default CompletableFuture<CreateReturnShippingLabelResponse> createReturnShippingLabel(Consumer<CreateReturnShippingLabelRequest.Builder> createReturnShippingLabelRequest)

      Creates a shipping label that will be used to return the Snow device to Amazon Web Services.


      This is a convenience which creates an instance of the CreateReturnShippingLabelRequest.Builder avoiding the need to create one manually via CreateReturnShippingLabelRequest.builder()

      Parameters:
      createReturnShippingLabelRequest - A Consumer that will call methods on CreateReturnShippingLabelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateReturnShippingLabel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • InvalidJobStateException The action can't be performed because the job's current state doesn't allow that action to be performed.
      • InvalidInputCombinationException Job or cluster creation failed. One or more inputs were invalid. Confirm that the CreateClusterRequestinvalid input: '&#36'SnowballType value supports your CreateJobRequestinvalid input: '&#36'JobType, and try again.
      • ConflictException You get this exception when you call CreateReturnShippingLabel more than once when other requests are not completed.
      • ReturnShippingLabelAlreadyExistsException You get this exception if you call CreateReturnShippingLabel and a valid return shipping label already exists. In this case, use DescribeReturnShippingLabel to get the URL.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAddress

      default CompletableFuture<DescribeAddressResponse> describeAddress(DescribeAddressRequest describeAddressRequest)

      Takes an AddressId and returns specific details about that address in the form of an Address object.

      Parameters:
      describeAddressRequest -
      Returns:
      A Java Future containing the result of the DescribeAddress operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAddress

      default CompletableFuture<DescribeAddressResponse> describeAddress(Consumer<DescribeAddressRequest.Builder> describeAddressRequest)

      Takes an AddressId and returns specific details about that address in the form of an Address object.


      This is a convenience which creates an instance of the DescribeAddressRequest.Builder avoiding the need to create one manually via DescribeAddressRequest.builder()

      Parameters:
      describeAddressRequest - A Consumer that will call methods on DescribeAddressRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAddress operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAddresses

      default CompletableFuture<DescribeAddressesResponse> describeAddresses(DescribeAddressesRequest describeAddressesRequest)

      Returns a specified number of ADDRESS objects. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions.

      Parameters:
      describeAddressesRequest -
      Returns:
      A Java Future containing the result of the DescribeAddresses operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAddresses

      default CompletableFuture<DescribeAddressesResponse> describeAddresses(Consumer<DescribeAddressesRequest.Builder> describeAddressesRequest)

      Returns a specified number of ADDRESS objects. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions.


      This is a convenience which creates an instance of the DescribeAddressesRequest.Builder avoiding the need to create one manually via DescribeAddressesRequest.builder()

      Parameters:
      describeAddressesRequest - A Consumer that will call methods on DescribeAddressesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAddresses operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAddresses

      default CompletableFuture<DescribeAddressesResponse> describeAddresses()

      Returns a specified number of ADDRESS objects. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions.

      Returns:
      A Java Future containing the result of the DescribeAddresses operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAddressesPaginator

      default DescribeAddressesPublisher describeAddressesPaginator()

      This is a variant of describeAddresses(software.amazon.awssdk.services.snowball.model.DescribeAddressesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.snowball.paginators.DescribeAddressesPublisher publisher = client.describeAddressesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.snowball.paginators.DescribeAddressesPublisher publisher = client.describeAddressesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.snowball.model.DescribeAddressesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.snowball.model.DescribeAddressesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 describeAddresses(software.amazon.awssdk.services.snowball.model.DescribeAddressesRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAddressesPaginator

      default DescribeAddressesPublisher describeAddressesPaginator(DescribeAddressesRequest describeAddressesRequest)

      This is a variant of describeAddresses(software.amazon.awssdk.services.snowball.model.DescribeAddressesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.snowball.paginators.DescribeAddressesPublisher publisher = client.describeAddressesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.snowball.paginators.DescribeAddressesPublisher publisher = client.describeAddressesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.snowball.model.DescribeAddressesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.snowball.model.DescribeAddressesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 describeAddresses(software.amazon.awssdk.services.snowball.model.DescribeAddressesRequest) operation.

      Parameters:
      describeAddressesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAddressesPaginator

      default DescribeAddressesPublisher describeAddressesPaginator(Consumer<DescribeAddressesRequest.Builder> describeAddressesRequest)

      This is a variant of describeAddresses(software.amazon.awssdk.services.snowball.model.DescribeAddressesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.snowball.paginators.DescribeAddressesPublisher publisher = client.describeAddressesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.snowball.paginators.DescribeAddressesPublisher publisher = client.describeAddressesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.snowball.model.DescribeAddressesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.snowball.model.DescribeAddressesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 describeAddresses(software.amazon.awssdk.services.snowball.model.DescribeAddressesRequest) operation.


      This is a convenience which creates an instance of the DescribeAddressesRequest.Builder avoiding the need to create one manually via DescribeAddressesRequest.builder()

      Parameters:
      describeAddressesRequest - A Consumer that will call methods on DescribeAddressesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeCluster

      default CompletableFuture<DescribeClusterResponse> describeCluster(DescribeClusterRequest describeClusterRequest)

      Returns information about a specific cluster including shipping information, cluster status, and other important metadata.

      Parameters:
      describeClusterRequest -
      Returns:
      A Java Future containing the result of the DescribeCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeCluster

      default CompletableFuture<DescribeClusterResponse> describeCluster(Consumer<DescribeClusterRequest.Builder> describeClusterRequest)

      Returns information about a specific cluster including shipping information, cluster status, and other important metadata.


      This is a convenience which creates an instance of the DescribeClusterRequest.Builder avoiding the need to create one manually via DescribeClusterRequest.builder()

      Parameters:
      describeClusterRequest - A Consumer that will call methods on DescribeClusterRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeJob

      default CompletableFuture<DescribeJobResponse> describeJob(DescribeJobRequest describeJobRequest)

      Returns information about a specific job including shipping information, job status, and other important metadata.

      Parameters:
      describeJobRequest -
      Returns:
      A Java Future containing the result of the DescribeJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeJob

      default CompletableFuture<DescribeJobResponse> describeJob(Consumer<DescribeJobRequest.Builder> describeJobRequest)

      Returns information about a specific job including shipping information, job status, and other important metadata.


      This is a convenience which creates an instance of the DescribeJobRequest.Builder avoiding the need to create one manually via DescribeJobRequest.builder()

      Parameters:
      describeJobRequest - A Consumer that will call methods on DescribeJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeReturnShippingLabel

      default CompletableFuture<DescribeReturnShippingLabelResponse> describeReturnShippingLabel(DescribeReturnShippingLabelRequest describeReturnShippingLabelRequest)

      Information on the shipping label of a Snow device that is being returned to Amazon Web Services.

      Parameters:
      describeReturnShippingLabelRequest -
      Returns:
      A Java Future containing the result of the DescribeReturnShippingLabel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • InvalidJobStateException The action can't be performed because the job's current state doesn't allow that action to be performed.
      • ConflictException You get this exception when you call CreateReturnShippingLabel more than once when other requests are not completed.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeReturnShippingLabel

      default CompletableFuture<DescribeReturnShippingLabelResponse> describeReturnShippingLabel(Consumer<DescribeReturnShippingLabelRequest.Builder> describeReturnShippingLabelRequest)

      Information on the shipping label of a Snow device that is being returned to Amazon Web Services.


      This is a convenience which creates an instance of the DescribeReturnShippingLabelRequest.Builder avoiding the need to create one manually via DescribeReturnShippingLabelRequest.builder()

      Parameters:
      describeReturnShippingLabelRequest - A Consumer that will call methods on DescribeReturnShippingLabelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeReturnShippingLabel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • InvalidJobStateException The action can't be performed because the job's current state doesn't allow that action to be performed.
      • ConflictException You get this exception when you call CreateReturnShippingLabel more than once when other requests are not completed.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getJobManifest

      default CompletableFuture<GetJobManifestResponse> getJobManifest(GetJobManifestRequest getJobManifestRequest)

      Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId value. You can access the manifest file for up to 60 minutes after this request has been made. To access the manifest file after 60 minutes have passed, you'll have to make another call to the GetJobManifest action.

      The manifest is an encrypted file that you can download after your job enters the WithCustomer status. This is the only valid status for calling this API as the manifest and UnlockCode code value are used for securing your device and should only be used when you have the device. The manifest is decrypted by using the UnlockCode code value, when you pass both values to the Snow device through the Snowball client when the client is started for the first time.

      As a best practice, we recommend that you don't save a copy of an UnlockCode value in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snow device associated with that job.

      The credentials of a given job, including its manifest file and unlock code, expire 360 days after the job is created.

      Parameters:
      getJobManifestRequest -
      Returns:
      A Java Future containing the result of the GetJobManifest operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • InvalidJobStateException The action can't be performed because the job's current state doesn't allow that action to be performed.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getJobManifest

      default CompletableFuture<GetJobManifestResponse> getJobManifest(Consumer<GetJobManifestRequest.Builder> getJobManifestRequest)

      Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId value. You can access the manifest file for up to 60 minutes after this request has been made. To access the manifest file after 60 minutes have passed, you'll have to make another call to the GetJobManifest action.

      The manifest is an encrypted file that you can download after your job enters the WithCustomer status. This is the only valid status for calling this API as the manifest and UnlockCode code value are used for securing your device and should only be used when you have the device. The manifest is decrypted by using the UnlockCode code value, when you pass both values to the Snow device through the Snowball client when the client is started for the first time.

      As a best practice, we recommend that you don't save a copy of an UnlockCode value in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snow device associated with that job.

      The credentials of a given job, including its manifest file and unlock code, expire 360 days after the job is created.


      This is a convenience which creates an instance of the GetJobManifestRequest.Builder avoiding the need to create one manually via GetJobManifestRequest.builder()

      Parameters:
      getJobManifestRequest - A Consumer that will call methods on GetJobManifestRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetJobManifest operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • InvalidJobStateException The action can't be performed because the job's current state doesn't allow that action to be performed.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getJobUnlockCode

      default CompletableFuture<GetJobUnlockCodeResponse> getJobUnlockCode(GetJobUnlockCodeRequest getJobUnlockCodeRequest)

      Returns the UnlockCode code value for the specified job. A particular UnlockCode value can be accessed for up to 360 days after the associated job has been created.

      The UnlockCode value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed along with the manifest to the Snow device through the Snowball client when the client is started for the first time. The only valid status for calling this API is WithCustomer as the manifest and Unlock code values are used for securing your device and should only be used when you have the device.

      As a best practice, we recommend that you don't save a copy of the UnlockCode in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snow device associated with that job.

      Parameters:
      getJobUnlockCodeRequest -
      Returns:
      A Java Future containing the result of the GetJobUnlockCode operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • InvalidJobStateException The action can't be performed because the job's current state doesn't allow that action to be performed.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getJobUnlockCode

      default CompletableFuture<GetJobUnlockCodeResponse> getJobUnlockCode(Consumer<GetJobUnlockCodeRequest.Builder> getJobUnlockCodeRequest)

      Returns the UnlockCode code value for the specified job. A particular UnlockCode value can be accessed for up to 360 days after the associated job has been created.

      The UnlockCode value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed along with the manifest to the Snow device through the Snowball client when the client is started for the first time. The only valid status for calling this API is WithCustomer as the manifest and Unlock code values are used for securing your device and should only be used when you have the device.

      As a best practice, we recommend that you don't save a copy of the UnlockCode in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snow device associated with that job.


      This is a convenience which creates an instance of the GetJobUnlockCodeRequest.Builder avoiding the need to create one manually via GetJobUnlockCodeRequest.builder()

      Parameters:
      getJobUnlockCodeRequest - A Consumer that will call methods on GetJobUnlockCodeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetJobUnlockCode operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • InvalidJobStateException The action can't be performed because the job's current state doesn't allow that action to be performed.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSnowballUsage

      default CompletableFuture<GetSnowballUsageResponse> getSnowballUsage(GetSnowballUsageRequest getSnowballUsageRequest)

      Returns information about the Snow Family service limit for your account, and also the number of Snow devices your account has in use.

      The default service limit for the number of Snow devices that you can have at one time is 1. If you want to increase your service limit, contact Amazon Web Services Support.

      Parameters:
      getSnowballUsageRequest -
      Returns:
      A Java Future containing the result of the GetSnowballUsage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSnowballUsage

      default CompletableFuture<GetSnowballUsageResponse> getSnowballUsage(Consumer<GetSnowballUsageRequest.Builder> getSnowballUsageRequest)

      Returns information about the Snow Family service limit for your account, and also the number of Snow devices your account has in use.

      The default service limit for the number of Snow devices that you can have at one time is 1. If you want to increase your service limit, contact Amazon Web Services Support.


      This is a convenience which creates an instance of the GetSnowballUsageRequest.Builder avoiding the need to create one manually via GetSnowballUsageRequest.builder()

      Parameters:
      getSnowballUsageRequest - A Consumer that will call methods on GetSnowballUsageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSnowballUsage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSnowballUsage

      default CompletableFuture<GetSnowballUsageResponse> getSnowballUsage()

      Returns information about the Snow Family service limit for your account, and also the number of Snow devices your account has in use.

      The default service limit for the number of Snow devices that you can have at one time is 1. If you want to increase your service limit, contact Amazon Web Services Support.

      Returns:
      A Java Future containing the result of the GetSnowballUsage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSoftwareUpdates

      default CompletableFuture<GetSoftwareUpdatesResponse> getSoftwareUpdates(GetSoftwareUpdatesRequest getSoftwareUpdatesRequest)

      Returns an Amazon S3 presigned URL for an update file associated with a specified JobId.

      Parameters:
      getSoftwareUpdatesRequest -
      Returns:
      A Java Future containing the result of the GetSoftwareUpdates operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • InvalidJobStateException The action can't be performed because the job's current state doesn't allow that action to be performed.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSoftwareUpdates

      default CompletableFuture<GetSoftwareUpdatesResponse> getSoftwareUpdates(Consumer<GetSoftwareUpdatesRequest.Builder> getSoftwareUpdatesRequest)

      Returns an Amazon S3 presigned URL for an update file associated with a specified JobId.


      This is a convenience which creates an instance of the GetSoftwareUpdatesRequest.Builder avoiding the need to create one manually via GetSoftwareUpdatesRequest.builder()

      Parameters:
      getSoftwareUpdatesRequest - A Consumer that will call methods on GetSoftwareUpdatesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSoftwareUpdates operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • InvalidJobStateException The action can't be performed because the job's current state doesn't allow that action to be performed.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listClusterJobs

      default CompletableFuture<ListClusterJobsResponse> listClusterJobs(ListClusterJobsRequest listClusterJobsRequest)

      Returns an array of JobListEntry objects of the specified length. Each JobListEntry object is for a job in the specified cluster and contains a job's state, a job's ID, and other information.

      Parameters:
      listClusterJobsRequest -
      Returns:
      A Java Future containing the result of the ListClusterJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listClusterJobs

      default CompletableFuture<ListClusterJobsResponse> listClusterJobs(Consumer<ListClusterJobsRequest.Builder> listClusterJobsRequest)

      Returns an array of JobListEntry objects of the specified length. Each JobListEntry object is for a job in the specified cluster and contains a job's state, a job's ID, and other information.


      This is a convenience which creates an instance of the ListClusterJobsRequest.Builder avoiding the need to create one manually via ListClusterJobsRequest.builder()

      Parameters:
      listClusterJobsRequest - A Consumer that will call methods on ListClusterJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListClusterJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listClusterJobsPaginator

      default ListClusterJobsPublisher listClusterJobsPaginator(ListClusterJobsRequest listClusterJobsRequest)

      This is a variant of listClusterJobs(software.amazon.awssdk.services.snowball.model.ListClusterJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.snowball.paginators.ListClusterJobsPublisher publisher = client.listClusterJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.snowball.paginators.ListClusterJobsPublisher publisher = client.listClusterJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.snowball.model.ListClusterJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.snowball.model.ListClusterJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listClusterJobs(software.amazon.awssdk.services.snowball.model.ListClusterJobsRequest) operation.

      Parameters:
      listClusterJobsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listClusterJobsPaginator

      default ListClusterJobsPublisher listClusterJobsPaginator(Consumer<ListClusterJobsRequest.Builder> listClusterJobsRequest)

      This is a variant of listClusterJobs(software.amazon.awssdk.services.snowball.model.ListClusterJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.snowball.paginators.ListClusterJobsPublisher publisher = client.listClusterJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.snowball.paginators.ListClusterJobsPublisher publisher = client.listClusterJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.snowball.model.ListClusterJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.snowball.model.ListClusterJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listClusterJobs(software.amazon.awssdk.services.snowball.model.ListClusterJobsRequest) operation.


      This is a convenience which creates an instance of the ListClusterJobsRequest.Builder avoiding the need to create one manually via ListClusterJobsRequest.builder()

      Parameters:
      listClusterJobsRequest - A Consumer that will call methods on ListClusterJobsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listClusters

      default CompletableFuture<ListClustersResponse> listClusters(ListClustersRequest listClustersRequest)

      Returns an array of ClusterListEntry objects of the specified length. Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.

      Parameters:
      listClustersRequest -
      Returns:
      A Java Future containing the result of the ListClusters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listClusters

      default CompletableFuture<ListClustersResponse> listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest)

      Returns an array of ClusterListEntry objects of the specified length. Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.


      This is a convenience which creates an instance of the ListClustersRequest.Builder avoiding the need to create one manually via ListClustersRequest.builder()

      Parameters:
      listClustersRequest - A Consumer that will call methods on ListClustersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListClusters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listClusters

      default CompletableFuture<ListClustersResponse> listClusters()

      Returns an array of ClusterListEntry objects of the specified length. Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.

      Returns:
      A Java Future containing the result of the ListClusters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listClustersPaginator

      default ListClustersPublisher listClustersPaginator()

      This is a variant of listClusters(software.amazon.awssdk.services.snowball.model.ListClustersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.snowball.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.snowball.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.snowball.model.ListClustersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.snowball.model.ListClustersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listClusters(software.amazon.awssdk.services.snowball.model.ListClustersRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listClustersPaginator

      default ListClustersPublisher listClustersPaginator(ListClustersRequest listClustersRequest)

      This is a variant of listClusters(software.amazon.awssdk.services.snowball.model.ListClustersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.snowball.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.snowball.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.snowball.model.ListClustersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.snowball.model.ListClustersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listClusters(software.amazon.awssdk.services.snowball.model.ListClustersRequest) operation.

      Parameters:
      listClustersRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listClustersPaginator

      default ListClustersPublisher listClustersPaginator(Consumer<ListClustersRequest.Builder> listClustersRequest)

      This is a variant of listClusters(software.amazon.awssdk.services.snowball.model.ListClustersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.snowball.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.snowball.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.snowball.model.ListClustersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.snowball.model.ListClustersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listClusters(software.amazon.awssdk.services.snowball.model.ListClustersRequest) operation.


      This is a convenience which creates an instance of the ListClustersRequest.Builder avoiding the need to create one manually via ListClustersRequest.builder()

      Parameters:
      listClustersRequest - A Consumer that will call methods on ListClustersRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCompatibleImages

      default CompletableFuture<ListCompatibleImagesResponse> listCompatibleImages(ListCompatibleImagesRequest listCompatibleImagesRequest)

      This action returns a list of the different Amazon EC2-compatible Amazon Machine Images (AMIs) that are owned by your Amazon Web Services accountthat would be supported for use on a Snow device. Currently, supported AMIs are based on the Amazon Linux-2, Ubuntu 20.04 LTS - Focal, or Ubuntu 22.04 LTS - Jammy images, available on the Amazon Web Services Marketplace. Ubuntu 16.04 LTS - Xenial (HVM) images are no longer supported in the Market, but still supported for use on devices through Amazon EC2 VM Import/Export and running locally in AMIs.

      Parameters:
      listCompatibleImagesRequest -
      Returns:
      A Java Future containing the result of the ListCompatibleImages operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
      • Ec2RequestFailedException Your user lacks the necessary Amazon EC2 permissions to perform the attempted 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCompatibleImages

      default CompletableFuture<ListCompatibleImagesResponse> listCompatibleImages(Consumer<ListCompatibleImagesRequest.Builder> listCompatibleImagesRequest)

      This action returns a list of the different Amazon EC2-compatible Amazon Machine Images (AMIs) that are owned by your Amazon Web Services accountthat would be supported for use on a Snow device. Currently, supported AMIs are based on the Amazon Linux-2, Ubuntu 20.04 LTS - Focal, or Ubuntu 22.04 LTS - Jammy images, available on the Amazon Web Services Marketplace. Ubuntu 16.04 LTS - Xenial (HVM) images are no longer supported in the Market, but still supported for use on devices through Amazon EC2 VM Import/Export and running locally in AMIs.


      This is a convenience which creates an instance of the ListCompatibleImagesRequest.Builder avoiding the need to create one manually via ListCompatibleImagesRequest.builder()

      Parameters:
      listCompatibleImagesRequest - A Consumer that will call methods on ListCompatibleImagesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListCompatibleImages operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
      • Ec2RequestFailedException Your user lacks the necessary Amazon EC2 permissions to perform the attempted 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCompatibleImages

      default CompletableFuture<ListCompatibleImagesResponse> listCompatibleImages()

      This action returns a list of the different Amazon EC2-compatible Amazon Machine Images (AMIs) that are owned by your Amazon Web Services accountthat would be supported for use on a Snow device. Currently, supported AMIs are based on the Amazon Linux-2, Ubuntu 20.04 LTS - Focal, or Ubuntu 22.04 LTS - Jammy images, available on the Amazon Web Services Marketplace. Ubuntu 16.04 LTS - Xenial (HVM) images are no longer supported in the Market, but still supported for use on devices through Amazon EC2 VM Import/Export and running locally in AMIs.

      Returns:
      A Java Future containing the result of the ListCompatibleImages operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
      • Ec2RequestFailedException Your user lacks the necessary Amazon EC2 permissions to perform the attempted 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCompatibleImagesPaginator

      default ListCompatibleImagesPublisher listCompatibleImagesPaginator()

      This is a variant of listCompatibleImages(software.amazon.awssdk.services.snowball.model.ListCompatibleImagesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.snowball.paginators.ListCompatibleImagesPublisher publisher = client.listCompatibleImagesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.snowball.paginators.ListCompatibleImagesPublisher publisher = client.listCompatibleImagesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.snowball.model.ListCompatibleImagesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.snowball.model.ListCompatibleImagesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listCompatibleImages(software.amazon.awssdk.services.snowball.model.ListCompatibleImagesRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
      • Ec2RequestFailedException Your user lacks the necessary Amazon EC2 permissions to perform the attempted 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCompatibleImagesPaginator

      default ListCompatibleImagesPublisher listCompatibleImagesPaginator(ListCompatibleImagesRequest listCompatibleImagesRequest)

      This is a variant of listCompatibleImages(software.amazon.awssdk.services.snowball.model.ListCompatibleImagesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.snowball.paginators.ListCompatibleImagesPublisher publisher = client.listCompatibleImagesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.snowball.paginators.ListCompatibleImagesPublisher publisher = client.listCompatibleImagesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.snowball.model.ListCompatibleImagesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.snowball.model.ListCompatibleImagesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listCompatibleImages(software.amazon.awssdk.services.snowball.model.ListCompatibleImagesRequest) operation.

      Parameters:
      listCompatibleImagesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
      • Ec2RequestFailedException Your user lacks the necessary Amazon EC2 permissions to perform the attempted 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCompatibleImagesPaginator

      default ListCompatibleImagesPublisher listCompatibleImagesPaginator(Consumer<ListCompatibleImagesRequest.Builder> listCompatibleImagesRequest)

      This is a variant of listCompatibleImages(software.amazon.awssdk.services.snowball.model.ListCompatibleImagesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.snowball.paginators.ListCompatibleImagesPublisher publisher = client.listCompatibleImagesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.snowball.paginators.ListCompatibleImagesPublisher publisher = client.listCompatibleImagesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.snowball.model.ListCompatibleImagesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.snowball.model.ListCompatibleImagesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listCompatibleImages(software.amazon.awssdk.services.snowball.model.ListCompatibleImagesRequest) operation.


      This is a convenience which creates an instance of the ListCompatibleImagesRequest.Builder avoiding the need to create one manually via ListCompatibleImagesRequest.builder()

      Parameters:
      listCompatibleImagesRequest - A Consumer that will call methods on ListCompatibleImagesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
      • Ec2RequestFailedException Your user lacks the necessary Amazon EC2 permissions to perform the attempted 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listJobs

      default CompletableFuture<ListJobsResponse> listJobs(ListJobsRequest listJobsRequest)

      Returns an array of JobListEntry objects of the specified length. Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs associated with this account in all US regions.

      Parameters:
      listJobsRequest -
      Returns:
      A Java Future containing the result of the ListJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listJobs

      default CompletableFuture<ListJobsResponse> listJobs(Consumer<ListJobsRequest.Builder> listJobsRequest)

      Returns an array of JobListEntry objects of the specified length. Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs associated with this account in all US regions.


      This is a convenience which creates an instance of the ListJobsRequest.Builder avoiding the need to create one manually via ListJobsRequest.builder()

      Parameters:
      listJobsRequest - A Consumer that will call methods on ListJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listJobs

      default CompletableFuture<ListJobsResponse> listJobs()

      Returns an array of JobListEntry objects of the specified length. Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs associated with this account in all US regions.

      Returns:
      A Java Future containing the result of the ListJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listJobsPaginator

      default ListJobsPublisher listJobsPaginator()

      This is a variant of listJobs(software.amazon.awssdk.services.snowball.model.ListJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.snowball.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.snowball.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.snowball.model.ListJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.snowball.model.ListJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listJobs(software.amazon.awssdk.services.snowball.model.ListJobsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listJobsPaginator

      default ListJobsPublisher listJobsPaginator(ListJobsRequest listJobsRequest)

      This is a variant of listJobs(software.amazon.awssdk.services.snowball.model.ListJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.snowball.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.snowball.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.snowball.model.ListJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.snowball.model.ListJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listJobs(software.amazon.awssdk.services.snowball.model.ListJobsRequest) operation.

      Parameters:
      listJobsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listJobsPaginator

      default ListJobsPublisher listJobsPaginator(Consumer<ListJobsRequest.Builder> listJobsRequest)

      This is a variant of listJobs(software.amazon.awssdk.services.snowball.model.ListJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.snowball.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.snowball.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.snowball.model.ListJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.snowball.model.ListJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listJobs(software.amazon.awssdk.services.snowball.model.ListJobsRequest) operation.


      This is a convenience which creates an instance of the ListJobsRequest.Builder avoiding the need to create one manually via ListJobsRequest.builder()

      Parameters:
      listJobsRequest - A Consumer that will call methods on ListJobsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLongTermPricing

      default CompletableFuture<ListLongTermPricingResponse> listLongTermPricing(ListLongTermPricingRequest listLongTermPricingRequest)

      Lists all long-term pricing types.

      Parameters:
      listLongTermPricingRequest -
      Returns:
      A Java Future containing the result of the ListLongTermPricing operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLongTermPricing

      default CompletableFuture<ListLongTermPricingResponse> listLongTermPricing(Consumer<ListLongTermPricingRequest.Builder> listLongTermPricingRequest)

      Lists all long-term pricing types.


      This is a convenience which creates an instance of the ListLongTermPricingRequest.Builder avoiding the need to create one manually via ListLongTermPricingRequest.builder()

      Parameters:
      listLongTermPricingRequest - A Consumer that will call methods on ListLongTermPricingRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListLongTermPricing operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLongTermPricingPaginator

      default ListLongTermPricingPublisher listLongTermPricingPaginator(ListLongTermPricingRequest listLongTermPricingRequest)

      This is a variant of listLongTermPricing(software.amazon.awssdk.services.snowball.model.ListLongTermPricingRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.snowball.paginators.ListLongTermPricingPublisher publisher = client.listLongTermPricingPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.snowball.paginators.ListLongTermPricingPublisher publisher = client.listLongTermPricingPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.snowball.model.ListLongTermPricingResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.snowball.model.ListLongTermPricingResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listLongTermPricing(software.amazon.awssdk.services.snowball.model.ListLongTermPricingRequest) operation.

      Parameters:
      listLongTermPricingRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLongTermPricingPaginator

      default ListLongTermPricingPublisher listLongTermPricingPaginator(Consumer<ListLongTermPricingRequest.Builder> listLongTermPricingRequest)

      This is a variant of listLongTermPricing(software.amazon.awssdk.services.snowball.model.ListLongTermPricingRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.snowball.paginators.ListLongTermPricingPublisher publisher = client.listLongTermPricingPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.snowball.paginators.ListLongTermPricingPublisher publisher = client.listLongTermPricingPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.snowball.model.ListLongTermPricingResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.snowball.model.ListLongTermPricingResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listLongTermPricing(software.amazon.awssdk.services.snowball.model.ListLongTermPricingRequest) operation.


      This is a convenience which creates an instance of the ListLongTermPricingRequest.Builder avoiding the need to create one manually via ListLongTermPricingRequest.builder()

      Parameters:
      listLongTermPricingRequest - A Consumer that will call methods on ListLongTermPricingRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPickupLocations

      default CompletableFuture<ListPickupLocationsResponse> listPickupLocations(ListPickupLocationsRequest listPickupLocationsRequest)

      A list of locations from which the customer can choose to pickup a device.

      Parameters:
      listPickupLocationsRequest -
      Returns:
      A Java Future containing the result of the ListPickupLocations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPickupLocations

      default CompletableFuture<ListPickupLocationsResponse> listPickupLocations(Consumer<ListPickupLocationsRequest.Builder> listPickupLocationsRequest)

      A list of locations from which the customer can choose to pickup a device.


      This is a convenience which creates an instance of the ListPickupLocationsRequest.Builder avoiding the need to create one manually via ListPickupLocationsRequest.builder()

      Parameters:
      listPickupLocationsRequest - A Consumer that will call methods on ListPickupLocationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListPickupLocations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPickupLocationsPaginator

      default ListPickupLocationsPublisher listPickupLocationsPaginator(ListPickupLocationsRequest listPickupLocationsRequest)

      This is a variant of listPickupLocations(software.amazon.awssdk.services.snowball.model.ListPickupLocationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.snowball.paginators.ListPickupLocationsPublisher publisher = client.listPickupLocationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.snowball.paginators.ListPickupLocationsPublisher publisher = client.listPickupLocationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.snowball.model.ListPickupLocationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.snowball.model.ListPickupLocationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listPickupLocations(software.amazon.awssdk.services.snowball.model.ListPickupLocationsRequest) operation.

      Parameters:
      listPickupLocationsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPickupLocationsPaginator

      default ListPickupLocationsPublisher listPickupLocationsPaginator(Consumer<ListPickupLocationsRequest.Builder> listPickupLocationsRequest)

      This is a variant of listPickupLocations(software.amazon.awssdk.services.snowball.model.ListPickupLocationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.snowball.paginators.ListPickupLocationsPublisher publisher = client.listPickupLocationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.snowball.paginators.ListPickupLocationsPublisher publisher = client.listPickupLocationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.snowball.model.ListPickupLocationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.snowball.model.ListPickupLocationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listPickupLocations(software.amazon.awssdk.services.snowball.model.ListPickupLocationsRequest) operation.


      This is a convenience which creates an instance of the ListPickupLocationsRequest.Builder avoiding the need to create one manually via ListPickupLocationsRequest.builder()

      Parameters:
      listPickupLocationsRequest - A Consumer that will call methods on ListPickupLocationsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listServiceVersions

      default CompletableFuture<ListServiceVersionsResponse> listServiceVersions(ListServiceVersionsRequest listServiceVersionsRequest)

      Lists all supported versions for Snow on-device services. Returns an array of ServiceVersion object containing the supported versions for a particular service.

      Parameters:
      listServiceVersionsRequest -
      Returns:
      A Java Future containing the result of the ListServiceVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listServiceVersions

      default CompletableFuture<ListServiceVersionsResponse> listServiceVersions(Consumer<ListServiceVersionsRequest.Builder> listServiceVersionsRequest)

      Lists all supported versions for Snow on-device services. Returns an array of ServiceVersion object containing the supported versions for a particular service.


      This is a convenience which creates an instance of the ListServiceVersionsRequest.Builder avoiding the need to create one manually via ListServiceVersionsRequest.builder()

      Parameters:
      listServiceVersionsRequest - A Consumer that will call methods on ListServiceVersionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListServiceVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateCluster

      default CompletableFuture<UpdateClusterResponse> updateCluster(UpdateClusterRequest updateClusterRequest)

      While a cluster's ClusterState value is in the AwaitingQuorum state, you can update some of the information associated with a cluster. Once the cluster changes to a different job state, usually 60 minutes after the cluster being created, this action is no longer available.

      Parameters:
      updateClusterRequest -
      Returns:
      A Java Future containing the result of the UpdateCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • InvalidJobStateException The action can't be performed because the job's current state doesn't allow that action to be performed.
      • KmsRequestFailedException The provided Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.
      • InvalidInputCombinationException Job or cluster creation failed. One or more inputs were invalid. Confirm that the CreateClusterRequestinvalid input: '&#36'SnowballType value supports your CreateJobRequestinvalid input: '&#36'JobType, and try again.
      • Ec2RequestFailedException Your user lacks the necessary Amazon EC2 permissions to perform the attempted 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateCluster

      default CompletableFuture<UpdateClusterResponse> updateCluster(Consumer<UpdateClusterRequest.Builder> updateClusterRequest)

      While a cluster's ClusterState value is in the AwaitingQuorum state, you can update some of the information associated with a cluster. Once the cluster changes to a different job state, usually 60 minutes after the cluster being created, this action is no longer available.


      This is a convenience which creates an instance of the UpdateClusterRequest.Builder avoiding the need to create one manually via UpdateClusterRequest.builder()

      Parameters:
      updateClusterRequest - A Consumer that will call methods on UpdateClusterRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • InvalidJobStateException The action can't be performed because the job's current state doesn't allow that action to be performed.
      • KmsRequestFailedException The provided Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.
      • InvalidInputCombinationException Job or cluster creation failed. One or more inputs were invalid. Confirm that the CreateClusterRequestinvalid input: '&#36'SnowballType value supports your CreateJobRequestinvalid input: '&#36'JobType, and try again.
      • Ec2RequestFailedException Your user lacks the necessary Amazon EC2 permissions to perform the attempted 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateJob

      default CompletableFuture<UpdateJobResponse> updateJob(UpdateJobRequest updateJobRequest)

      While a job's JobState value is New, you can update some of the information associated with a job. Once the job changes to a different job state, usually within 60 minutes of the job being created, this action is no longer available.

      Parameters:
      updateJobRequest -
      Returns:
      A Java Future containing the result of the UpdateJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • InvalidJobStateException The action can't be performed because the job's current state doesn't allow that action to be performed.
      • KmsRequestFailedException The provided Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.
      • InvalidInputCombinationException Job or cluster creation failed. One or more inputs were invalid. Confirm that the CreateClusterRequestinvalid input: '&#36'SnowballType value supports your CreateJobRequestinvalid input: '&#36'JobType, and try again.
      • ClusterLimitExceededException Job creation failed. Currently, clusters support five nodes. If you have fewer than five nodes for your cluster and you have more nodes to create for this cluster, try again and create jobs until your cluster has exactly five nodes.
      • Ec2RequestFailedException Your user lacks the necessary Amazon EC2 permissions to perform the attempted 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateJob

      default CompletableFuture<UpdateJobResponse> updateJob(Consumer<UpdateJobRequest.Builder> updateJobRequest)

      While a job's JobState value is New, you can update some of the information associated with a job. Once the job changes to a different job state, usually within 60 minutes of the job being created, this action is no longer available.


      This is a convenience which creates an instance of the UpdateJobRequest.Builder avoiding the need to create one manually via UpdateJobRequest.builder()

      Parameters:
      updateJobRequest - A Consumer that will call methods on UpdateJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • InvalidJobStateException The action can't be performed because the job's current state doesn't allow that action to be performed.
      • KmsRequestFailedException The provided Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.
      • InvalidInputCombinationException Job or cluster creation failed. One or more inputs were invalid. Confirm that the CreateClusterRequestinvalid input: '&#36'SnowballType value supports your CreateJobRequestinvalid input: '&#36'JobType, and try again.
      • ClusterLimitExceededException Job creation failed. Currently, clusters support five nodes. If you have fewer than five nodes for your cluster and you have more nodes to create for this cluster, try again and create jobs until your cluster has exactly five nodes.
      • Ec2RequestFailedException Your user lacks the necessary Amazon EC2 permissions to perform the attempted 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateJobShipmentState

      default CompletableFuture<UpdateJobShipmentStateResponse> updateJobShipmentState(UpdateJobShipmentStateRequest updateJobShipmentStateRequest)

      Updates the state when a shipment state changes to a different state.

      Parameters:
      updateJobShipmentStateRequest -
      Returns:
      A Java Future containing the result of the UpdateJobShipmentState operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • InvalidJobStateException The action can't be performed because the job's current state doesn't allow that action to be performed.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateJobShipmentState

      default CompletableFuture<UpdateJobShipmentStateResponse> updateJobShipmentState(Consumer<UpdateJobShipmentStateRequest.Builder> updateJobShipmentStateRequest)

      Updates the state when a shipment state changes to a different state.


      This is a convenience which creates an instance of the UpdateJobShipmentStateRequest.Builder avoiding the need to create one manually via UpdateJobShipmentStateRequest.builder()

      Parameters:
      updateJobShipmentStateRequest - A Consumer that will call methods on UpdateJobShipmentStateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateJobShipmentState operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • InvalidJobStateException The action can't be performed because the job's current state doesn't allow that action to be performed.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateLongTermPricing

      default CompletableFuture<UpdateLongTermPricingResponse> updateLongTermPricing(UpdateLongTermPricingRequest updateLongTermPricingRequest)

      Updates the long-term pricing type.

      Parameters:
      updateLongTermPricingRequest -
      Returns:
      A Java Future containing the result of the UpdateLongTermPricing operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateLongTermPricing

      default CompletableFuture<UpdateLongTermPricingResponse> updateLongTermPricing(Consumer<UpdateLongTermPricingRequest.Builder> updateLongTermPricingRequest)

      Updates the long-term pricing type.


      This is a convenience which creates an instance of the UpdateLongTermPricingRequest.Builder avoiding the need to create one manually via UpdateLongTermPricingRequest.builder()

      Parameters:
      updateLongTermPricingRequest - A Consumer that will call methods on UpdateLongTermPricingRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateLongTermPricing operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
      • 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.
      • SnowballException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default SnowballServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static SnowballAsyncClient create()
      Create a SnowballAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static SnowballAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a SnowballAsyncClient.