.. _minio-bucket-notifications: ==================== Bucket Notifications ==================== .. default-domain:: minio .. contents:: Table of Contents :local: :depth: 2 MinIO bucket notifications allow administrators to send notifications to supported external services on certain object or bucket events. MinIO supports bucket and object-level S3 events similar to the :s3-docs:`Amazon S3 Event Notifications `. Supported Notification Targets ------------------------------ MinIO supports publishing event notifications to the following targets: .. list-table:: :header-rows: 1 :widths: 30 70 :width: 100% * - Target - Description * - :guilabel:`AMQP` (RabbitMQ) - Publish notifications to an AMQP service such as `RabbitMQ `__. See :ref:`minio-bucket-notifications-publish-amqp` for a tutorial. * - :guilabel:`MQTT` - Publish notifications to an `MQTT `__ service. See :ref:`minio-bucket-notifications-publish-mqtt` for a tutorial. * - :guilabel:`NATS` - Publish notifications to a `NATS `__ service. See :ref:`minio-bucket-notifications-publish-nats` for a tutorial. * - :guilabel:`NSQ` - Publish notifications to a `NSQ `__ service. See :ref:`minio-bucket-notifications-publish-nsq` for a tutorial * - :guilabel:`Elasticsearch` - Publish notifications to a `Elasticsearch `__ service. See :ref:`minio-bucket-notifications-publish-elasticsearch` for a tutorial. * - :guilabel:`Kafka` - Publish notifications to a `Kafka `__ service. See :ref:`minio-bucket-notifications-publish-kafka` for a tutorial. * - :guilabel:`MySQL` - Publish notifications to a `MySQL `__ service. See :ref:`minio-bucket-notifications-publish-mysql` for a tutorial. * - :guilabel:`PostgreSQL` - Publish notifications to a `PostgreSQL `__ service. See :ref:`minio-bucket-notifications-publish-postgresql` for a tutorial. * - :guilabel:`Redis` - Publish notifications to a `Redis `__ service. See :ref:`minio-bucket-notifications-publish-redis` for a tutorial. * - :guilabel:`webhook` - Publish notifications to a `Webhook `__ service. See :ref:`minio-bucket-notifications-publish-webhook` for a tutorial. Asynchronous vs Synchronous Bucket Notifications ------------------------------------------------ .. versionadded:: RELEASE.2023-06-23T20-26-00Z MinIO supports either asynchronous (default) or synchronous bucket notifications for *all* remote targets. With asynchronous delivery, MinIO fires the event at the configured remote and does *not* wait for a response before continuing to the next event. Asynchronous bucket notification prioritizes sending events with the risk of some events being lost if the remote target has a transient issue during transit or processing. With synchronous delivery, MinIO fires the event at the configured remote and then waits for the remote to confirm a successful receipt before continuing to the next event. Synchronous bucket notification prioritizes delivery of events with the risk of a slower event-send rate and queue fill. To enable synchronous bucket notifications for *all configured remote targets*, use either of the following settings: - Set the :envvar:`MINIO_API_SYNC_EVENTS` environment variable to ``on`` and restart the MinIO deployment. - Set the :mc-conf:`api.sync_events` configuration setting to ``on`` and restart the MinIO deployment. .. note:: MinIO maintains a per-remote queue of events (``10000`` by default) where it stores unsent and pending events. For asynchronous or synchronous bucket notifications, MinIO discards new events if the queue fills. You can increase the queue size as necessary to better accommodate the rate of event send and processing of the MinIO deployment and remote target. .. _minio-bucket-notifications-event-types: Supported S3 Event Types ------------------------ MinIO bucket notifications are compatible with :s3-docs:`Amazon S3 Event Notifications `. This section lists all supported events. Object Events ~~~~~~~~~~~~~ MinIO supports triggering notifications on the following S3 object events: .. data:: s3:ObjectAccessed:Get .. data:: s3:ObjectAccessed:GetLegalHold .. data:: s3:ObjectAccessed:GetRetention .. data:: s3:ObjectAccessed:Head .. data:: s3:ObjectCreated:CompleteMultipartUpload .. data:: s3:ObjectCreated:Copy .. data:: s3:ObjectCreated:DeleteTagging .. data:: s3:ObjectCreated:Post .. data:: s3:ObjectCreated:Put .. data:: s3:ObjectCreated:PutLegalHold .. data:: s3:ObjectCreated:PutRetention .. data:: s3:ObjectCreated:PutTagging .. data:: s3:ObjectRemoved:Delete .. data:: s3:ObjectRemoved:DeleteMarkerCreated Specify the wildcard ``*`` character to select all events related to a prefix: .. data:: s3:ObjectAccessed:* Selects all ``s3:ObjectAccessed``\ -prefixed events. .. data:: s3:ObjectCreated:* Selects all ``s3:ObjectCreated``\ -prefixed events. .. data:: s3:ObjectRemoved:* Selects all ``s3:ObjectRemoved``\ -prefixed events. Replication Events ~~~~~~~~~~~~~~~~~~ MinIO supports triggering notifications on the following S3 replication events: .. data:: s3:Replication:OperationCompletedReplication .. data:: s3:Replication:OperationFailedReplication .. data:: s3:Replication:OperationMissedThreshold .. data:: s3:Replication:OperationNotTracked .. data:: s3:Replication:OperationReplicatedAfterThreshold Specify the wildcard ``*`` character to select all ``s3:Replication`` events: .. data:: s3:Replication:* ILM Transition Events ~~~~~~~~~~~~~~~~~~~~~ MinIO supports triggering notifications on the following S3 ILM transition events: .. data:: s3:ObjectRestore:Post .. data:: s3:ObjectRestore:Completed .. data:: s3:ObjectTransition:Failed .. data:: s3:ObjectTransition:Complete Specify the wildcard ``*`` character to select all events related to a prefix: .. data:: s3:ObjectTransition:* Selects all ``s3:ObjectTransition``\ -prefixed events. .. data:: s3:ObjectRestore:* Selects all ``s3:ObjectRestore``\ -prefixed events. Scanner Events ~~~~~~~~~~~~~~ MinIO supports triggering notifications on the following S3 :ref:`scanner ` transition events: .. data:: s3:Scanner:ManyVersions :ref:`Scanner ` finds objects with more than 1,000 versions. .. data:: s3:Scanner:BigPrefix :ref:`Scanner ` finds prefixes with more than 50,000 sub-folders. Global Events ~~~~~~~~~~~~~ MinIO supports triggering notifications on the following global events. You can only listen to these events through the `ListenNotification `__ API: .. data:: s3:BucketCreated .. data:: s3:BucketRemoved .. todo .. toctree:: :titlesonly: :hidden: /administration/monitoring/publish-events-to-amqp /administration/monitoring/publish-events-to-mqtt /administration/monitoring/publish-events-to-nats /administration/monitoring/publish-events-to-nsq /administration/monitoring/publish-events-to-elasticsearch /administration/monitoring/publish-events-to-kafka /administration/monitoring/publish-events-to-mysql /administration/monitoring/publish-events-to-postgresql /administration/monitoring/publish-events-to-redis /administration/monitoring/publish-events-to-webhook