com.amazonaws.services.snowball

Interface AmazonSnowballAsync

All Superinterfaces:

AmazonSnowball

All Known Implementing Classes:

AbstractAmazonSnowballAsync, AmazonSnowballAsyncClient

public interface AmazonSnowballAsync
extends AmazonSnowball

Interface for accessing Amazon Snowball asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

This is a test of the welcome page front matter.

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 cancelJobRequest) Cancels the specified job.
Future<CancelJobResult>	cancelJobAsync(CancelJobRequest cancelJobRequest, AsyncHandler<CancelJobRequest,CancelJobResult> asyncHandler) Cancels the specified job.
Future<CreateAddressResult>	createAddressAsync(CreateAddressRequest createAddressRequest) Creates an address for a Snowball to be shipped to.
Future<CreateAddressResult>	createAddressAsync(CreateAddressRequest createAddressRequest, AsyncHandler<CreateAddressRequest,CreateAddressResult> asyncHandler) Creates an address for a Snowball to be shipped to.
Future<CreateJobResult>	createJobAsync(CreateJobRequest createJobRequest) Creates a job to import or export data between Amazon S3 and your on-premises data center.
Future<CreateJobResult>	createJobAsync(CreateJobRequest createJobRequest, 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 describeAddressRequest) Takes an AddressId and returns specific details about that address in the form of an Address object.
Future<DescribeAddressResult>	describeAddressAsync(DescribeAddressRequest describeAddressRequest, 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 describeAddressesRequest) Returns a specified number of ADDRESS objects.
Future<DescribeAddressesResult>	describeAddressesAsync(DescribeAddressesRequest describeAddressesRequest, AsyncHandler<DescribeAddressesRequest,DescribeAddressesResult> asyncHandler) Returns a specified number of ADDRESS objects.
Future<DescribeJobResult>	describeJobAsync(DescribeJobRequest describeJobRequest) Returns information about a specific job including shipping information, job status, and other important metadata.
Future<DescribeJobResult>	describeJobAsync(DescribeJobRequest describeJobRequest, AsyncHandler<DescribeJobRequest,DescribeJobResult> asyncHandler) Returns information about a specific job including shipping information, job status, and other important metadata.
Future<GetJobManifestResult>	getJobManifestAsync(GetJobManifestRequest getJobManifestRequest) Returns a link to an Amazon S3 pre-signed URL for the manifest file associated with the specified JobId value.
Future<GetJobManifestResult>	getJobManifestAsync(GetJobManifestRequest getJobManifestRequest, 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 getJobUnlockCodeRequest) Returns the UnlockCode code value for the specified job.
Future<GetJobUnlockCodeResult>	getJobUnlockCodeAsync(GetJobUnlockCodeRequest getJobUnlockCodeRequest, AsyncHandler<GetJobUnlockCodeRequest,GetJobUnlockCodeResult> asyncHandler) Returns the UnlockCode code value for the specified job.
Future<GetSnowballUsageResult>	getSnowballUsageAsync(GetSnowballUsageRequest getSnowballUsageRequest) 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 getSnowballUsageRequest, 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 listJobsRequest) Returns an array of JobListEntry objects of the specified length.
Future<ListJobsResult>	listJobsAsync(ListJobsRequest listJobsRequest, AsyncHandler<ListJobsRequest,ListJobsResult> asyncHandler) Returns an array of JobListEntry objects of the specified length.
Future<UpdateJobResult>	updateJobAsync(UpdateJobRequest updateJobRequest) While a job's JobState value is New, you can update some of the information associated with a job.
Future<UpdateJobResult>	updateJobAsync(UpdateJobRequest updateJobRequest, 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 interface com.amazonaws.services.snowball.AmazonSnowball

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

Method Detail

cancelJobAsync

Future<CancelJobResult> cancelJobAsync(CancelJobRequest cancelJobRequest)

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.

Parameters:

cancelJobRequest -

Returns:

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

cancelJobAsync

Future<CancelJobResult> cancelJobAsync(CancelJobRequest cancelJobRequest,
                                       AsyncHandler<CancelJobRequest,CancelJobResult> asyncHandler)

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.

Parameters:

cancelJobRequest -

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

Future<CreateAddressResult> createAddressAsync(CreateAddressRequest createAddressRequest)

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.

Parameters:

createAddressRequest -

Returns:

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

createAddressAsync

Future<CreateAddressResult> createAddressAsync(CreateAddressRequest createAddressRequest,
                                               AsyncHandler<CreateAddressRequest,CreateAddressResult> asyncHandler)

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.

Parameters:

createAddressRequest -

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

Future<CreateJobResult> createJobAsync(CreateJobRequest createJobRequest)

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.

Parameters:

createJobRequest -

Returns:

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

createJobAsync

Future<CreateJobResult> createJobAsync(CreateJobRequest createJobRequest,
                                       AsyncHandler<CreateJobRequest,CreateJobResult> asyncHandler)

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.

Parameters:

createJobRequest -

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

Future<DescribeAddressResult> describeAddressAsync(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.

describeAddressAsync

Future<DescribeAddressResult> describeAddressAsync(DescribeAddressRequest describeAddressRequest,
                                                   AsyncHandler<DescribeAddressRequest,DescribeAddressResult> asyncHandler)

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

Parameters:

describeAddressRequest -

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

Future<DescribeAddressesResult> describeAddressesAsync(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.

describeAddressesAsync

Future<DescribeAddressesResult> describeAddressesAsync(DescribeAddressesRequest describeAddressesRequest,
                                                       AsyncHandler<DescribeAddressesRequest,DescribeAddressesResult> asyncHandler)

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 -

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

Future<DescribeJobResult> describeJobAsync(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.

describeJobAsync

Future<DescribeJobResult> describeJobAsync(DescribeJobRequest describeJobRequest,
                                           AsyncHandler<DescribeJobRequest,DescribeJobResult> asyncHandler)

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

Parameters:

describeJobRequest -

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

Future<GetJobManifestResult> getJobManifestAsync(GetJobManifestRequest getJobManifestRequest)

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.

Parameters:

getJobManifestRequest -

Returns:

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

getJobManifestAsync

Future<GetJobManifestResult> getJobManifestAsync(GetJobManifestRequest getJobManifestRequest,
                                                 AsyncHandler<GetJobManifestRequest,GetJobManifestResult> asyncHandler)

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.

Parameters:

getJobManifestRequest -

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

Future<GetJobUnlockCodeResult> getJobUnlockCodeAsync(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.

getJobUnlockCodeAsync

Future<GetJobUnlockCodeResult> getJobUnlockCodeAsync(GetJobUnlockCodeRequest getJobUnlockCodeRequest,
                                                     AsyncHandler<GetJobUnlockCodeRequest,GetJobUnlockCodeResult> asyncHandler)

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 -

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

Future<GetSnowballUsageResult> getSnowballUsageAsync(GetSnowballUsageRequest getSnowballUsageRequest)

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.

Parameters:

getSnowballUsageRequest -

Returns:

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

getSnowballUsageAsync

Future<GetSnowballUsageResult> getSnowballUsageAsync(GetSnowballUsageRequest getSnowballUsageRequest,
                                                     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.

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.

Parameters:

getSnowballUsageRequest -

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

Future<ListJobsResult> listJobsAsync(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 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.

Parameters:

listJobsRequest -

Returns:

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

listJobsAsync

Future<ListJobsResult> listJobsAsync(ListJobsRequest listJobsRequest,
                                     AsyncHandler<ListJobsRequest,ListJobsResult> asyncHandler)

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.

Parameters:

listJobsRequest -

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

Future<UpdateJobResult> updateJobAsync(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.

updateJobAsync

Future<UpdateJobResult> updateJobAsync(UpdateJobRequest updateJobRequest,
                                       AsyncHandler<UpdateJobRequest,UpdateJobResult> asyncHandler)

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 -

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.