Skip to content

Amazon Import/Export Snowball API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

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 <a href="https://docs.aws.amazon.com/AWSImportExport/latest/ug/api-reference.html">User Guide</a>.

Amazon Import/Export Snowball is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 26 endpoints.

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Version
2016-06-30
Endpoints
26
Spec updated
2020-04-16

Endpoints

MethodPathWhat it does
POST/#X-Amz-Target=AWSIESnowballJobManagementService.CancelClusterCancels a cluster job. You can only cancel a cluster job while it's in the <code>AwaitingQuorum</code> status. You'll have at least an hour after creating a clu
POST/#X-Amz-Target=AWSIESnowballJobManagementService.CancelJobCancels the specified job. You can only cancel a job before its <code>JobState</code> value changes to <code>PreparingAppliance</code>. Requesting the <code>Lis
POST/#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 located
POST/#X-Amz-Target=AWSIESnowballJobManagementService.CreateClusterCreates an empty cluster. Each cluster supports five nodes. You use the <a>CreateJob</a> action separately to create the jobs for each of these nodes. The clust
POST/#X-Amz-Target=AWSIESnowballJobManagementService.CreateJob<p>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 policie
POST/#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 upfr
POST/#X-Amz-Target=AWSIESnowballJobManagementService.CreateReturnShippingLabelCreates a shipping label that will be used to return the Snow device to Amazon Web Services.
POST/#X-Amz-Target=AWSIESnowballJobManagementService.DescribeAddressTakes an <code>AddressId</code> and returns specific details about that address in the form of an <code>Address</code> object.
POST/#X-Amz-Target=AWSIESnowballJobManagementService.DescribeAddressesReturns a specified number of <code>ADDRESS</code> objects. Calling this API in one of the US regions will return addresses from the list of all addresses assoc
POST/#X-Amz-Target=AWSIESnowballJobManagementService.DescribeClusterReturns information about a specific cluster including shipping information, cluster status, and other important metadata.
POST/#X-Amz-Target=AWSIESnowballJobManagementService.DescribeJobReturns information about a specific job including shipping information, job status, and other important metadata.
POST/#X-Amz-Target=AWSIESnowballJobManagementService.DescribeReturnShippingLabelInformation on the shipping label of a Snow device that is being returned to Amazon Web Services.
POST/#X-Amz-Target=AWSIESnowballJobManagementService.GetJobManifest<p>Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified <code>JobId</code> value. You can access the manifest file f
POST/#X-Amz-Target=AWSIESnowballJobManagementService.GetJobUnlockCode<p>Returns the <code>UnlockCode</code> code value for the specified job. A particular <code>UnlockCode</code> value can be accessed for up to 360 days after the
POST/#X-Amz-Target=AWSIESnowballJobManagementService.GetSnowballUsage<p>Returns information about the Snow Family service limit for your account, and also the number of Snow devices your account has in use.</p> <p>The default ser
POST/#X-Amz-Target=AWSIESnowballJobManagementService.GetSoftwareUpdatesReturns an Amazon S3 presigned URL for an update file associated with a specified <code>JobId</code>.
POST/#X-Amz-Target=AWSIESnowballJobManagementService.ListClusterJobsReturns an array of <code>JobListEntry</code> objects of the specified length. Each <code>JobListEntry</code> object is for a job in the specified cluster and c
POST/#X-Amz-Target=AWSIESnowballJobManagementService.ListClustersReturns an array of <code>ClusterListEntry</code> objects of the specified length. Each <code>ClusterListEntry</code> object contains a cluster's state, a clust
POST/#X-Amz-Target=AWSIESnowballJobManagementService.ListCompatibleImagesThis 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 fo
POST/#X-Amz-Target=AWSIESnowballJobManagementService.ListJobsReturns an array of <code>JobListEntry</code> objects of the specified length. Each <code>JobListEntry</code> object contains a job's state, a job's ID, and a v
POST/#X-Amz-Target=AWSIESnowballJobManagementService.ListLongTermPricingLists all long-term pricing types.
POST/#X-Amz-Target=AWSIESnowballJobManagementService.ListServiceVersionsLists all supported versions for Snow on-device services. Returns an array of <code>ServiceVersion</code> object containing the supported versions for a particu
POST/#X-Amz-Target=AWSIESnowballJobManagementService.UpdateClusterWhile a cluster's <code>ClusterState</code> value is in the <code>AwaitingQuorum</code> state, you can update some of the information associated with a cluster.
POST/#X-Amz-Target=AWSIESnowballJobManagementService.UpdateJobWhile a job's <code>JobState</code> value is <code>New</code>, you can update some of the information associated with a job. Once the job changes to a different
POST/#X-Amz-Target=AWSIESnowballJobManagementService.UpdateJobShipmentStateUpdates the state when a shipment state changes to a different state.
POST/#X-Amz-Target=AWSIESnowballJobManagementService.UpdateLongTermPricingUpdates the long-term pricing type.

