aws_snowball

AWS Snowball is 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 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 device, you'll need to use the Snowball client or the Amazon S3 API adapter for Snowball. For more information, see the User Guide.

Summary

Functions

• cancel_cluster(Client, Input)
  Cancels a cluster job.
• cancel_cluster(Client, Input, Options)
• cancel_job(Client, Input)
  Cancels the specified job.
• cancel_job(Client, Input, Options)
• create_address(Client, Input)
  Creates an address for a Snowball to be shipped to.
• create_address(Client, Input, Options)
• create_cluster(Client, Input)
  Creates an empty cluster.
• create_cluster(Client, Input, Options)
• create_job(Client, Input)
  Creates a job to import or export data between Amazon S3 and your on-premises data center.
• create_job(Client, Input, Options)
• describe_address(Client, Input)
  Takes an AddressId and returns specific details about that address in the form of an Address object.
• describe_address(Client, Input, Options)
• describe_addresses(Client, Input)
  Returns a specified number of ADDRESS objects.
• describe_addresses(Client, Input, Options)
• describe_cluster(Client, Input)
  Returns information about a specific cluster including shipping information, cluster status, and other important metadata.
• describe_cluster(Client, Input, Options)
• describe_job(Client, Input)
  Returns information about a specific job including shipping information, job status, and other important metadata.
• describe_job(Client, Input, Options)
• get_job_manifest(Client, Input)
  Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId value.
• get_job_manifest(Client, Input, Options)
• get_job_unlock_code(Client, Input)
  Returns the UnlockCode code value for the specified job.
• get_job_unlock_code(Client, Input, Options)
• get_snowball_usage(Client, Input)
  Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use.
• get_snowball_usage(Client, Input, Options)
• get_software_updates(Client, Input)
  Returns an Amazon S3 presigned URL for an update file associated with a specified JobId.
• get_software_updates(Client, Input, Options)
• list_cluster_jobs(Client, Input)
  Returns an array of JobListEntry objects of the specified length.
• list_cluster_jobs(Client, Input, Options)
• list_clusters(Client, Input)
  Returns an array of ClusterListEntry objects of the specified length.
• list_clusters(Client, Input, Options)
• list_compatible_images(Client, Input)
  This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs) that are owned by your AWS account that would be supported for use on a Snowball Edge device.
• list_compatible_images(Client, Input, Options)
• list_jobs(Client, Input)
  Returns an array of JobListEntry objects of the specified length.
• list_jobs(Client, Input, Options)
• update_cluster(Client, Input)
  While a cluster's ClusterState value is in the AwaitingQuorum state, you can update some of the information associated with a cluster.
• update_cluster(Client, Input, Options)
• update_job(Client, Input)
  While a job's JobState value is New, you can update some of the information associated with a job.
• update_job(Client, Input, Options)

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 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.

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 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.

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.

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.

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.

Returns information about the Snowball service limit for your account, and also the number of Snowballs 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. 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 AWS account that would be supported for use on a Snowball Edge 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 AWS 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.

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.