canonical: https://jentic.com/apis/amazonaws.com/amazon-eventbridge-schema-registry

# AWS Amazon EventBridge Schema Registry

Jentic publishes the only available OpenAPI specification for Amazon EventBridge Schema Registry, keeping it validated and agent-ready. The Schema Registry stores and versions the structure of events flowing through Amazon EventBridge - both AWS-published schemas and custom schemas your applications produce. Discoverers can auto-detect new schema shapes from event traffic; the registry exposes versions, code-binding artifacts, and search so engineering teams can generate strongly-typed event handlers in their language of choice.

## For AI agents

Store, version, discover, and generate code bindings for the event schemas that flow through Amazon EventBridge.

## Scope

Does not publish, route, or consume events itself, and does not enforce schemas at runtime - use for storing, versioning, discovering, and generating code bindings for event schemas only.

## Capabilities

- Create and manage schema registries with CreateRegistry and DeleteRegistry
- Author or import OpenAPI 3 / JSON Schema event definitions with CreateSchema and UpdateSchema
- Track schema versions and inspect a specific version with DescribeSchema and ListSchemaVersions
- Auto-detect new schemas from EventBridge event traffic with CreateDiscoverer and StartDiscoverer
- Search schemas by keyword or content with SearchSchemas across registries
- Generate strongly-typed code bindings (Java, Python, TypeScript) with PutCodeBinding and GetCodeBindingSource
- Tag schemas and registries for ownership and lifecycle policies

## Use cases

### Strongly-typed event consumer generation

Application teams use the Schema Registry to generate Java, Python, or TypeScript code bindings for events they consume from EventBridge. PutCodeBinding triggers generation; GetCodeBindingSource downloads the artifact zip. This eliminates hand-written deserialisation, catches breaking-change bugs at compile time rather than runtime, and keeps consumers in step with producers across teams.

Example prompt: Call PutCodeBinding with RegistryName='my-app', SchemaName='OrderPlaced', SchemaVersion='3', and Language='Python36', then poll DescribeCodeBinding until status is CREATE_COMPLETE and download via GetCodeBindingSource.

### Auto-discovery of unknown event shapes

Platform teams turn on schema discovery against an event bus to automatically generate schemas for new event shapes that arrive. CreateDiscoverer and StartDiscoverer attach the discoverer to a bus; the registry then populates the discovered-schemas registry as events flow, giving engineering visibility into payload structure without manual onboarding.

Example prompt: Call CreateDiscoverer with the EventBridge bus ARN, StartDiscoverer to begin discovery, then list discovered schemas with ListSchemas filtered by SchemaType='OpenApi3'.

### Schema governance across teams

Architecture teams use multiple registries to separate AWS-managed schemas from team-owned schemas, applying tags via TagResource so each registry is clearly owned. UpdateSchema accepts new versions while preserving prior ones, so consumers can pin to a known version while producers iterate. This is the governance layer that prevents accidental breaking changes from rippling through downstream services.

Example prompt: Call CreateRegistry RegistryName='payments-team', CreateSchema for InvoiceFinalised with content from the team's OpenAPI 3 definition, then TagResource with Owner='payments-team'.

### Agent-driven event schema lookup through Jentic

AI agents that route or transform events use Jentic to call DescribeSchema, SearchSchemas, and ListSchemaVersions without holding raw AWS credentials. Jentic stores keys in your Jentic One instance, signs each request with SigV4, and returns the structured schema content - so an agent can fetch the canonical shape of an event before deciding how to handle it.

Example prompt: Search Jentic for 'describe an EventBridge schema', load DescribeSchema, and execute it with RegistryName='aws.events' and SchemaName matching the event detail-type to retrieve the canonical structure.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /v1/registries/name/{registryName} | Create a schema registry |
| POST | /v1/registries/name/{registryName}/schemas/name/{schemaName} | Create or update a schema |
| GET | /v1/registries/name/{registryName}/schemas/name/{schemaName} | Describe a schema and its content |
| GET | /v1/registries/name/{registryName}/schemas | List schemas in a registry |
| POST | /v1/discoverers | Create a schema discoverer on an EventBridge bus |
| GET | /v1/discoverers | List discoverers |
| POST | /v1/registries/name/{registryName}/schemas/name/{schemaName}/language/{language} | Generate a code binding |
| GET | /v1/registries/name/{registryName}/schemas/name/{schemaName}/language/{language}/source | Download a generated code binding |

