Package software.amazon.awssdk.services.snowball

Interface SnowballAsyncClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface SnowballAsyncClient
extends AutoCloseable

Service client for accessing Amazon Snowball asynchronously. This can be created using the static builder() method.

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

Method Summary

Modifier and Type	Method	Description
static SnowballAsyncClientBuilder	builder()	Create a builder that can be used to configure and create a SnowballAsyncClient.
default CompletableFuture<CancelClusterResponse>	cancelCluster(CancelClusterRequest cancelClusterRequest)	Cancels a cluster job.
default CompletableFuture<CancelJobResponse>	cancelJob(CancelJobRequest cancelJobRequest)	Cancels the specified job.
static SnowballAsyncClient	create()	Create a SnowballAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<CreateAddressResponse>	createAddress(CreateAddressRequest createAddressRequest)	Creates an address for a Snowball to be shipped to.
default CompletableFuture<CreateClusterResponse>	createCluster(CreateClusterRequest createClusterRequest)	Creates an empty cluster.
default CompletableFuture<CreateJobResponse>	createJob(CreateJobRequest createJobRequest)	Creates a job to the other job attributes are inherited from the cluster.
default CompletableFuture<DescribeAddressResponse>	describeAddress(DescribeAddressRequest describeAddressRequest)	Takes an AddressId and returns specific details about that address in the form of an Address object.
default CompletableFuture<DescribeAddressesResponse>	describeAddresses(DescribeAddressesRequest describeAddressesRequest)	Returns a specified number of ADDRESS objects.
default CompletableFuture<DescribeClusterResponse>	describeCluster(DescribeClusterRequest describeClusterRequest)	Returns information about a specific cluster including shipping information, cluster status, and other important metadata.
default CompletableFuture<DescribeJobResponse>	describeJob(DescribeJobRequest describeJobRequest)	Returns information about a specific job including shipping information, job status, and other important metadata.
default CompletableFuture<GetJobManifestResponse>	getJobManifest(GetJobManifestRequest getJobManifestRequest)	Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId value.
default CompletableFuture<GetJobUnlockCodeResponse>	getJobUnlockCode(GetJobUnlockCodeRequest getJobUnlockCodeRequest)	Returns the UnlockCode code value for the specified job.
default CompletableFuture<GetSnowballUsageResponse>	getSnowballUsage(GetSnowballUsageRequest getSnowballUsageRequest)	Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use.
default CompletableFuture<ListClusterJobsResponse>	listClusterJobs(ListClusterJobsRequest listClusterJobsRequest)	Returns an array of JobListEntry objects of the specified length.
default CompletableFuture<ListClustersResponse>	listClusters(ListClustersRequest listClustersRequest)	Returns an array of ClusterListEntry objects of the specified length.
default CompletableFuture<ListJobsResponse>	listJobs(ListJobsRequest listJobsRequest)	Returns an array of JobListEntry objects of the specified length.
default CompletableFuture<UpdateClusterResponse>	updateCluster(UpdateClusterRequest updateClusterRequest)	While a cluster's ClusterState value is in the AwaitingQuorum state, you can update some of the information associated with a cluster.
default CompletableFuture<UpdateJobResponse>	updateJob(UpdateJobRequest updateJobRequest)	While a job's JobState value is New, you can update some of the information associated with a job.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

create

static SnowballAsyncClient create()

Create a SnowballAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static SnowballAsyncClientBuilder builder()

Create a builder that can be used to configure and create a SnowballAsyncClient.

cancelCluster

default CompletableFuture<CancelClusterResponse> cancelCluster(CancelClusterRequest cancelClusterRequest)

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

Parameters:

cancelClusterRequest -

Returns:

A Java Future containing the result of the CancelCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• KMSRequestFailedException The provided AWS 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.
• SdkBaseException 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

See Also:

AWS API Documentation

cancelJob

default CompletableFuture<CancelJobResponse> cancelJob(CancelJobRequest cancelJobRequest)

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

Parameters:

cancelJobRequest -

Returns:

A Java Future containing the result of the CancelJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.
• SdkBaseException 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

See Also:

AWS API Documentation

createAddress

default CompletableFuture<CreateAddressResponse> createAddress(CreateAddressRequest createAddressRequest)

Creates an address for a Snowball 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.

Parameters:

createAddressRequest -

Returns:

A Java Future containing the result of the CreateAddress operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Support.
• SdkBaseException 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

See Also:

AWS API Documentation

createCluster

default CompletableFuture<CreateClusterResponse> createCluster(CreateClusterRequest createClusterRequest)

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

Parameters:

createClusterRequest -

Returns:

A Java Future containing the result of the CreateCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
• KMSRequestFailedException The provided AWS Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.
• InvalidInputCombinationException Job or cluster creation failed. One ore more inputs were invalid. Confirm that the CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try again.
• SdkBaseException 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

