AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Implementation for accessing ImportExport

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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.ImportExport.AmazonImportExportClient

Namespace: Amazon.ImportExport
Assembly: AWSSDK.ImportExport.dll
Version: 3.x.y.z

Syntax

C# 
public class AmazonImportExportClient : AmazonServiceClient
         IAmazonImportExport, IAmazonService, IDisposable

The AmazonImportExportClient type exposes the following members

Constructors

NameDescription
Public Method AmazonImportExportClient()

Constructs AmazonImportExportClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. 

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>

Public Method AmazonImportExportClient(RegionEndpoint)

Constructs AmazonImportExportClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. 

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>

Public Method AmazonImportExportClient(AmazonImportExportConfig)

Constructs AmazonImportExportClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. 

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>

Public Method AmazonImportExportClient(AWSCredentials)

Constructs AmazonImportExportClient with AWS Credentials

Public Method AmazonImportExportClient(AWSCredentials, RegionEndpoint)

Constructs AmazonImportExportClient with AWS Credentials

Public Method AmazonImportExportClient(AWSCredentials, AmazonImportExportConfig)

Constructs AmazonImportExportClient with AWS Credentials and an AmazonImportExportClient Configuration object.

Public Method AmazonImportExportClient(string, string)

Constructs AmazonImportExportClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonImportExportClient(string, string, RegionEndpoint)

Constructs AmazonImportExportClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonImportExportClient(string, string, AmazonImportExportConfig)

Constructs AmazonImportExportClient with AWS Access Key ID, AWS Secret Key and an AmazonImportExportClient Configuration object.

Public Method AmazonImportExportClient(string, string, string)

Constructs AmazonImportExportClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonImportExportClient(string, string, string, RegionEndpoint)

Constructs AmazonImportExportClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonImportExportClient(string, string, string, AmazonImportExportConfig)

Constructs AmazonImportExportClient with AWS Access Key ID, AWS Secret Key and an AmazonImportExportClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method CancelJob(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.

Public Method CancelJobAsync(CancelJobRequest, CancellationToken)

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.

Public Method CreateJob(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.

Public Method CreateJobAsync(CreateJobRequest, CancellationToken)

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.

Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method GetShippingLabel(GetShippingLabelRequest)

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

Public Method GetShippingLabelAsync(GetShippingLabelRequest, CancellationToken)

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

Public Method GetStatus(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.

Public Method GetStatusAsync(GetStatusRequest, CancellationToken)

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.

Public Method ListJobs()

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.

Public Method ListJobs(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.

Public Method ListJobsAsync(CancellationToken)

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.

Public Method ListJobsAsync(ListJobsRequest, CancellationToken)

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.

Public Method UpdateJob(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.

Public Method UpdateJobAsync(UpdateJobRequest, CancellationToken)

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.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5