Upload
others
View
20
Download
0
Embed Size (px)
Citation preview
Amazon EventBridge Schemas REST API Reference
Amazon EventBridge Schemas: REST API ReferenceCopyright © 2020 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.
Amazon's trademarks and trade dress may not be used in connection with any product or service that is notAmazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages ordiscredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who mayor may not be affiliated with, connected to, or sponsored by Amazon.
Amazon EventBridge Schemas REST API Reference
Table of ContentsWelcome .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Operations .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Resources .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Schemas .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4URI ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4HTTP Methods .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Schemas .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Properties ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
List Schema Versions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7URI ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7HTTP Methods .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Schemas .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Properties ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Registries ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10URI ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10HTTP Methods .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Schemas .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Properties ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Stop Discoverer ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13URI ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13HTTP Methods .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Schemas .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Properties ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Start Discoverer ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14URI ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14HTTP Methods .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Schemas .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Properties ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Delete Schema Version .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16URI ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16HTTP Methods .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Schemas .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Properties ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Get Code Binding Source .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18URI ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18HTTP Methods .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Schemas .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Properties ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Tag .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19URI ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19HTTP Methods .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Schemas .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Properties ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Describe or Update Discoverer ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22URI ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22HTTP Methods .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Schemas .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Properties ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Code Binding .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26URI ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26HTTP Methods .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Schemas .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Properties ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Schema .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
iii
Amazon EventBridge Schemas REST API Reference
URI .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30HTTP Methods .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Schemas .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Properties ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Search Schemas .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38URI ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38HTTP Methods .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Schemas .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Properties ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Discoverers ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41URI ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41HTTP Methods .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Schemas .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Properties ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Discover .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46URI ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46HTTP Methods .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Schemas .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47Properties ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Registry .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48URI ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48HTTP Methods .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Schemas .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Properties ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Document History .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54AWS Glossary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
iv
Amazon EventBridge Schemas REST API Reference
WelcomeWelcome to the Amazon EventBridge Schema Registry API Reference.
The Amazon EventBridge Schema Registry allows you to discover, create, and manage OpenAPI schemasfor events on EventBridge. Using these API actions you can find schemas for existing AWS services,create and upload custom schemas, or generate a schema based on messages on an event bus. Youcan download code bindings for popular languages for all schemas in EventBridge to quickly buildapplications that use those events.
NoteInactive schemas will be deleted after two years.
For more information on Amazon EventBridge, and managing schemas in the EventBridge console, seethe following.
• Amazon EventBridge Schema Registry• Tutorial: Download Code Bindings for AWS Events
1
Amazon EventBridge Schemas REST API Reference
OperationsThe Amazon EventBridge Schemas REST API includes the following operations.
• CreateDiscoverer (p. 41)
Creates a discoverer.• CreateRegistry (p. 49)
Creates a registry.• CreateSchema (p. 30)
Creates a schema definition.
NoteInactive schemas will be deleted after two years.
• DeleteDiscoverer (p. 23)
Deletes a discoverer.• DeleteRegistry (p. 49)
Deletes a Registry.• DeleteSchema (p. 31)
Delete a schema definition.• DeleteSchemaVersion (p. 16)
Delete the schema version definition• DescribeCodeBinding (p. 27)
Describe the code binding URI.• DescribeDiscoverer (p. 23)
Describes the discoverer.• DescribeRegistry (p. 50)
Describes the registry.• DescribeSchema (p. 32)
Retrieve the schema definition.• GetCodeBindingSource (p. 18)
Get the code binding source URI.• GetDiscoveredSchema (p. 46)
Get the discovered schema that was generated based on sampled events.• ListDiscoverers (p. 41)
List the discoverers.• ListRegistries (p. 10)
List the registries.• ListSchemas (p. 4)
2
Amazon EventBridge Schemas REST API Reference
List the schemas.• ListSchemaVersions (p. 7)
Provides a list of the schema versions and related information.• ListTagsForResource (p. 21)
Get tags for resource.• PutCodeBinding (p. 26)
Put code binding URI• SearchSchemas (p. 38)
Search the schemas• StartDiscoverer (p. 15)
Starts the discoverer• StopDiscoverer (p. 13)
Stops the discoverer• TagResource (p. 19)
Add tags to a resource.• UntagResource (p. 20)
Removes tags from a resource.• UpdateDiscoverer (p. 22)
Updates the discoverer• UpdateRegistry (p. 48)
Updates a registry.• UpdateSchema (p. 30)
Updates the schema definition
NoteInactive schemas will be deleted after two years.
3
Amazon EventBridge Schemas REST API ReferenceSchemas
ResourcesThe Amazon EventBridge Schemas REST API includes the following resources.
Topics
• Schemas (p. 4)
• List Schema Versions (p. 7)
• Registries (p. 10)
• Stop Discoverer (p. 13)
• Start Discoverer (p. 14)
• Delete Schema Version (p. 16)
• Get Code Binding Source (p. 18)
• Tag (p. 19)
• Describe or Update Discoverer (p. 22)
• Code Binding (p. 26)
• Schema (p. 30)
• Search Schemas (p. 38)
• Discoverers (p. 41)
• Discover (p. 46)
• Registry (p. 48)
Schemas
URI/api/v1/registries/name/registryName/schemas
HTTP Methods
GET
Operation ID: ListSchemas
List the schemas.
Path Parameters
Name Type Required Description
registryName String True The name of theschema registry.
4
Amazon EventBridge Schemas REST API ReferenceSchemas
Query Parameters
Name Type Required Description
schemaNamePrefix String False Specifying this limitsthe results to only thoseschema names thatstart with the specifiedprefix.
limit String False The maximum numberof results to return perpage.
nextToken String False The token that specifiesthe next page of resultsto return. To requestthe first page, leaveNextToken empty. Thetoken will expire in24 hours, and cannotbe shared with otheraccounts.
Responses
Status Code Response Model Description
200 ListSchemasOutput (p. 5) 200 response
400 ErrorOutput (p. 6) 400 response
401 ErrorOutput (p. 6) 401 response
403 ErrorOutput (p. 6) 403 response
500 ErrorOutput (p. 6) 500 response
503 ErrorOutput (p. 6) 503 response
SchemasResponse BodiesExample ListSchemasOutput
{ "NextToken": "string", "Schemas": [ { "LastModified": "string", "SchemaName": "string", "SchemaArn": "string", "VersionCount": integer, "tags": { } } ]
5
Amazon EventBridge Schemas REST API ReferenceProperties
}
Example ErrorOutput
{ "Message": "string", "Code": "string"}
PropertiesErrorOutputMessage
The message string of the error output.
Type: stringRequired: True
Code
The error code.
Type: stringRequired: True
ListSchemasOutputNextToken
The token that specifies the next page of results to return. To request the first page, leave NextTokenempty. The token will expire in 24 hours, and cannot be shared with other accounts.
Type: stringRequired: False
Schemas
An array of schema summaries.
Type: Array of type SchemaSummary (p. 6)Required: False
SchemaSummaryA summary of schema details.
LastModified
The date and time that schema was modified.
Type: stringRequired: False
6
Amazon EventBridge Schemas REST API ReferenceList Schema Versions
Format: date-time
SchemaName
The name of the schema.
Type: stringRequired: False
SchemaArn
The ARN of the schema.
Type: stringRequired: False
VersionCount
The number of versions available for the schema.
Type: integerRequired: FalseFormat: int64
tags
Tags associated with the schema.
Type: Tags (p. 7)Required: False
TagsKey-value pairs associated with a resource.
key-value pairs
Type: string
List Schema VersionsURI/api/v1/registries/name/registryName/schemas/name/schemaName/versions
HTTP MethodsGETOperation ID: ListSchemaVersions
Provides a list of the schema versions and related information.
7
Amazon EventBridge Schemas REST API ReferenceSchemas
Path Parameters
Name Type Required Description
registryName String True The name of theschema registry.
schemaName String True The name of theschema.
Query Parameters
Name Type Required Description
limit String False The maximum numberof results to return perpage.
nextToken String False The token that specifiesthe next page of resultsto return. To requestthe first page, leaveNextToken empty. Thetoken will expire in24 hours, and cannotbe shared with otheraccounts.
Responses
Status Code Response Model Description
200 ListSchemaVersionsOutput (p. 8)200 response
400 ErrorOutput (p. 9) 400 response
401 ErrorOutput (p. 9) 401 response
403 ErrorOutput (p. 9) 403 response
404 ErrorOutput (p. 9) 404 response
500 ErrorOutput (p. 9) 500 response
503 ErrorOutput (p. 9) 503 response
SchemasResponse BodiesExample ListSchemaVersionsOutput
{ "SchemaVersions": [ { "SchemaVersion": "string", "SchemaArn": "string",
8
Amazon EventBridge Schemas REST API ReferenceProperties
"SchemaName": "string" } ], "NextToken": "string"}
Example ErrorOutput
{ "Message": "string", "Code": "string"}
PropertiesErrorOutputMessage
The message string of the error output.
Type: stringRequired: True
Code
The error code.
Type: stringRequired: True
ListSchemaVersionsOutputSchemaVersions
An array of schema version summaries.
Type: Array of type SchemaVersionSummary (p. 9)Required: False
NextToken
The token that specifies the next page of results to return. To request the first page, leave NextTokenempty. The token will expire in 24 hours, and cannot be shared with other accounts.
Type: stringRequired: False
SchemaVersionSummarySchemaVersion
The version number of the schema.
Type: string
9
Amazon EventBridge Schemas REST API ReferenceRegistries
Required: False
SchemaArn
The ARN of the schema version.
Type: stringRequired: False
SchemaName
The name of the schema.
Type: stringRequired: False
RegistriesURI/api/v1/registries
HTTP MethodsGETOperation ID: ListRegistries
List the registries.
Query Parameters
Name Type Required Description
scope String False Can be set to Local orAWS to limit responsesto your customregistries, or the onesprovided by AWS.
limit String False The maximum numberof results to return perpage.
nextToken String False The token that specifiesthe next page of resultsto return. To requestthe first page, leaveNextToken empty. Thetoken will expire in24 hours, and cannotbe shared with otheraccounts.
registryNamePrefix String False Specifying this limitsthe results to only those
10
Amazon EventBridge Schemas REST API ReferenceSchemas
Name Type Required Description
registry names thatstart with the specifiedprefix.
Responses
Status Code Response Model Description
200 ListRegistriesOutput (p. 11)200 response
400 ErrorOutput (p. 11) 400 response
401 ErrorOutput (p. 11) 401 response
403 ErrorOutput (p. 11) 403 response
500 ErrorOutput (p. 11) 500 response
503 ErrorOutput (p. 11) 503 response
SchemasResponse BodiesExample ListRegistriesOutput
{ "NextToken": "string", "Registries": [ { "RegistryName": "string", "RegistryArn": "string", "tags": { } } ]}
Example ErrorOutput
{ "Message": "string", "Code": "string"}
PropertiesErrorOutputMessage
The message string of the error output.
Type: string
11
Amazon EventBridge Schemas REST API ReferenceProperties
Required: True
Code
The error code.
Type: stringRequired: True
ListRegistriesOutputList the registries.
NextToken
The token that specifies the next page of results to return. To request the first page, leave NextTokenempty. The token will expire in 24 hours, and cannot be shared with other accounts.
Type: stringRequired: False
Registries
An array of registry summaries.
Type: Array of type RegistrySummary (p. 12)Required: False
RegistrySummaryRegistryName
The name of the registry.
Type: stringRequired: False
RegistryArn
The ARN of the registry.
Type: stringRequired: False
tags
Tags associated with the registry.
Type: Tags (p. 12)Required: False
TagsKey-value pairs associated with a resource.
12
Amazon EventBridge Schemas REST API ReferenceStop Discoverer
key-value pairs
Type: string
Stop DiscovererURI/api/v1/discoverers/id/discovererId/stop
HTTP MethodsPOSTOperation ID: StopDiscoverer
Stops the discoverer
Path Parameters
Name Type Required Description
discovererId String True The ID of the discoverer.
Responses
Status Code Response Model Description
200 DiscovererStateOutput (p. 13)200 response
400 ErrorOutput (p. 14) 400 response
401 ErrorOutput (p. 14) 401 response
403 ErrorOutput (p. 14) 403 response
404 ErrorOutput (p. 14) 404 response
500 ErrorOutput (p. 14) 500 response
503 ErrorOutput (p. 14) 503 response
SchemasResponse Bodies
Example DiscovererStateOutput
{ "State": enum, "DiscovererId": "string"}
13
Amazon EventBridge Schemas REST API ReferenceProperties
Example ErrorOutput
{ "Message": "string", "Code": "string"}
PropertiesDiscovererState
STARTEDSTOPPED
DiscovererStateOutputState
The state of the discoverer.
Type: DiscovererState (p. 14)Required: False
DiscovererId
The ID of the discoverer.
Type: stringRequired: False
ErrorOutputMessage
The message string of the error output.
Type: stringRequired: True
Code
The error code.
Type: stringRequired: True
Start DiscovererURI/api/v1/discoverers/id/discovererId/start
14
Amazon EventBridge Schemas REST API ReferenceHTTP Methods
HTTP MethodsPOSTOperation ID: StartDiscoverer
Starts the discoverer
Path Parameters
Name Type Required Description
discovererId String True The ID of the discoverer.
Responses
Status Code Response Model Description
200 DiscovererStateOutput (p. 15)200 response
400 ErrorOutput (p. 15) 400 response
401 ErrorOutput (p. 15) 401 response
403 ErrorOutput (p. 15) 403 response
404 ErrorOutput (p. 15) 404 response
500 ErrorOutput (p. 15) 500 response
503 ErrorOutput (p. 15) 503 response
SchemasResponse BodiesExample DiscovererStateOutput
{ "State": enum, "DiscovererId": "string"}
Example ErrorOutput
{ "Message": "string", "Code": "string"}
PropertiesDiscovererState
STARTED
15
Amazon EventBridge Schemas REST API ReferenceDelete Schema Version
STOPPED
DiscovererStateOutput
State
The state of the discoverer.
Type: DiscovererState (p. 15)Required: False
DiscovererId
The ID of the discoverer.
Type: stringRequired: False
ErrorOutput
Message
The message string of the error output.
Type: stringRequired: True
Code
The error code.
Type: stringRequired: True
Delete Schema Version
URI/api/v1/registries/name/registryName/schemas/name/schemaName/version/schemaVersion
HTTP Methods
DELETE
Operation ID: DeleteSchemaVersion
Delete the schema version definition
16
Amazon EventBridge Schemas REST API ReferenceSchemas
Path Parameters
Name Type Required Description
schemaVersion String True The version number ofthe schema
registryName String True The name of theschema registry.
schemaName String True The name of theschema.
Responses
Status Code Response Model Description
204 None 204 response
400 ErrorOutput (p. 17) 400 response
401 ErrorOutput (p. 17) 401 response
403 ErrorOutput (p. 17) 403 response
404 ErrorOutput (p. 17) 404 response
500 ErrorOutput (p. 17) 500 response
503 ErrorOutput (p. 17) 503 response
SchemasResponse BodiesExample ErrorOutput
{ "Message": "string", "Code": "string"}
PropertiesErrorOutputMessage
The message string of the error output.
Type: stringRequired: True
Code
The error code.
17
Amazon EventBridge Schemas REST API ReferenceGet Code Binding Source
Type: stringRequired: True
Get Code Binding SourceURI/api/v1/registries/name/registryName/schemas/name/schemaName/language/language/source
HTTP MethodsGETOperation ID: GetCodeBindingSource
Get the code binding source URI.
Path Parameters
Name Type Required Description
registryName String True The name of theschema registry.
schemaName String True The name of theschema.
language String True The language of thecode binding.
Query Parameters
Name Type Required Description
schemaVersion String False Specifying this limitsthe results to only thisschema version.
Responses
Status Code Response Model Description
200 GetCodeBindingSourceOutput (p. 19)200 response
400 ErrorOutput (p. 19) 400 response
401 ErrorOutput (p. 19) 401 response
403 ErrorOutput (p. 19) 403 response
404 ErrorOutput (p. 19) 404 response
429 ErrorOutput (p. 19) 429 response
500 ErrorOutput (p. 19) 500 response
18
Amazon EventBridge Schemas REST API ReferenceSchemas
Schemas
Response Bodies
Example GetCodeBindingSourceOutput
"string"
Example ErrorOutput
{ "Message": "string", "Code": "string"}
Properties
ErrorOutput
Message
The message string of the error output.
Type: stringRequired: True
Code
The error code.
Type: stringRequired: True
TagA tag is a key-value pair associated with a resource. You can use these metadata tags to identify thepurpose of a broker or configuration.
URI/api/tags/resource-arn
HTTP Methods
POST
Operation ID: TagResource
19
Amazon EventBridge Schemas REST API ReferenceHTTP Methods
Add tags to a resource.
Path Parameters
Name Type Required Description
resource-arn String True The ARN of theresource.
Responses
Status Code Response Model Description
204 None 204 response
400 ErrorOutput (p. 21) 400 response
403 ErrorOutput (p. 21) 403 response
404 ErrorOutput (p. 21) 404 response
500 ErrorOutput (p. 21) 500 response
DELETE
Operation ID: UntagResource
Removes tags from a resource.
Path Parameters
Name Type Required Description
resource-arn String True The ARN of theresource.
Query Parameters
Name Type Required Description
tagKeys String True Keys of key-value pairs.
Responses
Status Code Response Model Description
204 None 204 response
400 ErrorOutput (p. 21) 400 response
403 ErrorOutput (p. 21) 403 response
404 ErrorOutput (p. 21) 404 response
500 ErrorOutput (p. 21) 500 response
20
Amazon EventBridge Schemas REST API ReferenceSchemas
GET
Operation ID: ListTagsForResource
Get tags for resource.
Path Parameters
Name Type Required Description
resource-arn String True The ARN of theresource.
Responses
Status Code Response Model Description
200 Tags (p. 21) 200 response
400 ErrorOutput (p. 21) 400 response
403 ErrorOutput (p. 21) 403 response
404 ErrorOutput (p. 21) 404 response
500 ErrorOutput (p. 21) 500 response
Schemas
Request Bodies
Example POST
{ "tags": { }}
Response Bodies
Example Tags
{}
Example ErrorOutput
{ "Message": "string", "Code": "string"}
21
Amazon EventBridge Schemas REST API ReferenceProperties
Properties
ErrorOutput
Message
The message string of the error output.
Type: stringRequired: True
Code
The error code.
Type: stringRequired: True
TagResourceInput
tags
Tags associated with the resource.
Type: Tags (p. 22)Required: True
TagsKey-value pairs associated with a resource.
key-value pairs
Type: string
Describe or Update Discoverer
URI/api/v1/discoverers/id/discovererId
HTTP Methods
PUTOperation ID: UpdateDiscoverer
Updates the discoverer
22
Amazon EventBridge Schemas REST API ReferenceHTTP Methods
Path Parameters
Name Type Required Description
discovererId String True The ID of the discoverer.
Responses
Status Code Response Model Description
200 DiscovererOutput (p. 24) 200 response
400 ErrorOutput (p. 24) 400 response
401 ErrorOutput (p. 24) 401 response
403 ErrorOutput (p. 24) 403 response
404 ErrorOutput (p. 24) 404 response
500 ErrorOutput (p. 24) 500 response
503 ErrorOutput (p. 24) 503 response
DELETEOperation ID: DeleteDiscoverer
Deletes a discoverer.
Path Parameters
Name Type Required Description
discovererId String True The ID of the discoverer.
Responses
Status Code Response Model Description
204 None 204 response
400 ErrorOutput (p. 24) 400 response
401 ErrorOutput (p. 24) 401 response
403 ErrorOutput (p. 24) 403 response
404 ErrorOutput (p. 24) 404 response
500 ErrorOutput (p. 24) 500 response
503 ErrorOutput (p. 24) 503 response
GETOperation ID: DescribeDiscoverer
23
Amazon EventBridge Schemas REST API ReferenceSchemas
Describes the discoverer.
Path Parameters
Name Type Required Description
discovererId String True The ID of the discoverer.
Responses
Status Code Response Model Description
200 DiscovererOutput (p. 24) 200 response
400 ErrorOutput (p. 24) 400 response
401 ErrorOutput (p. 24) 401 response
403 ErrorOutput (p. 24) 403 response
404 ErrorOutput (p. 24) 404 response
500 ErrorOutput (p. 24) 500 response
503 ErrorOutput (p. 24) 503 response
Schemas
Request Bodies
Example PUT
{ "Description": "string"}
Response Bodies
Example DiscovererOutput
{ "Description": "string", "tags": { }, "DiscovererId": "string", "State": enum, "DiscovererArn": "string", "SourceArn": "string"}
Example ErrorOutput
{ "Message": "string",
24
Amazon EventBridge Schemas REST API ReferenceProperties
"Code": "string"}
Properties
DiscovererOutput
Description
The description of the discoverer.
Type: stringRequired: False
tags
Tags associated with the resource.
Type: Tags (p. 26)Required: False
DiscovererId
The ID of the discoverer.
Type: stringRequired: False
State
The state of the discoverer.
Type: DiscovererState (p. 25)Required: False
DiscovererArn
The ARN of the discoverer.
Type: stringRequired: False
SourceArn
The ARN of the event bus.
Type: stringRequired: False
DiscovererStateSTARTED
25
Amazon EventBridge Schemas REST API ReferenceCode Binding
STOPPED
ErrorOutput
Message
The message string of the error output.
Type: stringRequired: True
Code
The error code.
Type: stringRequired: True
TagsKey-value pairs associated with a resource.
key-value pairs
Type: string
UpdateDiscovererInput
Description
The description of the discoverer to update.
Type: stringRequired: FalseMinLength: 0MaxLength: 256
Code BindingURI/api/v1/registries/name/registryName/schemas/name/schemaName/language/language
HTTP Methods
POSTOperation ID: PutCodeBinding
Put code binding URI
26
Amazon EventBridge Schemas REST API ReferenceHTTP Methods
Path Parameters
Name Type Required Description
registryName String True The name of theschema registry.
schemaName String True The name of theschema.
language String True The language of thecode binding.
Query Parameters
Name Type Required Description
schemaVersion String False Specifying this limitsthe results to only thisschema version.
Responses
Status Code Response Model Description
202 CodeBindingOutput (p. 28) 202 response
400 ErrorOutput (p. 28) 400 response
401 ErrorOutput (p. 28) 401 response
403 ErrorOutput (p. 28) 403 response
404 ErrorOutput (p. 28) 404 response
410 ErrorOutput (p. 28) 410 response
429 ErrorOutput (p. 28) 429 response
500 ErrorOutput (p. 28) 500 response
GET
Operation ID: DescribeCodeBinding
Describe the code binding URI.
Path Parameters
Name Type Required Description
registryName String True The name of theschema registry.
schemaName String True The name of theschema.
27
Amazon EventBridge Schemas REST API ReferenceSchemas
Name Type Required Description
language String True The language of thecode binding.
Query Parameters
Name Type Required Description
schemaVersion String False Specifying this limitsthe results to only thisschema version.
Responses
Status Code Response Model Description
200 CodeBindingOutput (p. 28) 200 response
400 ErrorOutput (p. 28) 400 response
401 ErrorOutput (p. 28) 401 response
403 ErrorOutput (p. 28) 403 response
404 ErrorOutput (p. 28) 404 response
429 ErrorOutput (p. 28) 429 response
500 ErrorOutput (p. 28) 500 response
Schemas
Response Bodies
Example CodeBindingOutput
{ "Status": enum, "LastModified": "string", "SchemaVersion": "string", "CreationDate": "string"}
Example ErrorOutput
{ "Message": "string", "Code": "string"}
28
Amazon EventBridge Schemas REST API ReferenceProperties
Properties
CodeBindingOutput
Status
The current status of code binding generation.
Type: CodeGenerationStatus (p. 29)Required: False
LastModified
The date and time that code bindings were modified.
Type: stringRequired: FalseFormat: date-time
SchemaVersion
The version number of the schema.
Type: stringRequired: False
CreationDate
The time and date that the code binding was created.
Type: stringRequired: FalseFormat: date-time
CodeGenerationStatusCREATE_IN_PROGRESSCREATE_COMPLETECREATE_FAILED
ErrorOutput
Message
The message string of the error output.
Type: stringRequired: True
Code
The error code.
29
Amazon EventBridge Schemas REST API ReferenceSchema
Type: stringRequired: True
SchemaURI/api/v1/registries/name/registryName/schemas/name/schemaName
HTTP MethodsPUTOperation ID: UpdateSchema
Updates the schema definition
NoteInactive schemas will be deleted after two years.
Path Parameters
Name Type Required Description
registryName String True The name of theschema registry.
schemaName String True The name of theschema.
Responses
Status Code Response Model Description
200 SchemaOutput (p. 33) 200 response
304 None 304 response
400 ErrorOutput (p. 33) 400 response
403 ErrorOutput (p. 33) 403 response
404 ErrorOutput (p. 33) 404 response
500 ErrorOutput (p. 33) 500 response
503 ErrorOutput (p. 33) 503 response
POSTOperation ID: CreateSchema
Creates a schema definition.
NoteInactive schemas will be deleted after two years.
30
Amazon EventBridge Schemas REST API ReferenceHTTP Methods
Path Parameters
Name Type Required Description
registryName String True The name of theschema registry.
schemaName String True The name of theschema.
Responses
Status Code Response Model Description
201 SchemaOutput (p. 33) 201 response
400 ErrorOutput (p. 33) 400 response
403 ErrorOutput (p. 33) 403 response
500 ErrorOutput (p. 33) 500 response
503 ErrorOutput (p. 33) 503 response
DELETE
Operation ID: DeleteSchema
Delete a schema definition.
Path Parameters
Name Type Required Description
registryName String True The name of theschema registry.
schemaName String True The name of theschema.
Responses
Status Code Response Model Description
204 None 204 response
400 ErrorOutput (p. 33) 400 response
401 ErrorOutput (p. 33) 401 response
403 ErrorOutput (p. 33) 403 response
404 ErrorOutput (p. 33) 404 response
500 ErrorOutput (p. 33) 500 response
503 ErrorOutput (p. 33) 503 response
31
Amazon EventBridge Schemas REST API ReferenceSchemas
GETOperation ID: DescribeSchema
Retrieve the schema definition.
Path Parameters
Name Type Required Description
registryName String True The name of theschema registry.
schemaName String True The name of theschema.
Query Parameters
Name Type Required Description
schemaVersion String False Specifying this limitsthe results to only thisschema version.
Responses
Status Code Response Model Description
200 DescribeSchemaOutput (p. 33)200 response
400 ErrorOutput (p. 33) 400 response
401 ErrorOutput (p. 33) 401 response
403 ErrorOutput (p. 33) 403 response
404 ErrorOutput (p. 33) 404 response
500 ErrorOutput (p. 33) 500 response
503 ErrorOutput (p. 33) 503 response
Schemas
Request Bodies
Example PUT
{ "Content": "string", "Type": enum, "Description": "string", "ClientTokenId": "string"}
32
Amazon EventBridge Schemas REST API ReferenceProperties
Example POST
{ "Content": "string", "Type": enum, "Description": "string", "tags": { }}
Response Bodies
Example SchemaOutput
{ "SchemaArn": "string", "Description": "string", "tags": { }, "LastModified": "string", "VersionCreatedDate": "string", "SchemaVersion": "string", "Type": "string", "SchemaName": "string"}
Example DescribeSchemaOutput
{ "SchemaArn": "string", "Description": "string", "tags": { }, "LastModified": "string", "Content": "string", "VersionCreatedDate": "string", "SchemaVersion": "string", "Type": "string", "SchemaName": "string"}
Example ErrorOutput
{ "Message": "string", "Code": "string"}
PropertiesCreateSchemaInputContent
The source of the schema definition.
Type: string
33
Amazon EventBridge Schemas REST API ReferenceProperties
Required: TrueMinLength: 1MaxLength: 100000
Type
The type of schema.
Type: stringRequired: TrueValues: OpenApi3
Description
A description of the schema.
Type: stringRequired: FalseMinLength: 0MaxLength: 256
tags
Tags associated with the schema.
Type: Tags (p. 37)Required: False
DescribeSchemaOutputSchemaArn
The ARN of the schema.
Type: stringRequired: False
Description
The description of the schema.
Type: stringRequired: False
tags
Tags associated with the resource.
Type: Tags (p. 37)Required: False
LastModified
The date and time that schema was modified.
34
Amazon EventBridge Schemas REST API ReferenceProperties
Type: stringRequired: FalseFormat: date-time
Content
The source of the schema definition.
Type: stringRequired: False
VersionCreatedDate
The date the schema version was created.
Type: stringRequired: FalseFormat: date-time
SchemaVersion
The version number of the schema
Type: stringRequired: False
Type
The type of the schema.
Type: stringRequired: False
SchemaName
The name of the schema.
Type: stringRequired: False
ErrorOutput
Message
The message string of the error output.
Type: stringRequired: True
Code
The error code.
35
Amazon EventBridge Schemas REST API ReferenceProperties
Type: stringRequired: True
SchemaOutput
SchemaArn
The ARN of the schema.
Type: stringRequired: False
Description
The description of the schema.
Type: stringRequired: False
tags
Type: Tags (p. 37)Required: False
LastModified
The date and time that schema was modified.
Type: stringRequired: FalseFormat: date-time
VersionCreatedDate
The date the schema version was created.
Type: stringRequired: FalseFormat: date-time
SchemaVersion
The version number of the schema
Type: stringRequired: False
Type
The type of the schema.
Type: string
36
Amazon EventBridge Schemas REST API ReferenceProperties
Required: False
SchemaName
The name of the schema.
Type: stringRequired: False
TagsKey-value pairs associated with a resource.
key-value pairs
Type: string
UpdateSchemaInput
Content
The source of the schema definition.
Type: stringRequired: FalseMinLength: 1MaxLength: 100000
Type
The schema type for the events schema.
Type: stringRequired: FalseValues: OpenApi3
Description
The description of the schema.
Type: stringRequired: FalseMinLength: 0MaxLength: 256
ClientTokenId
The ID of the client token.
Type: stringRequired: FalseMinLength: 0MaxLength: 36
37
Amazon EventBridge Schemas REST API ReferenceSearch Schemas
Search Schemas
URI/api/v1/registries/name/registryName/schemas/search
HTTP Methods
GETOperation ID: SearchSchemas
Search the schemas
Path Parameters
Name Type Required Description
registryName String True The name of theschema registry.
Query Parameters
Name Type Required Description
keywords String True Specifying this limitsthe results to onlyschemas that includethe provided keywords.
limit String False The maximum numberof results to return perpage.
nextToken String False The token that specifiesthe next page of resultsto return. To requestthe first page, leaveNextToken empty. Thetoken will expire in24 hours, and cannotbe shared with otheraccounts.
Responses
Status Code Response Model Description
200 SearchSchemasOutput (p. 39)200 response
400 ErrorOutput (p. 39) 400 response
401 ErrorOutput (p. 39) 401 response
38
Amazon EventBridge Schemas REST API ReferenceSchemas
Status Code Response Model Description
403 ErrorOutput (p. 39) 403 response
500 ErrorOutput (p. 39) 500 response
503 ErrorOutput (p. 39) 503 response
SchemasResponse Bodies
Example SearchSchemasOutput
{ "NextToken": "string", "Schemas": [ { "RegistryName": "string", "SchemaVersions": [ { "SchemaVersion": "string", "CreatedDate": "string" } ], "SchemaName": "string", "SchemaArn": "string" } ]}
Example ErrorOutput
{ "Message": "string", "Code": "string"}
PropertiesErrorOutputMessage
The message string of the error output.
Type: stringRequired: True
Code
The error code.
Type: stringRequired: True
39
Amazon EventBridge Schemas REST API ReferenceProperties
SearchSchemaSummaryRegistryName
The name of the registry.
Type: stringRequired: False
SchemaVersions
An array of schema version summaries.
Type: Array of type SearchSchemaVersionSummary (p. 40)Required: False
SchemaName
The name of the schema.
Type: stringRequired: False
SchemaArn
The ARN of the schema.
Type: stringRequired: False
SearchSchemaVersionSummarySchemaVersion
The version number of the schema
Type: stringRequired: False
CreatedDate
The date the schema version was created.
Type: stringRequired: FalseFormat: date-time
SearchSchemasOutputNextToken
The token that specifies the next page of results to return. To request the first page, leave NextTokenempty. The token will expire in 24 hours, and cannot be shared with other accounts.
Type: string
40
Amazon EventBridge Schemas REST API ReferenceDiscoverers
Required: False
Schemas
An array of SearchSchemaSummary information.
Type: Array of type SearchSchemaSummary (p. 40)Required: False
DiscoverersDiscoverers allow you to infer EventBridge Schemas based on the events on an event bus.
URI/api/v1/discoverers
HTTP MethodsPOSTOperation ID: CreateDiscoverer
Creates a discoverer.
Responses
Status Code Response Model Description
201 DiscovererOutput (p. 43) 201 response
400 ErrorOutput (p. 43) 400 response
401 ErrorOutput (p. 43) 401 response
403 ErrorOutput (p. 43) 403 response
409 ErrorOutput (p. 43) 409 response
500 ErrorOutput (p. 43) 500 response
503 ErrorOutput (p. 43) 503 response
GETOperation ID: ListDiscoverers
List the discoverers.
Query Parameters
Name Type Required Description
sourceArnPrefix String False Specifying this limitsthe results to only those
41
Amazon EventBridge Schemas REST API ReferenceSchemas
Name Type Required Description
ARNs that start with thespecified prefix.
limit String False The maximum numberof results to return perpage.
nextToken String False The token that specifiesthe next page of resultsto return. To requestthe first page, leaveNextToken empty. Thetoken will expire in24 hours, and cannotbe shared with otheraccounts.
discovererIdPrefix String False Specifying this limitsthe results to only thosediscoverer IDs thatstart with the specifiedprefix.
Responses
Status Code Response Model Description
200 ListDiscoverersOutput (p. 43)200 response
400 ErrorOutput (p. 43) 400 response
401 ErrorOutput (p. 43) 401 response
403 ErrorOutput (p. 43) 403 response
500 ErrorOutput (p. 43) 500 response
503 ErrorOutput (p. 43) 503 response
Schemas
Request Bodies
Example POST
{ "tags": { }, "Description": "string", "SourceArn": "string"}
42
Amazon EventBridge Schemas REST API ReferenceProperties
Response Bodies
Example ListDiscoverersOutput
{ "NextToken": "string", "Discoverers": [ { "State": enum, "tags": { }, "DiscovererArn": "string", "SourceArn": "string", "DiscovererId": "string" } ]}
Example DiscovererOutput
{ "Description": "string", "tags": { }, "DiscovererId": "string", "State": enum, "DiscovererArn": "string", "SourceArn": "string"}
Example ErrorOutput
{ "Message": "string", "Code": "string"}
Properties
CreateDiscovererInput
tags
Tags associated with the resource.
Type: Tags (p. 46)Required: False
Description
A description for the discoverer.
Type: stringRequired: FalseMinLength: 0
43
Amazon EventBridge Schemas REST API ReferenceProperties
MaxLength: 256
SourceArn
The ARN of the event bus.
Type: stringRequired: TrueMinLength: 20MaxLength: 1600
DiscovererOutput
Description
The description of the discoverer.
Type: stringRequired: False
tags
Tags associated with the resource.
Type: Tags (p. 46)Required: False
DiscovererId
The ID of the discoverer.
Type: stringRequired: False
State
The state of the discoverer.
Type: DiscovererState (p. 45)Required: False
DiscovererArn
The ARN of the discoverer.
Type: stringRequired: False
SourceArn
The ARN of the event bus.
Type: stringRequired: False
44
Amazon EventBridge Schemas REST API ReferenceProperties
DiscovererStateSTARTEDSTOPPED
DiscovererSummaryState
The state of the discoverer.
Type: DiscovererState (p. 45)Required: False
tags
Tags associated with the resource.
Type: Tags (p. 46)Required: False
DiscovererArn
The ARN of the discoverer.
Type: stringRequired: False
SourceArn
The ARN of the event bus.
Type: stringRequired: False
DiscovererId
The ID of the discoverer.
Type: stringRequired: False
ErrorOutputMessage
The message string of the error output.
Type: stringRequired: True
Code
The error code.
45
Amazon EventBridge Schemas REST API ReferenceDiscover
Type: stringRequired: True
ListDiscoverersOutputNextToken
The token that specifies the next page of results to return. To request the first page, leave NextTokenempty. The token will expire in 24 hours, and cannot be shared with other accounts.
Type: stringRequired: False
Discoverers
An array of DiscovererSummary information.
Type: Array of type DiscovererSummary (p. 45)Required: False
TagsKey-value pairs associated with a resource.
key-value pairs
Type: string
DiscoverAllows you get the discovered schemas that have been inferred from events on an event bus.
URI/api/v1/discover
HTTP MethodsPOSTOperation ID: GetDiscoveredSchema
Get the discovered schema that was generated based on sampled events.
Responses
Status Code Response Model Description
200 GetDiscoveredSchemaOutput (p. 47)200 response
400 ErrorOutput (p. 47) 400 response
401 ErrorOutput (p. 47) 401 response
46
Amazon EventBridge Schemas REST API ReferenceSchemas
Status Code Response Model Description
403 ErrorOutput (p. 47) 403 response
500 ErrorOutput (p. 47) 500 response
503 ErrorOutput (p. 47) 503 response
SchemasRequest Bodies
Example POST
{ "Type": enum, "Events": [ "string" ]}
Response Bodies
Example GetDiscoveredSchemaOutput
{ "Content": "string"}
Example ErrorOutput
{ "Message": "string", "Code": "string"}
PropertiesErrorOutputMessage
The message string of the error output.
Type: stringRequired: True
Code
The error code.
Type: stringRequired: True
47
Amazon EventBridge Schemas REST API ReferenceRegistry
GetDiscoveredSchemaInputType
The type of event.
Type: stringRequired: TrueValues: OpenApi3
Events
An array of strings where each string is a JSON event. These are the events that were used to generatethe schema. The array includes a single type of event and has a maximum size of 10 events.
Type: Array of type stringRequired: True
GetDiscoveredSchemaOutputContent
The source of the schema definition.
Type: stringRequired: False
RegistryURI/api/v1/registries/name/registryName
HTTP MethodsPUTOperation ID: UpdateRegistry
Updates a registry.
Path Parameters
Name Type Required Description
registryName String True The name of theschema registry.
Responses
Status Code Response Model Description
200 RegistryOutput (p. 51) 200 response
48
Amazon EventBridge Schemas REST API ReferenceHTTP Methods
Status Code Response Model Description
400 ErrorOutput (p. 51) 400 response
401 ErrorOutput (p. 51) 401 response
403 ErrorOutput (p. 51) 403 response
404 ErrorOutput (p. 51) 404 response
500 ErrorOutput (p. 51) 500 response
503 ErrorOutput (p. 51) 503 response
POSTOperation ID: CreateRegistry
Creates a registry.
Path Parameters
Name Type Required Description
registryName String True The name of theschema registry.
Responses
Status Code Response Model Description
201 RegistryOutput (p. 51) 201 response
400 ErrorOutput (p. 51) 400 response
401 ErrorOutput (p. 51) 401 response
403 ErrorOutput (p. 51) 403 response
409 ErrorOutput (p. 51) 409 response
500 ErrorOutput (p. 51) 500 response
503 ErrorOutput (p. 51) 503 response
DELETEOperation ID: DeleteRegistry
Deletes a Registry.
Path Parameters
Name Type Required Description
registryName String True The name of theschema registry.
49
Amazon EventBridge Schemas REST API ReferenceSchemas
Responses
Status Code Response Model Description
204 None 204 response
400 ErrorOutput (p. 51) 400 response
401 ErrorOutput (p. 51) 401 response
403 ErrorOutput (p. 51) 403 response
404 ErrorOutput (p. 51) 404 response
500 ErrorOutput (p. 51) 500 response
503 ErrorOutput (p. 51) 503 response
GETOperation ID: DescribeRegistry
Describes the registry.
Path Parameters
Name Type Required Description
registryName String True The name of theschema registry.
Responses
Status Code Response Model Description
200 RegistryOutput (p. 51) 200 response
400 ErrorOutput (p. 51) 400 response
401 ErrorOutput (p. 51) 401 response
403 ErrorOutput (p. 51) 403 response
404 ErrorOutput (p. 51) 404 response
500 ErrorOutput (p. 51) 500 response
503 ErrorOutput (p. 51) 503 response
SchemasRequest Bodies
Example PUT
{ "Description": "string"
50
Amazon EventBridge Schemas REST API ReferenceProperties
}
Example POST
{ "Description": "string", "tags": { }}
Response Bodies
Example RegistryOutput
{ "RegistryName": "string", "tags": { }, "Description": "string", "RegistryArn": "string"}
Example ErrorOutput
{ "Message": "string", "Code": "string"}
PropertiesCreateRegistryInputDescription
A description of the registry to be created.
Type: stringRequired: FalseMinLength: 0MaxLength: 256
tags
Tags to associate with the registry.
Type: Tags (p. 52)Required: False
ErrorOutputMessage
The message string of the error output.
51
Amazon EventBridge Schemas REST API ReferenceProperties
Type: stringRequired: True
Code
The error code.
Type: stringRequired: True
RegistryOutputRegistryName
The name of the registry.
Type: stringRequired: False
tags
Tags associated with the registry.
Type: Tags (p. 52)Required: False
Description
The description of the registry.
Type: stringRequired: False
RegistryArn
The ARN of the registry.
Type: stringRequired: False
TagsKey-value pairs associated with a resource.
key-value pairs
Type: string
UpdateRegistryInputDescription
The description of the registry to update.
52
Amazon EventBridge Schemas REST API ReferenceProperties
Type: stringRequired: FalseMinLength: 0MaxLength: 256
53
Amazon EventBridge Schemas REST API Reference
Document History for AmazonEventBridge Schemas
The following table describes the documentation for this release of Amazon EventBridge Schemas.
• API version: latest• Latest documentation update: December 1, 2019
Change API Version Description Release Date
Initial release 2019-12-01 The initial release ofAmazon EventBridgeSchemas.
December 1, 2019
54
Amazon EventBridge Schemas REST API Reference
AWS GlossaryFor the latest AWS terminology, see the AWS Glossary in the AWS General Reference.
55