Amazon Web Services, Inc.

Amazon Import/Export 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…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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 .

Endpoints 27

  • POSTCancel cluster/#X-Amz-Target=AWSIESnowballJobManagementService.CancelClusterCancels 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…
  • POSTCancel job/#X-Amz-Target=AWSIESnowballJobManagementService.CancelJobCancels the specified job. You can only cancel a job before its JobState value changes to PreparingAppliance . Requesting the ListJobs or DescribeJob action…
  • POSTCreate address/#X-Amz-Target=AWSIESnowballJobManagementService.CreateAddressCreates 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…
  • POSTCreate cluster/#X-Amz-Target=AWSIESnowballJobManagementService.CreateClusterCreates 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…
  • POSTCreate job/#X-Amz-Target=AWSIESnowballJobManagementService.CreateJobCreates 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…
  • POSTCreate long term pricing/#X-Amz-Target=AWSIESnowballJobManagementService.CreateLongTermPricingCreates 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…
  • POSTCreate return shipping label/#X-Amz-Target=AWSIESnowballJobManagementService.CreateReturnShippingLabelCreates a shipping label that will be used to return the Snow device to Amazon Web Services.
  • POSTDescribe address/#X-Amz-Target=AWSIESnowballJobManagementService.DescribeAddressTakes an AddressId and returns specific details about that address in the form of an Address object.
  • POSTDescribe addresses/#X-Amz-Target=AWSIESnowballJobManagementService.DescribeAddressesReturns 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…
  • POSTDescribe cluster/#X-Amz-Target=AWSIESnowballJobManagementService.DescribeClusterReturns information about a specific cluster including shipping information, cluster status, and other important metadata.
  • POSTDescribe job/#X-Amz-Target=AWSIESnowballJobManagementService.DescribeJobReturns information about a specific job including shipping information, job status, and other important metadata.
  • POSTDescribe return shipping label/#X-Amz-Target=AWSIESnowballJobManagementService.DescribeReturnShippingLabelInformation on the shipping label of a Snow device that is being returned to Amazon Web Services.
  • POSTGet job manifest/#X-Amz-Target=AWSIESnowballJobManagementService.GetJobManifestReturns 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…
  • POSTGet job unlock code/#X-Amz-Target=AWSIESnowballJobManagementService.GetJobUnlockCodeReturns 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…
  • POSTGet snowball usage/#X-Amz-Target=AWSIESnowballJobManagementService.GetSnowballUsageReturns 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…
  • POSTGet software updates/#X-Amz-Target=AWSIESnowballJobManagementService.GetSoftwareUpdatesReturns an Amazon S3 presigned URL for an update file associated with a specified JobId .
  • POSTList cluster jobs/#X-Amz-Target=AWSIESnowballJobManagementService.ListClusterJobsReturns 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…
  • POSTList clusters/#X-Amz-Target=AWSIESnowballJobManagementService.ListClustersReturns an array of ClusterListEntry objects of the specified length. Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other…
  • POSTList compatible images/#X-Amz-Target=AWSIESnowballJobManagementService.ListCompatibleImagesThis 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…
  • POSTList jobs/#X-Amz-Target=AWSIESnowballJobManagementService.ListJobsReturns 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…
  • POSTList long term pricing/#X-Amz-Target=AWSIESnowballJobManagementService.ListLongTermPricingLists all long-term pricing types.
  • POSTList pickup locations/#X-Amz-Target=AWSIESnowballJobManagementService.ListPickupLocationsA list of locations from which the customer can choose to pickup a device.
  • POSTList service versions/#X-Amz-Target=AWSIESnowballJobManagementService.ListServiceVersionsLists all supported versions for Snow on-device services. Returns an array of ServiceVersion object containing the supported versions for a particular service.
  • POSTUpdate cluster/#X-Amz-Target=AWSIESnowballJobManagementService.UpdateClusterWhile a cluster's ClusterState value is in the AwaitingQuorum state, you can update some of the information associated with a cluster. Once the cluster…
  • POSTUpdate job/#X-Amz-Target=AWSIESnowballJobManagementService.UpdateJobWhile 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…
  • POSTUpdate job shipment state/#X-Amz-Target=AWSIESnowballJobManagementService.UpdateJobShipmentStateUpdates the state when a shipment state changes to a different state.
  • POSTUpdate long term pricing/#X-Amz-Target=AWSIESnowballJobManagementService.UpdateLongTermPricingUpdates the long-term pricing type.

API details

Base URL
https://snowball.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
27 operations on 27 pathsPOST 27
Description format
AWS Smithy model, API version 2016-06-30

How to test the Amazon Import/Export Snowball in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Import/Export Snowball collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Cancel cluster” (POST /#X-Amz-Target=AWSIESnowballJobManagementService.CancelCluster), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon Import/Export 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… It is listed under Developer tools and has 27 endpoints.

Who publishes the Amazon Import/Export Snowball?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon Import/Export Snowball?

Requests go to https://snowball.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon Import/Export Snowball?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon Import/Export Snowball have?

27 operations on 27 paths (27 POST).

Is forking the Amazon Import/Export Snowball free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.