Using S3COM

The S3COM command line interface (CLI) can be used manage S3 objects in a manner similar to the AWS CLI. Commands may be entered interactivity or supplied with a TACL macro or obey file.

S3COM supports the following commands and objects:

CODE

Commands:

!                  ALLOW              CP                 ENV
EXIT               FC                 HELP               HISTORY
INFO               LS                 MV                 OBEY
PAGESIZE           RM                 VALIDATE           VOLUME

Objects:

LICENSE

The commands used to interact with the S3 Object store are:

CP - Copies a local file or S3 object to another location locally or in S3.
LS - List S3 objects and common prefixes under a prefix or all S3 buckets.
MV - Moves a local file or S3 object to another location locally or in S3.
RM - Deletes a S3 object.

The S3 commands take one or two path arguments. The first path argument always represents the source reference. The second path, if provided, represents the destination. The path argument may be a LocalPath or S3Uri.

LocalPath - Represents a Guardian Enscribe file name. This name may be fully or partially qualified. If partially qualified, the full name will be resolved using the value of the _DEFAULTS DEFINE.
S3Uri - Represents the location of an S3 object, prefix, or bucket.

S3COM is self documenting using the HELP command. For example:

TEXT

TACL> run s3com
S3COM - 1.0.0
Copyright (c) 2023 NuWave Technologies, Inc. All rights reserved.
S3COM 1-> help
Help is available on the following commands and objects:
Commands:

!                  ALLOW              CP                 ENV
EXIT               FC                 HELP               HISTORY
INFO               LS                 MV                 OBEY
PAGESIZE           RM                 VALIDATE           VOLUME

Objects:

LICENSE

Enter HELP <command> | <object> for more information.
S3COM 2-> help cp

CP Command

Copies a local file or S3 object to another location locally or in S3.

  CP <source>
     , <destination> [ ! ]
     [ , PROFILE <profile-name> ]
     [ , REGION <s3-region> ]
     [ , DEBUG ]

<source>

  The source local path or S3Uri.

<destination> [ ! ]

  The destination local path or S3Uri.

PROFILE <profile-name>

  Use a specific profile from your credential file.

REGION <s3-region>

   The region to use. Overrides config/env settings.

DEBUG

  Enable debug logging.

S3COM 3->