com.amazonaws.services.importexport

Interface AmazonImportExport

All Known Subinterfaces:

AmazonImportExportAsync

All Known Implementing Classes:

AbstractAmazonImportExport, AbstractAmazonImportExportAsync, AmazonImportExportAsyncClient, AmazonImportExportClient

public interface AmazonImportExport

Interface for accessing AWS Import/Export.

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

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

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.
GetShippingLabelResult	getShippingLabel(GetShippingLabelRequest getShippingLabelRequest) This operation generates a pre-paid UPS shipping label that you will use to ship your device to AWS for processing.
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() Simplified method form for invoking the ListJobs operation.
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.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

setEndpoint

void setEndpoint(String endpoint)

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.

setRegion

void setRegion(Region region)

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. Must not be null and must be a region where the service is available.

See Also:

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

cancelJob

CancelJobResult cancelJob(CancelJobRequest cancelJobRequest)

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

Returns:

Result of the CancelJob operation returned by the service.

Throws:

InvalidJobIdException - The JOBID was missing, not found, or not associated with the AWS account.

ExpiredJobIdException - Indicates that the specified job has expired out of the system.

CanceledJobIdException - The specified job ID has been canceled and is no longer valid.

UnableToCancelJobIdException - AWS Import/Export cannot cancel the job

InvalidAccessKeyIdException - The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID.

InvalidVersionException - The client tool version is invalid.

createJob

CreateJobResult createJob(CreateJobRequest createJobRequest)

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

Returns:

Result of the CreateJob operation returned by the service.

Throws:

MissingParameterException - One or more required parameters was missing from the request.

InvalidParameterException - One or more parameters had an invalid value.

InvalidAccessKeyIdException - The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID.

InvalidAddressException - The address specified in the manifest is invalid.

InvalidManifestFieldException - One or more manifest fields was invalid. Please correct and resubmit.

MissingManifestFieldException - One or more required fields were missing from the manifest file. Please correct and resubmit.

NoSuchBucketException - The specified bucket does not exist. Create the specified bucket or change the manifest's bucket, exportBucket, or logBucket field to a bucket that the account, as specified by the manifest's Access Key ID, has write permissions to.

MissingCustomsException - One or more required customs parameters was missing from the manifest.

InvalidCustomsException - One or more customs parameters was invalid. Please correct and resubmit.

InvalidFileSystemException - File system specified in export manifest is invalid.

MultipleRegionsException - Your manifest file contained buckets from multiple regions. A job is restricted to buckets from one region. Please correct and resubmit.

BucketPermissionException - The account specified does not have the appropriate bucket permissions.

MalformedManifestException - Your manifest is not well-formed.

CreateJobQuotaExceededException - Each account can create only a certain number of jobs per day. If you need to create more than this, please contact [email protected] to explain your particular use case.

InvalidJobIdException - The JOBID was missing, not found, or not associated with the AWS account.

InvalidVersionException - The client tool version is invalid.

getShippingLabel

GetShippingLabelResult getShippingLabel(GetShippingLabelRequest getShippingLabelRequest)

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

Parameters:

getShippingLabelRequest -

Returns:

Result of the GetShippingLabel operation returned by the service.

Throws:

InvalidJobIdException - The JOBID was missing, not found, or not associated with the AWS account.

ExpiredJobIdException - Indicates that the specified job has expired out of the system.

CanceledJobIdException - The specified job ID has been canceled and is no longer valid.

InvalidAccessKeyIdException - The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID.

InvalidAddressException - The address specified in the manifest is invalid.

InvalidVersionException - The client tool version is invalid.

InvalidParameterException - One or more parameters had an invalid value.

getStatus

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. You can only return information about jobs you own.

Parameters:

getStatusRequest - Input structure for the GetStatus operation.

Returns:

Result of the GetStatus operation returned by the service.

Throws:

InvalidJobIdException - The JOBID was missing, not found, or not associated with the AWS account.

ExpiredJobIdException - Indicates that the specified job has expired out of the system.

CanceledJobIdException - The specified job ID has been canceled and is no longer valid.

InvalidAccessKeyIdException - The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID.

InvalidVersionException - The client tool version is invalid.

listJobs

ListJobsResult listJobs(ListJobsRequest listJobsRequest)

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

Returns:

Result of the ListJobs operation returned by the service.

Throws:

InvalidParameterException - One or more parameters had an invalid value.

InvalidAccessKeyIdException - The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID.

InvalidVersionException - The client tool version is invalid.

listJobs

ListJobsResult listJobs()

Simplified method form for invoking the ListJobs operation.

See Also:

listJobs(ListJobsRequest)

updateJob

UpdateJobResult updateJob(UpdateJobRequest updateJobRequest)

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

Returns:

Result of the UpdateJob operation returned by the service.

Throws:

MissingParameterException - One or more required parameters was missing from the request.

InvalidParameterException - One or more parameters had an invalid value.

InvalidAccessKeyIdException - The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID.

InvalidAddressException - The address specified in the manifest is invalid.

InvalidManifestFieldException - One or more manifest fields was invalid. Please correct and resubmit.

InvalidJobIdException - The JOBID was missing, not found, or not associated with the AWS account.

MissingManifestFieldException - One or more required fields were missing from the manifest file. Please correct and resubmit.

NoSuchBucketException - The specified bucket does not exist. Create the specified bucket or change the manifest's bucket, exportBucket, or logBucket field to a bucket that the account, as specified by the manifest's Access Key ID, has write permissions to.

ExpiredJobIdException - Indicates that the specified job has expired out of the system.

CanceledJobIdException - The specified job ID has been canceled and is no longer valid.

MissingCustomsException - One or more required customs parameters was missing from the manifest.

InvalidCustomsException - One or more customs parameters was invalid. Please correct and resubmit.

InvalidFileSystemException - File system specified in export manifest is invalid.

MultipleRegionsException - Your manifest file contained buckets from multiple regions. A job is restricted to buckets from one region. Please correct and resubmit.

BucketPermissionException - The account specified does not have the appropriate bucket permissions.

MalformedManifestException - Your manifest is not well-formed.

UnableToUpdateJobIdException - AWS Import/Export cannot update the job

InvalidVersionException - The client tool version is invalid.

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.