com.amazonaws.services.snowball

Class AbstractAmazonSnowballAsync

java.lang.Object

com.amazonaws.services.snowball.AbstractAmazonSnowball

com.amazonaws.services.snowball.AbstractAmazonSnowballAsync

All Implemented Interfaces:

AmazonSnowball, AmazonSnowballAsync

public class AbstractAmazonSnowballAsync
extends AbstractAmazonSnowball
implements AmazonSnowballAsync

Abstract implementation of AmazonSnowballAsync. Convenient method forms pass through to the corresponding overload that takes a request object and an AsyncHandler, which throws an UnsupportedOperationException.

Field Summary

Fields inherited from interface com.amazonaws.services.snowball.AmazonSnowball

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
Future<CancelJobResult>	cancelJobAsync(CancelJobRequest request) Cancels the specified job.
Future<CancelJobResult>	cancelJobAsync(CancelJobRequest request, AsyncHandler<CancelJobRequest,CancelJobResult> asyncHandler) Cancels the specified job.
Future<CreateAddressResult>	createAddressAsync(CreateAddressRequest request) Creates an address for a Snowball to be shipped to.
Future<CreateAddressResult>	createAddressAsync(CreateAddressRequest request, AsyncHandler<CreateAddressRequest,CreateAddressResult> asyncHandler) Creates an address for a Snowball to be shipped to.
Future<CreateJobResult>	createJobAsync(CreateJobRequest request) Creates a job to import or export data between Amazon S3 and your on-premises data center.
Future<CreateJobResult>	createJobAsync(CreateJobRequest request, AsyncHandler<CreateJobRequest,CreateJobResult> asyncHandler) Creates a job to import or export data between Amazon S3 and your on-premises data center.
Future<DescribeAddressResult>	describeAddressAsync(DescribeAddressRequest request) Takes an AddressId and returns specific details about that address in the form of an Address object.
Future<DescribeAddressResult>	describeAddressAsync(DescribeAddressRequest request, AsyncHandler<DescribeAddressRequest,DescribeAddressResult> asyncHandler) Takes an AddressId and returns specific details about that address in the form of an Address object.
Future<DescribeAddressesResult>	describeAddressesAsync(DescribeAddressesRequest request) Returns a specified number of ADDRESS objects.
Future<DescribeAddressesResult>	describeAddressesAsync(DescribeAddressesRequest request, AsyncHandler<DescribeAddressesRequest,DescribeAddressesResult> asyncHandler) Returns a specified number of ADDRESS objects.
Future<DescribeJobResult>	describeJobAsync(DescribeJobRequest request) Returns information about a specific job including shipping information, job status, and other important metadata.
Future<DescribeJobResult>	describeJobAsync(DescribeJobRequest request, AsyncHandler<DescribeJobRequest,DescribeJobResult> asyncHandler) Returns information about a specific job including shipping information, job status, and other important metadata.
Future<GetJobManifestResult>	getJobManifestAsync(GetJobManifestRequest request) Returns a link to an Amazon S3 pre-signed URL for the manifest file associated with the specified JobId value.
Future<GetJobManifestResult>	getJobManifestAsync(GetJobManifestRequest request, AsyncHandler<GetJobManifestRequest,GetJobManifestResult> asyncHandler) Returns a link to an Amazon S3 pre-signed URL for the manifest file associated with the specified JobId value.
Future<GetJobUnlockCodeResult>	getJobUnlockCodeAsync(GetJobUnlockCodeRequest request) Returns the UnlockCode code value for the specified job.
Future<GetJobUnlockCodeResult>	getJobUnlockCodeAsync(GetJobUnlockCodeRequest request, AsyncHandler<GetJobUnlockCodeRequest,GetJobUnlockCodeResult> asyncHandler) Returns the UnlockCode code value for the specified job.
Future<GetSnowballUsageResult>	getSnowballUsageAsync(GetSnowballUsageRequest request) Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use.
Future<GetSnowballUsageResult>	getSnowballUsageAsync(GetSnowballUsageRequest request, AsyncHandler<GetSnowballUsageRequest,GetSnowballUsageResult> asyncHandler) Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use.
Future<ListJobsResult>	listJobsAsync(ListJobsRequest request) Returns an array of JobListEntry objects of the specified length.
Future<ListJobsResult>	listJobsAsync(ListJobsRequest request, AsyncHandler<ListJobsRequest,ListJobsResult> asyncHandler) Returns an array of JobListEntry objects of the specified length.
Future<UpdateJobResult>	updateJobAsync(UpdateJobRequest request) While a job's JobState value is New, you can update some of the information associated with a job.
Future<UpdateJobResult>	updateJobAsync(UpdateJobRequest request, AsyncHandler<UpdateJobRequest,UpdateJobResult> asyncHandler) While a job's JobState value is New, you can update some of the information associated with a job.

