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.

Interface for accessing Snowball AWS Snowball is a petabyte-scale data transport solution that uses secure appliances to transfer large amounts of data between your on-premises data centers and Amazon Simple Storage Service (Amazon S3). The Snowball commands described here provide access to the same functionality that is available in the AWS Snowball Management Console, which enables you to create and manage jobs for Snowball. To transfer data locally with a Snowball appliance, you'll need to use the Snowball client or the Amazon S3 API adapter for Snowball. For more information, see the User Guide.

Inheritance Hierarchy

Amazon.Snowball.IAmazonSnowball

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

Syntax

C#
public interface IAmazonSnowball
         IAmazonService, IDisposable

The IAmazonSnowball type exposes the following members

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 CancelCluster(CancelClusterRequest)

Cancels a cluster job. You can only cancel a cluster job while it's in the AwaitingQuorum status. You'll have at least an hour after creating a cluster job to cancel it.

Public Method CancelClusterAsync(CancelClusterRequest, CancellationToken)

Initiates the asynchronous execution of the CancelCluster operation.

Public Method CancelJob(CancelJobRequest)

Cancels the specified job. You can only cancel a job before its JobState value changes to PreparingAppliance. Requesting the ListJobs or DescribeJob action will return a job's JobState as part of the response element data returned.

Public Method CancelJobAsync(CancelJobRequest, CancellationToken)

Initiates the asynchronous execution of the CancelJob operation.

Public Method CreateAddress(CreateAddressRequest)

Creates an address for a Snowball to be shipped to. In most regions, addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. If the address is invalid or unsupported, then an exception is thrown.

Public Method CreateAddressAsync(CreateAddressRequest, CancellationToken)

Initiates the asynchronous execution of the CreateAddress operation.

Public Method CreateCluster(CreateClusterRequest)

Creates an empty cluster. Each cluster supports five nodes. You use the CreateJob action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created.

Public Method CreateClusterAsync(CreateClusterRequest, CancellationToken)

Initiates the asynchronous execution of the CreateCluster operation.

Public Method CreateJob(CreateJobRequest)

Creates a job to import or export data between Amazon S3 and your on-premises data center. Your AWS account must have the right trust policies and permissions in place to create a job for Snowball. If you're creating a job for a node in a cluster, you only need to provide the clusterId value; the other job attributes are inherited from the cluster.

Public Method CreateJobAsync(CreateJobRequest, CancellationToken)

Initiates the asynchronous execution of the CreateJob operation.

Public Method DescribeAddress(DescribeAddressRequest)

Takes an AddressId and returns specific details about that address in the form of an Address object.

Public Method DescribeAddressAsync(DescribeAddressRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeAddress operation.

Public Method DescribeAddresses(DescribeAddressesRequest)

Returns a specified number of ADDRESS objects. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions.

Public Method DescribeAddressesAsync(DescribeAddressesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeAddresses operation.

Public Method DescribeCluster(DescribeClusterRequest)

Returns information about a specific cluster including shipping information, cluster status, and other important metadata.

Public Method DescribeClusterAsync(DescribeClusterRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeCluster operation.

Public Method DescribeJob(DescribeJobRequest)

Returns information about a specific job including shipping information, job status, and other important metadata.

Public Method DescribeJobAsync(DescribeJobRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeJob operation.

Public Method GetJobManifest(GetJobManifestRequest)

Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId value. You can access the manifest file for up to 60 minutes after this request has been made. To access the manifest file after 60 minutes have passed, you'll have to make another call to the GetJobManifest action.

The manifest is an encrypted file that you can download after your job enters the WithCustomer status. The manifest is decrypted by using the UnlockCode code value, when you pass both values to the Snowball through the Snowball client when the client is started for the first time.

As a best practice, we recommend that you don't save a copy of an UnlockCode value in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job.

The credentials of a given job, including its manifest file and unlock code, expire 90 days after the job is created.

Public Method GetJobManifestAsync(GetJobManifestRequest, CancellationToken)

Initiates the asynchronous execution of the GetJobManifest operation.

Public Method GetJobUnlockCode(GetJobUnlockCodeRequest)

Returns the UnlockCode code value for the specified job. A particular UnlockCode value can be accessed for up to 90 days after the associated job has been created.

The UnlockCode value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed along with the manifest to the Snowball through the Snowball client when the client is started for the first time.

As a best practice, we recommend that you don't save a copy of the UnlockCode in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job.

Public Method GetJobUnlockCodeAsync(GetJobUnlockCodeRequest, CancellationToken)

Initiates the asynchronous execution of the GetJobUnlockCode operation.

Public Method GetSnowballUsage(GetSnowballUsageRequest)

Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use.

The default service limit for the number of Snowballs that you can have at one time is 1. If you want to increase your service limit, contact AWS Support.

Public Method GetSnowballUsageAsync(GetSnowballUsageRequest, CancellationToken)

Initiates the asynchronous execution of the GetSnowballUsage operation.

Public Method ListClusterJobs(ListClusterJobsRequest)

Returns an array of JobListEntry objects of the specified length. Each JobListEntry object is for a job in the specified cluster and contains a job's state, a job's ID, and other information.

Public Method ListClusterJobsAsync(ListClusterJobsRequest, CancellationToken)

Initiates the asynchronous execution of the ListClusterJobs operation.

Public Method ListClusters(ListClustersRequest)

Returns an array of ClusterListEntry objects of the specified length. Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.

Public Method ListClustersAsync(ListClustersRequest, CancellationToken)

Initiates the asynchronous execution of the ListClusters operation.

Public Method ListJobs(ListJobsRequest)

Returns an array of JobListEntry objects of the specified length. Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs associated with this account in all US regions.

Public Method ListJobsAsync(ListJobsRequest, CancellationToken)

Initiates the asynchronous execution of the ListJobs operation.

Public Method UpdateCluster(UpdateClusterRequest)

While a cluster's ClusterState value is in the AwaitingQuorum state, you can update some of the information associated with a cluster. Once the cluster changes to a different job state, usually 60 minutes after the cluster being created, this action is no longer available.

Public Method UpdateClusterAsync(UpdateClusterRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateCluster operation.

Public Method UpdateJob(UpdateJobRequest)

While a job's JobState value is New, you can update some of the information associated with a job. Once the job changes to a different job state, usually within 60 minutes of the job being created, this action is no longer available.

Public Method UpdateJobAsync(UpdateJobRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateJob operation.

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms