com.amazonaws.services.importexport

Class AmazonImportExportAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.importexport.AmazonImportExportClient

com.amazonaws.services.importexport.AmazonImportExportAsyncClient

All Implemented Interfaces:

AmazonImportExport, AmazonImportExportAsync

public class AmazonImportExportAsyncClient
extends AmazonImportExportClient
implements AmazonImportExportAsync

Asynchronous client for accessing AmazonImportExport. All asynchronous calls made using this client are non-blocking. Callers could either process the result and handle the exceptions in the worker thread by providing a callback handler when making the call, or use the returned Future object to check the result of the call in the calling thread. AWS Import/Export Service

AWS Import/Export accelerates transferring large amounts of data between the AWS cloud and portable storage devices that you mail to us. AWS Import/Export transfers data directly onto and off of your storage devices using Amazon's high-speed internal network and bypassing the Internet. For large data sets, AWS Import/Export is often faster than Internet transfer and more cost effective than upgrading your connectivity.

Constructor Summary

Constructors

Constructor and Description
AmazonImportExportAsyncClient() Constructs a new asynchronous client to invoke service methods on AmazonImportExport.
AmazonImportExportAsyncClient(AWSCredentials awsCredentials) Constructs a new asynchronous client to invoke service methods on AmazonImportExport using the specified AWS account credentials.
AmazonImportExportAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on AmazonImportExport using the specified AWS account credentials, executor service, and client configuration options.
AmazonImportExportAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on AmazonImportExport using the specified AWS account credentials and executor service.
AmazonImportExportAsyncClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new asynchronous client to invoke service methods on AmazonImportExport using the specified AWS account credentials provider.
AmazonImportExportAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new asynchronous client to invoke service methods on AmazonImportExport using the specified AWS account credentials provider and client configuration options.
AmazonImportExportAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on AmazonImportExport using the specified AWS account credentials provider, executor service, and client configuration options.
AmazonImportExportAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on AmazonImportExport using the specified AWS account credentials provider and executor service.
AmazonImportExportAsyncClient(ClientConfiguration clientConfiguration) Constructs a new asynchronous client to invoke service methods on AmazonImportExport.

Method Summary

Methods

Modifier and Type	Method and Description
Future<CancelJobResult>	cancelJobAsync(CancelJobRequest cancelJobRequest) This operation cancels a specified job.
Future<CancelJobResult>	cancelJobAsync(CancelJobRequest cancelJobRequest, AsyncHandler<CancelJobRequest,CancelJobResult> asyncHandler) This operation cancels a specified job.
Future<CreateJobResult>	createJobAsync(CreateJobRequest createJobRequest) This operation initiates the process of scheduling an upload or download of your data.
Future<CreateJobResult>	createJobAsync(CreateJobRequest createJobRequest, AsyncHandler<CreateJobRequest,CreateJobResult> asyncHandler) This operation initiates the process of scheduling an upload or download of your data.
ExecutorService	getExecutorService() Returns the executor service used by this async client to execute requests.
Future<GetStatusResult>	getStatusAsync(GetStatusRequest getStatusRequest) This operation returns information about a job, including where the job is in the processing pipeline, the status of the results, and the signature value associated with the job.
Future<GetStatusResult>	getStatusAsync(GetStatusRequest getStatusRequest, AsyncHandler<GetStatusRequest,GetStatusResult> asyncHandler) This operation returns information about a job, including where the job is in the processing pipeline, the status of the results, and the signature value associated with the job.
Future<ListJobsResult>	listJobsAsync(ListJobsRequest listJobsRequest) This operation returns the jobs associated with the requester.
Future<ListJobsResult>	listJobsAsync(ListJobsRequest listJobsRequest, AsyncHandler<ListJobsRequest,ListJobsResult> asyncHandler) This operation returns the jobs associated with the requester.
void	shutdown() Shuts down the client, releasing all managed resources.
Future<UpdateJobResult>	updateJobAsync(UpdateJobRequest updateJobRequest) You use this operation to change the parameters specified in the original manifest file by supplying a new manifest file.
Future<UpdateJobResult>	updateJobAsync(UpdateJobRequest updateJobRequest, AsyncHandler<UpdateJobRequest,UpdateJobResult> asyncHandler) You use this operation to change the parameters specified in the original manifest file by supplying a new manifest file.

Methods inherited from class com.amazonaws.services.importexport.AmazonImportExportClient

cancelJob, createJob, getCachedResponseMetadata, getStatus, listJobs, listJobs, updateJob

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, getRequestMetricsCollector, getServiceName, getTimeOffset, removeRequestHandler, removeRequestHandler, setConfiguration, setEndpoint, setEndpoint, setRegion, setTimeOffset, withTimeOffset

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amazonaws.services.importexport.AmazonImportExport

cancelJob, createJob, getCachedResponseMetadata, getStatus, listJobs, listJobs, setEndpoint, setRegion, updateJob