Methods inherited from class com.amazonaws.services.snowball.AbstractAmazonSnowball

cancelJob, createAddress, createJob, describeAddress, describeAddresses, describeJob, getCachedResponseMetadata, getJobManifest, getJobUnlockCode, getSnowballUsage, listJobs, setEndpoint, setRegion, shutdown, updateJob

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.snowball.AmazonSnowball

cancelJob, createAddress, createJob, describeAddress, describeAddresses, describeJob, getCachedResponseMetadata, getJobManifest, getJobUnlockCode, getSnowballUsage, listJobs, setEndpoint, setRegion, shutdown, updateJob

Method Detail

cancelJobAsync

public Future<CancelJobResult> cancelJobAsync(CancelJobRequest request)

Description copied from interface: AmazonSnowballAsync

Cancels the specified job. Note that 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.

Specified by:

cancelJobAsync in interface AmazonSnowballAsync

Returns:

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

cancelJobAsync

public Future<CancelJobResult> cancelJobAsync(CancelJobRequest request,
                                              AsyncHandler<CancelJobRequest,CancelJobResult> asyncHandler)

Description copied from interface: AmazonSnowballAsync

Cancels the specified job. Note that 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.

Specified by:

cancelJobAsync in interface AmazonSnowballAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

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

createAddressAsync

public Future<CreateAddressResult> createAddressAsync(CreateAddressRequest request)

Description copied from interface: AmazonSnowballAsync

Creates an address for a Snowball to be shipped to.

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.

Specified by:

createAddressAsync in interface AmazonSnowballAsync

Returns:

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

createAddressAsync

public Future<CreateAddressResult> createAddressAsync(CreateAddressRequest request,
                                                      AsyncHandler<CreateAddressRequest,CreateAddressResult> asyncHandler)

Description copied from interface: AmazonSnowballAsync

Creates an address for a Snowball to be shipped to.

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.

Specified by:

createAddressAsync in interface AmazonSnowballAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

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

createJobAsync

public Future<CreateJobResult> createJobAsync(CreateJobRequest request)

Description copied from interface: AmazonSnowballAsync

Creates a job to import or export data between Amazon S3 and your on-premises data center. Note that your AWS account must have the right trust policies and permissions in place to create job for Snowball. For more information, see api-reference-policies.

Specified by:

createJobAsync in interface AmazonSnowballAsync

Returns:

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

createJobAsync

public Future<CreateJobResult> createJobAsync(CreateJobRequest request,
                                              AsyncHandler<CreateJobRequest,CreateJobResult> asyncHandler)

Description copied from interface: AmazonSnowballAsync

Creates a job to import or export data between Amazon S3 and your on-premises data center. Note that your AWS account must have the right trust policies and permissions in place to create job for Snowball. For more information, see api-reference-policies.

Specified by:

createJobAsync in interface AmazonSnowballAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

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

describeAddressAsync

public Future<DescribeAddressResult> describeAddressAsync(DescribeAddressRequest request)

Description copied from interface: AmazonSnowballAsync

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

Specified by:

describeAddressAsync in interface AmazonSnowballAsync

Returns:

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

describeAddressAsync

public Future<DescribeAddressResult> describeAddressAsync(DescribeAddressRequest request,
                                                          AsyncHandler<DescribeAddressRequest,DescribeAddressResult> asyncHandler)

Description copied from interface: AmazonSnowballAsync

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

Specified by:

describeAddressAsync in interface AmazonSnowballAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

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

describeAddressesAsync

public Future<DescribeAddressesResult> describeAddressesAsync(DescribeAddressesRequest request)

Description copied from interface: AmazonSnowballAsync

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.

Specified by:

describeAddressesAsync in interface AmazonSnowballAsync

Returns:

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

