Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
   * 
   * Licensed under the Apache License, Version 2.0 (the "License").
   * You may not use this file except in compliance with the License.
   * A copy of the License is located at
   * 
   *  http://aws.amazon.com/apache2.0
   * 
  * or in the "license" file accompanying this file. This file is distributed
  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
  * express or implied. See the License for the specific language governing
  * permissions and limitations under the License.
  */
 package com.amazonaws.services.importexport;
 
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.

 
 public 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 com.amazonaws.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:
java.lang.IllegalArgumentException If any problems are detected with the specified endpoint.
 
     public void setEndpoint(String endpointthrows java.lang.IllegalArgumentException;

    
An alternative to setEndpoint(java.lang.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 com.amazonaws.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.

 
     public void setRegion(Region regionthrows java.lang.IllegalArgumentException;
    
    

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:
com.amazonaws.services.importexport.model.MalformedManifestException
com.amazonaws.services.importexport.model.InvalidAddressException
com.amazonaws.services.importexport.model.BucketPermissionException
com.amazonaws.services.importexport.model.InvalidParameterException
com.amazonaws.services.importexport.model.MultipleRegionsException
com.amazonaws.services.importexport.model.InvalidVersionException
com.amazonaws.services.importexport.model.MissingParameterException
com.amazonaws.services.importexport.model.InvalidFileSystemException
com.amazonaws.services.importexport.model.MissingCustomsException
com.amazonaws.services.importexport.model.NoSuchBucketException
com.amazonaws.services.importexport.model.InvalidAccessKeyIdException
com.amazonaws.services.importexport.model.InvalidManifestFieldException
com.amazonaws.services.importexport.model.InvalidCustomsException
com.amazonaws.services.importexport.model.MissingManifestFieldException
com.amazonaws.services.importexport.model.CreateJobQuotaExceededException
com.amazonaws.services.importexport.model.InvalidJobIdException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonImportExport indicating either a problem with the data in the request, or a server side issue.
    public CreateJobResult createJob(CreateJobRequest createJobRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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:
getShippingLabelRequest Container for the necessary parameters to execute the GetShippingLabel service method on AmazonImportExport.
Returns:
The response from the GetShippingLabel service method, as returned by AmazonImportExport.
Throws:
com.amazonaws.services.importexport.model.InvalidVersionException
com.amazonaws.services.importexport.model.InvalidAddressException
com.amazonaws.services.importexport.model.CanceledJobIdException
com.amazonaws.services.importexport.model.ExpiredJobIdException
com.amazonaws.services.importexport.model.InvalidParameterException
com.amazonaws.services.importexport.model.InvalidAccessKeyIdException
com.amazonaws.services.importexport.model.InvalidJobIdException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonImportExport indicating either a problem with the data in the request, or a server side issue.
    public GetShippingLabelResult getShippingLabel(GetShippingLabelRequest getShippingLabelRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.importexport.model.InvalidVersionException
com.amazonaws.services.importexport.model.CanceledJobIdException
com.amazonaws.services.importexport.model.ExpiredJobIdException
com.amazonaws.services.importexport.model.InvalidAccessKeyIdException
com.amazonaws.services.importexport.model.InvalidJobIdException
com.amazonaws.services.importexport.model.UnableToCancelJobIdException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonImportExport indicating either a problem with the data in the request, or a server side issue.
    public CancelJobResult cancelJob(CancelJobRequest cancelJobRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.importexport.model.InvalidVersionException
com.amazonaws.services.importexport.model.CanceledJobIdException
com.amazonaws.services.importexport.model.ExpiredJobIdException
com.amazonaws.services.importexport.model.InvalidAccessKeyIdException
com.amazonaws.services.importexport.model.InvalidJobIdException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonImportExport indicating either a problem with the data in the request, or a server side issue.
    public GetStatusResult getStatus(GetStatusRequest getStatusRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.importexport.model.InvalidVersionException
com.amazonaws.services.importexport.model.InvalidParameterException
com.amazonaws.services.importexport.model.InvalidAccessKeyIdException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonImportExport indicating either a problem with the data in the request, or a server side issue.
    public ListJobsResult listJobs(ListJobsRequest listJobsRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.importexport.model.MalformedManifestException
com.amazonaws.services.importexport.model.BucketPermissionException
com.amazonaws.services.importexport.model.InvalidAddressException
com.amazonaws.services.importexport.model.InvalidParameterException
com.amazonaws.services.importexport.model.UnableToUpdateJobIdException
com.amazonaws.services.importexport.model.MultipleRegionsException
com.amazonaws.services.importexport.model.InvalidVersionException
com.amazonaws.services.importexport.model.MissingParameterException
com.amazonaws.services.importexport.model.InvalidFileSystemException
com.amazonaws.services.importexport.model.CanceledJobIdException
com.amazonaws.services.importexport.model.MissingCustomsException
com.amazonaws.services.importexport.model.NoSuchBucketException
com.amazonaws.services.importexport.model.ExpiredJobIdException
com.amazonaws.services.importexport.model.InvalidAccessKeyIdException
com.amazonaws.services.importexport.model.InvalidCustomsException
com.amazonaws.services.importexport.model.InvalidManifestFieldException
com.amazonaws.services.importexport.model.MissingManifestFieldException
com.amazonaws.services.importexport.model.InvalidJobIdException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonImportExport indicating either a problem with the data in the request, or a server side issue.
    public UpdateJobResult updateJob(UpdateJobRequest updateJobRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.importexport.model.InvalidVersionException
com.amazonaws.services.importexport.model.InvalidParameterException
com.amazonaws.services.importexport.model.InvalidAccessKeyIdException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonImportExport indicating either a problem with the data in the request, or a server side issue.
    public ListJobsResult listJobs() throws AmazonServiceExceptionAmazonClientException;
    
    
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.
    public void shutdown();
    
    
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.
}
        
New to GrepCode? Check out our FAQ X