Documentation

mc event ls

Syntax

The mc event ls command lists all event notification triggers for a bucket.

The alias mc event list has equivalent functionality to mc event ls.

The following command lists all configured event notifications for the specified bucket notification target for the mydata bucket on the myminio MinIO deployment:

mc event ls myminio myminio/mydata arn:aws:sqs::primary:target

The command has the following syntax:

mc [GLOBALFLAGS]
  • 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.

mc [GLOBALFLAGS] event remove [FLAGS] ALIAS ARN

Parameters

ALIAS

Required The S3 service alias and bucket to which the command lists event notification. For example:

mc event add play/mybucket
ARN

Required The Amazon Resource Name (ARN) of the bucket resource.

The MinIO server outputs an ARN for each configured notification target at server startup. See Bucket Notifications for more information.

Global Flags

This command supports any of the global flags.

Examples

List Event Notifications on a Bucket

The following command lists all event notification triggers on a bucket.

mc event ls myminio/mydata
mc event ls ALIAS ARN
  • Replace ALIAS with the alias of the MinIO deployment on which to add the bucket notification event. For example:

    myminio/mydata

  • Replace ARN with the notification target ARN.

Behavior

S3 Compatibility

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

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