software.amazon.awssdk.services.snowball.SnowballAsyncClient Maven / Gradle / Ivy
Show all versions of snowball Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.snowball;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.awscore.AwsClient;
import software.amazon.awssdk.services.snowball.model.CancelClusterRequest;
import software.amazon.awssdk.services.snowball.model.CancelClusterResponse;
import software.amazon.awssdk.services.snowball.model.CancelJobRequest;
import software.amazon.awssdk.services.snowball.model.CancelJobResponse;
import software.amazon.awssdk.services.snowball.model.CreateAddressRequest;
import software.amazon.awssdk.services.snowball.model.CreateAddressResponse;
import software.amazon.awssdk.services.snowball.model.CreateClusterRequest;
import software.amazon.awssdk.services.snowball.model.CreateClusterResponse;
import software.amazon.awssdk.services.snowball.model.CreateJobRequest;
import software.amazon.awssdk.services.snowball.model.CreateJobResponse;
import software.amazon.awssdk.services.snowball.model.CreateLongTermPricingRequest;
import software.amazon.awssdk.services.snowball.model.CreateLongTermPricingResponse;
import software.amazon.awssdk.services.snowball.model.CreateReturnShippingLabelRequest;
import software.amazon.awssdk.services.snowball.model.CreateReturnShippingLabelResponse;
import software.amazon.awssdk.services.snowball.model.DescribeAddressRequest;
import software.amazon.awssdk.services.snowball.model.DescribeAddressResponse;
import software.amazon.awssdk.services.snowball.model.DescribeAddressesRequest;
import software.amazon.awssdk.services.snowball.model.DescribeAddressesResponse;
import software.amazon.awssdk.services.snowball.model.DescribeClusterRequest;
import software.amazon.awssdk.services.snowball.model.DescribeClusterResponse;
import software.amazon.awssdk.services.snowball.model.DescribeJobRequest;
import software.amazon.awssdk.services.snowball.model.DescribeJobResponse;
import software.amazon.awssdk.services.snowball.model.DescribeReturnShippingLabelRequest;
import software.amazon.awssdk.services.snowball.model.DescribeReturnShippingLabelResponse;
import software.amazon.awssdk.services.snowball.model.GetJobManifestRequest;
import software.amazon.awssdk.services.snowball.model.GetJobManifestResponse;
import software.amazon.awssdk.services.snowball.model.GetJobUnlockCodeRequest;
import software.amazon.awssdk.services.snowball.model.GetJobUnlockCodeResponse;
import software.amazon.awssdk.services.snowball.model.GetSnowballUsageRequest;
import software.amazon.awssdk.services.snowball.model.GetSnowballUsageResponse;
import software.amazon.awssdk.services.snowball.model.GetSoftwareUpdatesRequest;
import software.amazon.awssdk.services.snowball.model.GetSoftwareUpdatesResponse;
import software.amazon.awssdk.services.snowball.model.ListClusterJobsRequest;
import software.amazon.awssdk.services.snowball.model.ListClusterJobsResponse;
import software.amazon.awssdk.services.snowball.model.ListClustersRequest;
import software.amazon.awssdk.services.snowball.model.ListClustersResponse;
import software.amazon.awssdk.services.snowball.model.ListCompatibleImagesRequest;
import software.amazon.awssdk.services.snowball.model.ListCompatibleImagesResponse;
import software.amazon.awssdk.services.snowball.model.ListJobsRequest;
import software.amazon.awssdk.services.snowball.model.ListJobsResponse;
import software.amazon.awssdk.services.snowball.model.ListLongTermPricingRequest;
import software.amazon.awssdk.services.snowball.model.ListLongTermPricingResponse;
import software.amazon.awssdk.services.snowball.model.ListPickupLocationsRequest;
import software.amazon.awssdk.services.snowball.model.ListPickupLocationsResponse;
import software.amazon.awssdk.services.snowball.model.ListServiceVersionsRequest;
import software.amazon.awssdk.services.snowball.model.ListServiceVersionsResponse;
import software.amazon.awssdk.services.snowball.model.UpdateClusterRequest;
import software.amazon.awssdk.services.snowball.model.UpdateClusterResponse;
import software.amazon.awssdk.services.snowball.model.UpdateJobRequest;
import software.amazon.awssdk.services.snowball.model.UpdateJobResponse;
import software.amazon.awssdk.services.snowball.model.UpdateJobShipmentStateRequest;
import software.amazon.awssdk.services.snowball.model.UpdateJobShipmentStateResponse;
import software.amazon.awssdk.services.snowball.model.UpdateLongTermPricingRequest;
import software.amazon.awssdk.services.snowball.model.UpdateLongTermPricingResponse;
import software.amazon.awssdk.services.snowball.paginators.DescribeAddressesPublisher;
import software.amazon.awssdk.services.snowball.paginators.ListClusterJobsPublisher;
import software.amazon.awssdk.services.snowball.paginators.ListClustersPublisher;
import software.amazon.awssdk.services.snowball.paginators.ListCompatibleImagesPublisher;
import software.amazon.awssdk.services.snowball.paginators.ListJobsPublisher;
import software.amazon.awssdk.services.snowball.paginators.ListLongTermPricingPublisher;
import software.amazon.awssdk.services.snowball.paginators.ListPickupLocationsPublisher;
/**
* Service client for accessing Amazon Snowball asynchronously. This can be created using the static {@link #builder()}
* method.The asynchronous client performs non-blocking I/O when configured with any {@code 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.
*
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface SnowballAsyncClient extends AwsClient {
String SERVICE_NAME = "snowball";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "snowball";
/**
*
* 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.
*
*
* @param cancelClusterRequest
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.CancelCluster
* @see AWS API
* Documentation
*/
default CompletableFuture cancelCluster(CancelClusterRequest cancelClusterRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CancelClusterRequest.Builder} avoiding the need to
* create one manually via {@link CancelClusterRequest#builder()}
*
*
* @param cancelClusterRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.snowball.model.CancelClusterRequest.Builder} to create a request.
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.CancelCluster
* @see AWS API
* Documentation
*/
default CompletableFuture cancelCluster(Consumer cancelClusterRequest) {
return cancelCluster(CancelClusterRequest.builder().applyMutation(cancelClusterRequest).build());
}
/**
*
* 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.
*
*
* @param cancelJobRequest
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.CancelJob
* @see AWS API
* Documentation
*/
default CompletableFuture cancelJob(CancelJobRequest cancelJobRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CancelJobRequest.Builder} avoiding the need to
* create one manually via {@link CancelJobRequest#builder()}
*
*
* @param cancelJobRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.snowball.model.CancelJobRequest.Builder} to create a request.
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.CancelJob
* @see AWS API
* Documentation
*/
default CompletableFuture cancelJob(Consumer cancelJobRequest) {
return cancelJob(CancelJobRequest.builder().applyMutation(cancelJobRequest).build());
}
/**
*
* 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.
*
*
* @param createAddressRequest
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.CreateAddress
* @see AWS API
* Documentation
*/
default CompletableFuture createAddress(CreateAddressRequest createAddressRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateAddressRequest.Builder} avoiding the need to
* create one manually via {@link CreateAddressRequest#builder()}
*
*
* @param createAddressRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.snowball.model.CreateAddressRequest.Builder} to create a request.
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.CreateAddress
* @see AWS API
* Documentation
*/
default CompletableFuture createAddress(Consumer createAddressRequest) {
return createAddress(CreateAddressRequest.builder().applyMutation(createAddressRequest).build());
}
/**
*
* 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.
*
*
* @param createClusterRequest
* @return 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
* {@link 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 CreateClusterRequest$SnowballType value supports your
* CreateJobRequest$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.
*
* @sample SnowballAsyncClient.CreateCluster
* @see AWS API
* Documentation
*/
default CompletableFuture createCluster(CreateClusterRequest createClusterRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateClusterRequest.Builder} avoiding the need to
* create one manually via {@link CreateClusterRequest#builder()}
*
*
* @param createClusterRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.snowball.model.CreateClusterRequest.Builder} to create a request.
* @return 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
* {@link 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 CreateClusterRequest$SnowballType value supports your
* CreateJobRequest$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.
*
* @sample SnowballAsyncClient.CreateCluster
* @see AWS API
* Documentation
*/
default CompletableFuture createCluster(Consumer createClusterRequest) {
return createCluster(CreateClusterRequest.builder().applyMutation(createClusterRequest).build());
}
/**
*
* 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
*
*
*
*
*
*
* @param createJobRequest
* @return 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
* {@link 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 CreateClusterRequest$SnowballType value supports your
* CreateJobRequest$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.
*
* @sample SnowballAsyncClient.CreateJob
* @see AWS API
* Documentation
*/
default CompletableFuture createJob(CreateJobRequest createJobRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateJobRequest.Builder} avoiding the need to
* create one manually via {@link CreateJobRequest#builder()}
*
*
* @param createJobRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.snowball.model.CreateJobRequest.Builder} to create a request.
* @return 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
* {@link 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 CreateClusterRequest$SnowballType value supports your
* CreateJobRequest$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.
*
* @sample SnowballAsyncClient.CreateJob
* @see AWS API
* Documentation
*/
default CompletableFuture createJob(Consumer createJobRequest) {
return createJob(CreateJobRequest.builder().applyMutation(createJobRequest).build());
}
/**
*
* 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.
*
*
* @param createLongTermPricingRequest
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.CreateLongTermPricing
* @see AWS API Documentation
*/
default CompletableFuture createLongTermPricing(
CreateLongTermPricingRequest createLongTermPricingRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateLongTermPricingRequest.Builder} avoiding the
* need to create one manually via {@link CreateLongTermPricingRequest#builder()}
*
*
* @param createLongTermPricingRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.snowball.model.CreateLongTermPricingRequest.Builder} to create a
* request.
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.CreateLongTermPricing
* @see AWS API Documentation
*/
default CompletableFuture createLongTermPricing(
Consumer createLongTermPricingRequest) {
return createLongTermPricing(CreateLongTermPricingRequest.builder().applyMutation(createLongTermPricingRequest).build());
}
/**
*
* Creates a shipping label that will be used to return the Snow device to Amazon Web Services.
*
*
* @param createReturnShippingLabelRequest
* @return 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
* {@link 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 CreateClusterRequest$SnowballType value supports your
* CreateJobRequest$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.
*
* @sample SnowballAsyncClient.CreateReturnShippingLabel
* @see AWS API Documentation
*/
default CompletableFuture createReturnShippingLabel(
CreateReturnShippingLabelRequest createReturnShippingLabelRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateReturnShippingLabelRequest.Builder} avoiding
* the need to create one manually via {@link CreateReturnShippingLabelRequest#builder()}
*
*
* @param createReturnShippingLabelRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.snowball.model.CreateReturnShippingLabelRequest.Builder} to create
* a request.
* @return 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
* {@link 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 CreateClusterRequest$SnowballType value supports your
* CreateJobRequest$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.
*
* @sample SnowballAsyncClient.CreateReturnShippingLabel
* @see AWS API Documentation
*/
default CompletableFuture createReturnShippingLabel(
Consumer createReturnShippingLabelRequest) {
return createReturnShippingLabel(CreateReturnShippingLabelRequest.builder()
.applyMutation(createReturnShippingLabelRequest).build());
}
/**
*
* Takes an AddressId and returns specific details about that address in the form of an
* Address object.
*
*
* @param describeAddressRequest
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.DescribeAddress
* @see AWS API
* Documentation
*/
default CompletableFuture describeAddress(DescribeAddressRequest describeAddressRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeAddressRequest.Builder} avoiding the need
* to create one manually via {@link DescribeAddressRequest#builder()}
*
*
* @param describeAddressRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.snowball.model.DescribeAddressRequest.Builder} to create a request.
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.DescribeAddress
* @see AWS API
* Documentation
*/
default CompletableFuture describeAddress(
Consumer describeAddressRequest) {
return describeAddress(DescribeAddressRequest.builder().applyMutation(describeAddressRequest).build());
}
/**
*
* 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.
*
*
* @param describeAddressesRequest
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.DescribeAddresses
* @see AWS
* API Documentation
*/
default CompletableFuture describeAddresses(DescribeAddressesRequest describeAddressesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeAddressesRequest.Builder} avoiding the need
* to create one manually via {@link DescribeAddressesRequest#builder()}
*
*
* @param describeAddressesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.snowball.model.DescribeAddressesRequest.Builder} to create a
* request.
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.DescribeAddresses
* @see AWS
* API Documentation
*/
default CompletableFuture describeAddresses(
Consumer describeAddressesRequest) {
return describeAddresses(DescribeAddressesRequest.builder().applyMutation(describeAddressesRequest).build());
}
/**
*
* 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.
*
*
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.DescribeAddresses
* @see AWS
* API Documentation
*/
default CompletableFuture describeAddresses() {
return describeAddresses(DescribeAddressesRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.DescribeAddressesPublisher publisher = client.describeAddressesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.DescribeAddressesPublisher publisher = client.describeAddressesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #describeAddresses(software.amazon.awssdk.services.snowball.model.DescribeAddressesRequest)}
* operation.
*
*
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.DescribeAddresses
* @see AWS
* API Documentation
*/
default DescribeAddressesPublisher describeAddressesPaginator() {
return describeAddressesPaginator(DescribeAddressesRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.DescribeAddressesPublisher publisher = client.describeAddressesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.DescribeAddressesPublisher publisher = client.describeAddressesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #describeAddresses(software.amazon.awssdk.services.snowball.model.DescribeAddressesRequest)}
* operation.
*
*
* @param describeAddressesRequest
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.DescribeAddresses
* @see AWS
* API Documentation
*/
default DescribeAddressesPublisher describeAddressesPaginator(DescribeAddressesRequest describeAddressesRequest) {
return new DescribeAddressesPublisher(this, describeAddressesRequest);
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.DescribeAddressesPublisher publisher = client.describeAddressesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.DescribeAddressesPublisher publisher = client.describeAddressesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #describeAddresses(software.amazon.awssdk.services.snowball.model.DescribeAddressesRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeAddressesRequest.Builder} avoiding the need
* to create one manually via {@link DescribeAddressesRequest#builder()}
*
*
* @param describeAddressesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.snowball.model.DescribeAddressesRequest.Builder} to create a
* request.
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.DescribeAddresses
* @see AWS
* API Documentation
*/
default DescribeAddressesPublisher describeAddressesPaginator(
Consumer describeAddressesRequest) {
return describeAddressesPaginator(DescribeAddressesRequest.builder().applyMutation(describeAddressesRequest).build());
}
/**
*
* Returns information about a specific cluster including shipping information, cluster status, and other important
* metadata.
*
*
* @param describeClusterRequest
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.DescribeCluster
* @see AWS API
* Documentation
*/
default CompletableFuture describeCluster(DescribeClusterRequest describeClusterRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeClusterRequest.Builder} avoiding the need
* to create one manually via {@link DescribeClusterRequest#builder()}
*
*
* @param describeClusterRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.snowball.model.DescribeClusterRequest.Builder} to create a request.
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.DescribeCluster
* @see AWS API
* Documentation
*/
default CompletableFuture describeCluster(
Consumer describeClusterRequest) {
return describeCluster(DescribeClusterRequest.builder().applyMutation(describeClusterRequest).build());
}
/**
*
* Returns information about a specific job including shipping information, job status, and other important
* metadata.
*
*
* @param describeJobRequest
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.DescribeJob
* @see AWS API
* Documentation
*/
default CompletableFuture describeJob(DescribeJobRequest describeJobRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeJobRequest.Builder} avoiding the need to
* create one manually via {@link DescribeJobRequest#builder()}
*
*
* @param describeJobRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.snowball.model.DescribeJobRequest.Builder} to create a request.
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.DescribeJob
* @see AWS API
* Documentation
*/
default CompletableFuture describeJob(Consumer describeJobRequest) {
return describeJob(DescribeJobRequest.builder().applyMutation(describeJobRequest).build());
}
/**
*
* Information on the shipping label of a Snow device that is being returned to Amazon Web Services.
*
*
* @param describeReturnShippingLabelRequest
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.DescribeReturnShippingLabel
* @see AWS API Documentation
*/
default CompletableFuture describeReturnShippingLabel(
DescribeReturnShippingLabelRequest describeReturnShippingLabelRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeReturnShippingLabelRequest.Builder}
* avoiding the need to create one manually via {@link DescribeReturnShippingLabelRequest#builder()}
*
*
* @param describeReturnShippingLabelRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.snowball.model.DescribeReturnShippingLabelRequest.Builder} to
* create a request.
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.DescribeReturnShippingLabel
* @see AWS API Documentation
*/
default CompletableFuture describeReturnShippingLabel(
Consumer describeReturnShippingLabelRequest) {
return describeReturnShippingLabel(DescribeReturnShippingLabelRequest.builder()
.applyMutation(describeReturnShippingLabelRequest).build());
}
/**
*
* 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.
*
*
* @param getJobManifestRequest
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.GetJobManifest
* @see AWS API
* Documentation
*/
default CompletableFuture getJobManifest(GetJobManifestRequest getJobManifestRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetJobManifestRequest.Builder} avoiding the need to
* create one manually via {@link GetJobManifestRequest#builder()}
*
*
* @param getJobManifestRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.snowball.model.GetJobManifestRequest.Builder} to create a request.
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.GetJobManifest
* @see AWS API
* Documentation
*/
default CompletableFuture getJobManifest(Consumer getJobManifestRequest) {
return getJobManifest(GetJobManifestRequest.builder().applyMutation(getJobManifestRequest).build());
}
/**
*
* 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.
*
*
* @param getJobUnlockCodeRequest
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.GetJobUnlockCode
* @see AWS API
* Documentation
*/
default CompletableFuture getJobUnlockCode(GetJobUnlockCodeRequest getJobUnlockCodeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetJobUnlockCodeRequest.Builder} avoiding the need
* to create one manually via {@link GetJobUnlockCodeRequest#builder()}
*
*
* @param getJobUnlockCodeRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.snowball.model.GetJobUnlockCodeRequest.Builder} to create a
* request.
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.GetJobUnlockCode
* @see AWS API
* Documentation
*/
default CompletableFuture getJobUnlockCode(
Consumer getJobUnlockCodeRequest) {
return getJobUnlockCode(GetJobUnlockCodeRequest.builder().applyMutation(getJobUnlockCodeRequest).build());
}
/**
*
* 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.
*
*
* @param getSnowballUsageRequest
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.GetSnowballUsage
* @see AWS API
* Documentation
*/
default CompletableFuture getSnowballUsage(GetSnowballUsageRequest getSnowballUsageRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetSnowballUsageRequest.Builder} avoiding the need
* to create one manually via {@link GetSnowballUsageRequest#builder()}
*
*
* @param getSnowballUsageRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.snowball.model.GetSnowballUsageRequest.Builder} to create a
* request.
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.GetSnowballUsage
* @see AWS API
* Documentation
*/
default CompletableFuture getSnowballUsage(
Consumer getSnowballUsageRequest) {
return getSnowballUsage(GetSnowballUsageRequest.builder().applyMutation(getSnowballUsageRequest).build());
}
/**
*
* 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.
*
*
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.GetSnowballUsage
* @see AWS API
* Documentation
*/
default CompletableFuture getSnowballUsage() {
return getSnowballUsage(GetSnowballUsageRequest.builder().build());
}
/**
*
* Returns an Amazon S3 presigned URL for an update file associated with a specified JobId.
*
*
* @param getSoftwareUpdatesRequest
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.GetSoftwareUpdates
* @see AWS
* API Documentation
*/
default CompletableFuture getSoftwareUpdates(GetSoftwareUpdatesRequest getSoftwareUpdatesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetSoftwareUpdatesRequest.Builder} avoiding the
* need to create one manually via {@link GetSoftwareUpdatesRequest#builder()}
*
*
* @param getSoftwareUpdatesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.snowball.model.GetSoftwareUpdatesRequest.Builder} to create a
* request.
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.GetSoftwareUpdates
* @see AWS
* API Documentation
*/
default CompletableFuture getSoftwareUpdates(
Consumer getSoftwareUpdatesRequest) {
return getSoftwareUpdates(GetSoftwareUpdatesRequest.builder().applyMutation(getSoftwareUpdatesRequest).build());
}
/**
*
* 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.
*
*
* @param listClusterJobsRequest
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.ListClusterJobs
* @see AWS API
* Documentation
*/
default CompletableFuture listClusterJobs(ListClusterJobsRequest listClusterJobsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListClusterJobsRequest.Builder} avoiding the need
* to create one manually via {@link ListClusterJobsRequest#builder()}
*
*
* @param listClusterJobsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.snowball.model.ListClusterJobsRequest.Builder} to create a request.
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.ListClusterJobs
* @see AWS API
* Documentation
*/
default CompletableFuture listClusterJobs(
Consumer listClusterJobsRequest) {
return listClusterJobs(ListClusterJobsRequest.builder().applyMutation(listClusterJobsRequest).build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.ListClusterJobsPublisher publisher = client.listClusterJobsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.ListClusterJobsPublisher publisher = client.listClusterJobsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listClusterJobs(software.amazon.awssdk.services.snowball.model.ListClusterJobsRequest)} operation.
*
*
* @param listClusterJobsRequest
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.ListClusterJobs
* @see AWS API
* Documentation
*/
default ListClusterJobsPublisher listClusterJobsPaginator(ListClusterJobsRequest listClusterJobsRequest) {
return new ListClusterJobsPublisher(this, listClusterJobsRequest);
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.ListClusterJobsPublisher publisher = client.listClusterJobsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.ListClusterJobsPublisher publisher = client.listClusterJobsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listClusterJobs(software.amazon.awssdk.services.snowball.model.ListClusterJobsRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListClusterJobsRequest.Builder} avoiding the need
* to create one manually via {@link ListClusterJobsRequest#builder()}
*
*
* @param listClusterJobsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.snowball.model.ListClusterJobsRequest.Builder} to create a request.
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.ListClusterJobs
* @see AWS API
* Documentation
*/
default ListClusterJobsPublisher listClusterJobsPaginator(Consumer listClusterJobsRequest) {
return listClusterJobsPaginator(ListClusterJobsRequest.builder().applyMutation(listClusterJobsRequest).build());
}
/**
*
* 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.
*
*
* @param listClustersRequest
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.ListClusters
* @see AWS API
* Documentation
*/
default CompletableFuture listClusters(ListClustersRequest listClustersRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListClustersRequest.Builder} avoiding the need to
* create one manually via {@link ListClustersRequest#builder()}
*
*
* @param listClustersRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.snowball.model.ListClustersRequest.Builder} to create a request.
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.ListClusters
* @see AWS API
* Documentation
*/
default CompletableFuture listClusters(Consumer listClustersRequest) {
return listClusters(ListClustersRequest.builder().applyMutation(listClustersRequest).build());
}
/**
*
* 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.
*
*
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.ListClusters
* @see AWS API
* Documentation
*/
default CompletableFuture listClusters() {
return listClusters(ListClustersRequest.builder().build());
}
/**
*
* This is a variant of {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listClusters(software.amazon.awssdk.services.snowball.model.ListClustersRequest)} operation.
*
*
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.ListClusters
* @see AWS API
* Documentation
*/
default ListClustersPublisher listClustersPaginator() {
return listClustersPaginator(ListClustersRequest.builder().build());
}
/**
*
* This is a variant of {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listClusters(software.amazon.awssdk.services.snowball.model.ListClustersRequest)} operation.
*
*
* @param listClustersRequest
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.ListClusters
* @see AWS API
* Documentation
*/
default ListClustersPublisher listClustersPaginator(ListClustersRequest listClustersRequest) {
return new ListClustersPublisher(this, listClustersRequest);
}
/**
*
* This is a variant of {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listClusters(software.amazon.awssdk.services.snowball.model.ListClustersRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListClustersRequest.Builder} avoiding the need to
* create one manually via {@link ListClustersRequest#builder()}
*
*
* @param listClustersRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.snowball.model.ListClustersRequest.Builder} to create a request.
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.ListClusters
* @see AWS API
* Documentation
*/
default ListClustersPublisher listClustersPaginator(Consumer listClustersRequest) {
return listClustersPaginator(ListClustersRequest.builder().applyMutation(listClustersRequest).build());
}
/**
*
* 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.
*
*
* @param listCompatibleImagesRequest
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.ListCompatibleImages
* @see AWS
* API Documentation
*/
default CompletableFuture listCompatibleImages(
ListCompatibleImagesRequest listCompatibleImagesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListCompatibleImagesRequest.Builder} avoiding the
* need to create one manually via {@link ListCompatibleImagesRequest#builder()}
*
*
* @param listCompatibleImagesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.snowball.model.ListCompatibleImagesRequest.Builder} to create a
* request.
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.ListCompatibleImages
* @see AWS
* API Documentation
*/
default CompletableFuture listCompatibleImages(
Consumer listCompatibleImagesRequest) {
return listCompatibleImages(ListCompatibleImagesRequest.builder().applyMutation(listCompatibleImagesRequest).build());
}
/**
*
* 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.
*
*
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.ListCompatibleImages
* @see AWS
* API Documentation
*/
default CompletableFuture listCompatibleImages() {
return listCompatibleImages(ListCompatibleImagesRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.ListCompatibleImagesPublisher publisher = client.listCompatibleImagesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.ListCompatibleImagesPublisher publisher = client.listCompatibleImagesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listCompatibleImages(software.amazon.awssdk.services.snowball.model.ListCompatibleImagesRequest)}
* operation.
*
*
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.ListCompatibleImages
* @see AWS
* API Documentation
*/
default ListCompatibleImagesPublisher listCompatibleImagesPaginator() {
return listCompatibleImagesPaginator(ListCompatibleImagesRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.ListCompatibleImagesPublisher publisher = client.listCompatibleImagesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.ListCompatibleImagesPublisher publisher = client.listCompatibleImagesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listCompatibleImages(software.amazon.awssdk.services.snowball.model.ListCompatibleImagesRequest)}
* operation.
*
*
* @param listCompatibleImagesRequest
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.ListCompatibleImages
* @see AWS
* API Documentation
*/
default ListCompatibleImagesPublisher listCompatibleImagesPaginator(ListCompatibleImagesRequest listCompatibleImagesRequest) {
return new ListCompatibleImagesPublisher(this, listCompatibleImagesRequest);
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.ListCompatibleImagesPublisher publisher = client.listCompatibleImagesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.ListCompatibleImagesPublisher publisher = client.listCompatibleImagesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listCompatibleImages(software.amazon.awssdk.services.snowball.model.ListCompatibleImagesRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListCompatibleImagesRequest.Builder} avoiding the
* need to create one manually via {@link ListCompatibleImagesRequest#builder()}
*
*
* @param listCompatibleImagesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.snowball.model.ListCompatibleImagesRequest.Builder} to create a
* request.
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.ListCompatibleImages
* @see AWS
* API Documentation
*/
default ListCompatibleImagesPublisher listCompatibleImagesPaginator(
Consumer listCompatibleImagesRequest) {
return listCompatibleImagesPaginator(ListCompatibleImagesRequest.builder().applyMutation(listCompatibleImagesRequest)
.build());
}
/**
*
* 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.
*
*
* @param listJobsRequest
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.ListJobs
* @see AWS API
* Documentation
*/
default CompletableFuture listJobs(ListJobsRequest listJobsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListJobsRequest.Builder} avoiding the need to
* create one manually via {@link ListJobsRequest#builder()}
*
*
* @param listJobsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.snowball.model.ListJobsRequest.Builder} to create a request.
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.ListJobs
* @see AWS API
* Documentation
*/
default CompletableFuture listJobs(Consumer listJobsRequest) {
return listJobs(ListJobsRequest.builder().applyMutation(listJobsRequest).build());
}
/**
*
* 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.
*
*
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.ListJobs
* @see AWS API
* Documentation
*/
default CompletableFuture listJobs() {
return listJobs(ListJobsRequest.builder().build());
}
/**
*
* This is a variant of {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listJobs(software.amazon.awssdk.services.snowball.model.ListJobsRequest)} operation.
*
*
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.ListJobs
* @see AWS API
* Documentation
*/
default ListJobsPublisher listJobsPaginator() {
return listJobsPaginator(ListJobsRequest.builder().build());
}
/**
*
* This is a variant of {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listJobs(software.amazon.awssdk.services.snowball.model.ListJobsRequest)} operation.
*
*
* @param listJobsRequest
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.ListJobs
* @see AWS API
* Documentation
*/
default ListJobsPublisher listJobsPaginator(ListJobsRequest listJobsRequest) {
return new ListJobsPublisher(this, listJobsRequest);
}
/**
*
* This is a variant of {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listJobs(software.amazon.awssdk.services.snowball.model.ListJobsRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListJobsRequest.Builder} avoiding the need to
* create one manually via {@link ListJobsRequest#builder()}
*
*
* @param listJobsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.snowball.model.ListJobsRequest.Builder} to create a request.
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.ListJobs
* @see AWS API
* Documentation
*/
default ListJobsPublisher listJobsPaginator(Consumer listJobsRequest) {
return listJobsPaginator(ListJobsRequest.builder().applyMutation(listJobsRequest).build());
}
/**
*
* Lists all long-term pricing types.
*
*
* @param listLongTermPricingRequest
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.ListLongTermPricing
* @see AWS
* API Documentation
*/
default CompletableFuture listLongTermPricing(
ListLongTermPricingRequest listLongTermPricingRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists all long-term pricing types.
*
*
*
* This is a convenience which creates an instance of the {@link ListLongTermPricingRequest.Builder} avoiding the
* need to create one manually via {@link ListLongTermPricingRequest#builder()}
*
*
* @param listLongTermPricingRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.snowball.model.ListLongTermPricingRequest.Builder} to create a
* request.
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.ListLongTermPricing
* @see AWS
* API Documentation
*/
default CompletableFuture listLongTermPricing(
Consumer listLongTermPricingRequest) {
return listLongTermPricing(ListLongTermPricingRequest.builder().applyMutation(listLongTermPricingRequest).build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.ListLongTermPricingPublisher publisher = client.listLongTermPricingPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.ListLongTermPricingPublisher publisher = client.listLongTermPricingPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listLongTermPricing(software.amazon.awssdk.services.snowball.model.ListLongTermPricingRequest)}
* operation.
*
*
* @param listLongTermPricingRequest
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.ListLongTermPricing
* @see AWS
* API Documentation
*/
default ListLongTermPricingPublisher listLongTermPricingPaginator(ListLongTermPricingRequest listLongTermPricingRequest) {
return new ListLongTermPricingPublisher(this, listLongTermPricingRequest);
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.ListLongTermPricingPublisher publisher = client.listLongTermPricingPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.ListLongTermPricingPublisher publisher = client.listLongTermPricingPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listLongTermPricing(software.amazon.awssdk.services.snowball.model.ListLongTermPricingRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListLongTermPricingRequest.Builder} avoiding the
* need to create one manually via {@link ListLongTermPricingRequest#builder()}
*
*
* @param listLongTermPricingRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.snowball.model.ListLongTermPricingRequest.Builder} to create a
* request.
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.ListLongTermPricing
* @see AWS
* API Documentation
*/
default ListLongTermPricingPublisher listLongTermPricingPaginator(
Consumer listLongTermPricingRequest) {
return listLongTermPricingPaginator(ListLongTermPricingRequest.builder().applyMutation(listLongTermPricingRequest)
.build());
}
/**
*
* A list of locations from which the customer can choose to pickup a device.
*
*
* @param listPickupLocationsRequest
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.ListPickupLocations
* @see AWS
* API Documentation
*/
default CompletableFuture listPickupLocations(
ListPickupLocationsRequest listPickupLocationsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* A list of locations from which the customer can choose to pickup a device.
*
*
*
* This is a convenience which creates an instance of the {@link ListPickupLocationsRequest.Builder} avoiding the
* need to create one manually via {@link ListPickupLocationsRequest#builder()}
*
*
* @param listPickupLocationsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.snowball.model.ListPickupLocationsRequest.Builder} to create a
* request.
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.ListPickupLocations
* @see AWS
* API Documentation
*/
default CompletableFuture listPickupLocations(
Consumer listPickupLocationsRequest) {
return listPickupLocations(ListPickupLocationsRequest.builder().applyMutation(listPickupLocationsRequest).build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.ListPickupLocationsPublisher publisher = client.listPickupLocationsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.ListPickupLocationsPublisher publisher = client.listPickupLocationsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listPickupLocations(software.amazon.awssdk.services.snowball.model.ListPickupLocationsRequest)}
* operation.
*
*
* @param listPickupLocationsRequest
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.ListPickupLocations
* @see AWS
* API Documentation
*/
default ListPickupLocationsPublisher listPickupLocationsPaginator(ListPickupLocationsRequest listPickupLocationsRequest) {
return new ListPickupLocationsPublisher(this, listPickupLocationsRequest);
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.ListPickupLocationsPublisher publisher = client.listPickupLocationsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.snowball.paginators.ListPickupLocationsPublisher publisher = client.listPickupLocationsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listPickupLocations(software.amazon.awssdk.services.snowball.model.ListPickupLocationsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListPickupLocationsRequest.Builder} avoiding the
* need to create one manually via {@link ListPickupLocationsRequest#builder()}
*
*
* @param listPickupLocationsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.snowball.model.ListPickupLocationsRequest.Builder} to create a
* request.
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.ListPickupLocations
* @see AWS
* API Documentation
*/
default ListPickupLocationsPublisher listPickupLocationsPaginator(
Consumer listPickupLocationsRequest) {
return listPickupLocationsPaginator(ListPickupLocationsRequest.builder().applyMutation(listPickupLocationsRequest)
.build());
}
/**
*
* Lists all supported versions for Snow on-device services. Returns an array of ServiceVersion object
* containing the supported versions for a particular service.
*
*
* @param listServiceVersionsRequest
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.ListServiceVersions
* @see AWS
* API Documentation
*/
default CompletableFuture listServiceVersions(
ListServiceVersionsRequest listServiceVersionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListServiceVersionsRequest.Builder} avoiding the
* need to create one manually via {@link ListServiceVersionsRequest#builder()}
*
*
* @param listServiceVersionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.snowball.model.ListServiceVersionsRequest.Builder} to create a
* request.
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.ListServiceVersions
* @see AWS
* API Documentation
*/
default CompletableFuture listServiceVersions(
Consumer listServiceVersionsRequest) {
return listServiceVersions(ListServiceVersionsRequest.builder().applyMutation(listServiceVersionsRequest).build());
}
/**
*
* 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.
*
*
* @param updateClusterRequest
* @return 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
* {@link 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 CreateClusterRequest$SnowballType value supports your
* CreateJobRequest$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.
*
* @sample SnowballAsyncClient.UpdateCluster
* @see AWS API
* Documentation
*/
default CompletableFuture updateCluster(UpdateClusterRequest updateClusterRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link UpdateClusterRequest.Builder} avoiding the need to
* create one manually via {@link UpdateClusterRequest#builder()}
*
*
* @param updateClusterRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.snowball.model.UpdateClusterRequest.Builder} to create a request.
* @return 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
* {@link 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 CreateClusterRequest$SnowballType value supports your
* CreateJobRequest$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.
*
* @sample SnowballAsyncClient.UpdateCluster
* @see AWS API
* Documentation
*/
default CompletableFuture updateCluster(Consumer updateClusterRequest) {
return updateCluster(UpdateClusterRequest.builder().applyMutation(updateClusterRequest).build());
}
/**
*
* 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.
*
*
* @param updateJobRequest
* @return 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
* {@link 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 CreateClusterRequest$SnowballType value supports your
* CreateJobRequest$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.
*
* @sample SnowballAsyncClient.UpdateJob
* @see AWS API
* Documentation
*/
default CompletableFuture updateJob(UpdateJobRequest updateJobRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link UpdateJobRequest.Builder} avoiding the need to
* create one manually via {@link UpdateJobRequest#builder()}
*
*
* @param updateJobRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.snowball.model.UpdateJobRequest.Builder} to create a request.
* @return 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
* {@link 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 CreateClusterRequest$SnowballType value supports your
* CreateJobRequest$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.
*
* @sample SnowballAsyncClient.UpdateJob
* @see AWS API
* Documentation
*/
default CompletableFuture updateJob(Consumer updateJobRequest) {
return updateJob(UpdateJobRequest.builder().applyMutation(updateJobRequest).build());
}
/**
*
* Updates the state when a shipment state changes to a different state.
*
*
* @param updateJobShipmentStateRequest
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.UpdateJobShipmentState
* @see AWS API Documentation
*/
default CompletableFuture updateJobShipmentState(
UpdateJobShipmentStateRequest updateJobShipmentStateRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Updates the state when a shipment state changes to a different state.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateJobShipmentStateRequest.Builder} avoiding the
* need to create one manually via {@link UpdateJobShipmentStateRequest#builder()}
*
*
* @param updateJobShipmentStateRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.snowball.model.UpdateJobShipmentStateRequest.Builder} to create a
* request.
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.UpdateJobShipmentState
* @see AWS API Documentation
*/
default CompletableFuture updateJobShipmentState(
Consumer updateJobShipmentStateRequest) {
return updateJobShipmentState(UpdateJobShipmentStateRequest.builder().applyMutation(updateJobShipmentStateRequest)
.build());
}
/**
*
* Updates the long-term pricing type.
*
*
* @param updateLongTermPricingRequest
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.UpdateLongTermPricing
* @see AWS API Documentation
*/
default CompletableFuture updateLongTermPricing(
UpdateLongTermPricingRequest updateLongTermPricingRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Updates the long-term pricing type.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateLongTermPricingRequest.Builder} avoiding the
* need to create one manually via {@link UpdateLongTermPricingRequest#builder()}
*
*
* @param updateLongTermPricingRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.snowball.model.UpdateLongTermPricingRequest.Builder} to create a
* request.
* @return 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
* {@link 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.
*
* @sample SnowballAsyncClient.UpdateLongTermPricing
* @see AWS API Documentation
*/
default CompletableFuture updateLongTermPricing(
Consumer updateLongTermPricingRequest) {
return updateLongTermPricing(UpdateLongTermPricingRequest.builder().applyMutation(updateLongTermPricingRequest).build());
}
@Override
default SnowballServiceClientConfiguration serviceClientConfiguration() {
throw new UnsupportedOperationException();
}
/**
* Create a {@link SnowballAsyncClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static SnowballAsyncClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link SnowballAsyncClient}.
*/
static SnowballAsyncClientBuilder builder() {
return new DefaultSnowballAsyncClientBuilder();
}
}