@Generated(value="software.amazon.awssdk:codegen") public interface ImportExportClient extends SdkClient
builder()
method.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static ImportExportClientBuilder |
builder()
Create a builder that can be used to configure and create a
ImportExportClient . |
default CancelJobResponse |
cancelJob(CancelJobRequest cancelJobRequest)
This operation cancels a specified job.
|
default CancelJobResponse |
cancelJob(Consumer<CancelJobRequest.Builder> cancelJobRequest)
This operation cancels a specified job.
|
static ImportExportClient |
create()
Create a
ImportExportClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateJobResponse |
createJob(Consumer<CreateJobRequest.Builder> createJobRequest)
This operation initiates the process of scheduling an upload or download of your data.
|
default CreateJobResponse |
createJob(CreateJobRequest createJobRequest)
This operation initiates the process of scheduling an upload or download of your data.
|
default 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 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 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 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 ListJobsResponse |
listJobs(Consumer<ListJobsRequest.Builder> listJobsRequest)
This operation returns the jobs associated with the requester.
|
default ListJobsResponse |
listJobs(ListJobsRequest listJobsRequest)
This operation returns the jobs associated with the requester.
|
static ServiceMetadata |
serviceMetadata() |
default 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 UpdateJobResponse |
updateJob(UpdateJobRequest updateJobRequest)
You use this operation to change the parameters specified in the original manifest file by supplying a new
manifest file.
|
serviceName
close
static final String SERVICE_NAME
static ImportExportClient create()
ImportExportClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static ImportExportClientBuilder builder()
ImportExportClient
.default CancelJobResponse cancelJob(CancelJobRequest cancelJobRequest) throws InvalidJobIdException, ExpiredJobIdException, CanceledJobIdException, UnableToCancelJobIdException, InvalidAccessKeyIdException, InvalidVersionException, AwsServiceException, SdkClientException, ImportExportException
cancelJobRequest
- Input structure for the CancelJob operation.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 jobInvalidAccessKeyIdException
- 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.AwsServiceException
default CancelJobResponse cancelJob(Consumer<CancelJobRequest.Builder> cancelJobRequest) throws InvalidJobIdException, ExpiredJobIdException, CanceledJobIdException, UnableToCancelJobIdException, InvalidAccessKeyIdException, InvalidVersionException, AwsServiceException, SdkClientException, ImportExportException
This is a convenience which creates an instance of the CancelJobRequest.Builder
avoiding the need to
create one manually via CancelJobRequest.builder()
cancelJobRequest
- A Consumer
that will call methods on CancelJobInput.Builder
to create a request. Input
structure for the CancelJob operation.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 jobInvalidAccessKeyIdException
- 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.AwsServiceException
default CreateJobResponse createJob(CreateJobRequest createJobRequest) throws MissingParameterException, InvalidParameterException, InvalidAccessKeyIdException, InvalidAddressException, InvalidManifestFieldException, MissingManifestFieldException, NoSuchBucketException, MissingCustomsException, InvalidCustomsException, InvalidFileSystemException, MultipleRegionsException, BucketPermissionException, MalformedManifestException, CreateJobQuotaExceededException, InvalidJobIdException, InvalidVersionException, AwsServiceException, SdkClientException, ImportExportException
createJobRequest
- Input structure for the CreateJob operation.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.AwsServiceException
default CreateJobResponse createJob(Consumer<CreateJobRequest.Builder> createJobRequest) throws MissingParameterException, InvalidParameterException, InvalidAccessKeyIdException, InvalidAddressException, InvalidManifestFieldException, MissingManifestFieldException, NoSuchBucketException, MissingCustomsException, InvalidCustomsException, InvalidFileSystemException, MultipleRegionsException, BucketPermissionException, MalformedManifestException, CreateJobQuotaExceededException, InvalidJobIdException, InvalidVersionException, AwsServiceException, SdkClientException, ImportExportException
This is a convenience which creates an instance of the CreateJobRequest.Builder
avoiding the need to
create one manually via CreateJobRequest.builder()
createJobRequest
- A Consumer
that will call methods on CreateJobInput.Builder
to create a request. Input
structure for the CreateJob operation.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.AwsServiceException
default GetShippingLabelResponse getShippingLabel(GetShippingLabelRequest getShippingLabelRequest) throws InvalidJobIdException, ExpiredJobIdException, CanceledJobIdException, InvalidAccessKeyIdException, InvalidAddressException, InvalidVersionException, InvalidParameterException, AwsServiceException, SdkClientException, ImportExportException
getShippingLabelRequest
- 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.AwsServiceException
default GetShippingLabelResponse getShippingLabel(Consumer<GetShippingLabelRequest.Builder> getShippingLabelRequest) throws InvalidJobIdException, ExpiredJobIdException, CanceledJobIdException, InvalidAccessKeyIdException, InvalidAddressException, InvalidVersionException, InvalidParameterException, AwsServiceException, SdkClientException, ImportExportException
This is a convenience which creates an instance of the GetShippingLabelRequest.Builder
avoiding the need
to create one manually via GetShippingLabelRequest.builder()
getShippingLabelRequest
- A Consumer
that will call methods on GetShippingLabelInput.Builder
to create a request.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.AwsServiceException
default GetStatusResponse getStatus(GetStatusRequest getStatusRequest) throws InvalidJobIdException, ExpiredJobIdException, CanceledJobIdException, InvalidAccessKeyIdException, InvalidVersionException, AwsServiceException, SdkClientException, ImportExportException
getStatusRequest
- Input structure for the GetStatus operation.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.AwsServiceException
default GetStatusResponse getStatus(Consumer<GetStatusRequest.Builder> getStatusRequest) throws InvalidJobIdException, ExpiredJobIdException, CanceledJobIdException, InvalidAccessKeyIdException, InvalidVersionException, AwsServiceException, SdkClientException, ImportExportException
This is a convenience which creates an instance of the GetStatusRequest.Builder
avoiding the need to
create one manually via GetStatusRequest.builder()
getStatusRequest
- A Consumer
that will call methods on GetStatusInput.Builder
to create a request. Input
structure for the GetStatus operation.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.AwsServiceException
default ListJobsResponse listJobs(ListJobsRequest listJobsRequest) throws InvalidParameterException, InvalidAccessKeyIdException, InvalidVersionException, AwsServiceException, SdkClientException, ImportExportException
listJobsRequest
- Input structure for the ListJobs operation.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.AwsServiceException
default ListJobsResponse listJobs(Consumer<ListJobsRequest.Builder> listJobsRequest) throws InvalidParameterException, InvalidAccessKeyIdException, InvalidVersionException, AwsServiceException, SdkClientException, ImportExportException
This is a convenience which creates an instance of the ListJobsRequest.Builder
avoiding the need to
create one manually via ListJobsRequest.builder()
listJobsRequest
- A Consumer
that will call methods on ListJobsInput.Builder
to create a request. Input
structure for the ListJobs operation.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.AwsServiceException
default UpdateJobResponse updateJob(UpdateJobRequest updateJobRequest) throws MissingParameterException, InvalidParameterException, InvalidAccessKeyIdException, InvalidAddressException, InvalidManifestFieldException, InvalidJobIdException, MissingManifestFieldException, NoSuchBucketException, ExpiredJobIdException, CanceledJobIdException, MissingCustomsException, InvalidCustomsException, InvalidFileSystemException, MultipleRegionsException, BucketPermissionException, MalformedManifestException, UnableToUpdateJobIdException, InvalidVersionException, AwsServiceException, SdkClientException, ImportExportException
updateJobRequest
- Input structure for the UpateJob operation.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 jobInvalidVersionException
- 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.AwsServiceException
default UpdateJobResponse updateJob(Consumer<UpdateJobRequest.Builder> updateJobRequest) throws MissingParameterException, InvalidParameterException, InvalidAccessKeyIdException, InvalidAddressException, InvalidManifestFieldException, InvalidJobIdException, MissingManifestFieldException, NoSuchBucketException, ExpiredJobIdException, CanceledJobIdException, MissingCustomsException, InvalidCustomsException, InvalidFileSystemException, MultipleRegionsException, BucketPermissionException, MalformedManifestException, UnableToUpdateJobIdException, InvalidVersionException, AwsServiceException, SdkClientException, ImportExportException
This is a convenience which creates an instance of the UpdateJobRequest.Builder
avoiding the need to
create one manually via UpdateJobRequest.builder()
updateJobRequest
- A Consumer
that will call methods on UpdateJobInput.Builder
to create a request. Input
structure for the UpateJob operation.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 jobInvalidVersionException
- 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.AwsServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.