software.amazon.awssdk.services.importexport

Interface ImportExportAsyncClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
public interface ImportExportAsyncClient
extends SdkClient, SdkAutoCloseable

Service client for accessing null asynchronously. This can be created using the static builder() method. 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	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static ImportExportAsyncClientBuilder	builder() Create a builder that can be used to configure and create a ImportExportAsyncClient.
default CompletableFuture<CancelJobResponse>	cancelJob(CancelJobRequest cancelJobRequest) This operation cancels a specified job.
default CompletableFuture<CancelJobResponse>	cancelJob(Consumer<CancelJobRequest.Builder> cancelJobRequest) This operation cancels a specified job.
static ImportExportAsyncClient	create() Create a ImportExportAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<CreateJobResponse>	createJob(Consumer<CreateJobRequest.Builder> createJobRequest) This operation initiates the process of scheduling an upload or download of your data.
default CompletableFuture<CreateJobResponse>	createJob(CreateJobRequest createJobRequest) This operation initiates the process of scheduling an upload or download of your data.
default CompletableFuture<GetShippingLabelResponse>	getShippingLabel(Consumer<GetShippingLabelRequest.Builder> getShippingLabelRequest) This operation generates a pre-paid UPS shipping label that you will use to ship your device to AWS for processing.
default CompletableFuture<GetShippingLabelResponse>	getShippingLabel(GetShippingLabelRequest getShippingLabelRequest) This operation generates a pre-paid UPS shipping label that you will use to ship your device to AWS for processing.
default CompletableFuture<GetStatusResponse>	getStatus(Consumer<GetStatusRequest.Builder> 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.
default CompletableFuture<GetStatusResponse>	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.
default CompletableFuture<ListJobsResponse>	listJobs(Consumer<ListJobsRequest.Builder> listJobsRequest) This operation returns the jobs associated with the requester.
default CompletableFuture<ListJobsResponse>	listJobs(ListJobsRequest listJobsRequest) This operation returns the jobs associated with the requester.
default CompletableFuture<UpdateJobResponse>	updateJob(Consumer<UpdateJobRequest.Builder> updateJobRequest) You use this operation to change the parameters specified in the original manifest file by supplying a new manifest file.
default CompletableFuture<UpdateJobResponse>	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 interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static ImportExportAsyncClient create()

Create a ImportExportAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static ImportExportAsyncClientBuilder builder()

Create a builder that can be used to configure and create a ImportExportAsyncClient.

cancelJob

default CompletableFuture<CancelJobResponse> 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:

A Java Future containing the result of the CancelJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• ImportExportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

cancelJob

default CompletableFuture<CancelJobResponse> cancelJob(Consumer<CancelJobRequest.Builder> 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.

This is a convenience which creates an instance of the CancelJobRequest.Builder avoiding the need to create one manually via CancelJobRequest.builder()

Parameters:

cancelJobRequest - A Consumer that will call methods on CancelJobInput.Builder to create a request. Input structure for the CancelJob operation.

Returns:

A Java Future containing the result of the CancelJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• ImportExportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

createJob

default CompletableFuture<CreateJobResponse> 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:

A Java Future containing the result of the CreateJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 awsimportexport@amazon.com 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• ImportExportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

createJob

default CompletableFuture<CreateJobResponse> createJob(Consumer<CreateJobRequest.Builder> 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.

This is a convenience which creates an instance of the CreateJobRequest.Builder avoiding the need to create one manually via CreateJobRequest.builder()

Parameters:

createJobRequest - A Consumer that will call methods on CreateJobInput.Builder to create a request. Input structure for the CreateJob operation.

Returns:

A Java Future containing the result of the CreateJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 awsimportexport@amazon.com 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• ImportExportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

getShippingLabel

default CompletableFuture<GetShippingLabelResponse> 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:

A Java Future containing the result of the GetShippingLabel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• ImportExportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

getShippingLabel

default CompletableFuture<GetShippingLabelResponse> getShippingLabel(Consumer<GetShippingLabelRequest.Builder> getShippingLabelRequest)

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

This is a convenience which creates an instance of the GetShippingLabelRequest.Builder avoiding the need to create one manually via GetShippingLabelRequest.builder()

Parameters:

getShippingLabelRequest - A Consumer that will call methods on GetShippingLabelInput.Builder to create a request.

Returns:

A Java Future containing the result of the GetShippingLabel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• ImportExportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

getStatus

default CompletableFuture<GetStatusResponse> 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:

A Java Future containing the result of the GetStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• ImportExportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

getStatus

default CompletableFuture<GetStatusResponse> getStatus(Consumer<GetStatusRequest.Builder> 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.

This is a convenience which creates an instance of the GetStatusRequest.Builder avoiding the need to create one manually via GetStatusRequest.builder()

Parameters:

getStatusRequest - A Consumer that will call methods on GetStatusInput.Builder to create a request. Input structure for the GetStatus operation.

Returns:

A Java Future containing the result of the GetStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• ImportExportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

listJobs

default CompletableFuture<ListJobsResponse> 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:

A Java Future containing the result of the ListJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• ImportExportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

listJobs

default CompletableFuture<ListJobsResponse> listJobs(Consumer<ListJobsRequest.Builder> 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.

This is a convenience which creates an instance of the ListJobsRequest.Builder avoiding the need to create one manually via ListJobsRequest.builder()

Parameters:

listJobsRequest - A Consumer that will call methods on ListJobsInput.Builder to create a request. Input structure for the ListJobs operation.

Returns:

A Java Future containing the result of the ListJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• ImportExportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

updateJob

default CompletableFuture<UpdateJobResponse> 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:

A Java Future containing the result of the UpdateJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• ImportExportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

updateJob

default CompletableFuture<UpdateJobResponse> updateJob(Consumer<UpdateJobRequest.Builder> 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.

This is a convenience which creates an instance of the UpdateJobRequest.Builder avoiding the need to create one manually via UpdateJobRequest.builder()

Parameters:

updateJobRequest - A Consumer that will call methods on UpdateJobInput.Builder to create a request. Input structure for the UpateJob operation.

Returns:

A Java Future containing the result of the UpdateJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• ImportExportException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.