`bm tag set`

Syntax

The bm tag set command sets one or more tags to a bucket or object.

Buckit supports adding up to 10 custom tags to an object.

EXAMPLE

The following command sets tags for the mydata bucket on the mybuckit Buckit deployment:

bm tag set mybuckit/mydata "tag1=value1&tag2=value2"

SYNTAX

The command has the following syntax:

bm [GLOBALFLAGS] tag set                   \
                 [--rewind "string"]       \
                 [--versions]              \
                 [--version-id "string"]*  \
                 ALIAS                     \
                 "TAGS"

Brackets [] indicate optional parameters.
Parameters sharing a line are mutually dependent.
Parameters separated using the pipe | operator are mutually exclusive.

Copy the example to a text editor and modify as-needed before running the command in the terminal/shell.

bm tag set --version-id is mutually exclusive with multiple parameters. See the reference documentation for more information.

Parameters

ALIAS

Required

The alias for a Buckit deployment and the full path to the object on which to apply the tag (e.g. bucket and path to object). For example:

bm tag set mybuckit/mybucket/object.txt

TAGS

Required

An ampersand-seperated (&) list of key-value pairs (KEY=VALUE), where each pair represents one tag to assign to the object. For example:

bm tag set mybuckit/mybucket/object.txt "key1=value1&key2=value2"

--exclude-folders: Optional

--recursive, r: Optional

--rewind

Optional

Directs bm tag set to operate only on the object version(s) that existed at specified point-in-time.

To rewind to a specific date in the past, specify the date as an ISO8601-formatted timestamp. For example: --rewind "2020.03.24T10:00".
To rewind a duration in time, specify the duration as a string in #d#hh#mm#ss format. For example: --rewind "1d2hh3mm4ss".

--rewind requires that the specified ALIAS be an S3-compatible service that supports Bucket Versioning. For Buckit deployments, use bm version to enable or disable bucket versioning.

--versions

Optional

Directs bm tag set to operate on all object versions that exist in the bucket.

--versions requires that the specified ALIAS be an S3-compatible service that supports Bucket Versioning. For Buckit deployments, use bm version to enable or disable bucket versioning.

Use --versions and --rewind together to apply the tag all object versions which existed at a specific point in time.

--version-id, --vid

Optional

Directs bm tag set to operate only on the specified object version.

--version-id requires that the specified ALIAS be an S3-compatible service that supports Bucket Versioning. For Buckit deployments, use bm version to enable or disable bucket versioning.

Mutually exclusive with the following parameters:

--rewind
--versions

Global Flags

This command supports any of the global flags.

Examples

Apply Tags to a Bucket or Object

Use bm tag set to apply tags to a bucket or object:

bm tag set ALIAS/PATH "TAGS"

Replace ALIAS with the alias of the Buckit deployment.
Replace PATH with the path to the bucket or object on the Buckit deployment.
Replace TAGS with one or more ampersand-separated (&) key-value pairs for each tag and its corresponding value.

Behavior

S3 Compatibility

The bm commandline tool is built for compatibility with the AWS S3 API and is tested with Buckit and AWS S3 for expected functionality and behavior.

Buckit provides no guarantees for other S3-compatible services, as their S3 API implementation is unknown and therefore unsupported. While bm commands may work as documented, any such usage is at your own risk.