AWS.Snowball (aws-elixir v0.10.1) View Source
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.
Link to this section Summary
Functions
Cancels a cluster job.
Cancels the specified job.
Creates an address for a Snow device to be shipped to.
Creates an empty cluster.
Creates a job to import or export data between Amazon S3 and your on-premises data center.
Creates a job with the long-term usage option for a device.
Creates a shipping label that will be used to return the Snow device to Amazon Web Services.
Takes an AddressId and returns specific details about that address in the form
of an Address object.
Returns a specified number of ADDRESS objects.
Returns information about a specific cluster including shipping information, cluster status, and other important metadata.
Returns information about a specific job including shipping information, job status, and other important metadata.
Information on the shipping label of a Snow device that is being returned to Amazon Web Services.
Returns a link to an Amazon S3 presigned URL for the manifest file associated
with the specified JobId value.
Returns the UnlockCode code value for the specified job.
Returns information about the Snow Family service limit for your account, and also the number of Snow devices your account has in use.
Returns an Amazon S3 presigned URL for an update file associated with a
specified JobId.
Returns an array of JobListEntry objects of the specified length.
Returns an array of ClusterListEntry objects of the specified length.
This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs) that are owned by your Amazon Web Services accountthat would be supported for use on a Snow device.
Returns an array of JobListEntry objects of the specified length.
Lists all long-term pricing types.
While a cluster's ClusterState value is in the AwaitingQuorum state, you can
update some of the information associated with a cluster.
While a job's JobState value is New, you can update some of the information
associated with a job.
Updates the state when a shipment state changes to a different state.
Updates the long-term pricing type.
Link to this section Functions
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.
Cancels the specified job.
You can only cancel a job before its JobState value changes to
PreparingAppliance. Requesting the ListJobs or DescribeJob action returns
a job's JobState as part of the response element data returned.
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.
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.
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 clusterId value; the
other job attributes are inherited from the cluster.
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.
Snow Family device type: ## SNC1_SSD
- Capacity: T14
- Description: Snowcone
Snow Family device type: ## SNC1_HDD
- Capacity: T8
- Description: Snowcone
Device type: ## EDGE_S
- Capacity: T98
- Description: Snowball Edge Storage Optimized for data
transfer only
Device type: ## EDGE_CG
- Capacity: T42
- Description: Snowball Edge Compute Optimized with GPU
Device type: ## EDGE_C
- Capacity: T42
- Description: Snowball Edge Compute Optimized without
GPU
Device type: ## EDGE
- Capacity: T100
- Description: Snowball Edge Storage Optimized with EC2
Compute
Device type: ## STANDARD
- Capacity: T50
- Description: Original Snowball device
This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region
Device type: ## STANDARD
- Capacity: T80
- Description: Original Snowball device
This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region.
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.
Creates a shipping label that will be used to return the Snow device to Amazon Web Services.
Takes an AddressId and returns specific details about that address in the form
of an Address object.
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.
Returns information about a specific cluster including shipping information, cluster status, and other important metadata.
Returns information about a specific job including shipping information, job status, and other important metadata.
Information on the shipping label of a Snow device that is being returned to Amazon Web Services.
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 Snow device 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 Snow
device associated with that job.
The credentials of a given job, including its manifest file and unlock code, expire 360 days after the job is created.
Returns the UnlockCode code value for the specified job.
A particular UnlockCode value can be accessed for up to 360 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 Snow device 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 Snow device
associated with that job.
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.
Returns an Amazon S3 presigned URL for an update file associated with a
specified JobId.
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.
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.
This action returns a list of the different Amazon EC2 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 CentOS 7 (x86_64) - with Updates HVM, Ubuntu Server 14.04 LTS (HVM), and Ubuntu 16.04 LTS - Xenial (HVM) images, available on the Amazon Web Services Marketplace.
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.
Lists all long-term pricing types.
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.
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.
Updates the state when a shipment state changes to a different state.
Updates the long-term pricing type.