Amazon EventBridge · Schema
Amazon EventBridge Event
JSON Schema for the standard Amazon EventBridge event envelope. All events delivered through EventBridge conform to this structure.
Amazon Web ServicesEvent BusEvent-DrivenEventsIntegrationServerless
Properties
| Name | Type | Description |
|---|---|---|
| version | string | By default, this is set to 0 (zero) in all events. |
| id | string | A unique identifier for the event, generated by EventBridge for each event. |
| detail-type | string | Identifies, in combination with the source field, the fields and values that appear in the detail field. |
| source | string | Identifies the service or application that generated the event. All events originating from AWS services begin with aws. |
| account | string | The 12-digit number identifying an AWS account. |
| time | string | The event timestamp, which can be specified by the service originating the event. |
| region | string | Identifies the AWS region where the event originated. |
| resources | array | A JSON array containing ARNs that identify resources that are involved in the event. |
| detail | object | A JSON object that contains information about the event. The service generating the event determines the content of this field. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://aws.amazon.com/eventbridge/schemas/event.json",
"title": "Amazon EventBridge Event",
"description": "JSON Schema for the standard Amazon EventBridge event envelope. All events delivered through EventBridge conform to this structure.",
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "By default, this is set to 0 (zero) in all events.",
"const": "0"
},
"id": {
"type": "string",
"format": "uuid",
"description": "A unique identifier for the event, generated by EventBridge for each event."
},
"detail-type": {
"type": "string",
"description": "Identifies, in combination with the source field, the fields and values that appear in the detail field."
},
"source": {
"type": "string",
"description": "Identifies the service or application that generated the event. All events originating from AWS services begin with aws."
},
"account": {
"type": "string",
"pattern": "^[0-9]{12}$",
"description": "The 12-digit number identifying an AWS account."
},
"time": {
"type": "string",
"format": "date-time",
"description": "The event timestamp, which can be specified by the service originating the event."
},
"region": {
"type": "string",
"description": "Identifies the AWS region where the event originated.",
"examples": [
"us-east-1",
"us-west-2",
"eu-west-1",
"ap-southeast-1"
]
},
"resources": {
"type": "array",
"items": {
"type": "string"
},
"description": "A JSON array containing ARNs that identify resources that are involved in the event."
},
"detail": {
"type": "object",
"description": "A JSON object that contains information about the event. The service generating the event determines the content of this field.",
"additionalProperties": true
}
},
"required": [
"version",
"id",
"detail-type",
"source",
"account",
"time",
"region",
"resources",
"detail"
],
"additionalProperties": false,
"examples": [
{
"version": "0",
"id": "12345678-1234-1234-1234-123456789012",
"detail-type": "EC2 Instance State-change Notification",
"source": "aws.ec2",
"account": "123456789012",
"time": "2023-10-01T12:00:00Z",
"region": "us-east-1",
"resources": [
"arn:aws:ec2:us-east-1:123456789012:instance/i-1234567890abcdef0"
],
"detail": {
"instance-id": "i-1234567890abcdef0",
"state": "running"
}
}
]
}