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

Interface for accessing AWS Import/Export 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.

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.

Field Summary

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

exceptionUnmarshallers

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AmazonImportExportAsyncClient() Constructs a new asynchronous client to invoke service methods on AWS Import/Export.
AmazonImportExportAsyncClient(AWSCredentials awsCredentials) Constructs a new asynchronous client to invoke service methods on AWS Import/Export using the specified AWS account credentials.
AmazonImportExportAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on AWS Import/Export 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 AWS Import/Export using the specified AWS account credentials and executor service.
AmazonImportExportAsyncClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new asynchronous client to invoke service methods on AWS Import/Export using the specified AWS account credentials provider.
AmazonImportExportAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new asynchronous client to invoke service methods on AWS Import/Export using the provided 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 AWS Import/Export 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 AWS Import/Export using the specified AWS account credentials provider and executor service.
AmazonImportExportAsyncClient(ClientConfiguration clientConfiguration) Constructs a new asynchronous client to invoke service methods on AWS Import/Export.

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 client to execute async requests.
Future<GetShippingLabelResult>	getShippingLabelAsync(GetShippingLabelRequest getShippingLabelRequest) This operation generates a pre-paid UPS shipping label that you will use to ship your device to AWS for processing.
Future<GetShippingLabelResult>	getShippingLabelAsync(GetShippingLabelRequest getShippingLabelRequest, AsyncHandler<GetShippingLabelRequest,GetShippingLabelResult> asyncHandler) This operation generates a pre-paid UPS shipping label that you will use to ship your device to AWS for processing.
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() Simplified method form for invoking the ListJobs operation.
Future<ListJobsResult>	listJobsAsync(AsyncHandler<ListJobsRequest,ListJobsResult> asyncHandler) Simplified method form for invoking the ListJobs operation with an AsyncHandler.
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, getShippingLabel, getStatus, listJobs, listJobs, updateJob

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeMarshalling, configSigner, configSigner, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

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

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

Constructor Detail

AmazonImportExportAsyncClient

public AmazonImportExportAsyncClient()

Constructs a new asynchronous client to invoke service methods on AWS Import/Export. 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
• Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
• Instance profile credentials delivered through the Amazon EC2 metadata service

Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

See Also:

DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)

AmazonImportExportAsyncClient

public AmazonImportExportAsyncClient(ClientConfiguration clientConfiguration)

Constructs a new asynchronous client to invoke service methods on AWS Import/Export. 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
• Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
• Instance profile credentials delivered through the Amazon EC2 metadata service

Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().

Parameters:

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

See Also:

DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)

AmazonImportExportAsyncClient

public AmazonImportExportAsyncClient(AWSCredentials awsCredentials)

Constructs a new asynchronous client to invoke service methods on AWS Import/Export using the specified AWS account credentials.

Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

Parameters:

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

See Also:

Executors.newFixedThreadPool(int)

AmazonImportExportAsyncClient

public AmazonImportExportAsyncClient(AWSCredentials awsCredentials,
                             ExecutorService executorService)

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

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 AWS Import/Export using the specified AWS account credentials, executor service, and client configuration options.

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 AWS Import/Export using the specified AWS account credentials provider. Default client settings will be used.

Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

Parameters:

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

See Also:

Executors.newFixedThreadPool(int)

AmazonImportExportAsyncClient

public AmazonImportExportAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                             ClientConfiguration clientConfiguration)

Constructs a new asynchronous client to invoke service methods on AWS Import/Export using the provided AWS account credentials provider and client configuration options.

Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().

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).

See Also:

DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)

AmazonImportExportAsyncClient

public AmazonImportExportAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                             ExecutorService executorService)

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

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,
                             ExecutorService executorService)

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

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 client to execute async requests.

Returns:

The executor service used by this client to execute async 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() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AmazonImportExport

Overrides:

shutdown in class AmazonWebServiceClient

cancelJobAsync

public Future<CancelJobResult> cancelJobAsync(CancelJobRequest cancelJobRequest)

Description copied from interface: AmazonImportExportAsync

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 - Input structure for the CancelJob operation.

Returns:

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

cancelJobAsync

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

Description copied from interface: AmazonImportExportAsync

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 - Input structure for the CancelJob operation.

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.

createJobAsync

public Future<CreateJobResult> createJobAsync(CreateJobRequest createJobRequest)

Description copied from interface: AmazonImportExportAsync

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 - Input structure for the CreateJob operation.

Returns:

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

createJobAsync

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

Description copied from interface: AmazonImportExportAsync

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 - Input structure for the CreateJob operation.

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.

getShippingLabelAsync

public Future<GetShippingLabelResult> getShippingLabelAsync(GetShippingLabelRequest getShippingLabelRequest)

Description copied from interface: AmazonImportExportAsync

This operation generates a pre-paid UPS shipping label that you will use to ship your device to AWS for processing.

Specified by:

getShippingLabelAsync in interface AmazonImportExportAsync

Parameters:

getShippingLabelRequest - null

Returns:

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

getShippingLabelAsync

public Future<GetShippingLabelResult> getShippingLabelAsync(GetShippingLabelRequest getShippingLabelRequest,
                                                   AsyncHandler<GetShippingLabelRequest,GetShippingLabelResult> asyncHandler)

Description copied from interface: AmazonImportExportAsync

This operation generates a pre-paid UPS shipping label that you will use to ship your device to AWS for processing.

Specified by:

getShippingLabelAsync in interface AmazonImportExportAsync

Parameters:

getShippingLabelRequest - null

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 GetShippingLabel operation returned by the service.

getStatusAsync

public Future<GetStatusResult> getStatusAsync(GetStatusRequest getStatusRequest)

Description copied from interface: AmazonImportExportAsync

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 - Input structure for the GetStatus operation.

Returns:

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

getStatusAsync

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

Description copied from interface: AmazonImportExportAsync

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 - Input structure for the GetStatus operation.

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 GetStatus operation returned by the service.

listJobsAsync

public Future<ListJobsResult> listJobsAsync(ListJobsRequest listJobsRequest)

Description copied from interface: AmazonImportExportAsync

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 - Input structure for the ListJobs operation.

Returns:

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

listJobsAsync

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

Description copied from interface: AmazonImportExportAsync

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 - Input structure for the ListJobs operation.

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.

listJobsAsync

public Future<ListJobsResult> listJobsAsync()

Description copied from interface: AmazonImportExportAsync

Simplified method form for invoking the ListJobs operation.

Specified by:

listJobsAsync in interface AmazonImportExportAsync

See Also:

AmazonImportExportAsync.listJobsAsync(ListJobsRequest)

listJobsAsync

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

Simplified method form for invoking the ListJobs operation with an AsyncHandler.

Specified by:

listJobsAsync in interface AmazonImportExportAsync

See Also:

listJobsAsync(ListJobsRequest, com.amazonaws.handlers.AsyncHandler)

updateJobAsync

public Future<UpdateJobResult> updateJobAsync(UpdateJobRequest updateJobRequest)

Description copied from interface: AmazonImportExportAsync

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 - Input structure for the UpateJob operation.

Returns:

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

updateJobAsync

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

Description copied from interface: AmazonImportExportAsync

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 - Input structure for the UpateJob operation.

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.