Event record

An event holds information about the operation done by the Ceph Object Gateway and is sent as a payload over the chosen endpoint, such as HTTP, HTTPS, Kafka, or AMQ0.9.1. The event record is in JSON format.

The following ObjectLifecycle:Expiration events are supported:
  • ObjectLifecycle:Expiration:Current
  • ObjectLifecycle:Expiration:NonCurrent
  • ObjectLifecycle:Expiration:DeleteMarker
  • ObjectLifecycle:Expiration:AbortMultipartUpload

Example

{"Records":[
    {
        "eventVersion":"2.1",
        "eventSource":"ceph:s3",
        "awsRegion":"us-east-1",
        "eventTime":"2019-11-22T13:47:35.124724Z",
        "eventName":"ObjectCreated:Put",
        "userIdentity":{
            "principalId":"tester"
        },
        "requestParameters":{
            "sourceIPAddress":""
        },
        "responseElements":{
            "x-amz-request-id":"503a4c37-85eb-47cd-8681-2817e80b4281.5330.903595",
            "x-amz-id-2":"14d2-zone1-zonegroup1"
        },
        "s3":{
            "s3SchemaVersion":"1.0",
            "configurationId":"mynotif1",
            "bucket":{
                "name":"mybucket1",
                "ownerIdentity":{
                    "principalId":"tester"
                },
                "arn":"arn:aws:s3:us-east-1::mybucket1",
                "id":"503a4c37-85eb-47cd-8681-2817e80b4281.5332.38"
            },
            "object":{
                "key":"myimage1.jpg",
                "size":"1024",
                "eTag":"37b51d194a7513e45b56f6524f2d51f2",
                "versionId":"",
                "sequencer": "F7E6D75DC742D108",
                "metadata":[],
                "tags":[]
            }
        },
        "eventId":"",
        "opaqueData":"me@example.com"
    }
]}

These are the event record keys and their definitions:

awsRegion

Zonegroup.

eventTime

Timestamp that indicates when the event was triggered.

eventName

The type of the event. It can be ObjectCreated, ObjectRemovedObjectLifecycle:Expiration

userIdentity.principalId

The identity of the user that triggered the event.

requestParameters.sourceIPAddress

The IP address of the client that triggered the event. This field is not supported.

responseElements.x-amz-request-id

The request ID that triggered the event.

responseElements.x_amzID2

The identity of the Ceph Object Gateway on which the event was triggered. The identity format is RGWID*-ZONE-ZONEGROUP.

s3.configurationId

The notification ID that created the event.

s3.bucket.name

The name of the bucket.

s3.bucket.ownerIdentity.principalId

The owner of the bucket.

s3.bucket.arn

Amazon Resource Name (ARN) of the bucket.

s3.bucket.id

Identity of the bucket.

s3.object.key

The object key.

s3.object.size

The size of the object.

s3.object.eTag

The object etag.

s3.object.version

The object version in a versioned bucket.

s3.object.sequencer

Monotonically increasing identifier of the change per object in the hexadecimal format.

s3.object.metadata

Any metadata set on the object sent as x-amz-meta.

s3.object.tags

Any tags set on the object.

s3.eventId

Unique identity of the event.

s3.opaqueData

Opaque data is set in the topic configuration and added to all notifications triggered by the topic.