Supported REST API actions - Amazon Snowball Edge Developer Guide
Supported REST API actions for Snowball Edge devicesSupported REST API actions for the Amazon S3 adapter
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Supported REST API actions

Following, you can find REST API actions that you can use with an Amazon Snowball Edge device and Amazon S3.

Supported REST API actions for Snowball Edge devices

HEAD Snowball Edge

Description

Currently, there's only one Snowball Edge REST API operation, which you can use to return status information for a specific device. This operation returns the status of a Snowball Edge. This status includes information that can be used by Amazon Web Services Support for troubleshooting purposes.

You can't use this operation with the Amazon SDKs or the Amazon CLI. We recommend that you use curl or an HTTP client. The request doesn't need to be signed for this operation.

Request

In the following example, the IP address for the Snowball Edge is 192.0.2.0. Replace this value with the IP address of your actual device.

curl -X HEAD http://192.0.2.0:8080

Response

<Status xsi:schemaLocation="http://s3.amazonaws.com/doc/2006-03-01/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <snowballIp>127.0.0.1</snowballIp>
    <snowballPort>8080</snowballPort>
    <snowballId>device-id</snowballId>
    <totalSpaceInBytes>499055067136</totalSpaceInBytes>
    <freeSpaceInBytes>108367699968</freeSpaceInBytes>
    <jobId>job-id</jobId>
    <snowballServerVersion>1.0.1</snowballServerVersion>
    <snowballServerBuild>DevBuild</snowballServerBuild>
    <snowballClientVersion>Version 1.0</snowballClientVersion>
    <snowballRoundTripLatencyInMillis>33</snowballRoundTripLatencyInMillis>
</Status>

Supported REST API actions for the Amazon S3 adapter

Following, you can find the list of Amazon S3 REST API actions that are supported for using the Amazon S3 adapter. The list includes links to information about how the API actions work with Amazon S3. The list also covers any differences in behavior between the Amazon S3 API action and the Amazon Snowball Edge device counterpart. All responses coming back from an Amazon Snowball Edge device declare Server as AWSSnowball, as in the following example.

HTTP/1.1 201 OK
x-amz-id-2: JuKZqmXuiwFeDQxhD7M8KtsKobSzWA1QEjLbTMTagkKdBX2z7Il/jGhDeJ3j6s80
x-amz-request-id: 32FE2CEB32F5EE25
Date: Fri, 08 2016 21:34:56 GMT
Server: AWSSnowball

Amazon S3 REST API calls require SigV4 signing. If you're using the Amazon CLI or an Amazon SDK to make these API calls, the SigV4 signing is handled for you. Otherwise, you need to implement your own SigV4 signing solution. For more information, see Authenticating requests (Amazon Signature Version 4) in the Amazon Simple Storage Service User Guide.

  • GET Bucket (List Objects) version 1 – Supported. However, in this implemetation of the GET operation, the following is not supported:

    • Pagination

    • Markers

    • Delimiters

    • When the list is returned, the list is not sorted

    Only version 1 is supported. GET Bucket (List Objects) version 2 is not supported.

  • GET Service

  • HEAD Bucket

  • HEAD Object

  • GET Object – is a DOWNLOAD of an object from the Snow device's S3 bucket.

  • PUT Object – When an object is uploaded to an Amazon Snowball Edge device using PUT Object, an ETag is generated.

    The ETag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. The ETag might or might not be an MD5 digest of the object data. For more information about ETags, see Common Response Headers in the Amazon Simple Storage Service API Reference.

  • DELETE Object

  • Initiate Multipart Upload – In this implementation, initiating a multipart upload request for an object already on the Amazon Snowball Edge device first deletes that object. It then copies it in parts to the Amazon Snowball Edge device.

  • List Multipart Uploads

  • Upload Part

  • Complete Multipart Upload

  • Abort Multipart Upload

Note

Any Amazon S3 adapter REST API actions not listed here are not supported. Using any unsupported REST API actions with your Snowball Edge returns an error message saying that the action is not supported.