Menu
AWS Snowball
User Guide

This guide is for the Snowball (50TB or 80TB of storage space). If you are looking for documentation for the Snowball Edge, see the AWS Snowball Edge Developer Guide.

Using the Adapter with Amazon S3 Commands for the AWS CLI

The following shows how to specify the Amazon S3 Adapter for Snowball as the endpoint for applicable AWS CLI commands, and outlines what Amazon S3 AWS CLI commands are supported for transferring data to the Snowball with the adapter.

Note

For information on installing and setting up the AWS CLI, including specifying what regions you want to make AWS CLI calls against, see the AWS Command Line Interface User Guide.

Specifying the Adapter as the AWS CLI Endpoint

Whenever you use the AWS CLI to issue a command to the Snowball, you'll have to specify that the endpoint is the Amazon S3 Adapter for Snowball, as shown following.

aws s3 ls --endpoint http://<IP address for the S3 Adapter>:8080

By default, the adapter runs on port 8080. You can specify a different port by changing the contents in the snowball-adapter.config file described in Downloading and Installing the Amazon S3 Adapter for Snowball.

Supported AWS CLI Amazon S3 Commands

Following, you can find a description of the subset of AWS CLI commands and options for Amazon S3 that the AWS Snowball Edge appliance supports. If a command or option isn't listed following, it's not supported. You can declare some unsupported options, like --sse or --storage-class, along with a command. However, these are ignored and have no impact on how data is imported.

  • cp Copies a file or object to or from the Snowball.

    • --dryrun (boolean) The operations that would be performed using the specified command are displayed without being run.

    • --follow-symlinks | --no-follow-symlinks (boolean) Symbolic links (symlinks) are followed only when uploading to S3 from the local file system. Amazon S3 doesn't support symbolic links, so the contents of the link target are uploaded under the name of the link. When neither option is specified, the default is to follow symlinks.

    • --only-show-errors (boolean) Only errors and warnings are displayed. All other output is suppressed.

    • --recursive (boolean) The command is performed on all files or objects under the specified directory or prefix. Currently, this option is only supported for uploading data to a Snowball.

    • --quiet (boolean) Operations performed by the specified command are not displayed.

  • ls Lists objects on the Snowball.

    • --human-readable (boolean) File sizes are displayed in human-readable format.

    • --summarize (boolean) Summary information is displayed (number of objects, total size).

  • rm Deletes an object on the Snowball.

    • --dryrun (boolean) The operations that would be performed using the specified command are displayed without being run.

    • --only-show-errors (boolean) Only errors and warnings are displayed. All other output is suppressed.

    • --quiet (boolean) Operations performed by the specified command are not displayed.