describeAddressesAsync

public Future<DescribeAddressesResult> describeAddressesAsync(DescribeAddressesRequest request,
                                                              AsyncHandler<DescribeAddressesRequest,DescribeAddressesResult> asyncHandler)

Description copied from interface: AmazonSnowballAsync

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.

Specified by:

describeAddressesAsync in interface AmazonSnowballAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

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

describeJobAsync

public Future<DescribeJobResult> describeJobAsync(DescribeJobRequest request)

Description copied from interface: AmazonSnowballAsync

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

Specified by:

describeJobAsync in interface AmazonSnowballAsync

Returns:

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

describeJobAsync

public Future<DescribeJobResult> describeJobAsync(DescribeJobRequest request,
                                                  AsyncHandler<DescribeJobRequest,DescribeJobResult> asyncHandler)

Description copied from interface: AmazonSnowballAsync

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

Specified by:

describeJobAsync in interface AmazonSnowballAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

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

getJobManifestAsync

public Future<GetJobManifestResult> getJobManifestAsync(GetJobManifestRequest request)

Description copied from interface: AmazonSnowballAsync

Returns a link to an Amazon S3 pre-signed 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.

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

Specified by:

getJobManifestAsync in interface AmazonSnowballAsync

Returns:

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

getJobManifestAsync

public Future<GetJobManifestResult> getJobManifestAsync(GetJobManifestRequest request,
                                                        AsyncHandler<GetJobManifestRequest,GetJobManifestResult> asyncHandler)

Description copied from interface: AmazonSnowballAsync

Returns a link to an Amazon S3 pre-signed 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.

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

Specified by:

getJobManifestAsync in interface AmazonSnowballAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

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

getJobUnlockCodeAsync

public Future<GetJobUnlockCodeResult> getJobUnlockCodeAsync(GetJobUnlockCodeRequest request)

Description copied from interface: AmazonSnowballAsync

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.

Specified by:

getJobUnlockCodeAsync in interface AmazonSnowballAsync

Returns:

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

getJobUnlockCodeAsync

public Future<GetJobUnlockCodeResult> getJobUnlockCodeAsync(GetJobUnlockCodeRequest request,
                                                            AsyncHandler<GetJobUnlockCodeRequest,GetJobUnlockCodeResult> asyncHandler)

Description copied from interface: AmazonSnowballAsync

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.

Specified by:

getJobUnlockCodeAsync in interface AmazonSnowballAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

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

getSnowballUsageAsync

public Future<GetSnowballUsageResult> getSnowballUsageAsync(GetSnowballUsageRequest request)

Description copied from interface: AmazonSnowballAsync

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

Note that 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.

Specified by:

getSnowballUsageAsync in interface AmazonSnowballAsync

Returns:

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

getSnowballUsageAsync

public Future<GetSnowballUsageResult> getSnowballUsageAsync(GetSnowballUsageRequest request,
                                                            AsyncHandler<GetSnowballUsageRequest,GetSnowballUsageResult> asyncHandler)

Description copied from interface: AmazonSnowballAsync

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

Note that 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.

Specified by:

getSnowballUsageAsync in interface AmazonSnowballAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

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

listJobsAsync

public Future<ListJobsResult> listJobsAsync(ListJobsRequest request)

Description copied from interface: AmazonSnowballAsync

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

Specified by:

listJobsAsync in interface AmazonSnowballAsync

Returns:

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

listJobsAsync

public Future<ListJobsResult> listJobsAsync(ListJobsRequest request,
                                            AsyncHandler<ListJobsRequest,ListJobsResult> asyncHandler)

Description copied from interface: AmazonSnowballAsync

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

Specified by:

listJobsAsync in interface AmazonSnowballAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

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

updateJobAsync

public Future<UpdateJobResult> updateJobAsync(UpdateJobRequest request)

Description copied from interface: AmazonSnowballAsync

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.

Specified by:

updateJobAsync in interface AmazonSnowballAsync

Returns:

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

updateJobAsync

public Future<UpdateJobResult> updateJobAsync(UpdateJobRequest request,
                                              AsyncHandler<UpdateJobRequest,UpdateJobResult> asyncHandler)

Description copied from interface: AmazonSnowballAsync

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.

Specified by:

updateJobAsync in interface AmazonSnowballAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

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