Schemas
Amazon EventBridge Schema Registry
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Amazon EventBridge Schema Registry
Endpoints 31
- GETList discoverers
/v1/discoverers?discovererIdPrefix=string&limit=0&nextToken=string&sourceArnPrefix=stringList the discoverers. - POSTCreate discoverer
/v1/discoverersCreates a discoverer. - GETDescribe registry
/v1/registries/name/:RegistryNameDescribes the registry. - PUTUpdate registry
/v1/registries/name/:RegistryNameUpdates a registry. - POSTCreate registry
/v1/registries/name/:RegistryNameCreates a registry. - DELETEDelete registry
/v1/registries/name/:RegistryNameDeletes a Registry. - GETDescribe schema
/v1/registries/name/:RegistryName/schemas/name/:SchemaName?schemaVersion=stringRetrieve the schema definition. - PUTUpdate schema
/v1/registries/name/:RegistryName/schemas/name/:SchemaNameUpdates the schema definition Inactive schemas will be deleted after two years. - POSTCreate schema
/v1/registries/name/:RegistryName/schemas/name/:SchemaNameCreates a schema definition. Inactive schemas will be deleted after two years. - DELETEDelete schema
/v1/registries/name/:RegistryName/schemas/name/:SchemaNameDelete a schema definition. - GETDescribe discoverer
/v1/discoverers/id/:DiscovererIdDescribes the discoverer. - PUTUpdate discoverer
/v1/discoverers/id/:DiscovererIdUpdates the discoverer - DELETEDelete discoverer
/v1/discoverers/id/:DiscovererIdDeletes a discoverer. - GETGet resource policy
/v1/policy?registryName=stringRetrieves the resource-based policy attached to a given registry. - PUTPut resource policy
/v1/policy?registryName=stringThe name of the policy. - DELETEDelete resource policy
/v1/policy?registryName=stringDelete the resource-based policy attached to the specified registry. - DELETEDelete schema version
/v1/registries/name/:RegistryName/schemas/name/:SchemaName/version/:SchemaVersionDelete the schema version definition - GETDescribe code binding
/v1/registries/name/:RegistryName/schemas/name/:SchemaName/language/:Language?schemaVersion=stringDescribe the code binding URI. - POSTPut code binding
/v1/registries/name/:RegistryName/schemas/name/:SchemaName/language/:Language?schemaVersion=stringPut code binding URI - GETExport schema
/v1/registries/name/:RegistryName/schemas/name/:SchemaName/export?schemaVersion=string&type=string - GETGet code binding source
/v1/registries/name/:RegistryName/schemas/name/:SchemaName/language/:Language/source?schemaVersion=stringGet the code binding source URI. - POSTGet discovered schema
/v1/discoverGet the discovered schema that was generated based on sampled events. - GETList registries
/v1/registries?limit=0&nextToken=string®istryNamePrefix=string&scope=stringList the registries. - GETList schema versions
/v1/registries/name/:RegistryName/schemas/name/:SchemaName/versions?limit=0&nextToken=stringProvides a list of the schema versions and related information. - GETList schemas
/v1/registries/name/:RegistryName/schemas?limit=0&nextToken=string&schemaNamePrefix=stringList the schemas. - GETList tags for resource
/tags/:ResourceArnGet tags for resource. - POSTTag resource
/tags/:ResourceArnAdd tags to a resource. - DELETEUntag resource
/tags/:ResourceArn?tagKeys=Removes tags from a resource. - GETSearch schemas
/v1/registries/name/:RegistryName/schemas/search?keywords=string&limit=0&nextToken=stringSearch the schemas - POSTStart discoverer
/v1/discoverers/id/:DiscovererId/startStarts the discoverer - POSTStop discoverer
/v1/discoverers/id/:DiscovererId/stopStops the discoverer
API details
- Base URL
https://schemas.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 31 operations on 17 pathsGET 13POST 8DELETE 6PUT 4
- Description format
- AWS Smithy model, API version
2019-12-02 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Schemas in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Schemas collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List discoverers” (GET /v1/discoverers?discovererIdPrefix=string&limit=0&nextToken=string&sourceArnPrefix=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Schemas?
Amazon EventBridge Schema Registry It is listed under Developer tools and has 31 endpoints.
Who publishes the Schemas?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Schemas?
Requests go to https://schemas.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Schemas?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Schemas have?
31 operations on 17 paths (13 GET, 8 POST, 6 DELETE, 4 PUT).
Is forking the Schemas free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.