## Key resources

- **Registry** — A namespace for schemas - separates AWS-managed, discovered, and custom schemas
- **Schema** — A versioned event definition in OpenAPI 3 or JSON Schema format
- **SchemaVersion** — An immutable revision of a schema's content
- **Discoverer** — An agent attached to an EventBridge bus that auto-generates schemas from observed events
- **CodeBinding** — Generated client code (Java, Python, TypeScript) for a specific schema version
- **Tags** — Key-value pairs applied to registries and schemas for ownership

## Why Jentic

- **Setup:** Wiring Amazon EventBridge Schema Registry by hand means implementing AWS SigV4 signing, resolving the schemas regional host, and polling code-binding generation to completion before downloading the artifact. Through Jentic you install once, import Amazon EventBridge Schema Registry from the API Directory, store your AWS access key and secret once, and your agent calls it.
- **Permission scoping:** The Schema Registry puts registryName and schemaName in the URL path (/v1/registries/name/{registryName}/schemas/name/{schemaName}), so a rule can pin your agent to one registry: it can read and describe schemas in that registry and nothing else. You choose the operations it may call, so DeleteRegistry or DeleteSchema are not included unless you add them.
- **Credential handling:** Your AWS access key and secret are stored once, encrypted, by your own Jentic One instance and each request is signed with SigV4 at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'describe an EventBridge schema' or 'generate Python code bindings for a schema', and Jentic returns the matching operation like DescribeSchema or PutCodeBinding with its input schema so the agent calls it without reading the AWS reference.

## Related APIs

- **Amazon EventBridge** — The event bus that the schema registry catalogues schemas for
- **AWS Lambda** — Lambda functions are the most common typed-binding consumers of registered schemas
- **AWS Step Functions** — Step Functions workflows triggered by EventBridge benefit from registered, versioned schemas

## FAQ

### Why is there no official OpenAPI spec for the EventBridge Schema Registry?

AWS does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Amazon EventBridge Schema Registry via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the EventBridge Schema Registry API use?

It uses AWS Signature Version 4 HMAC signing with an access key ID and secret access key, optionally with a session token. Through Jentic, those credentials live in your Jentic One instance and the agent never handles raw secrets - Jentic signs each request server-side.

### Can I publish or consume events with the EventBridge Schema Registry API?

No - this API stores schemas and versions, not events themselves. To publish events, use the EventBridge PutEvents operation on the events service. To consume, attach an EventBridge target (Lambda, SQS, Step Functions). The schema registry is the type system, not the event bus.

### What are the rate limits for the EventBridge Schema Registry API?

AWS does not publish a fixed RPS in the spec; standard AWS API throttling applies and the service returns ThrottlingException on overage. There are also quotas on schemas per registry and discoverers per account, surfaced in the AWS service quotas console.

### How do I generate Python code bindings for an event schema through Jentic?

Search Jentic for 'generate EventBridge code binding', load PutCodeBinding, and call POST /v1/registries/name/{registryName}/schemas/name/{schemaName}/language/Python36. Poll DescribeCodeBinding until Status is CREATE_COMPLETE, then download with GetCodeBindingSource. Install with pip install jentic.

### What schema formats does the EventBridge Schema Registry support?

The registry supports OpenAPI 3.0 and JSON Schema Draft 4 as schema content. CreateSchema accepts either format; DescribeSchema returns the original content as written. AWS-managed schemas (the aws.events registry) are published in OpenAPI 3.0 form by default.

### Can I limit what my agent is allowed to do with the EventBridge Schema Registry API?

Yes. Jentic One runs self-hosted, so your own rules decide which operations and credentials the agent may use. Because the API puts registryName and schemaName in the URL path, you can pin the agent to a single registry and grant only read operations such as DescribeSchema, ListSchemaVersions, and SearchSchemas. Destructive calls like DeleteRegistry and DeleteSchema stay out of reach unless you explicitly add them, and your AWS access key and secret are signed server-side so the agent never handles the raw credentials.