com.amazonaws.services.importexport

Interface AmazonImportExport

All Known Subinterfaces:

AmazonImportExportAsync

All Known Implementing Classes:

AmazonImportExportAsyncClient, AmazonImportExportClient

public interface AmazonImportExport

Interface for accessing AmazonImportExport. 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.

Method Summary

Methods

Modifier and Type	Method and Description
CancelJobResult	cancelJob(CancelJobRequest cancelJobRequest) This operation cancels a specified job.
CreateJobResult	createJob(CreateJobRequest createJobRequest) This operation initiates the process of scheduling an upload or download of your data.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetStatusResult	getStatus(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.
ListJobsResult	listJobs() This operation returns the jobs associated with the requester.
ListJobsResult	listJobs(ListJobsRequest listJobsRequest) This operation returns the jobs associated with the requester.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("https://importexport.amazonaws.com").
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateJobResult	updateJob(UpdateJobRequest updateJobRequest) You use this operation to change the parameters specified in the original manifest file by supplying a new manifest file.

Method Detail

setEndpoint

void setEndpoint(String endpoint)
                 throws IllegalArgumentException

Overrides the default endpoint for this client ("https://importexport.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "importexport.amazonaws.com") or a full URL, including the protocol (ex: "https://importexport.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "importexport.amazonaws.com") or a full URL, including the protocol (ex: "https://importexport.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

Throws:

IllegalArgumentException - If any problems are detected with the specified endpoint.

setRegion

void setRegion(Region region)
               throws IllegalArgumentException

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region.

Throws:

IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

createJob

CreateJobResult createJob(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.

Parameters:

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

Returns:

The response from the CreateJob service method, as returned by AmazonImportExport.

Throws:

MalformedManifestException

InvalidAddressException

BucketPermissionException

InvalidParameterException

MultipleRegionsException

MissingParameterException

InvalidFileSystemException

MissingCustomsException

NoSuchBucketException

InvalidAccessKeyIdException

InvalidManifestFieldException

InvalidCustomsException

MissingManifestFieldException

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.

cancelJob

CancelJobResult cancelJob(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.

Parameters:

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

Returns:

The response from the CancelJob service method, as returned by AmazonImportExport.

Throws:

CanceledJobIdException

ExpiredJobIdException

InvalidAccessKeyIdException

InvalidJobIdException

UnableToCancelJobIdException

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.

getStatus

GetStatusResult getStatus(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.

Parameters:

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

Returns:

The response from the GetStatus service method, as returned by AmazonImportExport.

Throws:

CanceledJobIdException

ExpiredJobIdException

InvalidAccessKeyIdException

InvalidJobIdException

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.

listJobs

ListJobsResult listJobs(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.

Parameters:

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

Returns:

The response from the ListJobs service method, as returned by AmazonImportExport.

Throws:

InvalidParameterException

InvalidAccessKeyIdException

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.

updateJob

UpdateJobResult updateJob(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.

Parameters:

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

Returns:

The response from the UpdateJob service method, as returned by AmazonImportExport.

Throws:

MalformedManifestException

BucketPermissionException

InvalidAddressException

InvalidParameterException

MultipleRegionsException

MissingParameterException

InvalidFileSystemException

CanceledJobIdException

MissingCustomsException

NoSuchBucketException

ExpiredJobIdException

InvalidAccessKeyIdException

InvalidCustomsException

InvalidManifestFieldException

MissingManifestFieldException

InvalidJobIdException

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.

listJobs

ListJobsResult listJobs()
                        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.

Returns:

The response from the ListJobs service method, as returned by AmazonImportExport.

Throws:

InvalidParameterException

InvalidAccessKeyIdException

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.

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.