com.amazonaws.services.importexport

Class AmazonImportExportClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.importexport.AmazonImportExportClient

All Implemented Interfaces:

AmazonImportExport

Direct Known Subclasses:

AmazonImportExportAsyncClient

public class AmazonImportExportClient
extends AmazonWebServiceClient
implements AmazonImportExport

Client for accessing AWS Import/Export. All service calls made using this client are blocking, and will not return until the service call 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

Modifier and Type	Field and Description
protected List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>>	exceptionUnmarshallers List of exception unmarshallers for all AWS Import/Export exceptions.

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AmazonImportExportClient() Constructs a new client to invoke service methods on AWS Import/Export.
AmazonImportExportClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AWS Import/Export using the specified AWS account credentials.
AmazonImportExportClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWS Import/Export using the specified AWS account credentials and client configuration options.
AmazonImportExportClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AWS Import/Export using the specified AWS account credentials provider.
AmazonImportExportClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWS Import/Export using the specified AWS account credentials provider and client configuration options.
AmazonImportExportClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on AWS Import/Export using the specified AWS account credentials provider, client configuration options, and request metric collector.
AmazonImportExportClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWS Import/Export.

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.
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.
UpdateJobResult	updateJob(UpdateJobRequest updateJobRequest) 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.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, shutdown, 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

setEndpoint, setRegion, shutdown

Field Detail

exceptionUnmarshallers

protected final List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> exceptionUnmarshallers

List of exception unmarshallers for all AWS Import/Export exceptions.

Constructor Detail

AmazonImportExportClient

public AmazonImportExportClient()

Constructs a new 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
• 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

AmazonImportExportClient

public AmazonImportExportClient(ClientConfiguration clientConfiguration)

Constructs a new 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
• 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 AWS Import/Export (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonImportExportClient

public AmazonImportExportClient(AWSCredentials awsCredentials)

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

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

Parameters:

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

AmazonImportExportClient

public AmazonImportExportClient(AWSCredentials awsCredentials,
                        ClientConfiguration clientConfiguration)

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

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

Parameters:

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

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

AmazonImportExportClient

public AmazonImportExportClient(AWSCredentialsProvider awsCredentialsProvider)

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

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

Parameters:

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

AmazonImportExportClient

public AmazonImportExportClient(AWSCredentialsProvider awsCredentialsProvider,
                        ClientConfiguration clientConfiguration)

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

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

Parameters:

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

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

AmazonImportExportClient

public AmazonImportExportClient(AWSCredentialsProvider awsCredentialsProvider,
                        ClientConfiguration clientConfiguration,
                        RequestMetricCollector requestMetricCollector)

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

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

Parameters:

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

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

requestMetricCollector - optional request metric collector

Method Detail

cancelJob

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

Specified by:

cancelJob in interface AmazonImportExport

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

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

Specified by:

createJob in interface AmazonImportExport

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

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

Specified by:

getShippingLabel in interface AmazonImportExport

Parameters:

getShippingLabelRequest - null

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

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

Specified by:

getStatus in interface AmazonImportExport

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

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

Specified by:

listJobs in interface AmazonImportExport

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

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

Specified by:

updateJob in interface AmazonImportExport

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.

getCachedResponseMetadata

public 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 the 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.