See Also:

AWS API Documentation

createJob

default CompletableFuture<CreateJobResponse> createJob(CreateJobRequest createJobRequest)

Creates a job to the other job attributes are inherited from the cluster.

Parameters:

createJobRequest -

Returns:

A Java Future containing the result of the CreateJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
• KMSRequestFailedException The provided AWS Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.
• InvalidInputCombinationException Job or cluster creation failed. One ore 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 less 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 notes.
• SdkBaseException 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

See Also:

AWS API Documentation

describeAddress

default CompletableFuture<DescribeAddressResponse> describeAddress(DescribeAddressRequest describeAddressRequest)

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

Parameters:

describeAddressRequest -

Returns:

A Java Future containing the result of the DescribeAddress operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
• SdkBaseException 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

See Also:

AWS API Documentation

describeAddresses

default CompletableFuture<DescribeAddressesResponse> describeAddresses(DescribeAddressesRequest describeAddressesRequest)

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

Parameters:

describeAddressesRequest -

Returns:

A Java Future containing the result of the DescribeAddresses operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException 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

See Also:

AWS API Documentation

describeCluster

default CompletableFuture<DescribeClusterResponse> describeCluster(DescribeClusterRequest describeClusterRequest)

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

Parameters:

describeClusterRequest -

Returns:

A Java Future containing the result of the DescribeCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
• SdkBaseException 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

See Also:

AWS API Documentation

describeJob

default CompletableFuture<DescribeJobResponse> describeJob(DescribeJobRequest describeJobRequest)

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

Parameters:

describeJobRequest -

Returns:

A Java Future containing the result of the DescribeJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
• SdkBaseException 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

See Also:

AWS API Documentation

getJobManifest

default CompletableFuture<GetJobManifestResponse> getJobManifest(GetJobManifestRequest getJobManifestRequest)

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

The manifest is an encrypted file that you can download after your job enters the WithCustomer status. The manifest is decrypted by using the UnlockCode code value, when you pass both values to the Snowball 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 Snowball associated with that job.

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

Parameters:

getJobManifestRequest -

Returns:

A Java Future containing the result of the GetJobManifest operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException 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

See Also:

AWS API Documentation

getJobUnlockCode

default CompletableFuture<GetJobUnlockCodeResponse> getJobUnlockCode(GetJobUnlockCodeRequest getJobUnlockCodeRequest)

Returns the UnlockCode code value for the specified job. A particular UnlockCode value can be accessed for up to 90 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 Snowball 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 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 Snowball associated with that job.

Parameters:

getJobUnlockCodeRequest -

Returns:

A Java Future containing the result of the GetJobUnlockCode operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException 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

See Also:

AWS API Documentation

getSnowballUsage

default CompletableFuture<GetSnowballUsageResponse> getSnowballUsage(GetSnowballUsageRequest getSnowballUsageRequest)

Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use.

The default service limit for the number of Snowballs that you can have at one time is 1. If you want to increase your service limit, contact AWS Support.

Parameters:

getSnowballUsageRequest -

Returns:

A Java Future containing the result of the GetSnowballUsage operation returned by the service.

See Also:

AWS API Documentation

listClusterJobs

default CompletableFuture<ListClusterJobsResponse> listClusterJobs(ListClusterJobsRequest listClusterJobsRequest)

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

Parameters:

listClusterJobsRequest -

Returns:

A Java Future containing the result of the ListClusterJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException 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

See Also:

AWS API Documentation

listClusters

default CompletableFuture<ListClustersResponse> listClusters(ListClustersRequest listClustersRequest)

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

Parameters:

listClustersRequest -

Returns:

A Java Future containing the result of the ListClusters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
• SdkBaseException 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

See Also:

AWS API Documentation

listJobs

default CompletableFuture<ListJobsResponse> listJobs(ListJobsRequest listJobsRequest)

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

Parameters:

listJobsRequest -

Returns:

A Java Future containing the result of the ListJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
• SdkBaseException 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

See Also:

AWS API Documentation

updateCluster

default CompletableFuture<UpdateClusterResponse> updateCluster(UpdateClusterRequest updateClusterRequest)

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

Parameters:

updateClusterRequest -

Returns:

A Java Future containing the result of the UpdateCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.
• InvalidInputCombinationException Job or cluster creation failed. One ore more inputs were invalid. Confirm that the CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try again.
• SdkBaseException 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

See Also:

AWS API Documentation

updateJob

default CompletableFuture<UpdateJobResponse> updateJob(UpdateJobRequest updateJobRequest)

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

Parameters:

updateJobRequest -

Returns:

A Java Future containing the result of the UpdateJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.
• InvalidInputCombinationException Job or cluster creation failed. One ore 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 less 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 notes.
• SdkBaseException 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

See Also:

AWS API Documentation