com.amazonaws.services.importexport

Class AbstractAmazonImportExport

java.lang.Object

com.amazonaws.services.importexport.AbstractAmazonImportExport

All Implemented Interfaces:

AmazonImportExport

Direct Known Subclasses:

AbstractAmazonImportExportAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonImportExport
extends Object
implements AmazonImportExport

Abstract implementation of AmazonImportExport. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
CancelJobResult	cancelJob(CancelJobRequest request) This operation cancels a specified job.
CreateJobResult	createJob(CreateJobRequest request) 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 request) This operation generates a pre-paid UPS shipping label that you will use to ship your device to AWS for processing.
GetStatusResult	getStatus(GetStatusRequest request) 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 request) 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 AmazonImportExport.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 request) You use this operation to change the parameters specified in the original manifest file by supplying a new manifest file.

Methods inherited from class java.lang.Object

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

Method Detail

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: AmazonImportExport

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.

Specified by:

setEndpoint in interface AmazonImportExport

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

public void setRegion(Region region)

Description copied from interface: AmazonImportExport

An alternative to AmazonImportExport.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.

Specified by:

setRegion in interface AmazonImportExport

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

public CancelJobResult cancelJob(CancelJobRequest request)

Description copied from interface: AmazonImportExport

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:

cancelJob in interface AmazonImportExport

Parameters:

request - Input structure for the CancelJob operation.

Returns:

Result of the CancelJob operation returned by the service.

createJob

public CreateJobResult createJob(CreateJobRequest request)

Description copied from interface: AmazonImportExport

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:

createJob in interface AmazonImportExport

Parameters:

request - Input structure for the CreateJob operation.

Returns:

Result of the CreateJob operation returned by the service.

getShippingLabel

public GetShippingLabelResult getShippingLabel(GetShippingLabelRequest request)

Description copied from interface: AmazonImportExport

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

Specified by:

getShippingLabel in interface AmazonImportExport

Returns:

Result of the GetShippingLabel operation returned by the service.

getStatus

public GetStatusResult getStatus(GetStatusRequest request)

Description copied from interface: AmazonImportExport

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:

getStatus in interface AmazonImportExport

Parameters:

request - Input structure for the GetStatus operation.

Returns:

Result of the GetStatus operation returned by the service.

listJobs

public ListJobsResult listJobs(ListJobsRequest request)

Description copied from interface: AmazonImportExport

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:

listJobs in interface AmazonImportExport

Parameters:

request - Input structure for the ListJobs operation.

Returns:

Result of the ListJobs operation returned by the service.

listJobs

public ListJobsResult listJobs()

Description copied from interface: AmazonImportExport

Simplified method form for invoking the ListJobs operation.

Specified by:

listJobs in interface AmazonImportExport

See Also:

AmazonImportExport.listJobs(ListJobsRequest)

updateJob

public UpdateJobResult updateJob(UpdateJobRequest request)

Description copied from interface: AmazonImportExport

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:

updateJob in interface AmazonImportExport

Parameters:

request - Input structure for the UpateJob operation.

Returns:

Result of the UpdateJob operation returned by the service.

shutdown

public void shutdown()

Description copied from interface: AmazonImportExport

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.

Specified by:

shutdown in interface AmazonImportExport

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AmazonImportExport

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.

Specified by:

getCachedResponseMetadata in interface AmazonImportExport

Parameters:

request - The originally executed request.

Returns:

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