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 Snowball
The Amazon Web Services Snow Family provides a petabyte-scale data transport solution that uses secure devices to transfer large amounts of data between your on-premises data centers and Amazon Simple Storage Service (Amazon S3). The Snow Family commands described here provide access to the same functionality that is available in the Amazon Web Services Snow Family Management Console, which enables you to create and manage jobs for a Snow Family device. To transfer data locally with a Snow Family device, you'll need to use the Snowball Edge client or the Amazon S3 API Interface for Snowball or OpsHub for Snow Family. For more information, see the User Guide.Namespace: Amazon.Snowball
Assembly: AWSSDK.Snowball.dll
Version: 3.x.y.z
public class AmazonSnowballClient : AmazonServiceClient IAmazonService, IAmazonSnowball, IDisposable
The AmazonSnowballClient type exposes the following members
Name | Description | |
---|---|---|
AmazonSnowballClient() |
Constructs AmazonSnowballClient 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> |
|
AmazonSnowballClient(RegionEndpoint) |
Constructs AmazonSnowballClient 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> |
|
AmazonSnowballClient(AmazonSnowballConfig) |
Constructs AmazonSnowballClient 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> |
|
AmazonSnowballClient(AWSCredentials) |
Constructs AmazonSnowballClient with AWS Credentials |
|
AmazonSnowballClient(AWSCredentials, RegionEndpoint) |
Constructs AmazonSnowballClient with AWS Credentials |
|
AmazonSnowballClient(AWSCredentials, AmazonSnowballConfig) |
Constructs AmazonSnowballClient with AWS Credentials and an AmazonSnowballClient Configuration object. |
|
AmazonSnowballClient(string, string) |
Constructs AmazonSnowballClient with AWS Access Key ID and AWS Secret Key |
|
AmazonSnowballClient(string, string, RegionEndpoint) |
Constructs AmazonSnowballClient with AWS Access Key ID and AWS Secret Key |
|
AmazonSnowballClient(string, string, AmazonSnowballConfig) |
Constructs AmazonSnowballClient with AWS Access Key ID, AWS Secret Key and an AmazonSnowballClient Configuration object. |
|
AmazonSnowballClient(string, string, string) |
Constructs AmazonSnowballClient with AWS Access Key ID and AWS Secret Key |
|
AmazonSnowballClient(string, string, string, RegionEndpoint) |
Constructs AmazonSnowballClient with AWS Access Key ID and AWS Secret Key |
|
AmazonSnowballClient(string, string, string, AmazonSnowballConfig) |
Constructs AmazonSnowballClient with AWS Access Key ID, AWS Secret Key and an AmazonSnowballClient Configuration object. |
Name | Type | Description | |
---|---|---|---|
Config | Amazon.Runtime.IClientConfig | Inherited from Amazon.Runtime.AmazonServiceClient. | |
Paginators | Amazon.Snowball.Model.ISnowballPaginatorFactory |
Paginators for the service |
Name | Description | |
---|---|---|
CancelCluster(CancelClusterRequest) |
Cancels a cluster job. You can only cancel a cluster job while it's in the |
|
CancelClusterAsync(CancelClusterRequest, CancellationToken) |
Cancels a cluster job. You can only cancel a cluster job while it's in the |
|
CancelJob(CancelJobRequest) |
Cancels the specified job. You can only cancel a job before its |
|
CancelJobAsync(CancelJobRequest, CancellationToken) |
Cancels the specified job. You can only cancel a job before its |
|
CreateAddress(CreateAddressRequest) |
Creates an address for a Snow device 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. If providing an address as a JSON file through the |
|
CreateAddressAsync(CreateAddressRequest, CancellationToken) |
Creates an address for a Snow device 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. If providing an address as a JSON file through the |
|
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. |
|
CreateClusterAsync(CreateClusterRequest, CancellationToken) |
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. |
|
CreateJob(CreateJobRequest) |
Creates a job to import or export data between Amazon S3 and your on-premises data
center. Your Amazon Web Services account must have the right trust policies and permissions
in place to create a job for a Snow device. If you're creating a job for a node in
a cluster, you only need to provide the
Only the Snowball; Edge device type is supported when ordering clustered jobs.
The device capacity is optional.
Availability of device types differ by Amazon Web Services Region. For more information
about Region availability, see Amazon
Web Services Regional Services.
Snow Family devices and their capacities.
|
|
CreateJobAsync(CreateJobRequest, CancellationToken) |
Creates a job to import or export data between Amazon S3 and your on-premises data
center. Your Amazon Web Services account must have the right trust policies and permissions
in place to create a job for a Snow device. If you're creating a job for a node in
a cluster, you only need to provide the
Only the Snowball; Edge device type is supported when ordering clustered jobs.
The device capacity is optional.
Availability of device types differ by Amazon Web Services Region. For more information
about Region availability, see Amazon
Web Services Regional Services.
Snow Family devices and their capacities.
|
|
CreateLongTermPricing(CreateLongTermPricingRequest) |
Creates a job with the long-term usage option for a device. The long-term usage is a 1-year or 3-year long-term pricing type for the device. You are billed upfront, and Amazon Web Services provides discounts for long-term pricing. |
|
CreateLongTermPricingAsync(CreateLongTermPricingRequest, CancellationToken) |
Creates a job with the long-term usage option for a device. The long-term usage is a 1-year or 3-year long-term pricing type for the device. You are billed upfront, and Amazon Web Services provides discounts for long-term pricing. |
|
CreateReturnShippingLabel(CreateReturnShippingLabelRequest) |
Creates a shipping label that will be used to return the Snow device to Amazon Web Services. |
|
CreateReturnShippingLabelAsync(CreateReturnShippingLabelRequest, CancellationToken) |
Creates a shipping label that will be used to return the Snow device to Amazon Web Services. |
|
DescribeAddress(DescribeAddressRequest) |
Takes an |
|
DescribeAddressAsync(DescribeAddressRequest, CancellationToken) |
Takes an |
|
DescribeAddresses(DescribeAddressesRequest) |
Returns a specified number of |
|
DescribeAddressesAsync(DescribeAddressesRequest, CancellationToken) |
Returns a specified number of |
|
DescribeCluster(DescribeClusterRequest) |
Returns information about a specific cluster including shipping information, cluster status, and other important metadata. |
|
DescribeClusterAsync(DescribeClusterRequest, CancellationToken) |
Returns information about a specific cluster including shipping information, cluster status, and other important metadata. |
|
DescribeJob(DescribeJobRequest) |
Returns information about a specific job including shipping information, job status, and other important metadata. |
|
DescribeJobAsync(DescribeJobRequest, CancellationToken) |
Returns information about a specific job including shipping information, job status, and other important metadata. |
|
DescribeReturnShippingLabel(DescribeReturnShippingLabelRequest) |
Information on the shipping label of a Snow device that is being returned to Amazon Web Services. |
|
DescribeReturnShippingLabelAsync(DescribeReturnShippingLabelRequest, CancellationToken) |
Information on the shipping label of a Snow device that is being returned to Amazon Web Services. |
|
DetermineServiceOperationEndpoint(AmazonWebServiceRequest) |
Returns the endpoint that will be used for a particular request. |
|
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. | |
GetJobManifest(GetJobManifestRequest) |
Returns a link to an Amazon S3 presigned URL for the manifest file associated with
the specified
The manifest is an encrypted file that you can download after your job enters the
As a best practice, we recommend that you don't save a copy of an The credentials of a given job, including its manifest file and unlock code, expire 360 days after the job is created. |
|
GetJobManifestAsync(GetJobManifestRequest, CancellationToken) |
Returns a link to an Amazon S3 presigned URL for the manifest file associated with
the specified
The manifest is an encrypted file that you can download after your job enters the
As a best practice, we recommend that you don't save a copy of an The credentials of a given job, including its manifest file and unlock code, expire 360 days after the job is created. |
|
GetJobUnlockCode(GetJobUnlockCodeRequest) |
Returns the
The
As a best practice, we recommend that you don't save a copy of the |
|
GetJobUnlockCodeAsync(GetJobUnlockCodeRequest, CancellationToken) |
Returns the
The
As a best practice, we recommend that you don't save a copy of the |
|
GetSnowballUsage(GetSnowballUsageRequest) |
Returns information about the Snow Family service limit for your account, and also the number of Snow devices your account has in use. The default service limit for the number of Snow devices that you can have at one time is 1. If you want to increase your service limit, contact Amazon Web Services Support. |
|
GetSnowballUsageAsync(GetSnowballUsageRequest, CancellationToken) |
Returns information about the Snow Family service limit for your account, and also the number of Snow devices your account has in use. The default service limit for the number of Snow devices that you can have at one time is 1. If you want to increase your service limit, contact Amazon Web Services Support. |
|
GetSoftwareUpdates(GetSoftwareUpdatesRequest) |
Returns an Amazon S3 presigned URL for an update file associated with a specified
|
|
GetSoftwareUpdatesAsync(GetSoftwareUpdatesRequest, CancellationToken) |
Returns an Amazon S3 presigned URL for an update file associated with a specified
|
|
ListClusterJobs(ListClusterJobsRequest) |
Returns an array of |
|
ListClusterJobsAsync(ListClusterJobsRequest, CancellationToken) |
Returns an array of |
|
ListClusters(ListClustersRequest) |
Returns an array of |
|
ListClustersAsync(ListClustersRequest, CancellationToken) |
Returns an array of |
|
ListCompatibleImages(ListCompatibleImagesRequest) |
This action returns a list of the different Amazon EC2-compatible Amazon Machine Images (AMIs) that are owned by your Amazon Web Services accountthat would be supported for use on a Snow device. Currently, supported AMIs are based on the Amazon Linux-2, Ubuntu 20.04 LTS - Focal, or Ubuntu 22.04 LTS - Jammy images, available on the Amazon Web Services Marketplace. Ubuntu 16.04 LTS - Xenial (HVM) images are no longer supported in the Market, but still supported for use on devices through Amazon EC2 VM Import/Export and running locally in AMIs. |
|
ListCompatibleImagesAsync(ListCompatibleImagesRequest, CancellationToken) |
This action returns a list of the different Amazon EC2-compatible Amazon Machine Images (AMIs) that are owned by your Amazon Web Services accountthat would be supported for use on a Snow device. Currently, supported AMIs are based on the Amazon Linux-2, Ubuntu 20.04 LTS - Focal, or Ubuntu 22.04 LTS - Jammy images, available on the Amazon Web Services Marketplace. Ubuntu 16.04 LTS - Xenial (HVM) images are no longer supported in the Market, but still supported for use on devices through Amazon EC2 VM Import/Export and running locally in AMIs. |
|
ListJobs(ListJobsRequest) |
Returns an array of |
|
ListJobsAsync(ListJobsRequest, CancellationToken) |
Returns an array of |
|
ListLongTermPricing(ListLongTermPricingRequest) |
Lists all long-term pricing types. |
|
ListLongTermPricingAsync(ListLongTermPricingRequest, CancellationToken) |
Lists all long-term pricing types. |
|
ListPickupLocations(ListPickupLocationsRequest) |
A list of locations from which the customer can choose to pickup a device. |
|
ListPickupLocationsAsync(ListPickupLocationsRequest, CancellationToken) |
A list of locations from which the customer can choose to pickup a device. |
|
ListServiceVersions(ListServiceVersionsRequest) |
Lists all supported versions for Snow on-device services. Returns an array of |
|
ListServiceVersionsAsync(ListServiceVersionsRequest, CancellationToken) |
Lists all supported versions for Snow on-device services. Returns an array of |
|
UpdateCluster(UpdateClusterRequest) |
While a cluster's |
|
UpdateClusterAsync(UpdateClusterRequest, CancellationToken) |
While a cluster's |
|
UpdateJob(UpdateJobRequest) |
While a job's |
|
UpdateJobAsync(UpdateJobRequest, CancellationToken) |
While a job's |
|
UpdateJobShipmentState(UpdateJobShipmentStateRequest) |
Updates the state when a shipment state changes to a different state. |
|
UpdateJobShipmentStateAsync(UpdateJobShipmentStateRequest, CancellationToken) |
Updates the state when a shipment state changes to a different state. |
|
UpdateLongTermPricing(UpdateLongTermPricingRequest) |
Updates the long-term pricing type. |
|
UpdateLongTermPricingAsync(UpdateLongTermPricingRequest, CancellationToken) |
Updates the long-term pricing type. |
Name | Description | |
---|---|---|
AfterResponseEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
BeforeRequestEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
ExceptionEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5