Constructor Detail

AmazonImportExportAsyncClient

public AmazonImportExportAsyncClient()

Constructs a new asynchronous client to invoke service methods on AmazonImportExport. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AmazonImportExportAsyncClient

public AmazonImportExportAsyncClient(ClientConfiguration clientConfiguration)

Constructs a new asynchronous client to invoke service methods on AmazonImportExport. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AmazonImportExport (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonImportExportAsyncClient

public AmazonImportExportAsyncClient(AWSCredentials awsCredentials)

Constructs a new asynchronous client to invoke service methods on AmazonImportExport using the specified AWS account credentials. Default client settings will be used, and a default cached thread pool will be created for executing the asynchronous tasks.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonImportExportAsyncClient

public AmazonImportExportAsyncClient(AWSCredentials awsCredentials,
                             ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AmazonImportExport using the specified AWS account credentials and executor service. Default client settings will be used.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

executorService - The executor service by which all asynchronous requests will be executed.

AmazonImportExportAsyncClient

public AmazonImportExportAsyncClient(AWSCredentials awsCredentials,
                             ClientConfiguration clientConfiguration,
                             ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AmazonImportExport using the specified AWS account credentials, executor service, and client configuration options.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

AmazonImportExportAsyncClient

public AmazonImportExportAsyncClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new asynchronous client to invoke service methods on AmazonImportExport using the specified AWS account credentials provider. Default client settings will be used, and a default cached thread pool will be created for executing the asynchronous tasks.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonImportExportAsyncClient

public AmazonImportExportAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                             ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AmazonImportExport using the specified AWS account credentials provider and executor service. Default client settings will be used.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

executorService - The executor service by which all asynchronous requests will be executed.

AmazonImportExportAsyncClient

public AmazonImportExportAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                             ClientConfiguration clientConfiguration)

Constructs a new asynchronous client to invoke service methods on AmazonImportExport using the specified AWS account credentials provider and client configuration options.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

AmazonImportExportAsyncClient

public AmazonImportExportAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                             ClientConfiguration clientConfiguration,
                             ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AmazonImportExport using the specified AWS account credentials provider, executor service, and client configuration options.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

Method Detail

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this async client to execute requests.

Returns:

The executor service used by this async client to execute requests.

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() prior to calling this method.

Specified by:

shutdown in interface AmazonImportExport

Overrides:

shutdown in class AmazonWebServiceClient

createJobAsync

public Future<CreateJobResult> createJobAsync(CreateJobRequest createJobRequest)
                                       throws AmazonServiceException,
                                              AmazonClientException

This operation initiates the process of scheduling an upload or download of your data. You include in the request a manifest that describes the data transfer specifics. The response to the request includes a job ID, which you can use in other operations, a signature that you use to identify your storage device, and the address where you should ship your storage device.

Specified by:

createJobAsync in interface AmazonImportExportAsync

Parameters:

createJobRequest - Container for the necessary parameters to execute the CreateJob operation on AmazonImportExport.

Returns:

A Java Future object containing the response from the CreateJob service method, as returned by AmazonImportExport.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonImportExport indicating either a problem with the data in the request, or a server side issue.

createJobAsync

public Future<CreateJobResult> createJobAsync(CreateJobRequest createJobRequest,
                                     AsyncHandler<CreateJobRequest,CreateJobResult> asyncHandler)
                                       throws AmazonServiceException,
                                              AmazonClientException

This operation initiates the process of scheduling an upload or download of your data. You include in the request a manifest that describes the data transfer specifics. The response to the request includes a job ID, which you can use in other operations, a signature that you use to identify your storage device, and the address where you should ship your storage device.

Specified by:

createJobAsync in interface AmazonImportExportAsync

Parameters:

createJobRequest - Container for the necessary parameters to execute the CreateJob operation on AmazonImportExport.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the CreateJob service method, as returned by AmazonImportExport.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonImportExport indicating either a problem with the data in the request, or a server side issue.

cancelJobAsync

public Future<CancelJobResult> cancelJobAsync(CancelJobRequest cancelJobRequest)
                                       throws AmazonServiceException,
                                              AmazonClientException

This operation cancels a specified job. Only the job owner can cancel it. The operation fails if the job has already started or is complete.

Specified by:

cancelJobAsync in interface AmazonImportExportAsync

Parameters:

cancelJobRequest - Container for the necessary parameters to execute the CancelJob operation on AmazonImportExport.

Returns:

A Java Future object containing the response from the CancelJob service method, as returned by AmazonImportExport.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonImportExport indicating either a problem with the data in the request, or a server side issue.

cancelJobAsync

public Future<CancelJobResult> cancelJobAsync(CancelJobRequest cancelJobRequest,
                                     AsyncHandler<CancelJobRequest,CancelJobResult> asyncHandler)
                                       throws AmazonServiceException,
                                              AmazonClientException

This operation cancels a specified job. Only the job owner can cancel it. The operation fails if the job has already started or is complete.

Specified by:

cancelJobAsync in interface AmazonImportExportAsync

Parameters:

cancelJobRequest - Container for the necessary parameters to execute the CancelJob operation on AmazonImportExport.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the CancelJob service method, as returned by AmazonImportExport.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonImportExport indicating either a problem with the data in the request, or a server side issue.

getStatusAsync

public Future<GetStatusResult> getStatusAsync(GetStatusRequest getStatusRequest)
                                       throws AmazonServiceException,
                                              AmazonClientException

This operation returns information about a job, including where the job is in the processing pipeline, the status of the results, and the signature value associated with the job. You can only return information about jobs you own.

Specified by:

getStatusAsync in interface AmazonImportExportAsync

Parameters:

getStatusRequest - Container for the necessary parameters to execute the GetStatus operation on AmazonImportExport.

Returns:

A Java Future object containing the response from the GetStatus service method, as returned by AmazonImportExport.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonImportExport indicating either a problem with the data in the request, or a server side issue.

getStatusAsync

public Future<GetStatusResult> getStatusAsync(GetStatusRequest getStatusRequest,
                                     AsyncHandler<GetStatusRequest,GetStatusResult> asyncHandler)
                                       throws AmazonServiceException,
                                              AmazonClientException

This operation returns information about a job, including where the job is in the processing pipeline, the status of the results, and the signature value associated with the job. You can only return information about jobs you own.

Specified by:

getStatusAsync in interface AmazonImportExportAsync

Parameters:

getStatusRequest - Container for the necessary parameters to execute the GetStatus operation on AmazonImportExport.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the GetStatus service method, as returned by AmazonImportExport.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonImportExport indicating either a problem with the data in the request, or a server side issue.

listJobsAsync

public Future<ListJobsResult> listJobsAsync(ListJobsRequest listJobsRequest)
                                     throws AmazonServiceException,
                                            AmazonClientException

This operation returns the jobs associated with the requester. AWS Import/Export lists the jobs in reverse chronological order based on the date of creation. For example if Job Test1 was created 2009Dec30 and Test2 was created 2010Feb05, the ListJobs operation would return Test2 followed by Test1.

Specified by:

listJobsAsync in interface AmazonImportExportAsync

Parameters:

listJobsRequest - Container for the necessary parameters to execute the ListJobs operation on AmazonImportExport.

Returns:

A Java Future object containing the response from the ListJobs service method, as returned by AmazonImportExport.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonImportExport indicating either a problem with the data in the request, or a server side issue.

listJobsAsync

public Future<ListJobsResult> listJobsAsync(ListJobsRequest listJobsRequest,
                                   AsyncHandler<ListJobsRequest,ListJobsResult> asyncHandler)
                                     throws AmazonServiceException,
                                            AmazonClientException

This operation returns the jobs associated with the requester. AWS Import/Export lists the jobs in reverse chronological order based on the date of creation. For example if Job Test1 was created 2009Dec30 and Test2 was created 2010Feb05, the ListJobs operation would return Test2 followed by Test1.

Specified by:

listJobsAsync in interface AmazonImportExportAsync

Parameters:

listJobsRequest - Container for the necessary parameters to execute the ListJobs operation on AmazonImportExport.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the ListJobs service method, as returned by AmazonImportExport.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonImportExport indicating either a problem with the data in the request, or a server side issue.

updateJobAsync

public Future<UpdateJobResult> updateJobAsync(UpdateJobRequest updateJobRequest)
                                       throws AmazonServiceException,
                                              AmazonClientException

You use this operation to change the parameters specified in the original manifest file by supplying a new manifest file. The manifest file attached to this request replaces the original manifest file. You can only use the operation after a CreateJob request but before the data transfer starts and you can only use it on jobs you own.

Specified by:

updateJobAsync in interface AmazonImportExportAsync

Parameters:

updateJobRequest - Container for the necessary parameters to execute the UpdateJob operation on AmazonImportExport.

Returns:

A Java Future object containing the response from the UpdateJob service method, as returned by AmazonImportExport.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonImportExport indicating either a problem with the data in the request, or a server side issue.

updateJobAsync

public Future<UpdateJobResult> updateJobAsync(UpdateJobRequest updateJobRequest,
                                     AsyncHandler<UpdateJobRequest,UpdateJobResult> asyncHandler)
                                       throws AmazonServiceException,
                                              AmazonClientException

You use this operation to change the parameters specified in the original manifest file by supplying a new manifest file. The manifest file attached to this request replaces the original manifest file. You can only use the operation after a CreateJob request but before the data transfer starts and you can only use it on jobs you own.

Specified by:

updateJobAsync in interface AmazonImportExportAsync

Parameters:

updateJobRequest - Container for the necessary parameters to execute the UpdateJob operation on AmazonImportExport.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the UpdateJob service method, as returned by AmazonImportExport.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonImportExport indicating either a problem with the data in the request, or a server side issue.