Supported Amazon CLI commands - Amazon Snowball Edge Developer Guide
Supported Amazon CLI commands for Amazon S3
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 Amazon CLI commands

Following, you can find information about how to specify the Amazon S3 adapter or Amazon S3 compatible storage on Snow Family devices as the endpoint for applicable Amazon Command Line Interface (Amazon CLI) commands. You can also find the list of Amazon CLI commands for Amazon S3 that are supported for transferring data to the Amazon Snowball Edge device with the adapter or Amazon S3 compatible storage on Snow Family devices.

Note

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

Currently, Snowball Edge devices support only version 1.16.14 and earlier of the Amazon CLI when using the Amazon S3 adapter. See Snowball Edge client version. If you are using Amazon S3 compatible storage on Snow Family devices, you can use the lastest version of the Amazon CLI. To download and use the latest version, see Amazon Command Line Interface User Guide.

Note

Be sure to install version 2.6.5+ or 3.4+ of Python before you install version 1.16.14 of the Amazon CLI.

Supported Amazon CLI commands for Amazon S3

Following is a description of the subset of Amazon CLI commands and options for Amazon S3 that the Amazon Snowball Edge device supports. If a command or option isn't listed, 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 Amazon Snowball Edge device. The following are options for this command:

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

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

    • --include (string) – Don't exclude files or objects in the command that match the specified pattern. For details, see Use of Exclude and Include Filters in the Amazon CLI Command Reference.

    • --exclude (string) – Exclude all files or objects from the command that matches the specified pattern.

    • --follow-symlinks | --no-follow-symlinks (Boolean) – Symbolic links (symlinks) are followed only when uploading to Amazon 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.

    • --page-size (integer) – The number of results to return in each response to a list operation. The default value is 1000 (the maximum allowed). Using a lower value might help if an operation times out.

    • --metadata (map) – A map of metadata to store with the objects in Amazon S3. This map is applied to every object that is part of this request. In a sync, this functionality means that files that haven't changed don't receive the new metadata. When copying between two Amazon S3 locations, the metadata-directive argument defaults to REPLACE unless otherwise specified.

  • ls – Lists objects on the Amazon Snowball Edge device. The following are options for this command:

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

    • --summarize (Boolean) – Summary information is displayed. This information is the number of objects and their total size.

    • --recursive (Boolean) – The command is performed on all files or objects under the specified directory or prefix.

    • --page-size (integer) – The number of results to return in each response to a list operation. The default value is 1000 (the maximum allowed). Using a lower value might help if an operation times out.

  • rm – Deletes an object on the Amazon Snowball Edge device. The following are options for this command:

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

    • --include (string) – Don't exclude files or objects in the command that match the specified pattern. For details, see Use of Exclude and Include Filters in the Amazon CLI Command Reference.

    • --exclude (string) – Exclude all files or objects from the command that matches the specified pattern.

    • --recursive (Boolean) – The command is performed on all files or objects under the specified directory or prefix.

    • --page-size (integer) – The number of results to return in each response to a list operation. The default value is 1000 (the maximum allowed). Using a lower value might help if an operation times out.

    • --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. This command copies new and updated files from the source directory to the destination. This command only creates directories in the destination if they contain one or more files.

    Important

    Syncing from one directory to another directory on the same Snowball Edge isn't supported.

    Syncing from one Amazon Snowball device to another Amazon Snowball device isn't supported.

    You can only use this option to sync the contents between your on-premises data storage and a Snowball Edge.

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

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

    • --include (string) – Don't exclude files or objects in the command that match the specified pattern. For details, see Use of Exclude and Include Filters in the Amazon CLI Command Reference.

    • --exclude (string) – Exclude all files or objects from the command that matches the specified pattern.

    • --follow-symlinks or --no-follow-symlinks (Boolean) – Symbolic links (symlinks) are followed only when uploading to Amazon 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.

    • --no-progress (Boolean) – File transfer progress is not displayed. This option is only applied when the --quiet and --only-show-errors options are not provided.

    • --page-size (integer) – The number of results to return in each response to a list operation. The default value is 1000 (the maximum allowed). Using a lower value might help if an operation times out.

    • --metadata (map) – A map of metadata to store with the objects in Amazon S3. This map is applied to every object that is part of this request. In a sync, this functionality means that files that haven't changed don't receive the new metadata. When copying between two Amazon S3 locations, the metadata-directive argument defaults to REPLACE unless otherwise specified.

      Important

      Syncing from one directory to another directory on the same Snowball Edge isn't supported.

      Syncing from one Amazon Snowball device to another Amazon Snowball device isn't supported.

      You can only use this option to sync the contents between your on-premises data storage and a Snowball Edge.

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

    • --exact-timestamps (Boolean) – When syncing from Amazon S3 to local storage, 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 Amazon S3 version.

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

You can work with files or folders with spaces in their names, such as my photo.jpg or My Documents. However, make sure that you handle the spaces properly in the Amazon CLI commands. For more information, see Specifying parameter values for the Amazon CLI in the Amazon Command Line Interface User Guide.