EventBridge events detail reference
EventBridge itself emits the following events. These events are automatically sent to the default event bus as with any other Amazon service.
For definitions of the metadata fields that are included in all events, see Event structure reference.
Scheduled Event
Below are the detail fields for the Scheduled Event
event.
The source
and detail-type
fields are included because they contain specific values for EventBridge events.
For definitions of the other metadata fields that are included in all events, see Event structure reference.
{ . . ., "detail-type": "Scheduled Event", "source": "aws.events", . . ., "detail": {} }
detail-type
-
Identifies the type of event.
For this event, this value is
Scheduled Event
.Required: Yes
source
-
Identifies the service that generated the event. For EventBridge events, this value is
aws.events
.Required: Yes
detail
-
A JSON object that contains information about the event. The service generating the event determines the content of this field.
Required: Yes
There are no required fields in this object for
Scheduled Event
events.
Example Scheduled Event event
{ "version": "0", "id": "89d1a02d-5ec7-412e-82f5-13505f849b41", "detail-type": "Scheduled Event", "source": "aws.events", "account": "123456789012", "time": "2016-12-30T18:44:49Z", "region": "us-east-1", "resources": ["arn:aws:events:us-east-1:123456789012:rule/SampleRule"], "detail": {} }
Schema Created
Below are the detail fields for the Schema Created
event.
When a schema is created, EventBridge sends both a Schema Created
and a Schema Version Created
event.
The source
and detail-type
fields are included because they contain specific values for EventBridge events.
For definitions of the other metadata fields that are included in all events, see Event structure reference.
{ . . ., "detail-type": "Schema Created", "source": "aws.schemas", . . ., "detail": { "SchemaName" : "String", "SchemaType" : "String", "RegistryName" : "String", "CreationDate" : "DateTime", "Version" : "Number" } }
detail-type
-
Identifies the type of event.
For this event, this value is
Schema Created
.Required: Yes
source
-
Identifies the service that generated the event. For EventBridge events, this value is
aws.schemas
.Required: Yes
detail
-
A JSON object that contains information about the event. The service generating the event determines the content of this field.
Required: Yes
For this event, this data includes:
SchemaName
-
The name of the schema.
Required: Yes
SchemaType
-
The type of schema.
Valid values:
OpenApi3
|JSONSchemaDraft4
Required: Yes
RegistryName
-
The name of the registry that contains the schema.
Required: Yes
CreationDate
-
The date the schema was created.
Required: Yes
Version
-
The version of the schema.
For
Schema Created
events, this value will always be1
.Required: Yes
Example Schema Created event
{ "version": "0", "id": "01234567-0123-0123-0123-012345678901", "detail-type": "Schema Created", "source": "aws.schemas", "account": "123456789012", "time": "2019-05-31T21:49:54Z", "region": "us-east-1", "resources": ["arn:aws:schemas:us-east-1::schema/myRegistry/mySchema"], "detail": { "SchemaName": "mySchema", "SchemaType": "OpenApi3", "RegistryName": "myRegistry", "CreationDate": "2019-11-29T20:08:55Z", "Version": "1" } }
Schema Version Created
Below are the detail fields for the Schema Version Created
event.
When a schema is created, EventBridge sends both a Schema Created
and a Schema Version Created
event.
The source
and detail-type
fields are included because they contain specific values for EventBridge events.
For definitions of the other metadata fields that are included in all events, see Event structure reference.
{ . . ., "detail-type": "Schema Version Created", "source": "aws.schemas", . . ., "detail": { "SchemaName" : "String", "SchemaType" : "String", "RegistryName" : "String", "CreationDate" : "DateTime", "Version" : "Number" } }
detail-type
-
Identifies the type of event.
For this event, this value is
Schema Version Created
.Required: Yes
source
-
Identifies the service that generated the event. For EventBridge events, this value is
aws.schemas
.Required: Yes
detail
-
A JSON object that contains information about the event. The service generating the event determines the content of this field.
Required: Yes
For this event, this data includes:
SchemaName
-
The name of the schema.
Required: Yes
SchemaType
-
The type of schema.
Valid values:
OpenApi3
|JSONSchemaDraft4
Required: Yes
RegistryName
-
The name of the registry that contains the schema.
Required: Yes
CreationDate
-
The date the schema version was created.
Required: Yes
Version
-
The version of the schema.
Required: Yes
Example Schema Version Created event
{ "version": "0", "id": "01234567-0123-0123-0123-012345678901", "detail-type": "Schema Version Created", "source": "aws.schemas", "account": "123456789012", "time": "2019-05-31T21:49:54Z", "region": "us-east-1", "resources": ["arn:aws:schemas:us-east-1::schema/myRegistry/mySchema"], "detail": { "SchemaName": "mySchema", "SchemaType": "OpenApi3", "RegistryName": "myRegistry", "CreationDate": "2019-11-29T20:08:55Z", "Version": "5" } }