Questions

Does the Amazon Import/Export Snowball API need an API key?

Yes. The Amazon Import/Export Snowball API uses API key authentication; the documentation explains how to get credentials.

Does the Amazon Import/Export Snowball API support HTTPS?

Yes, the Amazon Import/Export Snowball API is served over HTTPS.

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

Its OpenAPI description lists 26 endpoints in version 2016-06-30. All of them are shown on this page.

What are alternatives to the Amazon Import/Export Snowball API?

Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.

Compare alternatives →

Remote Settings PROD

Cloud Platforms

Firefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.

No auth19 endpoints

Linode API

Cloud Platforms

## Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to assist application developers and system administrators. Each endpoint includes descriptions, request syntax, and examples using standard HTTP requests. Response data is returned in JSON format. This document was generated from our OpenAPI Specification. See the <a target="_top" href="https://www.openapis.org">OpenAPI website</a> for more information. <a target="_top" href="/docs/api/openapi.yaml">Download the Linode OpenAPI Specification</a>. ## Changelog <a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release notes on all changes made to our API. ## Access and Authentication Some endpoints are publicly accessible without requiring authentication. All endpoints affecting your Account, however, require either a Personal Access Token or OAuth authentication (when using third-party applications). ### Personal Access Token The easiest way to access the API is with a Personal Access Token (PAT) generated from the <a target="_top" href="https://cloud.linode.com/profile/tokens">Linode Cloud Manager</a> or the [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint. All scopes for the OAuth security model ([defined below](/docs/api/profile/#oauth)) apply to this security model as well. #### Authentication | Security Scheme Type: | HTTP | |-----------------------|------| | **HTTP Authorization Scheme** | bearer | ### OAuth If you only need to access the Linode API for personal use, we recommend that you create a [personal access token](/docs/api/#personal-access-token). If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange). Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. - Clients can be public or private, and are private by default. You can choose to make the client public when it is created. - A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation. - A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client. - Public and private clients follow different workflows, as described below. #### OAuth Workflow The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used to authenticate a user before an application can start making API calls on the user's behalf. Notes: - With respect to the diagram in [section 1.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-1.2), login.linode.com (referred to in this section as the *login server*) is the Resource Owner and the Authorization Server; api.linode.com (referred to here as the *api se

Bearer token350 endpoints

DigitalOcean API

Cloud Platforms

# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints. ## Requests Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required. |Method|Usage| |--- |--- | |GET|For simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.| |DELETE|To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.| |PUT|To update the information about a resource in your account, the PUT method is available. Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.| |PATCH|Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH request is is a set of instructions on how to modify a resource updating only specific attributes.| |POST|To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.| |HEAD|Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request. Response headers contain some useful information about your API access and the results that are available for your request. For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.| ## HTTP Statuses Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes. In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered. In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered. Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed. If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having

Bearer token290 endpoints

Vercel API

Cloud Platforms

Vercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.

Bearer token112 endpoints

Platform API

Cloud Platforms

The [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.

HTTP Basic22 endpoints

Azure Data Lake Storage

Cloud Platforms

Azure Data Lake Storage provides storage for Hadoop and other big data workloads.

No auth10 endpoints

Listed from APIs.guru (CC0).