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;
 
 import org.w3c.dom.*;
 
 import java.net.*;
 import java.util.*;
 
 
Client for accessing AmazonImportExport. 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.

 
 public class AmazonImportExportClient extends AmazonWebServiceClient implements AmazonImportExport {

    
Provider for AWS credentials.
 
List of exception unmarshallers for all AmazonImportExport exceptions.
 
             = new ArrayList<Unmarshaller<AmazonServiceExceptionNode>>();

    
Constructs a new client to invoke service methods on AmazonImportExport. 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.

 
     public AmazonImportExportClient() {
         this(new DefaultAWSCredentialsProviderChain(), new ClientConfiguration());
     }

    
Constructs a new client to invoke service methods on AmazonImportExport. 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 AmazonImportExport (ex: proxy settings, retry counts, etc.).
See also:
com.amazonaws.auth.DefaultAWSCredentialsProviderChain
    public AmazonImportExportClient(ClientConfiguration clientConfiguration) {
        this(new DefaultAWSCredentialsProviderChain(), clientConfiguration);
    }

    
Constructs a new client to invoke service methods on AmazonImportExport 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.
    public AmazonImportExportClient(AWSCredentials awsCredentials) {
        this(awsCredentialsnew ClientConfiguration());
    }

    
Constructs a new client to invoke service methods on AmazonImportExport 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 AmazonImportExport (ex: proxy settings, retry counts, etc.).
    public AmazonImportExportClient(AWSCredentials awsCredentialsClientConfiguration clientConfiguration) {
        super(clientConfiguration);
        this. = new StaticCredentialsProvider(awsCredentials);
        init();
    }

    
Constructs a new client to invoke service methods on AmazonImportExport 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.
    public AmazonImportExportClient(AWSCredentialsProvider awsCredentialsProvider) {
        this(awsCredentialsProvidernew ClientConfiguration());
    }

    
Constructs a new client to invoke service methods on AmazonImportExport 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 AmazonImportExport (ex: proxy settings, retry counts, etc.).
    public AmazonImportExportClient(AWSCredentialsProvider awsCredentialsProviderClientConfiguration clientConfiguration) {
        this(awsCredentialsProviderclientConfigurationnull);
    }

    
Constructs a new client to invoke service methods on AmazonImportExport 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 AmazonImportExport (ex: proxy settings, retry counts, etc.).
requestMetricCollector optional request metric collector
    public AmazonImportExportClient(AWSCredentialsProvider awsCredentialsProvider,
            ClientConfiguration clientConfiguration,
            RequestMetricCollector requestMetricCollector) {
        super(clientConfigurationrequestMetricCollector);
        this. = awsCredentialsProvider;
        init();
    }
    private void init() {
        
        
        // calling this.setEndPoint(...) will also modify the signer accordingly
        this.setEndpoint("importexport.amazonaws.com");
        
        HandlerChainFactory chainFactory = new HandlerChainFactory();
        .addAll(chainFactory.newRequestHandlerChain(
                "/com/amazonaws/services/importexport/request.handlers"));
        .addAll(chainFactory.newRequestHandler2Chain(
                "/com/amazonaws/services/importexport/request.handler2s"));
    }

    

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) {
        ExecutionContext executionContext = createExecutionContext(createJobRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<CreateJobRequestrequest = null;
        Response<CreateJobResultresponse = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new CreateJobRequestMarshaller().marshall(super.beforeMarshalling(createJobRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            response = invoke(requestnew CreateJobResultStaxUnmarshaller(), executionContext);
            return response.getAwsResponse();
        } finally {
            
            endClientExecution(awsRequestMetricsrequestresponse);
        }
    }
    
    

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

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) {
        ExecutionContext executionContext = createExecutionContext(getShippingLabelRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<GetShippingLabelRequestrequest = null;
        Response<GetShippingLabelResultresponse = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new GetShippingLabelRequestMarshaller().marshall(super.beforeMarshalling(getShippingLabelRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            response = invoke(requestnew GetShippingLabelResultStaxUnmarshaller(), executionContext);
            return response.getAwsResponse();
        } finally {
            
            endClientExecution(awsRequestMetricsrequestresponse);
        }
    }
    
    

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) {
        ExecutionContext executionContext = createExecutionContext(cancelJobRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<CancelJobRequestrequest = null;
        Response<CancelJobResultresponse = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new CancelJobRequestMarshaller().marshall(super.beforeMarshalling(cancelJobRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            response = invoke(requestnew CancelJobResultStaxUnmarshaller(), executionContext);
            return response.getAwsResponse();
        } finally {
            
            endClientExecution(awsRequestMetricsrequestresponse);
        }
    }
    
    

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) {
        ExecutionContext executionContext = createExecutionContext(getStatusRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<GetStatusRequestrequest = null;
        Response<GetStatusResultresponse = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new GetStatusRequestMarshaller().marshall(super.beforeMarshalling(getStatusRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            response = invoke(requestnew GetStatusResultStaxUnmarshaller(), executionContext);
            return response.getAwsResponse();
        } finally {
            
            endClientExecution(awsRequestMetricsrequestresponse);
        }
    }
    
    

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) {
        ExecutionContext executionContext = createExecutionContext(listJobsRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<ListJobsRequestrequest = null;
        Response<ListJobsResultresponse = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new ListJobsRequestMarshaller().marshall(super.beforeMarshalling(listJobsRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            response = invoke(requestnew ListJobsResultStaxUnmarshaller(), executionContext);
            return response.getAwsResponse();
        } finally {
            
            endClientExecution(awsRequestMetricsrequestresponse);
        }
    }
    
    

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) {
        ExecutionContext executionContext = createExecutionContext(updateJobRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<UpdateJobRequestrequest = null;
        Response<UpdateJobResultresponse = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new UpdateJobRequestMarshaller().marshall(super.beforeMarshalling(updateJobRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            response = invoke(requestnew UpdateJobResultStaxUnmarshaller(), executionContext);
            return response.getAwsResponse();
        } finally {
            
            endClientExecution(awsRequestMetricsrequestresponse);
        }
    }
    
    

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.
        return listJobs(new ListJobsRequest());
    }

    
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.

Parameters:
request The originally executed request
Returns:
The response metadata for the specified request, or null if none is available.
        return .getResponseMetadataForRequest(request);
    }
    private <X, Y extends AmazonWebServiceRequestResponse<X> invoke(Request<Y> request,
            Unmarshaller<X, StaxUnmarshallerContextunmarshaller,
            ExecutionContext executionContext)
    {
        request.setEndpoint();
        request.setTimeOffset();
        AmazonWebServiceRequest originalRequest = request.getOriginalRequest();
        for (Entry<StringStringentry : originalRequest.copyPrivateRequestParameters().entrySet()) {
            request.addParameter(entry.getKey(), entry.getValue());
        }
        AWSCredentials credentials = .getCredentials();
        if (originalRequest.getRequestCredentials() != null) {
            credentials = originalRequest.getRequestCredentials();
        }
        executionContext.setCredentials(credentials);
        
        StaxResponseHandler<X> responseHandler = new StaxResponseHandler<X>(unmarshaller);
        return .execute(requestresponseHandlererrorResponseHandlerexecutionContext);
    }
}
        
New to GrepCode? Check out our FAQ X