Menu
AWS Snowball
User Guide

Using the Adapter with Amazon S3 Commands for the AWS CLI

The following shows how to specify the S3 SDK 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 S3 SDK Adapter for Snowball, as shown following.

aws s3 ls --endpoint http://localhost: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

The following subset of AWS CLI Amazon S3 commands and options are supported:

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

  • mv Moves a file or object to another location. You can't move an object from one destination on a Snowball to a different destination on the same 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. S3 does not 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.

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

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

  • sync Syncs directories and prefixes. Recursively copies new and updated files from the source directory to the destination. This command only creates folders in the destination if they contain one or more files.

    • --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 are followed only when uploading to S3 from the local file system. S3 does not 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.

    • --delete (boolean) Files that exist in the destination but not in the source are deleted during sync.

    • --exact-timestamps (boolean) When syncing from S3 to local, same-sized items are ignored only when the timestamps match exactly. The default behavior is to ignore same-sized items unless the local version is newer than the S3 version.

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

    • --size-only (boolean) With this option, the size of each key is the only criterion used to decide whether to sync from source to destination.

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