amazon eventbridge - api referencethe name of the new event bus. event bus names cannot contain the...
TRANSCRIPT
Amazon EventBridgeAPI Reference
API Version 2015-10-07
Amazon EventBridge API Reference
Amazon EventBridge: 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 API Reference
Table of ContentsAmazon EventBridge API Reference .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Actions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
ActivateEventSource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
CancelReplay .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
CreateArchive .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
CreateEventBus .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
CreatePartnerEventSource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
DeactivateEventSource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
DeleteArchive .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
DeleteEventBus .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
API Version 2015-10-07iii
Amazon EventBridge API Reference
DeletePartnerEventSource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
DeleteRule .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Examples .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
DescribeArchive .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
DescribeEventBus .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Examples .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
DescribeEventSource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
DescribePartnerEventSource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
DescribeReplay .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
DescribeRule .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Examples .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
API Version 2015-10-07iv
Amazon EventBridge API Reference
DisableRule .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Examples .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
EnableRule .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Examples .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
ListArchives .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
ListEventBuses .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
ListEventSources .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
ListPartnerEventSourceAccounts .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
ListPartnerEventSources .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
ListReplays .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
ListRuleNamesByTarget .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
API Version 2015-10-07v
Amazon EventBridge API Reference
Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Examples .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
ListRules .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Examples .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
ListTagsForResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Examples .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
ListTargetsByRule .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Examples .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
PutEvents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Examples .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
PutPartnerEvents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
PutPermission .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Examples .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
PutRule .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
API Version 2015-10-07vi
Amazon EventBridge API Reference
Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Examples .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
PutTargets ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103Examples .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
RemovePermission .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
RemoveTargets ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115Examples .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
StartReplay .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
TagResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123Examples .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
TestEventPattern .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126Examples .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
UntagResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128Examples .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
UpdateArchive .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
API Version 2015-10-07vii
Amazon EventBridge API Reference
Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Data Types .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134Archive .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
AwsVpcConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
BatchArrayProperties ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
BatchParameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
BatchRetryStrategy .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Condition .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
DeadLetterConfig .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
EcsParameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
EventBus .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
EventSource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
HttpParameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
InputTransformer .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
KinesisParameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
NetworkConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
PartnerEventSource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
PartnerEventSourceAccount .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
PutEventsRequestEntry .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
API Version 2015-10-07viii
Amazon EventBridge API Reference
PutEventsResultEntry .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
PutPartnerEventsRequestEntry .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
PutPartnerEventsResultEntry .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
PutTargetsResultEntry .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
RedshiftDataParameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
RemoveTargetsResultEntry .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Replay .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
ReplayDestination .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
RetryPolicy .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Rule .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
RunCommandParameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
RunCommandTarget .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
SqsParameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Tag .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Target .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Making API Requests ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178CloudWatch Events Endpoints ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178Query Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178Request Identifiers ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178Query API Authentication .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178Available Libraries ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Common Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180Common Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
API Version 2015-10-07ix
Amazon EventBridge API Reference
Amazon EventBridge API ReferenceAmazon EventBridge is a serverless event bus service that makes it easy to connect your applicationswith data from a variety of sources.
EventBridge was formerly known as Amazon CloudWatch Events. EventBridge expands on thecapabilities of CloudWatch Events, adding support for processing events from software-as-a-service(SaaS) partner applications and making it easier for you to process events from your own applications.EventBridge starts with the same set of APIs as CloudWatch Events and adds new APIs. EventBridge alsooffers more functionality both in the API and on the console.
Use the following links to get started using the EventBridge API:
• Actions (p. 2): An alphabetical list of all EventBridge actions• Data Types (p. 134): An alphabetical list of all EventBridge data types• Common Parameters (p. 180): Parameters that all Query actions can use• Common Errors (p. 182): Client and server errors that all actions can return• Regions and Endpoints: Supported Regions and endpoints for all AWS products
Alternatively, you can use one of the AWS SDKs to access EventBridge using an API that is tailored toyour programming language or platform.
Developers in the AWS developer community also provide their own libraries, which you can find at thefollowing AWS developer centers:
• Java Developer Center• JavaScript Developer Center• AWS Mobile Services• PHP Developer Center• Python Developer Center• Ruby Developer Center• Windows and .NET Developer Center
API Version 2015-10-071
Amazon EventBridge API Reference
ActionsThe following actions are supported:
• ActivateEventSource (p. 4)• CancelReplay (p. 6)• CreateArchive (p. 9)• CreateEventBus (p. 12)• CreatePartnerEventSource (p. 15)• DeactivateEventSource (p. 18)• DeleteArchive (p. 20)• DeleteEventBus (p. 22)• DeletePartnerEventSource (p. 24)• DeleteRule (p. 26)• DescribeArchive (p. 29)• DescribeEventBus (p. 32)• DescribeEventSource (p. 35)• DescribePartnerEventSource (p. 38)• DescribeReplay (p. 40)• DescribeRule (p. 44)• DisableRule (p. 48)• EnableRule (p. 51)• ListArchives (p. 54)• ListEventBuses (p. 57)• ListEventSources (p. 59)• ListPartnerEventSourceAccounts (p. 62)• ListPartnerEventSources (p. 65)• ListReplays (p. 68)• ListRuleNamesByTarget (p. 71)• ListRules (p. 74)• ListTagsForResource (p. 78)• ListTargetsByRule (p. 81)• PutEvents (p. 85)• PutPartnerEvents (p. 88)• PutPermission (p. 90)• PutRule (p. 94)• PutTargets (p. 99)• RemovePermission (p. 112)• RemoveTargets (p. 114)• StartReplay (p. 118)• TagResource (p. 122)• TestEventPattern (p. 125)• UntagResource (p. 128)• UpdateArchive (p. 131)
API Version 2015-10-072
Amazon EventBridge API Reference
API Version 2015-10-073
Amazon EventBridge API ReferenceActivateEventSource
ActivateEventSourceActivates a partner event source that has been deactivated. Once activated, your matching event bus willstart receiving events from the event source.
Request Syntax{ "Name": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
Name (p. 4)
The name of the partner event source to activate.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: aws\.partner(/[\.\-_A-Za-z0-9]+){2,}
Required: Yes
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
ConcurrentModificationException
There is concurrent modification on a rule, target, archive, or replay.
HTTP Status Code: 400InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500InvalidStateException
The specified state is not a valid state for an event source.
HTTP Status Code: 400
API Version 2015-10-074
Amazon EventBridge API ReferenceSee Also
OperationDisabledException
The operation you are attempting is not available in this region.
HTTP Status Code: 400ResourceNotFoundException
An entity that you specified does not exist.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-075
Amazon EventBridge API ReferenceCancelReplay
CancelReplayCancels the specified replay.
Request Syntax{ "ReplayName": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
ReplayName (p. 6)
The name of the replay to cancel.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [\.\-_A-Za-z0-9]+
Required: Yes
Response Syntax{ "ReplayArn": "string", "State": "string", "StateReason": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
ReplayArn (p. 6)
The ARN of the replay to cancel.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:.+\/[\.\-_A-Za-z0-9]+$
API Version 2015-10-076
Amazon EventBridge API ReferenceErrors
State (p. 6)
The current state of the replay.
Type: String
Valid Values: STARTING | RUNNING | CANCELLING | COMPLETED | CANCELLED | FAILEDStateReason (p. 6)
The reason that the replay is in the current state.
Type: String
Length Constraints: Maximum length of 512.
Pattern: .*
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
ConcurrentModificationException
There is concurrent modification on a rule, target, archive, or replay.
HTTP Status Code: 400IllegalStatusException
An error occurred because a replay can be canceled only when the state is Running or Starting.
HTTP Status Code: 400InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500ResourceNotFoundException
An entity that you specified does not exist.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python
API Version 2015-10-077
Amazon EventBridge API ReferenceSee Also
• AWS SDK for Ruby V3
API Version 2015-10-078
Amazon EventBridge API ReferenceCreateArchive
CreateArchiveCreates an archive of events with the specified settings. When you create an archive, incoming eventsmight not immediately start being sent to the archive. Allow a short period of time for changes to takeeffect. If you do not specify a pattern to filter events sent to the archive, all events are sent to the archiveexcept replayed events. Replayed events are not sent to an archive.
Request Syntax{ "ArchiveName": "string", "Description": "string", "EventPattern": "string", "EventSourceArn": "string", "RetentionDays": number}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
ArchiveName (p. 9)
The name for the archive to create.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 48.
Pattern: [\.\-_A-Za-z0-9]+
Required: YesDescription (p. 9)
A description for the archive.
Type: String
Length Constraints: Maximum length of 512.
Pattern: .*
Required: NoEventPattern (p. 9)
An event pattern to use to filter events sent to the archive.
Type: String
Required: NoEventSourceArn (p. 9)
The ARN of the event source associated with the archive.
API Version 2015-10-079
Amazon EventBridge API ReferenceResponse Syntax
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Required: YesRetentionDays (p. 9)
The number of days to retain events for. Default value is 0. If set to 0, events are retainedindefinitely
Type: Integer
Valid Range: Minimum value of 0.
Required: No
Response Syntax{ "ArchiveArn": "string", "CreationTime": number, "State": "string", "StateReason": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
ArchiveArn (p. 10)
The ARN of the archive that was created.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:.+\/.+$CreationTime (p. 10)
The time at which the archive was created.
Type: TimestampState (p. 10)
The state of the archive that was created.
Type: String
Valid Values: ENABLED | DISABLED | CREATING | UPDATING | CREATE_FAILED |UPDATE_FAILED
StateReason (p. 10)
The reason that the archive is in the state.
Type: String
API Version 2015-10-0710
Amazon EventBridge API ReferenceErrors
Length Constraints: Maximum length of 512.
Pattern: .*
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
ConcurrentModificationException
There is concurrent modification on a rule, target, archive, or replay.
HTTP Status Code: 400InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500InvalidEventPatternException
The event pattern is not valid.
HTTP Status Code: 400LimitExceededException
The request failed because it attempted to create resource beyond the allowed service quota.
HTTP Status Code: 400ResourceAlreadyExistsException
The resource you are trying to create already exists.
HTTP Status Code: 400ResourceNotFoundException
An entity that you specified does not exist.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-0711
Amazon EventBridge API ReferenceCreateEventBus
CreateEventBusCreates a new event bus within your account. This can be a custom event bus which you can use toreceive events from your custom applications and services, or it can be a partner event bus which can bematched to a partner event source.
Request Syntax{ "EventSourceName": "string", "Name": "string", "Tags": [ { "Key": "string", "Value": "string" } ]}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
EventSourceName (p. 12)
If you are creating a partner event bus, this specifies the partner event source that the new eventbus will be matched with.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: aws\.partner(/[\.\-_A-Za-z0-9]+){2,}
Required: NoName (p. 12)
The name of the new event bus.
Event bus names cannot contain the / character. You can't use the name default for a customevent bus, as this name is already used for your account's default event bus.
If this is a partner event bus, the name must exactly match the name of the partner event sourcethat this event bus is matched to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [/\.\-_A-Za-z0-9]+
Required: YesTags (p. 12)
Tags to associate with the event bus.
API Version 2015-10-0712
Amazon EventBridge API ReferenceResponse Syntax
Type: Array of Tag (p. 174) objects
Required: No
Response Syntax{ "EventBusArn": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
EventBusArn (p. 13)
The ARN of the new event bus.
Type: String
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
ConcurrentModificationException
There is concurrent modification on a rule, target, archive, or replay.
HTTP Status Code: 400InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500InvalidStateException
The specified state is not a valid state for an event source.
HTTP Status Code: 400LimitExceededException
The request failed because it attempted to create resource beyond the allowed service quota.
HTTP Status Code: 400OperationDisabledException
The operation you are attempting is not available in this region.
HTTP Status Code: 400ResourceAlreadyExistsException
The resource you are trying to create already exists.
API Version 2015-10-0713
Amazon EventBridge API ReferenceSee Also
HTTP Status Code: 400ResourceNotFoundException
An entity that you specified does not exist.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-0714
Amazon EventBridge API ReferenceCreatePartnerEventSource
CreatePartnerEventSourceCalled by an SaaS partner to create a partner event source. This operation is not used by AWS customers.
Each partner event source can be used by one AWS account to create a matching partner event busin that AWS account. A SaaS partner must create one partner event source for each AWS account thatwants to receive those event types.
A partner event source creates events based on resources within the SaaS partner's service or application.
An AWS account that creates a partner event bus that matches the partner event source can use thatevent bus to receive events from the partner, and then process them using AWS Events rules and targets.
Partner event source names follow this format:
partner_name/event_namespace/event_name
partner_name is determined during partner registration and identifies the partner to AWS customers.event_namespace is determined by the partner and is a way for the partner to categorize their events.event_name is determined by the partner, and should uniquely identify an event-generating resourcewithin the partner system. The combination of event_namespace and event_name should help AWScustomers decide whether to create an event bus to receive these events.
Request Syntax{ "Account": "string", "Name": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
Account (p. 15)
The AWS account ID that is permitted to create a matching partner event bus for this partner eventsource.
Type: String
Length Constraints: Fixed length of 12.
Pattern: \d{12}
Required: Yes
Name (p. 15)
The name of the partner event source. This name must be unique and must be in the format partner_name/event_namespace/event_name . The AWS account that wants to use thispartner event source must create a partner event bus with a name that matches the name of thepartner event source.
API Version 2015-10-0715
Amazon EventBridge API ReferenceResponse Syntax
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: aws\.partner(/[\.\-_A-Za-z0-9]+){2,}
Required: Yes
Response Syntax{ "EventSourceArn": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
EventSourceArn (p. 16)
The ARN of the partner event source.
Type: String
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
ConcurrentModificationException
There is concurrent modification on a rule, target, archive, or replay.
HTTP Status Code: 400InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500LimitExceededException
The request failed because it attempted to create resource beyond the allowed service quota.
HTTP Status Code: 400OperationDisabledException
The operation you are attempting is not available in this region.
HTTP Status Code: 400ResourceAlreadyExistsException
The resource you are trying to create already exists.
HTTP Status Code: 400
API Version 2015-10-0716
Amazon EventBridge API ReferenceSee Also
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-0717
Amazon EventBridge API ReferenceDeactivateEventSource
DeactivateEventSourceYou can use this operation to temporarily stop receiving events from the specified partner event source.The matching event bus is not deleted.
When you deactivate a partner event source, the source goes into PENDING state. If it remains inPENDING state for more than two weeks, it is deleted.
To activate a deactivated partner event source, use ActivateEventSource (p. 4).
Request Syntax{ "Name": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
Name (p. 18)
The name of the partner event source to deactivate.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: aws\.partner(/[\.\-_A-Za-z0-9]+){2,}
Required: Yes
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
ConcurrentModificationException
There is concurrent modification on a rule, target, archive, or replay.
HTTP Status Code: 400
InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500
API Version 2015-10-0718
Amazon EventBridge API ReferenceSee Also
InvalidStateException
The specified state is not a valid state for an event source.
HTTP Status Code: 400OperationDisabledException
The operation you are attempting is not available in this region.
HTTP Status Code: 400ResourceNotFoundException
An entity that you specified does not exist.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-0719
Amazon EventBridge API ReferenceDeleteArchive
DeleteArchiveDeletes the specified archive.
Request Syntax{ "ArchiveName": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
ArchiveName (p. 20)
The name of the archive to delete.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 48.
Pattern: [\.\-_A-Za-z0-9]+
Required: Yes
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
ConcurrentModificationException
There is concurrent modification on a rule, target, archive, or replay.
HTTP Status Code: 400
InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500
ResourceNotFoundException
An entity that you specified does not exist.
HTTP Status Code: 400
API Version 2015-10-0720
Amazon EventBridge API ReferenceSee Also
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-0721
Amazon EventBridge API ReferenceDeleteEventBus
DeleteEventBusDeletes the specified custom event bus or partner event bus. All rules associated with this event busneed to be deleted. You can't delete your account's default event bus.
Request Syntax{ "Name": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
Name (p. 22)
The name of the event bus to delete.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [/\.\-_A-Za-z0-9]+
Required: Yes
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
ConcurrentModificationException
There is concurrent modification on a rule, target, archive, or replay.
HTTP Status Code: 400InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
API Version 2015-10-0722
Amazon EventBridge API ReferenceSee Also
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-0723
Amazon EventBridge API ReferenceDeletePartnerEventSource
DeletePartnerEventSourceThis operation is used by SaaS partners to delete a partner event source. This operation is not used byAWS customers.
When you delete an event source, the status of the corresponding partner event bus in the AWScustomer account becomes DELETED.
Request Syntax{ "Account": "string", "Name": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
Account (p. 24)
The AWS account ID of the AWS customer that the event source was created for.
Type: String
Length Constraints: Fixed length of 12.
Pattern: \d{12}
Required: Yes
Name (p. 24)
The name of the event source to delete.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: aws\.partner(/[\.\-_A-Za-z0-9]+){2,}
Required: Yes
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
API Version 2015-10-0724
Amazon EventBridge API ReferenceSee Also
ConcurrentModificationException
There is concurrent modification on a rule, target, archive, or replay.
HTTP Status Code: 400InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500OperationDisabledException
The operation you are attempting is not available in this region.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-0725
Amazon EventBridge API ReferenceDeleteRule
DeleteRuleDeletes the specified rule.
Before you can delete the rule, you must remove all targets, using RemoveTargets (p. 114).
When you delete a rule, incoming events might continue to match to the deleted rule. Allow a shortperiod of time for changes to take effect.
Managed rules are rules created and managed by another AWS service on your behalf. These rules arecreated by those other AWS services to support functionality in those services. You can delete these rulesusing the Force option, but you should do so only if you are sure the other service is not still using thatrule.
Request Syntax{ "EventBusName": "string", "Force": boolean, "Name": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
EventBusName (p. 26)
The name or ARN of the event bus associated with the rule. If you omit this, the default event bus isused.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: (arn:aws[\w-]*:events:[a-z]{2}-[a-z]+-[\w-]+:[0-9]{12}:event-bus\/)?[/\.\-_A-Za-z0-9]+
Required: NoForce (p. 26)
If this is a managed rule, created by an AWS service on your behalf, you must specify Force asTrue to delete the rule. This parameter is ignored for rules that are not managed rules. You cancheck whether a rule is a managed rule by using DescribeRule or ListRules and checking theManagedBy field of the response.
Type: Boolean
Required: NoName (p. 26)
The name of the rule.
Type: String
API Version 2015-10-0726
Amazon EventBridge API ReferenceResponse Elements
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [\.\-_A-Za-z0-9]+
Required: Yes
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
ConcurrentModificationException
There is concurrent modification on a rule, target, archive, or replay.
HTTP Status Code: 400InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500ManagedRuleException
This rule was created by an AWS service on behalf of your account. It is managed by that service.If you see this error in response to DeleteRule or RemoveTargets, you can use the Forceparameter in those calls to delete the rule or remove targets from the rule. You cannot modify thesemanaged rules by using DisableRule, EnableRule, PutTargets, PutRule, TagResource, orUntagResource.
HTTP Status Code: 400ResourceNotFoundException
An entity that you specified does not exist.
HTTP Status Code: 400
Examples
Deletes a rule named "test"The following is an example of a DeleteRule request.
Sample Request
POST / HTTP/1.1Host: events.<region>.<domain>x-amz-Date: <Date>Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>User-Agent: <UserAgentString>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>
API Version 2015-10-0727
Amazon EventBridge API ReferenceSee Also
Connection: Keep-Alive X-Amz-Target: AWSEvents.DeleteRule
{ "Name": "test"}
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: <RequestId>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Date: <Date>
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-0728
Amazon EventBridge API ReferenceDescribeArchive
DescribeArchiveRetrieves details about an archive.
Request Syntax{ "ArchiveName": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
ArchiveName (p. 29)
The name of the archive to retrieve.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 48.
Pattern: [\.\-_A-Za-z0-9]+
Required: Yes
Response Syntax{ "ArchiveArn": "string", "ArchiveName": "string", "CreationTime": number, "Description": "string", "EventCount": number, "EventPattern": "string", "EventSourceArn": "string", "RetentionDays": number, "SizeBytes": number, "State": "string", "StateReason": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
ArchiveArn (p. 29)
The ARN of the archive.
API Version 2015-10-0729
Amazon EventBridge API ReferenceResponse Elements
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:.+\/.+$ArchiveName (p. 29)
The name of the archive.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 48.
Pattern: [\.\-_A-Za-z0-9]+CreationTime (p. 29)
The time at which the archive was created.
Type: TimestampDescription (p. 29)
The description of the archive.
Type: String
Length Constraints: Maximum length of 512.
Pattern: .*EventCount (p. 29)
The number of events in the archive.
Type: LongEventPattern (p. 29)
The event pattern used to filter events sent to the archive.
Type: StringEventSourceArn (p. 29)
The ARN of the event source associated with the archive.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.RetentionDays (p. 29)
The number of days to retain events for in the archive.
Type: Integer
Valid Range: Minimum value of 0.SizeBytes (p. 29)
The size of the archive in bytes.
Type: LongState (p. 29)
The state of the archive.
API Version 2015-10-0730
Amazon EventBridge API ReferenceErrors
Type: String
Valid Values: ENABLED | DISABLED | CREATING | UPDATING | CREATE_FAILED |UPDATE_FAILED
StateReason (p. 29)
The reason that the archive is in the state.
Type: String
Length Constraints: Maximum length of 512.
Pattern: .*
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500ResourceAlreadyExistsException
The resource you are trying to create already exists.
HTTP Status Code: 400ResourceNotFoundException
An entity that you specified does not exist.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-0731
Amazon EventBridge API ReferenceDescribeEventBus
DescribeEventBusDisplays details about an event bus in your account. This can include the external AWS accounts that arepermitted to write events to your default event bus, and the associated policy. For custom event busesand partner event buses, it displays the name, ARN, policy, state, and creation time.
To enable your account to receive events from other accounts on its default event bus, usePutPermission (p. 90).
For more information about partner event buses, see CreateEventBus (p. 12).
Request Syntax{ "Name": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
Name (p. 32)
The name or ARN of the event bus to show details for. If you omit this, the default event bus isdisplayed.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: (arn:aws[\w-]*:events:[a-z]{2}-[a-z]+-[\w-]+:[0-9]{12}:event-bus\/)?[/\.\-_A-Za-z0-9]+
Required: No
Response Syntax{ "Arn": "string", "Name": "string", "Policy": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Arn (p. 32)
The Amazon Resource Name (ARN) of the account permitted to write events to the current account.
API Version 2015-10-0732
Amazon EventBridge API ReferenceErrors
Type: StringName (p. 32)
The name of the event bus. Currently, this is always default.
Type: StringPolicy (p. 32)
The policy that enables the external account to send events to your account.
Type: String
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500ResourceNotFoundException
An entity that you specified does not exist.
HTTP Status Code: 400
ExamplesExampleThe following example is run in account 444455556666, which has granted permission to AWS account111122223333 to send events to 444455556666.
Sample Request
POST / HTTP/1.1Host: events.<region>.<domain>x-amz-Date: <Date>Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>User-Agent: <UserAgentString>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Connection: Keep-Alive X-Amz-Target: AWSEvents.DescribeEventBus
ExampleThis example illustrates one usage of DescribeEventBus.
Sample Response
HTTP/1.1 200 OK
API Version 2015-10-0733
Amazon EventBridge API ReferenceSee Also
x-amzn-RequestId: <RequestId>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Date: <Date>
{ "Policy": { "Version":"2012-10-17", "Statement":[ { "Sid": "mysid", "Effect": "Allow", "Principal":{ "AWS": "arn:aws:iam::111122223333:root" }, "Action":"events:PutEvents", "Resource": "arn:aws:events:us-east-1:444455556666:event-bus/default" } ] }, "Name": "default", "Arn": "arn:aws:events:us-east-1:444455556666:event-bus/default"}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-0734
Amazon EventBridge API ReferenceDescribeEventSource
DescribeEventSourceThis operation lists details about a partner event source that is shared with your account.
Request Syntax{ "Name": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
Name (p. 35)
The name of the partner event source to display the details of.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: aws\.partner(/[\.\-_A-Za-z0-9]+){2,}
Required: Yes
Response Syntax{ "Arn": "string", "CreatedBy": "string", "CreationTime": number, "ExpirationTime": number, "Name": "string", "State": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Arn (p. 35)
The ARN of the partner event source.
Type: StringCreatedBy (p. 35)
The name of the SaaS partner that created the event source.
API Version 2015-10-0735
Amazon EventBridge API ReferenceErrors
Type: StringCreationTime (p. 35)
The date and time that the event source was created.
Type: TimestampExpirationTime (p. 35)
The date and time that the event source will expire if you do not create a matching event bus.
Type: TimestampName (p. 35)
The name of the partner event source.
Type: StringState (p. 35)
The state of the event source. If it is ACTIVE, you have already created a matching event bus for thisevent source, and that event bus is active. If it is PENDING, either you haven't yet created a matchingevent bus, or that event bus is deactivated. If it is DELETED, you have created a matching event bus,but the event source has since been deleted.
Type: String
Valid Values: PENDING | ACTIVE | DELETED
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500OperationDisabledException
The operation you are attempting is not available in this region.
HTTP Status Code: 400ResourceNotFoundException
An entity that you specified does not exist.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go
API Version 2015-10-0736
Amazon EventBridge API ReferenceSee Also
• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-0737
Amazon EventBridge API ReferenceDescribePartnerEventSource
DescribePartnerEventSourceAn SaaS partner can use this operation to list details about a partner event source that theyhave created. AWS customers do not use this operation. Instead, AWS customers can useDescribeEventSource (p. 35) to see details about a partner event source that is shared with them.
Request Syntax{ "Name": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
Name (p. 38)
The name of the event source to display.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: aws\.partner(/[\.\-_A-Za-z0-9]+){2,}
Required: Yes
Response Syntax{ "Arn": "string", "Name": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Arn (p. 38)
The ARN of the event source.
Type: StringName (p. 38)
The name of the event source.
Type: String
API Version 2015-10-0738
Amazon EventBridge API ReferenceErrors
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500OperationDisabledException
The operation you are attempting is not available in this region.
HTTP Status Code: 400ResourceNotFoundException
An entity that you specified does not exist.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-0739
Amazon EventBridge API ReferenceDescribeReplay
DescribeReplayRetrieves details about a replay. Use DescribeReplay to determine the progress of a running replay.A replay processes events to replay based on the time in the event, and replays them using 1 minuteintervals. If you use StartReplay and specify an EventStartTime and an EventEndTime that coversa 20 minute time range, the events are replayed from the first minute of that 20 minute range first.Then the events from the second minute are replayed. You can use DescribeReplay to determine theprogress of a replay. The value returned for EventLastReplayedTime indicates the time within thespecified time range associated with the last event replayed.
Request Syntax
{ "ReplayName": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
ReplayName (p. 40)
The name of the replay to retrieve.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [\.\-_A-Za-z0-9]+
Required: Yes
Response Syntax
{ "Description": "string", "Destination": { "Arn": "string", "FilterArns": [ "string" ] }, "EventEndTime": number, "EventLastReplayedTime": number, "EventSourceArn": "string", "EventStartTime": number, "ReplayArn": "string", "ReplayEndTime": number, "ReplayName": "string", "ReplayStartTime": number, "State": "string", "StateReason": "string"}
API Version 2015-10-0740
Amazon EventBridge API ReferenceResponse Elements
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Description (p. 40)
The description of the replay.
Type: String
Length Constraints: Maximum length of 512.
Pattern: .*Destination (p. 40)
A ReplayDestination object that contains details about the replay.
Type: ReplayDestination (p. 167) objectEventEndTime (p. 40)
The time stamp for the last event that was replayed from the archive.
Type: TimestampEventLastReplayedTime (p. 40)
The time that the event was last replayed.
Type: TimestampEventSourceArn (p. 40)
The ARN of the archive events were replayed from.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.EventStartTime (p. 40)
The time stamp of the first event that was last replayed from the archive.
Type: TimestampReplayArn (p. 40)
The ARN of the replay.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:.+\/[\.\-_A-Za-z0-9]+$
ReplayEndTime (p. 40)
A time stamp for the time that the replay stopped.
Type: Timestamp
API Version 2015-10-0741
Amazon EventBridge API ReferenceErrors
ReplayName (p. 40)
The name of the replay.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [\.\-_A-Za-z0-9]+ReplayStartTime (p. 40)
A time stamp for the time that the replay started.
Type: TimestampState (p. 40)
The current state of the replay.
Type: String
Valid Values: STARTING | RUNNING | CANCELLING | COMPLETED | CANCELLED | FAILEDStateReason (p. 40)
The reason that the replay is in the current state.
Type: String
Length Constraints: Maximum length of 512.
Pattern: .*
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500ResourceNotFoundException
An entity that you specified does not exist.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2
API Version 2015-10-0742
Amazon EventBridge API ReferenceSee Also
• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-0743
Amazon EventBridge API ReferenceDescribeRule
DescribeRuleDescribes the specified rule.
DescribeRule does not list the targets of a rule. To see the targets associated with a rule, useListTargetsByRule (p. 81).
Request Syntax{ "EventBusName": "string", "Name": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
EventBusName (p. 44)
The name or ARN of the event bus associated with the rule. If you omit this, the default event bus isused.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: (arn:aws[\w-]*:events:[a-z]{2}-[a-z]+-[\w-]+:[0-9]{12}:event-bus\/)?[/\.\-_A-Za-z0-9]+
Required: NoName (p. 44)
The name of the rule.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [\.\-_A-Za-z0-9]+
Required: Yes
Response Syntax{ "Arn": "string", "CreatedBy": "string", "Description": "string", "EventBusName": "string", "EventPattern": "string", "ManagedBy": "string",
API Version 2015-10-0744
Amazon EventBridge API ReferenceResponse Elements
"Name": "string", "RoleArn": "string", "ScheduleExpression": "string", "State": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Arn (p. 44)
The Amazon Resource Name (ARN) of the rule.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.CreatedBy (p. 44)
The account ID of the user that created the rule. If you use PutRule to put a rule on an event bus inanother account, the other account is the owner of the rule, and the rule ARN includes the accountID for that account. However, the value for CreatedBy is the account ID as the account that createdthe rule in the other account.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.Description (p. 44)
The description of the rule.
Type: String
Length Constraints: Maximum length of 512.EventBusName (p. 44)
The name of the event bus associated with the rule.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [/\.\-_A-Za-z0-9]+EventPattern (p. 44)
The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridgeUser Guide.
Type: StringManagedBy (p. 44)
If this is a managed rule, created by an AWS service on your behalf, this field displays the principalname of the AWS service that created the rule.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
API Version 2015-10-0745
Amazon EventBridge API ReferenceErrors
Name (p. 44)
The name of the rule.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [\.\-_A-Za-z0-9]+RoleArn (p. 44)
The Amazon Resource Name (ARN) of the IAM role associated with the rule.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.ScheduleExpression (p. 44)
The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
Type: String
Length Constraints: Maximum length of 256.State (p. 44)
Specifies whether the rule is enabled or disabled.
Type: String
Valid Values: ENABLED | DISABLED
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500ResourceNotFoundException
An entity that you specified does not exist.
HTTP Status Code: 400
ExamplesDescribes a rule named "test"The following is an example of a DescribeRule request and response.
Sample Request
POST / HTTP/1.1Host: events.<region>.<domain>
API Version 2015-10-0746
Amazon EventBridge API ReferenceSee Also
x-amz-Date: <Date>Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>User-Agent: <UserAgentString>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Connection: Keep-Alive X-Amz-Target: AWSEvents.DescribeRule
{ "Name": "test"}
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: <RequestId>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Date: <Date>
{ "Name": "test", "EventPattern": "{\"source\":[\"aws.autoscaling\"],\"detail-type\":[\"EC2 Instance Launch Successful\",\"EC2 Instance Terminate Successful\",\"EC2 Instance Launch Unsuccessful\",\"EC2 Instance Terminate Unsuccessful\"]}", "State": "ENABLED", "Arn": "arn:aws:events:us-east-1:123456789012:rule/test", "Description": "Test rule for Auto Scaling events"}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-0747
Amazon EventBridge API ReferenceDisableRule
DisableRuleDisables the specified rule. A disabled rule won't match any events, and won't self-trigger if it has aschedule expression.
When you disable a rule, incoming events might continue to match to the disabled rule. Allow a shortperiod of time for changes to take effect.
Request Syntax{ "EventBusName": "string", "Name": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
EventBusName (p. 48)
The name or ARN of the event bus associated with the rule. If you omit this, the default event bus isused.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: (arn:aws[\w-]*:events:[a-z]{2}-[a-z]+-[\w-]+:[0-9]{12}:event-bus\/)?[/\.\-_A-Za-z0-9]+
Required: NoName (p. 48)
The name of the rule.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [\.\-_A-Za-z0-9]+
Required: Yes
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
API Version 2015-10-0748
Amazon EventBridge API ReferenceExamples
ConcurrentModificationException
There is concurrent modification on a rule, target, archive, or replay.
HTTP Status Code: 400
InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500
ManagedRuleException
This rule was created by an AWS service on behalf of your account. It is managed by that service.If you see this error in response to DeleteRule or RemoveTargets, you can use the Forceparameter in those calls to delete the rule or remove targets from the rule. You cannot modify thesemanaged rules by using DisableRule, EnableRule, PutTargets, PutRule, TagResource, orUntagResource.
HTTP Status Code: 400
ResourceNotFoundException
An entity that you specified does not exist.
HTTP Status Code: 400
Examples
Disables a rule named "test"The following is an example of a DisableRule request.
Sample Request
POST / HTTP/1.1Host: events.<region>.<domain>x-amz-Date: <Date>Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>User-Agent: <UserAgentString>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Connection: Keep-Alive X-Amz-Target: AWSEvents.DisableRule
{ "Name": "test"}
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: <RequestId>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Date: <Date>
API Version 2015-10-0749
Amazon EventBridge API ReferenceSee Also
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-0750
Amazon EventBridge API ReferenceEnableRule
EnableRuleEnables the specified rule. If the rule does not exist, the operation fails.
When you enable a rule, incoming events might not immediately start matching to a newly enabled rule.Allow a short period of time for changes to take effect.
Request Syntax{ "EventBusName": "string", "Name": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
EventBusName (p. 51)
The name or ARN of the event bus associated with the rule. If you omit this, the default event bus isused.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: (arn:aws[\w-]*:events:[a-z]{2}-[a-z]+-[\w-]+:[0-9]{12}:event-bus\/)?[/\.\-_A-Za-z0-9]+
Required: No
Name (p. 51)
The name of the rule.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [\.\-_A-Za-z0-9]+
Required: Yes
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
API Version 2015-10-0751
Amazon EventBridge API ReferenceExamples
ConcurrentModificationException
There is concurrent modification on a rule, target, archive, or replay.
HTTP Status Code: 400
InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500
ManagedRuleException
This rule was created by an AWS service on behalf of your account. It is managed by that service.If you see this error in response to DeleteRule or RemoveTargets, you can use the Forceparameter in those calls to delete the rule or remove targets from the rule. You cannot modify thesemanaged rules by using DisableRule, EnableRule, PutTargets, PutRule, TagResource, orUntagResource.
HTTP Status Code: 400
ResourceNotFoundException
An entity that you specified does not exist.
HTTP Status Code: 400
Examples
Enables a rule named "test"The following is an example of an EnableRule request.
Sample Request
POST / HTTP/1.1Host: events.<region>.<domain>x-amz-Date: <Date>Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>User-Agent: <UserAgentString>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Connection: Keep-Alive X-Amz-Target: AWSEvents.EnableRule
{ "Name": "test"}
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: <RequestId>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Date: <Date>
API Version 2015-10-0752
Amazon EventBridge API ReferenceSee Also
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-0753
Amazon EventBridge API ReferenceListArchives
ListArchivesLists your archives. You can either list all the archives or you can provide a prefix to match to the archivenames. Filter parameters are exclusive.
Request Syntax{ "EventSourceArn": "string", "Limit": number, "NamePrefix": "string", "NextToken": "string", "State": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
EventSourceArn (p. 54)
The ARN of the event source associated with the archive.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Required: No
Limit (p. 54)
The maximum number of results to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
NamePrefix (p. 54)
A name prefix to filter the archives returned. Only archives with name that match the prefix arereturned.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 48.
Pattern: [\.\-_A-Za-z0-9]+
Required: No
NextToken (p. 54)
The token returned by a previous call to retrieve the next set of results.
API Version 2015-10-0754
Amazon EventBridge API ReferenceResponse Syntax
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: NoState (p. 54)
The state of the archive.
Type: String
Valid Values: ENABLED | DISABLED | CREATING | UPDATING | CREATE_FAILED |UPDATE_FAILED
Required: No
Response Syntax{ "Archives": [ { "ArchiveName": "string", "CreationTime": number, "EventCount": number, "EventSourceArn": "string", "RetentionDays": number, "SizeBytes": number, "State": "string", "StateReason": "string" } ], "NextToken": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Archives (p. 55)
An array of Archive objects that include details about an archive.
Type: Array of Archive (p. 135) objectsNextToken (p. 55)
The token returned by a previous call to retrieve the next set of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
API Version 2015-10-0755
Amazon EventBridge API ReferenceSee Also
InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500ResourceNotFoundException
An entity that you specified does not exist.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-0756
Amazon EventBridge API ReferenceListEventBuses
ListEventBusesLists all the event buses in your account, including the default event bus, custom event buses, andpartner event buses.
Request Syntax{ "Limit": number, "NamePrefix": "string", "NextToken": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
Limit (p. 57)
Specifying this limits the number of results returned by this operation. The operation also returns aNextToken which you can use in a subsequent operation to retrieve the next set of results.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: NoNamePrefix (p. 57)
Specifying this limits the results to only those event buses with names that start with the specifiedprefix.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [/\.\-_A-Za-z0-9]+
Required: NoNextToken (p. 57)
The token returned by a previous call to retrieve the next set of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
Response Syntax{
API Version 2015-10-0757
Amazon EventBridge API ReferenceResponse Elements
"EventBuses": [ { "Arn": "string", "Name": "string", "Policy": "string" } ], "NextToken": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
EventBuses (p. 57)
This list of event buses.
Type: Array of EventBus (p. 145) objectsNextToken (p. 57)
A token you can use in a subsequent operation to retrieve the next set of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-0758
Amazon EventBridge API ReferenceListEventSources
ListEventSourcesYou can use this to see all the partner event sources that have been shared with your AWS account. Formore information about partner event sources, see CreateEventBus (p. 12).
Request Syntax{ "Limit": number, "NamePrefix": "string", "NextToken": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
Limit (p. 59)
Specifying this limits the number of results returned by this operation. The operation also returns aNextToken which you can use in a subsequent operation to retrieve the next set of results.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: NoNamePrefix (p. 59)
Specifying this limits the results to only those partner event sources with names that start with thespecified prefix.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [/\.\-_A-Za-z0-9]+
Required: NoNextToken (p. 59)
The token returned by a previous call to retrieve the next set of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
Response Syntax{
API Version 2015-10-0759
Amazon EventBridge API ReferenceResponse Elements
"EventSources": [ { "Arn": "string", "CreatedBy": "string", "CreationTime": number, "ExpirationTime": number, "Name": "string", "State": "string" } ], "NextToken": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
EventSources (p. 59)
The list of event sources.
Type: Array of EventSource (p. 146) objectsNextToken (p. 59)
A token you can use in a subsequent operation to retrieve the next set of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500OperationDisabledException
The operation you are attempting is not available in this region.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2
API Version 2015-10-0760
Amazon EventBridge API ReferenceSee Also
• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-0761
Amazon EventBridge API ReferenceListPartnerEventSourceAccounts
ListPartnerEventSourceAccountsAn SaaS partner can use this operation to display the AWS account ID that a particular partner eventsource name is associated with. This operation is not used by AWS customers.
Request Syntax{ "EventSourceName": "string", "Limit": number, "NextToken": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
EventSourceName (p. 62)
The name of the partner event source to display account information about.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: aws\.partner(/[\.\-_A-Za-z0-9]+){2,}
Required: YesLimit (p. 62)
Specifying this limits the number of results returned by this operation. The operation also returns aNextToken which you can use in a subsequent operation to retrieve the next set of results.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: NoNextToken (p. 62)
The token returned by a previous call to this operation. Specifying this retrieves the next set ofresults.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
Response Syntax{
API Version 2015-10-0762
Amazon EventBridge API ReferenceResponse Elements
"NextToken": "string", "PartnerEventSourceAccounts": [ { "Account": "string", "CreationTime": number, "ExpirationTime": number, "State": "string" } ]}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
NextToken (p. 62)
A token you can use in a subsequent operation to retrieve the next set of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.PartnerEventSourceAccounts (p. 62)
The list of partner event sources returned by the operation.
Type: Array of PartnerEventSourceAccount (p. 154) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500OperationDisabledException
The operation you are attempting is not available in this region.
HTTP Status Code: 400ResourceNotFoundException
An entity that you specified does not exist.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET
API Version 2015-10-0763
Amazon EventBridge API ReferenceSee Also
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-0764
Amazon EventBridge API ReferenceListPartnerEventSources
ListPartnerEventSourcesAn SaaS partner can use this operation to list all the partner event source names that they have created.This operation is not used by AWS customers.
Request Syntax{ "Limit": number, "NamePrefix": "string", "NextToken": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
Limit (p. 65)
pecifying this limits the number of results returned by this operation. The operation also returns aNextToken which you can use in a subsequent operation to retrieve the next set of results.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: NoNamePrefix (p. 65)
If you specify this, the results are limited to only those partner event sources that start with thestring you specify.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: aws\.partner/[\.\-_A-Za-z0-9]+/[/\.\-_A-Za-z0-9]*
Required: YesNextToken (p. 65)
The token returned by a previous call to this operation. Specifying this retrieves the next set ofresults.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
Response Syntax{
API Version 2015-10-0765
Amazon EventBridge API ReferenceResponse Elements
"NextToken": "string", "PartnerEventSources": [ { "Arn": "string", "Name": "string" } ]}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
NextToken (p. 65)
A token you can use in a subsequent operation to retrieve the next set of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.PartnerEventSources (p. 65)
The list of partner event sources returned by the operation.
Type: Array of PartnerEventSource (p. 153) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500OperationDisabledException
The operation you are attempting is not available in this region.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3
API Version 2015-10-0766
Amazon EventBridge API ReferenceSee Also
• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-0767
Amazon EventBridge API ReferenceListReplays
ListReplaysLists your replays. You can either list all the replays or you can provide a prefix to match to the replaynames. Filter parameters are exclusive.
Request Syntax{ "EventSourceArn": "string", "Limit": number, "NamePrefix": "string", "NextToken": "string", "State": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
EventSourceArn (p. 68)
The ARN of the event source associated with the replay.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Required: No
Limit (p. 68)
The maximum number of replays to retrieve.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
NamePrefix (p. 68)
A name prefix to filter the replays returned. Only replays with name that match the prefix arereturned.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [\.\-_A-Za-z0-9]+
Required: No
NextToken (p. 68)
The token returned by a previous call to retrieve the next set of results.
API Version 2015-10-0768
Amazon EventBridge API ReferenceResponse Syntax
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: NoState (p. 68)
The state of the replay.
Type: String
Valid Values: STARTING | RUNNING | CANCELLING | COMPLETED | CANCELLED | FAILED
Required: No
Response Syntax{ "NextToken": "string", "Replays": [ { "EventEndTime": number, "EventLastReplayedTime": number, "EventSourceArn": "string", "EventStartTime": number, "ReplayEndTime": number, "ReplayName": "string", "ReplayStartTime": number, "State": "string", "StateReason": "string" } ]}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
NextToken (p. 69)
The token returned by a previous call to retrieve the next set of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.Replays (p. 69)
An array of Replay objects that contain information about the replay.
Type: Array of Replay (p. 165) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
API Version 2015-10-0769
Amazon EventBridge API ReferenceSee Also
InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-0770
Amazon EventBridge API ReferenceListRuleNamesByTarget
ListRuleNamesByTargetLists the rules for the specified target. You can see which of the rules in Amazon EventBridge can invokea specific target in your account.
Request Syntax{ "EventBusName": "string", "Limit": number, "NextToken": "string", "TargetArn": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
EventBusName (p. 71)
The name or ARN of the event bus to list rules for. If you omit this, the default event bus is used.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: (arn:aws[\w-]*:events:[a-z]{2}-[a-z]+-[\w-]+:[0-9]{12}:event-bus\/)?[/\.\-_A-Za-z0-9]+
Required: NoLimit (p. 71)
The maximum number of results to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: NoNextToken (p. 71)
The token returned by a previous call to retrieve the next set of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: NoTargetArn (p. 71)
The Amazon Resource Name (ARN) of the target resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
API Version 2015-10-0771
Amazon EventBridge API ReferenceResponse Syntax
Required: Yes
Response Syntax{ "NextToken": "string", "RuleNames": [ "string" ]}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
NextToken (p. 72)
Indicates whether there are additional results to retrieve. If there are no more results, the value isnull.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.RuleNames (p. 72)
The names of the rules that can invoke the given target.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [\.\-_A-Za-z0-9]+
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500ResourceNotFoundException
An entity that you specified does not exist.
HTTP Status Code: 400
Examples
Lists rule names by target with the specified ARNThe following is an example of a ListRuleNamesByTarget request and response.
API Version 2015-10-0772
Amazon EventBridge API ReferenceSee Also
Sample Request
POST / HTTP/1.1Host: events.<region>.<domain>x-amz-Date: <Date>Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>User-Agent: <UserAgentString>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Connection: Keep-Alive X-Amz-Target: AWSEvents.ListRuleNamesByTarget
{ "TargetArn": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", "NextToken": "", "Limit": 0}
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: <RequestId>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Date: <Date>
{ "RuleNames": [ "test1", "test2", "test3", "test4", "test5" ]}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-0773
Amazon EventBridge API ReferenceListRules
ListRulesLists your Amazon EventBridge rules. You can either list all the rules or you can provide a prefix to matchto the rule names.
ListRules does not list the targets of a rule. To see the targets associated with a rule, useListTargetsByRule (p. 81).
Request Syntax{ "EventBusName": "string", "Limit": number, "NamePrefix": "string", "NextToken": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
EventBusName (p. 74)
The name or ARN of the event bus to list the rules for. If you omit this, the default event bus is used.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: (arn:aws[\w-]*:events:[a-z]{2}-[a-z]+-[\w-]+:[0-9]{12}:event-bus\/)?[/\.\-_A-Za-z0-9]+
Required: NoLimit (p. 74)
The maximum number of results to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: NoNamePrefix (p. 74)
The prefix matching the rule name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [\.\-_A-Za-z0-9]+
Required: NoNextToken (p. 74)
The token returned by a previous call to retrieve the next set of results.
API Version 2015-10-0774
Amazon EventBridge API ReferenceResponse Syntax
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
Response Syntax{ "NextToken": "string", "Rules": [ { "Arn": "string", "Description": "string", "EventBusName": "string", "EventPattern": "string", "ManagedBy": "string", "Name": "string", "RoleArn": "string", "ScheduleExpression": "string", "State": "string" } ]}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
NextToken (p. 75)
Indicates whether there are additional results to retrieve. If there are no more results, the value isnull.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.Rules (p. 75)
The rules that match the specified criteria.
Type: Array of Rule (p. 169) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500ResourceNotFoundException
An entity that you specified does not exist.
API Version 2015-10-0775
Amazon EventBridge API ReferenceExamples
HTTP Status Code: 400
Examples
Lists all the rules that start with the letter "t" with a page size of1The following is an example of a ListRules request and response.
Sample Request
POST / HTTP/1.1Host: events.<region>.<domain>x-amz-Date: <Date>Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>User-Agent: <UserAgentString>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Connection: Keep-Alive X-Amz-Target: AWSEvents.ListRules
{ "NamePrefix": "t", "Limit": 1}
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: <RequestId>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Date: <Date>
{ "Rules": [ { "EventPattern": "{\"source\":[\"aws.autoscaling\"],\"detail-type\":[\"EC2 Instance Launch Successful\",\"EC2 Instance Terminate Successful\",\"EC2 Instance Launch Unsuccessful\",\"EC2 Instance Terminate Unsuccessful\"]}", "State": "DISABLED", "Name": "test", "Arn": "arn:aws:events:us-east-1:123456789012:rule/test", "Description": "Test rule for Auto Scaling events" } ], "NextToken": "ABCDEgAAAAAAAAAAQAAABCXtD8i7XlyFv5XFKH8GrudAAAAQIoQ0+7qXp63vQf1pvVklfHFd+p2QgY36pjlAqsSsrkNbOtTePaCeJqN8O+jbu66UhpJh7huA9r0iY9zjdtZ3vsAAAAgAAAAAAAAAAF5MZWktllmMuLd9gUjryM4sL9EG5IkcPUm60Vq1tzyYw=="}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
API Version 2015-10-0776
Amazon EventBridge API ReferenceSee Also
• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-0777
Amazon EventBridge API ReferenceListTagsForResource
ListTagsForResourceDisplays the tags associated with an EventBridge resource. In EventBridge, rules and event buses can betagged.
Request Syntax{ "ResourceARN": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
ResourceARN (p. 78)
The ARN of the EventBridge resource for which you want to view tags.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Required: Yes
Response Syntax{ "Tags": [ { "Key": "string", "Value": "string" } ]}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Tags (p. 78)
The list of tag keys and values associated with the resource you specified
Type: Array of Tag (p. 174) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
API Version 2015-10-0778
Amazon EventBridge API ReferenceExamples
InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500ResourceNotFoundException
An entity that you specified does not exist.
HTTP Status Code: 400
ExamplesRemoves two tags from an EventBridge ruleThe following is an example of an UntagResource request.
Sample Request
POST / HTTP/1.1Host: events.<region>.<domain>x-amz-Date: <Date>Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>User-Agent: <UserAgentString>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Connection: Keep-Alive X-Amz-Target: AWSEvents.ListTagsForResource
{ "ResourceARN": "arn:aws:events:us-west-1:123456789012:rule/test",}
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: <RequestId>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Date: <Date>
{ "Tags": [ { "Key": "Stack", "Value": "Prod" }, { "Key": "CostCenter", "Value": "12345" } ]}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
API Version 2015-10-0779
Amazon EventBridge API ReferenceSee Also
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-0780
Amazon EventBridge API ReferenceListTargetsByRule
ListTargetsByRuleLists the targets assigned to the specified rule.
Request Syntax{ "EventBusName": "string", "Limit": number, "NextToken": "string", "Rule": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
EventBusName (p. 81)
The name or ARN of the event bus associated with the rule. If you omit this, the default event bus isused.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: (arn:aws[\w-]*:events:[a-z]{2}-[a-z]+-[\w-]+:[0-9]{12}:event-bus\/)?[/\.\-_A-Za-z0-9]+
Required: NoLimit (p. 81)
The maximum number of results to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: NoNextToken (p. 81)
The token returned by a previous call to retrieve the next set of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: NoRule (p. 81)
The name of the rule.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
API Version 2015-10-0781
Amazon EventBridge API ReferenceResponse Syntax
Pattern: [\.\-_A-Za-z0-9]+
Required: Yes
Response Syntax{ "NextToken": "string", "Targets": [ { "Arn": "string", "BatchParameters": { "ArrayProperties": { "Size": number }, "JobDefinition": "string", "JobName": "string", "RetryStrategy": { "Attempts": number } }, "DeadLetterConfig": { "Arn": "string" }, "EcsParameters": { "Group": "string", "LaunchType": "string", "NetworkConfiguration": { "awsvpcConfiguration": { "AssignPublicIp": "string", "SecurityGroups": [ "string" ], "Subnets": [ "string" ] } }, "PlatformVersion": "string", "TaskCount": number, "TaskDefinitionArn": "string" }, "HttpParameters": { "HeaderParameters": { "string" : "string" }, "PathParameterValues": [ "string" ], "QueryStringParameters": { "string" : "string" } }, "Id": "string", "Input": "string", "InputPath": "string", "InputTransformer": { "InputPathsMap": { "string" : "string" }, "InputTemplate": "string" }, "KinesisParameters": { "PartitionKeyPath": "string" }, "RedshiftDataParameters": { "Database": "string", "DbUser": "string", "SecretManagerArn": "string",
API Version 2015-10-0782
Amazon EventBridge API ReferenceResponse Elements
"Sql": "string", "StatementName": "string", "WithEvent": boolean }, "RetryPolicy": { "MaximumEventAgeInSeconds": number, "MaximumRetryAttempts": number }, "RoleArn": "string", "RunCommandParameters": { "RunCommandTargets": [ { "Key": "string", "Values": [ "string" ] } ] }, "SqsParameters": { "MessageGroupId": "string" } } ]}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
NextToken (p. 82)
Indicates whether there are additional results to retrieve. If there are no more results, the value isnull.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.Targets (p. 82)
The targets assigned to the rule.
Type: Array of Target (p. 175) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500ResourceNotFoundException
An entity that you specified does not exist.
HTTP Status Code: 400
API Version 2015-10-0783
Amazon EventBridge API ReferenceExamples
ExamplesLists the targets associated with a rule named "test"The following is an example of a ListTargetsByRule request and response.
Sample Request
POST / HTTP/1.1Host: events.<region>.<domain>x-amz-Date: <Date>Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>User-Agent: <UserAgentString>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Connection: Keep-Alive X-Amz-Target: AWSEvents.ListTargetsByRule
{ "Rule": "test" }
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: <RequestId>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Date: <Date>
{ "Targets": [ { "Id": "MyTargetId", "Arn": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction" } ]}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-0784
Amazon EventBridge API ReferencePutEvents
PutEventsSends custom events to Amazon EventBridge so that they can be matched to rules.
Request Syntax{ "Entries": [ { "Detail": "string", "DetailType": "string", "EventBusName": "string", "Resources": [ "string" ], "Source": "string", "Time": number } ]}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
Entries (p. 85)
The entry that defines an event in your system. You can specify several parameters for the entrysuch as the source and type of the event, resources associated with the event, and so on.
Type: Array of PutEventsRequestEntry (p. 155) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: Yes
Response Syntax{ "Entries": [ { "ErrorCode": "string", "ErrorMessage": "string", "EventId": "string" } ], "FailedEntryCount": number}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
API Version 2015-10-0785
Amazon EventBridge API ReferenceErrors
Entries (p. 85)
The successfully and unsuccessfully ingested events results. If the ingestion was successful, theentry has the event ID in it. Otherwise, you can use the error code and error message to identify theproblem with the entry.
Type: Array of PutEventsResultEntry (p. 157) objectsFailedEntryCount (p. 85)
The number of failed entries.
Type: Integer
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500
ExamplesSends two custom eventsThe following is an example of a PutEvents request and response.
Sample Request
POST / HTTP/1.1Host: events.<region>.<domain>x-amz-Date: <Date>Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>User-Agent: <UserAgentString>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Connection: Keep-Alive X-Amz-Target: AWSEvents.PutEvents
{ "Entries":[ { "Source":"com.mycompany.myapp", "Detail":"{ \"key1\": \"value1\", \"key2\": \"value2\" }", "Resources":[ "resource1", "resource2" ], "DetailType":"myDetailType" }, { "Source":"com.mycompany.myapp", "Detail":"{ \"key1\": \"value3\", \"key2\": \"value4\" }", "Resources":[ "resource1",
API Version 2015-10-0786
Amazon EventBridge API ReferenceSee Also
"resource2" ], "DetailType":"myDetailType" } ]}
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: <RequestId>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Date: <Date>
{ "FailedEntryCount": 0, "Entries": [ { "EventId": "11710aed-b79e-4468-a20b-bb3c0c3b4860" }, { "EventId": "d804d26a-88db-4b66-9eaf-9a11c708ae82" } ]}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-0787
Amazon EventBridge API ReferencePutPartnerEvents
PutPartnerEventsThis is used by SaaS partners to write events to a customer's partner event bus. AWS customers do notuse this operation.
Request Syntax{ "Entries": [ { "Detail": "string", "DetailType": "string", "Resources": [ "string" ], "Source": "string", "Time": number } ]}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
Entries (p. 88)
The list of events to write to the event bus.
Type: Array of PutPartnerEventsRequestEntry (p. 158) objects
Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required: Yes
Response Syntax{ "Entries": [ { "ErrorCode": "string", "ErrorMessage": "string", "EventId": "string" } ], "FailedEntryCount": number}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
API Version 2015-10-0788
Amazon EventBridge API ReferenceErrors
Entries (p. 88)
The list of events from this operation that were successfully written to the partner event bus.
Type: Array of PutPartnerEventsResultEntry (p. 160) objectsFailedEntryCount (p. 88)
The number of events from this operation that could not be written to the partner event bus.
Type: Integer
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500OperationDisabledException
The operation you are attempting is not available in this region.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-0789
Amazon EventBridge API ReferencePutPermission
PutPermissionRunning PutPermission permits the specified AWS account or AWS organization to put events to thespecified event bus. Amazon EventBridge (CloudWatch Events) rules in your account are triggered bythese events arriving to an event bus in your account.
For another account to send events to your account, that external account must have an EventBridge rulewith your account's event bus as a target.
To enable multiple AWS accounts to put events to your event bus, run PutPermission once foreach of these accounts. Or, if all the accounts are members of the same AWS organization, you canrun PutPermission once specifying Principal as "*" and specifying the AWS organization ID inCondition, to grant permissions to all accounts in that organization.
If you grant permissions using an organization, then accounts in that organization must specify aRoleArn with proper permissions when they use PutTarget to add your account's event bus as atarget. For more information, see Sending and Receiving Events Between AWS Accounts in the AmazonEventBridge User Guide.
The permission policy on the default event bus cannot exceed 10 KB in size.
Request Syntax
{ "Action": "string", "Condition": { "Key": "string", "Type": "string", "Value": "string" }, "EventBusName": "string", "Policy": "string", "Principal": "string", "StatementId": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
Action (p. 90)
The action that you are enabling the other account to perform. Currently, this must beevents:PutEvents.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: events:[a-zA-Z]+
Required: No
API Version 2015-10-0790
Amazon EventBridge API ReferenceRequest Parameters
Condition (p. 90)
This parameter enables you to limit the permission to accounts that fulfill a certain condition, suchas being a member of a certain AWS organization. For more information about AWS Organizations,see What Is AWS Organizations in the AWS Organizations User Guide.
If you specify Condition with an AWS organization ID, and specify "*" as the value for Principal,you grant permission to all the accounts in the named organization.
The Condition is a JSON string which must contain Type, Key, and Value fields.
Type: Condition (p. 141) object
Required: NoEventBusName (p. 90)
The name of the event bus associated with the rule. If you omit this, the default event bus is used.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [\.\-_A-Za-z0-9]+
Required: NoPolicy (p. 90)
A JSON string that describes the permission policy statement. You can include a Policy parameterin the request instead of using the StatementId, Action, Principal, or Condition parameters.
Type: String
Required: NoPrincipal (p. 90)
The 12-digit AWS account ID that you are permitting to put events to your default event bus. Specify"*" to permit any account to put events to your default event bus.
If you specify "*" without specifying Condition, avoid creating rules that may match undesirableevents. To create more secure rules, make sure that the event pattern for each rule contains anaccount field with a specific account ID from which to receive events. Rules with an account field donot match any events sent from other accounts.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 12.
Pattern: (\d{12}|\*)
Required: NoStatementId (p. 90)
An identifier string for the external account that you are granting permissions to. If you laterwant to revoke the permission for this external account, specify this StatementId when you runRemovePermission (p. 112).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [a-zA-Z0-9-_]+
API Version 2015-10-0791
Amazon EventBridge API ReferenceResponse Elements
Required: No
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
ConcurrentModificationException
There is concurrent modification on a rule, target, archive, or replay.
HTTP Status Code: 400InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500OperationDisabledException
The operation you are attempting is not available in this region.
HTTP Status Code: 400PolicyLengthExceededException
The event bus policy is too long. For more information, see the limits.
HTTP Status Code: 400ResourceNotFoundException
An entity that you specified does not exist.
HTTP Status Code: 400
ExamplesThe following example enables the current account to receive events from account 111122223333.
ExampleThis example illustrates one usage of PutPermission.
Sample Request
POST / HTTP/1.1Host: events.<region>.<domain>x-amz-Date: <Date>Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>User-Agent: <UserAgentString>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Connection: Keep-Alive
API Version 2015-10-0792
Amazon EventBridge API ReferenceSee Also
X-Amz-Target: AWSEvents.PutPermission
{ "Action":"events:PutEvents" "Principal":"111122223333" "StatementId":"MyStatement" }
ExampleThe following example grants permissions to all accounts in the organization with an ID ofo-1234567890
Sample Request
POST / HTTP/1.1Host: events.<region>.<domain>x-amz-Date: <Date>Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>User-Agent: <UserAgentString>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Connection: Keep-Alive X-Amz-Target: AWSEvents.PutPermission
{ "Action":"events:PutEvents" "Principal":"*" "Condition": '{"Type" : "StringEquals", "Key": "aws:PrincipalOrgID", "Value": "o-1234567890"}' "StatementId":"MyStatement" }
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-0793
Amazon EventBridge API ReferencePutRule
PutRuleCreates or updates the specified rule. Rules are enabled by default, or based on value of the state. Youcan disable a rule using DisableRule (p. 48).
A single rule watches for events from a single event bus. Events generated by AWS services go toyour account's default event bus. Events generated by SaaS partner services or applications go to thematching partner event bus. If you have custom applications or services, you can specify whether theirevents go to your default event bus or a custom event bus that you have created. For more information,see CreateEventBus (p. 12).
If you are updating an existing rule, the rule is replaced with what you specify in this PutRule command.If you omit arguments in PutRule, the old values for those arguments are not kept. Instead, they arereplaced with null values.
When you create or update a rule, incoming events might not immediately start matching to new orupdated rules. Allow a short period of time for changes to take effect.
A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns aretriggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on thegiven schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the ruletriggers on matching events as well as on a schedule.
When you initially create a rule, you can optionally assign one or more tags to the rule. Tags can help youorganize and categorize your resources. You can also use them to scope user permissions, by granting auser permission to access or change only rules with certain tag values. To use the PutRule operation andassign tags, you must have both the events:PutRule and events:TagResource permissions.
If you are updating an existing rule, any tags you specify in the PutRule operation are ignored. Toupdate the tags of an existing rule, use TagResource (p. 122) and UntagResource (p. 128).
Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However,EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characterswhen creating event patterns so that they match the ARN syntax in the event you want to match.
In EventBridge, it is possible to create rules that lead to infinite loops, where a rule is fired repeatedly.For example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software tochange them to the desired state. If the rule is not written carefully, the subsequent change to the ACLsfires the rule again, creating an infinite loop.
To prevent this, write the rules so that the triggered actions do not re-fire the same rule. For example,your rule could fire only if ACLs are found to be in a bad state, instead of after any change.
An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting,which alerts you when charges exceed your specified limit. For more information, see Managing YourCosts with Budgets.
Request Syntax{ "Description": "string", "EventBusName": "string", "EventPattern": "string", "Name": "string", "RoleArn": "string", "ScheduleExpression": "string", "State": "string", "Tags": [
API Version 2015-10-0794
Amazon EventBridge API ReferenceRequest Parameters
{ "Key": "string", "Value": "string" } ]}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
Description (p. 94)
A description of the rule.
Type: String
Length Constraints: Maximum length of 512.
Required: NoEventBusName (p. 94)
The name or ARN of the event bus to associate with this rule. If you omit this, the default event busis used.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: (arn:aws[\w-]*:events:[a-z]{2}-[a-z]+-[\w-]+:[0-9]{12}:event-bus\/)?[/\.\-_A-Za-z0-9]+
Required: NoEventPattern (p. 94)
The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridgeUser Guide.
Type: String
Required: NoName (p. 94)
The name of the rule that you are creating or updating.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [\.\-_A-Za-z0-9]+
Required: YesRoleArn (p. 94)
The Amazon Resource Name (ARN) of the IAM role associated with the rule.
Type: String
API Version 2015-10-0795
Amazon EventBridge API ReferenceResponse Syntax
Length Constraints: Minimum length of 1. Maximum length of 1600.
Required: NoScheduleExpression (p. 94)
The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".
Type: String
Length Constraints: Maximum length of 256.
Required: NoState (p. 94)
Indicates whether the rule is enabled or disabled.
Type: String
Valid Values: ENABLED | DISABLED
Required: NoTags (p. 94)
The list of key-value pairs to associate with the rule.
Type: Array of Tag (p. 174) objects
Required: No
Response Syntax{ "RuleArn": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
RuleArn (p. 96)
The Amazon Resource Name (ARN) of the rule.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
ConcurrentModificationException
There is concurrent modification on a rule, target, archive, or replay.
API Version 2015-10-0796
Amazon EventBridge API ReferenceExamples
HTTP Status Code: 400InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500InvalidEventPatternException
The event pattern is not valid.
HTTP Status Code: 400LimitExceededException
The request failed because it attempted to create resource beyond the allowed service quota.
HTTP Status Code: 400ManagedRuleException
This rule was created by an AWS service on behalf of your account. It is managed by that service.If you see this error in response to DeleteRule or RemoveTargets, you can use the Forceparameter in those calls to delete the rule or remove targets from the rule. You cannot modify thesemanaged rules by using DisableRule, EnableRule, PutTargets, PutRule, TagResource, orUntagResource.
HTTP Status Code: 400ResourceNotFoundException
An entity that you specified does not exist.
HTTP Status Code: 400
Examples
Creates a rule named "test" that matches events from AmazonEC2. The rule is also given two tags.The following is an example of a PutRule request and response.
Sample Request
POST / HTTP/1.1Host: events.<region>.<domain>x-amz-Date: <Date>Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>User-Agent: <UserAgentString>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Connection: Keep-Alive X-Amz-Target: AWSEvents.PutRule
{ "Name": "test", "EventPattern": "{ \"source\": [\"aws.ec2\"] }", "Tags": [ { "Key": "Stack",
API Version 2015-10-0797
Amazon EventBridge API ReferenceSee Also
"Value": "Prod" }, { "Key": "CostCenter", "Value": "12345" } ]}
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: <RequestId>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Date: <Date>
{ "RuleArn": "arn:aws:events:us-east-1:123456789012:rule/test"}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-0798
Amazon EventBridge API ReferencePutTargets
PutTargetsAdds the specified targets to the specified rule, or updates the targets if they are already associated withthe rule.
Targets are the resources that are invoked when a rule is triggered.
You can configure the following as targets for Events:
• EC2 instances
• SSM Run Command
• SSM Automation
• AWS Lambda functions
• Data streams in Amazon Kinesis Data Streams
• Data delivery streams in Amazon Kinesis Data Firehose
• Amazon ECS tasks
• AWS Step Functions state machines
• AWS Batch jobs
• AWS CodeBuild projects
• Pipelines in AWS CodePipeline
• Amazon Inspector assessment templates
• Amazon SNS topics
• Amazon SQS queues, including FIFO queues
• The default event bus of another AWS account
• Amazon API Gateway REST APIs
• Redshift Clusters to invoke Data API ExecuteStatement on
Creating rules with built-in targets is supported only in the AWS Management Console. The built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API call, EC2StopInstances API call, and EC2 TerminateInstances API call.
For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis datastream, you can optionally specify which shard the event goes to by using the KinesisParametersargument. To invoke a command on multiple EC2 instances with one rule, you can use theRunCommandParameters field.
To be able to make API calls against the resources that you own, Amazon EventBridge (CloudWatchEvents) needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, EventBridgerelies on resource-based policies. For EC2 instances, Kinesis data streams, AWS Step Functions statemachines and API Gateway REST APIs, EventBridge relies on IAM roles that you specify in the RoleARNargument in PutTargets. For more information, see Authentication and Access Control in the AmazonEventBridge User Guide.
If another AWS account is in the same region and has granted you permission (using PutPermission),you can send events to that account. Set that account's event bus as a target of the rules in your account.To send the matched events to the other account, specify that account's event bus as the Arn value whenyou run PutTargets. If your account sends events to another account, your account is charged for eachsent event. Each event sent to another account is charged as a custom event. The account receiving theevent is not charged. For more information, see Amazon EventBridge (CloudWatch Events) Pricing.
API Version 2015-10-0799
Amazon EventBridge API ReferenceRequest Syntax
NoteInput, InputPath, and InputTransformer are not available with PutTarget if the target isan event bus of a different AWS account.
If you are setting the event bus of another account as the target, and that account granted permissionto your account through an organization instead of directly by the account ID, then you must specifya RoleArn with proper permissions in the Target structure. For more information, see Sending andReceiving Events Between AWS Accounts in the Amazon EventBridge User Guide.
For more information about enabling cross-account events, see PutPermission (p. 90).
Input, InputPath, and InputTransformer are mutually exclusive and optional parameters of a target.When a rule is triggered due to a matched event:
• If none of the following arguments are specified for a target, then the entire event is passed to thetarget in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in whichcase nothing from the event is passed to the target).
• If Input is specified in the form of valid JSON, then the matched event is overridden with this constant.
• If InputPath is specified in the form of JSONPath (for example, $.detail), then only the part of theevent specified in the path is passed to the target (for example, only the detail part of the event ispassed).
• If InputTransformer is specified, then one or more specified JSONPaths are extracted from the eventand used as values in a template that you specify as the input to the target.
When you specify InputPath or InputTransformer, you must use JSON dot notation, not bracketnotation.
When you add targets to a rule and the associated rule triggers soon after, new or updated targets mightnot be immediately invoked. Allow a short period of time for changes to take effect.
This action can partially fail if too many requests are made at the same time. If that happens,FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID ofthe failed target and the error code.
Request Syntax{ "EventBusName": "string", "Rule": "string", "Targets": [ { "Arn": "string", "BatchParameters": { "ArrayProperties": { "Size": number }, "JobDefinition": "string", "JobName": "string", "RetryStrategy": { "Attempts": number } }, "DeadLetterConfig": { "Arn": "string" }, "EcsParameters": { "Group": "string", "LaunchType": "string",
API Version 2015-10-07100
Amazon EventBridge API ReferenceRequest Parameters
"NetworkConfiguration": { "awsvpcConfiguration": { "AssignPublicIp": "string", "SecurityGroups": [ "string" ], "Subnets": [ "string" ] } }, "PlatformVersion": "string", "TaskCount": number, "TaskDefinitionArn": "string" }, "HttpParameters": { "HeaderParameters": { "string" : "string" }, "PathParameterValues": [ "string" ], "QueryStringParameters": { "string" : "string" } }, "Id": "string", "Input": "string", "InputPath": "string", "InputTransformer": { "InputPathsMap": { "string" : "string" }, "InputTemplate": "string" }, "KinesisParameters": { "PartitionKeyPath": "string" }, "RedshiftDataParameters": { "Database": "string", "DbUser": "string", "SecretManagerArn": "string", "Sql": "string", "StatementName": "string", "WithEvent": boolean }, "RetryPolicy": { "MaximumEventAgeInSeconds": number, "MaximumRetryAttempts": number }, "RoleArn": "string", "RunCommandParameters": { "RunCommandTargets": [ { "Key": "string", "Values": [ "string" ] } ] }, "SqsParameters": { "MessageGroupId": "string" } } ]}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
API Version 2015-10-07101
Amazon EventBridge API ReferenceResponse Syntax
The request accepts the following data in JSON format.
EventBusName (p. 100)
The name or ARN of the event bus associated with the rule. If you omit this, the default event bus isused.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: (arn:aws[\w-]*:events:[a-z]{2}-[a-z]+-[\w-]+:[0-9]{12}:event-bus\/)?[/\.\-_A-Za-z0-9]+
Required: NoRule (p. 100)
The name of the rule.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [\.\-_A-Za-z0-9]+
Required: YesTargets (p. 100)
The targets to update or add to the rule.
Type: Array of Target (p. 175) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: Yes
Response Syntax{ "FailedEntries": [ { "ErrorCode": "string", "ErrorMessage": "string", "TargetId": "string" } ], "FailedEntryCount": number}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
FailedEntries (p. 102)
The failed target entries.
API Version 2015-10-07102
Amazon EventBridge API ReferenceErrors
Type: Array of PutTargetsResultEntry (p. 161) objectsFailedEntryCount (p. 102)
The number of failed entries.
Type: Integer
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
ConcurrentModificationException
There is concurrent modification on a rule, target, archive, or replay.
HTTP Status Code: 400InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500LimitExceededException
The request failed because it attempted to create resource beyond the allowed service quota.
HTTP Status Code: 400ManagedRuleException
This rule was created by an AWS service on behalf of your account. It is managed by that service.If you see this error in response to DeleteRule or RemoveTargets, you can use the Forceparameter in those calls to delete the rule or remove targets from the rule. You cannot modify thesemanaged rules by using DisableRule, EnableRule, PutTargets, PutRule, TagResource, orUntagResource.
HTTP Status Code: 400ResourceNotFoundException
An entity that you specified does not exist.
HTTP Status Code: 400
ExamplesAdds a target to a Lambda function with the ID "MyTargetId" tothe rule named "test"The following is an example of a PutTargets request.
Sample Request
POST / HTTP/1.1Host: events.<region>.<domain>x-amz-Date: <Date>Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>User-Agent: <UserAgentString>
API Version 2015-10-07103
Amazon EventBridge API ReferenceExamples
Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Connection: Keep-Alive X-Amz-Target: AWSEvents.PutTargets
{ "Rule": "test", "Targets": [ { "Id": "MyTargetId", "Arn": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction" } ]}
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: <RequestId>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Date: <Date>
{ "FailedEntries": [], "FailedEntryCount": 0}
Use Input Transformer to extract data from an event and inputthat data to the targetThis example extracts the instance and state from an event, puts them into a simple text template, andpasses this data to a Lambda function called MyFunction.
NoteIf your are using InputTransformer with CloudWatch Logs as a target, the Template must be{"timestamp":<timestamp>,"message":<version-id>}.
Sample Request
POST / HTTP/1.1Host: events.<region>.<domain>x-amz-Date: <Date>Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>User-Agent: <UserAgentString>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Connection: Keep-Alive X-Amz-Target: AWSEvents.PutTargets
{ "Rule": "testrule", "Targets": [ { "Id": "MyTargetId", "Arn": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", "InputTransformer": { "InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
API Version 2015-10-07104
Amazon EventBridge API ReferenceExamples
"InputTemplate": "<instance> is in state <status>" } } ]}
ExampleHere is another sample request using InputTransformer. The input to the Lambda function is in JSONformat, with an array substituted. Below that sample request are examples of an event and the resultingoutput to the target, using this sample request.
POST / HTTP/1.1Host: events.<region>.<domain>x-amz-Date: <Date>Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>User-Agent: <UserAgentString>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Connection: Keep-Alive X-Amz-Target: AWSEvents.PutTargets
{ "Rule": "testrule", "Targets": [ { "Id": "MyTargetId", "Arn": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction" "InputTransformer": { "InputPathsMap": {"commandsToRun": "$.detail.commands"}, "InputTemplate": "{\"commands\": <commandsToRun>}" } } ]}
Incoming event: { "Time": 1225864800, "Source": "foo", "Resources": ["foo", "foo"], "DetailType": "foo", "Detail": { "commands": ["ls -lrt", "echo HelloWorld!"] }}
Output sent to the target: { "commands" : ["ls -lrt", "echo HelloWorld!"]}
API Version 2015-10-07105
Amazon EventBridge API ReferenceExamples
Sends a command to a list of EC2 instances specified byInstanceIds, using Amazon EC2 Run CommandThis example illustrates one usage of PutTargets.
POST / HTTP/1.1Host: events.<region>.<domain>x-amz-Date: <Date>Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>User-Agent: <UserAgentString>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Connection: Keep-Alive X-Amz-Target: AWSEvents.PutTargets
{ "Rule": "testrule", "Targets": [ { "Id": "id123456789", "Arn": "arn:aws:ssm:us-east-1:12345679012:document/RestartLinuxService", "RoleArn": "arn:aws:iam::123456789012:role/MyRoleToAccessEC2" "RunCommandParameters": { "RunCommandTargets": [ { "Key":"InstanceIds", "Values":["i-123456789012", "i-098765432109"] } ] }
]}
Sends a batch job command to an AWS Batch job queueWhen the target is an AWS Batch job queue, the Arn field specifies the ARN of the job queue, whileJobDefinition specifies the ARN of the job definition.
POST / HTTP/1.1Host: events.<region>.<domain>x-amz-Date: <Date>Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>User-Agent: <UserAgentString>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Connection: Keep-Alive X-Amz-Target: AWSEvents.PutTargets
{ "Rule":"batch-job-rule", "Targets":[ { "Id":"id123456789", "Arn":"arn:aws:batch:us-west-2:012345678910:job-queue/default", "BatchParameters":{
API Version 2015-10-07106
Amazon EventBridge API ReferenceExamples
"ArrayProperties":{ "Size":25 }, "JobDefinition":"arn:aws:batch:us-west-2:012345678910:job-definition/nvidia-smi:1", "JobName":"unique-job-name", "RetryStrategy":{ "Attempts":5 } } } ]}
Uses KinesisParameters to control the shard assignmentIn this example, KinesisParameters is used to specify that events related to status changes are sentto a shard specific to the affected instance ID.
POST / HTTP/1.1Host: events.<region>.<domain>x-amz-Date: <Date>Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>User-Agent: <UserAgentString>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Connection: Keep-Alive X-Amz-Target: AWSEvents.PutTargets
{ "Rule": "StatusChangeRule", "Targets": [ { "Id" : "1", "Arn": "arn:aws:kinesis:us-east-1:123456789012:function:stream/mystream", "KinesisParameters":{ "PartitionKeyPath":"$.detail.instance-id"}' }]}
Adds an Amazon Kinesis Data Firehose data delivery stream as atargetThis example sets a Kinesis data delivery stream named target-stream-name as a target.
POST / HTTP/1.1Host: events.<region>.<domain>x-amz-Date: <Date>Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>User-Agent: <UserAgentString>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Connection: Keep-Alive X-Amz-Target: AWSEvents.PutTargets
{ "Rule": "FirehoseExample", "Targets": [
API Version 2015-10-07107
Amazon EventBridge API ReferenceExamples
{ "Id" : "FirehoseStream", "Arn": "arn:aws:firehose:us-east-1:123456789012:deliverystream/target-stream-name", }]}
Adds a Step Functions state machine as a targetThis example targets a state machine called "HelloWorld", and sends the input constant "Hello World!" tothat target.
POST / HTTP/1.1Host: events.<region>.<domain>x-amz-Date: <Date>Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>User-Agent: <UserAgentString>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Connection: Keep-Alive X-Amz-Target: AWSEvents.PutTargets
{ "Rule": "testrule", "Targets": [ { "RoleArn": "arn:aws:iam::123456789012:role/MyRoleToAccessStepFunctions" "Arn":"arn:aws:states:us-east-1:123456789012:stateMachine:HelloWorld", "Input":"HelloWorld!" }]}
Adds a target that creates three Amazon ECS tasks based on atask definitionThis example uses Amazon ECS as the target. You must have already created the task definition andcluster in Amazon ECS.
POST / HTTP/1.1Host: events.<region>.<domain>x-amz-Date: <Date>Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>User-Agent: <UserAgentString>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Connection: Keep-Alive X-Amz-Target: AWSEvents.PutTargets
{ "Rule": "test", "Targets": [ { "Id": "Target1", "RoleArn": "arn:aws:iam::123456789012:role/MyRoleToAccessECS" "Arn": "arn:aws:ecs:us-east-1:123456789012:cluster/example-cluster", "ECSParameters": { "TaskDefinitionArn": "arn:aws:ecs:us-east-1:123456789012:task-definition/example",
API Version 2015-10-07108
Amazon EventBridge API ReferenceExamples
"TaskCount": 3 } } ]}
Specifying two targets with one commandThis example sets two simple targets with one command. In this example, both targets are AWS Lambdafunctions, but the two targets could be different AWS services as well.
Sample Request
POST / HTTP/1.1Host: events.<region>.<domain>x-amz-Date: <Date>Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>User-Agent: <UserAgentString>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Connection: Keep-Alive X-Amz-Target: AWSEvents.PutTargets
{ "Rule": "test", "Targets": [ { "Id": "MyTargetId", "Arn": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction" } { "Id": "MyTargetId2", "Arn": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction2" } ]}
Specifying another AWS account as a targetThis example shows cross-account event delivery. The target being added is the event bus of a separateAWS account, which has the AWS account ID of 444455556666.
NoteInput, InputPath, and InputTransformer are not available with PutTarget if the target isan event bus of a different AWS account.
Sample Request
POST / HTTP/1.1Host: events.<region>.<domain>x-amz-Date: <Date>Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>User-Agent: <UserAgentString>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>
API Version 2015-10-07109
Amazon EventBridge API ReferenceSee Also
Connection: Keep-Alive X-Amz-Target: AWSEvents.PutTargets
{ "Rule": "producer-rule", "Targets": [ { "Id": "CrossAccountTargetId", "Arn": "arn:aws:events:us-east-1:444455556666:event-bus/default" } ]}
Adds a API Gateway REST API as a targetThis example targets an API Gateway REST API with static and dynamic HTTP parameters.
NoteHTTP parameters with static values are passed through to API Gateway as-is. If you provide aJSON Path (prefixed with "$."), it will be dynamically replaced at runtime with a value from theevent payload (before input transformation).
Sample Request
POST / HTTP/1.1Host: events.<region>.<domain>x-amz-Date: <Date>Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>User-Agent: <UserAgentString>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Connection: Keep-Alive X-Amz-Target: AWSEvents.PutTargets
{ "Rule": "test", "Targets": [ { "Id": "testTargetId", "Arn": "arn:aws:execute-api:us-east-1:444455556666:py1kl011je/testStage/POST/path1/*/path2/*", "RoleArn": "arn:aws:iam::415653183693:role/APIGatewayPOC", "HttpParameters": { "PathParameterValues": ["pp1Val", "pp2Val"], "HeaderParameters": {"hp1": "hp1Val", "hp2": "$.detail.header"}, "QueryStringParameters": {"qsp1": "qsp1Val", "qsp2": "$.source"} } } ]}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
API Version 2015-10-07110
Amazon EventBridge API ReferenceSee Also
• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-07111
Amazon EventBridge API ReferenceRemovePermission
RemovePermissionRevokes the permission of another AWS account to be able to put events to the specified eventbus. Specify the account to revoke by the StatementId value that you associated with the accountwhen you granted it permission with PutPermission. You can find the StatementId by usingDescribeEventBus (p. 32).
Request Syntax{ "EventBusName": "string", "RemoveAllPermissions": boolean, "StatementId": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
EventBusName (p. 112)
The name of the event bus to revoke permissions for. If you omit this, the default event bus is used.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [\.\-_A-Za-z0-9]+
Required: NoRemoveAllPermissions (p. 112)
Specifies whether to remove all permissions.
Type: Boolean
Required: NoStatementId (p. 112)
The statement ID corresponding to the account that is no longer allowed to put events to thedefault event bus.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [a-zA-Z0-9-_]+
Required: No
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
API Version 2015-10-07112
Amazon EventBridge API ReferenceErrors
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
ConcurrentModificationException
There is concurrent modification on a rule, target, archive, or replay.
HTTP Status Code: 400InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500OperationDisabledException
The operation you are attempting is not available in this region.
HTTP Status Code: 400ResourceNotFoundException
An entity that you specified does not exist.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-07113
Amazon EventBridge API ReferenceRemoveTargets
RemoveTargetsRemoves the specified targets from the specified rule. When the rule is triggered, those targets are nolonger be invoked.
When you remove a target, when the associated rule triggers, removed targets might continue to beinvoked. Allow a short period of time for changes to take effect.
This action can partially fail if too many requests are made at the same time. If that happens,FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID ofthe failed target and the error code.
Request Syntax{ "EventBusName": "string", "Force": boolean, "Ids": [ "string" ], "Rule": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
EventBusName (p. 114)
The name or ARN of the event bus associated with the rule. If you omit this, the default event bus isused.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: (arn:aws[\w-]*:events:[a-z]{2}-[a-z]+-[\w-]+:[0-9]{12}:event-bus\/)?[/\.\-_A-Za-z0-9]+
Required: NoForce (p. 114)
If this is a managed rule, created by an AWS service on your behalf, you must specify Force asTrue to remove targets. This parameter is ignored for rules that are not managed rules. You cancheck whether a rule is a managed rule by using DescribeRule or ListRules and checking theManagedBy field of the response.
Type: Boolean
Required: NoIds (p. 114)
The IDs of the targets to remove from the rule.
Type: Array of strings
API Version 2015-10-07114
Amazon EventBridge API ReferenceResponse Syntax
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [\.\-_A-Za-z0-9]+
Required: YesRule (p. 114)
The name of the rule.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [\.\-_A-Za-z0-9]+
Required: Yes
Response Syntax{ "FailedEntries": [ { "ErrorCode": "string", "ErrorMessage": "string", "TargetId": "string" } ], "FailedEntryCount": number}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
FailedEntries (p. 115)
The failed target entries.
Type: Array of RemoveTargetsResultEntry (p. 164) objectsFailedEntryCount (p. 115)
The number of failed entries.
Type: Integer
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
ConcurrentModificationException
There is concurrent modification on a rule, target, archive, or replay.
API Version 2015-10-07115
Amazon EventBridge API ReferenceExamples
HTTP Status Code: 400InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500ManagedRuleException
This rule was created by an AWS service on behalf of your account. It is managed by that service.If you see this error in response to DeleteRule or RemoveTargets, you can use the Forceparameter in those calls to delete the rule or remove targets from the rule. You cannot modify thesemanaged rules by using DisableRule, EnableRule, PutTargets, PutRule, TagResource, orUntagResource.
HTTP Status Code: 400ResourceNotFoundException
An entity that you specified does not exist.
HTTP Status Code: 400
ExamplesRemoves a target with ID "MyTargetId" from a rule named "test"The following is an example of a RemoveTargets request.
Sample Request
POST / HTTP/1.1Host: events.<region>.<domain>x-amz-Date: <Date>Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>User-Agent: <UserAgentString>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Connection: Keep-Alive X-Amz-Target: AWSEvents.RemoveTargets
{ "Rule": "test", "Ids": [ "MyTargetId" ]}
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: <RequestId>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Date: <Date>
{ "FailedEntries": [], "FailedEntryCount": 0
API Version 2015-10-07116
Amazon EventBridge API ReferenceSee Also
}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-07117
Amazon EventBridge API ReferenceStartReplay
StartReplayStarts the specified replay. Events are not necessarily replayed in the exact same order that they wereadded to the archive. A replay processes events to replay based on the time in the event, and replaysthem using 1 minute intervals. If you specify an EventStartTime and an EventEndTime that coversa 20 minute time range, the events are replayed from the first minute of that 20 minute range first.Then the events from the second minute are replayed. You can use DescribeReplay to determine theprogress of a replay. The value returned for EventLastReplayedTime indicates the time within thespecified time range associated with the last event replayed.
Request Syntax{ "Description": "string", "Destination": { "Arn": "string", "FilterArns": [ "string" ] }, "EventEndTime": number, "EventSourceArn": "string", "EventStartTime": number, "ReplayName": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
Description (p. 118)
A description for the replay to start.
Type: String
Length Constraints: Maximum length of 512.
Pattern: .*
Required: NoDestination (p. 118)
A ReplayDestination object that includes details about the destination for the replay.
Type: ReplayDestination (p. 167) object
Required: YesEventEndTime (p. 118)
A time stamp for the time to stop replaying events. Only events that occurred between theEventStartTime and EventEndTime are replayed.
Type: Timestamp
Required: Yes
API Version 2015-10-07118
Amazon EventBridge API ReferenceResponse Syntax
EventSourceArn (p. 118)
The ARN of the archive to replay events from.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Required: YesEventStartTime (p. 118)
A time stamp for the time to start replaying events. Only events that occurred between theEventStartTime and EventEndTime are replayed.
Type: Timestamp
Required: YesReplayName (p. 118)
The name of the replay to start.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [\.\-_A-Za-z0-9]+
Required: Yes
Response Syntax{ "ReplayArn": "string", "ReplayStartTime": number, "State": "string", "StateReason": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
ReplayArn (p. 119)
The ARN of the replay.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:.+\/[\.\-_A-Za-z0-9]+$
ReplayStartTime (p. 119)
The time at which the replay started.
API Version 2015-10-07119
Amazon EventBridge API ReferenceErrors
Type: TimestampState (p. 119)
The state of the replay.
Type: String
Valid Values: STARTING | RUNNING | CANCELLING | COMPLETED | CANCELLED | FAILEDStateReason (p. 119)
The reason that the replay is in the state.
Type: String
Length Constraints: Maximum length of 512.
Pattern: .*
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500InvalidEventPatternException
The event pattern is not valid.
HTTP Status Code: 400LimitExceededException
The request failed because it attempted to create resource beyond the allowed service quota.
HTTP Status Code: 400ResourceAlreadyExistsException
The resource you are trying to create already exists.
HTTP Status Code: 400ResourceNotFoundException
An entity that you specified does not exist.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++
API Version 2015-10-07120
Amazon EventBridge API ReferenceSee Also
• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-07121
Amazon EventBridge API ReferenceTagResource
TagResourceAssigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can help youorganize and categorize your resources. You can also use them to scope user permissions by grantinga user permission to access or change only resources with certain tag values. In EventBridge, rules andevent buses can be tagged.
Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.
You can use the TagResource action with a resource that already has tags. If you specify a new tagkey, this tag is appended to the list of tags associated with the resource. If you specify a tag key that isalready associated with the resource, the new tag value that you specify replaces the previous value forthat tag.
You can associate as many as 50 tags with a resource.
Request Syntax{ "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ]}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
ResourceARN (p. 122)
The ARN of the EventBridge resource that you're adding tags to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Required: YesTags (p. 122)
The list of key-value pairs to associate with the resource.
Type: Array of Tag (p. 174) objects
Required: Yes
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
API Version 2015-10-07122
Amazon EventBridge API ReferenceErrors
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
ConcurrentModificationException
There is concurrent modification on a rule, target, archive, or replay.
HTTP Status Code: 400InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500ManagedRuleException
This rule was created by an AWS service on behalf of your account. It is managed by that service.If you see this error in response to DeleteRule or RemoveTargets, you can use the Forceparameter in those calls to delete the rule or remove targets from the rule. You cannot modify thesemanaged rules by using DisableRule, EnableRule, PutTargets, PutRule, TagResource, orUntagResource.
HTTP Status Code: 400ResourceNotFoundException
An entity that you specified does not exist.
HTTP Status Code: 400
ExamplesAdds two tags to a EventBridge ruleThe following is an example of a TagResource request.
Sample Request
POST / HTTP/1.1Host: events.<region>.<domain>x-amz-Date: <Date>Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>User-Agent: <UserAgentString>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Connection: Keep-Alive X-Amz-Target: AWSEvents.TagResource
{ "ResourceARN": "arn:aws:events:us-west-1:123456789012:rule/test", "Tags": [ { "Key": "Stack", "Value": "Prod" }, { "Key": "Team", "Value": "Green"
API Version 2015-10-07123
Amazon EventBridge API ReferenceSee Also
} ]}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-07124
Amazon EventBridge API ReferenceTestEventPattern
TestEventPatternTests whether the specified event pattern matches the provided event.
Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However,EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characterswhen creating event patterns so that they match the ARN syntax in the event you want to match.
Request Syntax{ "Event": "string", "EventPattern": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
Event (p. 125)
The event, in JSON format, to test against the event pattern.
Type: String
Required: YesEventPattern (p. 125)
The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridgeUser Guide.
Type: String
Required: Yes
Response Syntax{ "Result": boolean}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Result (p. 125)
Indicates whether the event matches the event pattern.
API Version 2015-10-07125
Amazon EventBridge API ReferenceErrors
Type: Boolean
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500
InvalidEventPatternException
The event pattern is not valid.
HTTP Status Code: 400
Examples
Tests that a given event matches a given event patternThe following is an example of a TestEventPattern request and response.
Sample Request
POST / HTTP/1.1Host: events.<region>.<domain>x-amz-Date: <Date>Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>User-Agent: <UserAgentString>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Connection: Keep-Alive X-Amz-Target: AWSEvents.TestEventPattern
{ "EventPattern": "{\"source\": [\"com.mycompany.myapp\"]}", "Event": "{\"id\": \"e00c66cb-fe7a-4fcc-81ad-58eb60f5d96b\", \"detail-type\": \"myDetailType\", \"source\": \"com.mycompany.myapp\", \"account\": \"123456789012\", \"time\": \"2016-01-10T01:29:23Z\", \"region\": \"us-east-1\", \"resources\": [\"resource1\", \"resource2\"], \"detail\": {{\"key1\": \"value1\", \"key2\": \"value2\"}}" }}
Sample Response
HTTP/1.1 200 OKx-amzn-RequestId: <RequestId>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Date: <Date>
{ "Result": true
API Version 2015-10-07126
Amazon EventBridge API ReferenceSee Also
}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-07127
Amazon EventBridge API ReferenceUntagResource
UntagResourceRemoves one or more tags from the specified EventBridge resource. In Amazon EventBridge (CloudWatchEvents, rules and event buses can be tagged.
Request Syntax{ "ResourceARN": "string", "TagKeys": [ "string" ]}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
ResourceARN (p. 128)
The ARN of the EventBridge resource from which you are removing tags.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Required: YesTagKeys (p. 128)
The list of tag keys to remove from the resource.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
ConcurrentModificationException
There is concurrent modification on a rule, target, archive, or replay.
HTTP Status Code: 400InternalException
This exception occurs due to unexpected causes.
API Version 2015-10-07128
Amazon EventBridge API ReferenceExamples
HTTP Status Code: 500ManagedRuleException
This rule was created by an AWS service on behalf of your account. It is managed by that service.If you see this error in response to DeleteRule or RemoveTargets, you can use the Forceparameter in those calls to delete the rule or remove targets from the rule. You cannot modify thesemanaged rules by using DisableRule, EnableRule, PutTargets, PutRule, TagResource, orUntagResource.
HTTP Status Code: 400ResourceNotFoundException
An entity that you specified does not exist.
HTTP Status Code: 400
Examples
Removes two tags from an EventBridge ruleThe following is an example of an UntagResource request.
Sample Request
POST / HTTP/1.1Host: events.<region>.<domain>x-amz-Date: <Date>Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>User-Agent: <UserAgentString>Content-Type: application/x-amz-json-1.1Content-Length: <PayloadSizeBytes>Connection: Keep-Alive X-Amz-Target: AWSEvents.UntagResource
{ "ResourceARN": "arn:aws:events:us-west-1:123456789012:rule/test", "TagKeys": [ "CostCenter", "Team" ]}
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-07129
Amazon EventBridge API ReferenceSee Also
API Version 2015-10-07130
Amazon EventBridge API ReferenceUpdateArchive
UpdateArchiveUpdates the specified archive.
Request Syntax{ "ArchiveName": "string", "Description": "string", "EventPattern": "string", "RetentionDays": number}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 180).
The request accepts the following data in JSON format.
ArchiveName (p. 131)
The name of the archive to update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 48.
Pattern: [\.\-_A-Za-z0-9]+
Required: YesDescription (p. 131)
The description for the archive.
Type: String
Length Constraints: Maximum length of 512.
Pattern: .*
Required: NoEventPattern (p. 131)
The event pattern to use to filter events sent to the archive.
Type: String
Required: NoRetentionDays (p. 131)
The number of days to retain events in the archive.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
API Version 2015-10-07131
Amazon EventBridge API ReferenceResponse Syntax
Response Syntax{ "ArchiveArn": "string", "CreationTime": number, "State": "string", "StateReason": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
ArchiveArn (p. 132)
The ARN of the archive.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:.+\/.+$CreationTime (p. 132)
The time at which the archive was updated.
Type: TimestampState (p. 132)
The state of the archive.
Type: String
Valid Values: ENABLED | DISABLED | CREATING | UPDATING | CREATE_FAILED |UPDATE_FAILED
StateReason (p. 132)
The reason that the archive is in the current state.
Type: String
Length Constraints: Maximum length of 512.
Pattern: .*
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 182).
ConcurrentModificationException
There is concurrent modification on a rule, target, archive, or replay.
HTTP Status Code: 400
API Version 2015-10-07132
Amazon EventBridge API ReferenceSee Also
InternalException
This exception occurs due to unexpected causes.
HTTP Status Code: 500InvalidEventPatternException
The event pattern is not valid.
HTTP Status Code: 400LimitExceededException
The request failed because it attempted to create resource beyond the allowed service quota.
HTTP Status Code: 400ResourceNotFoundException
An entity that you specified does not exist.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2015-10-07133
Amazon EventBridge API Reference
Data TypesThe Amazon EventBridge API contains several data types that various actions use. This section describeseach data type in detail.
NoteThe order of each element in a data type structure is not guaranteed. Applications should notassume a particular order.
The following data types are supported:
• Archive (p. 135)• AwsVpcConfiguration (p. 137)• BatchArrayProperties (p. 138)• BatchParameters (p. 139)• BatchRetryStrategy (p. 140)• Condition (p. 141)• DeadLetterConfig (p. 142)• EcsParameters (p. 143)• EventBus (p. 145)• EventSource (p. 146)• HttpParameters (p. 148)• InputTransformer (p. 149)• KinesisParameters (p. 151)• NetworkConfiguration (p. 152)• PartnerEventSource (p. 153)• PartnerEventSourceAccount (p. 154)• PutEventsRequestEntry (p. 155)• PutEventsResultEntry (p. 157)• PutPartnerEventsRequestEntry (p. 158)• PutPartnerEventsResultEntry (p. 160)• PutTargetsResultEntry (p. 161)• RedshiftDataParameters (p. 162)• RemoveTargetsResultEntry (p. 164)• Replay (p. 165)• ReplayDestination (p. 167)• RetryPolicy (p. 168)• Rule (p. 169)• RunCommandParameters (p. 171)• RunCommandTarget (p. 172)• SqsParameters (p. 173)• Tag (p. 174)• Target (p. 175)
API Version 2015-10-07134
Amazon EventBridge API ReferenceArchive
ArchiveAn Archive object that contains details about an archive.
ContentsArchiveName
The name of the archive.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 48.
Pattern: [\.\-_A-Za-z0-9]+
Required: NoCreationTime
The time stamp for the time that the archive was created.
Type: Timestamp
Required: NoEventCount
The number of events in the archive.
Type: Long
Required: NoEventSourceArn
The ARN of the event bus associated with the archive. Only events from this event bus are sent tothe archive.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Required: NoRetentionDays
The number of days to retain events in the archive before they are deleted.
Type: Integer
Valid Range: Minimum value of 0.
Required: NoSizeBytes
The size of the archive, in bytes.
Type: Long
Required: No
API Version 2015-10-07135
Amazon EventBridge API ReferenceSee Also
State
The current state of the archive.
Type: String
Valid Values: ENABLED | DISABLED | CREATING | UPDATING | CREATE_FAILED |UPDATE_FAILED
Required: NoStateReason
A description for the reason that the archive is in the current state.
Type: String
Length Constraints: Maximum length of 512.
Pattern: .*
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2015-10-07136
Amazon EventBridge API ReferenceAwsVpcConfiguration
AwsVpcConfigurationThis structure specifies the VPC subnets and security groups for the task, and whether a public IP addressis to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.
ContentsAssignPublicIp
Specifies whether the task's elastic network interface receives a public IP address. You can specifyENABLED only when LaunchType in EcsParameters is set to FARGATE.
Type: String
Valid Values: ENABLED | DISABLED
Required: NoSecurityGroups
Specifies the security groups associated with the task. These security groups must all be in the sameVPC. You can specify as many as five security groups. If you do not specify a security group, thedefault security group for the VPC is used.
Type: Array of strings
Required: NoSubnets
Specifies the subnets associated with the task. These subnets must all be in the same VPC. You canspecify as many as 16 subnets.
Type: Array of strings
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2015-10-07137
Amazon EventBridge API ReferenceBatchArrayProperties
BatchArrayPropertiesThe array properties for the submitted job, such as the size of the array. The array size can be between 2and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used onlyif the target is an AWS Batch job.
ContentsSize
The size of the array, if this is an array batch job. Valid values are integers between 2 and 10,000.
Type: Integer
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2015-10-07138
Amazon EventBridge API ReferenceBatchParameters
BatchParametersThe custom parameters to be used when the target is an AWS Batch job.
ContentsArrayProperties
The array properties for the submitted job, such as the size of the array. The array size can bebetween 2 and 10,000. If you specify array properties for a job, it becomes an array job. Thisparameter is used only if the target is an AWS Batch job.
Type: BatchArrayProperties (p. 138) object
Required: NoJobDefinition
The ARN or name of the job definition to use if the event target is an AWS Batch job. This jobdefinition must already exist.
Type: String
Required: YesJobName
The name to use for this execution of the job, if the target is an AWS Batch job.
Type: String
Required: YesRetryStrategy
The retry strategy to use for failed jobs, if the target is an AWS Batch job. The retry strategy is thenumber of times to retry the failed job execution. Valid values are 1–10. When you specify a retrystrategy here, it overrides the retry strategy defined in the job definition.
Type: BatchRetryStrategy (p. 140) object
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2015-10-07139
Amazon EventBridge API ReferenceBatchRetryStrategy
BatchRetryStrategyThe retry strategy to use for failed jobs, if the target is an AWS Batch job. If you specify a retry strategyhere, it overrides the retry strategy defined in the job definition.
ContentsAttempts
The number of times to attempt to retry, if the job fails. Valid values are 1–10.
Type: Integer
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2015-10-07140
Amazon EventBridge API ReferenceCondition
ConditionA JSON string which you can use to limit the event bus permissions you are granting to only accountsthat fulfill the condition. Currently, the only supported condition is membership in a certain AWSorganization. The string must contain Type, Key, and Value fields. The Value field specifies the ID ofthe AWS organization. Following is an example value for Condition:
'{"Type" : "StringEquals", "Key": "aws:PrincipalOrgID", "Value":"o-1234567890"}'
ContentsKey
Specifies the key for the condition. Currently the only supported key is aws:PrincipalOrgID.
Type: String
Required: YesType
Specifies the type of condition. Currently the only supported value is StringEquals.
Type: String
Required: YesValue
Specifies the value for the key. Currently, this must be the ID of the organization.
Type: String
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2015-10-07141
Amazon EventBridge API ReferenceDeadLetterConfig
DeadLetterConfigA DeadLetterConfig object that contains information about a dead-letter queue configuration.
ContentsArn
The ARN of the SQS queue specified as the target for the dead-letter queue.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2015-10-07142
Amazon EventBridge API ReferenceEcsParameters
EcsParametersThe custom parameters to be used when the target is an Amazon ECS task.
ContentsGroup
Specifies an ECS task group for the task. The maximum length is 255 characters.
Type: String
Required: NoLaunchType
Specifies the launch type on which your task is running. The launch type that you specify here mustmatch one of the launch type (compatibilities) of the target task. The FARGATE value is supportedonly in the Regions where AWS Fargate with Amazon ECS is supported. For more information, seeAWS Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.
Type: String
Valid Values: EC2 | FARGATE
Required: NoNetworkConfiguration
Use this structure if the ECS task uses the awsvpc network mode. This structure specifies the VPCsubnets and security groups associated with the task, and whether a public IP address is to be used.This structure is required if LaunchType is FARGATE because the awsvpc mode is required forFargate tasks.
If you specify NetworkConfiguration when the target ECS task does not use the awsvpc networkmode, the task fails.
Type: NetworkConfiguration (p. 152) object
Required: NoPlatformVersion
Specifies the platform version for the task. Specify only the numeric portion of the platform version,such as 1.1.0.
This structure is used only if LaunchType is FARGATE. For more information about valid platformversions, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
Type: String
Required: NoTaskCount
The number of tasks to create based on TaskDefinition. The default is 1.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
API Version 2015-10-07143
Amazon EventBridge API ReferenceSee Also
TaskDefinitionArn
The ARN of the task definition to use if the event target is an Amazon ECS task.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2015-10-07144
Amazon EventBridge API ReferenceEventBus
EventBusAn event bus receives events from a source and routes them to rules associated with that event bus.Your account's default event bus receives rules from AWS services. A custom event bus can receive rulesfrom AWS services as well as your custom applications and services. A partner event bus receives eventsfrom an event source created by an SaaS partner. These events come from the partners services orapplications.
ContentsArn
The ARN of the event bus.
Type: String
Required: NoName
The name of the event bus.
Type: String
Required: NoPolicy
The permissions policy of the event bus, describing which other AWS accounts can write events tothis event bus.
Type: String
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2015-10-07145
Amazon EventBridge API ReferenceEventSource
EventSourceA partner event source is created by an SaaS partner. If a customer creates a partner event bus thatmatches this event source, that AWS account can receive events from the partner's applications orservices.
ContentsArn
The ARN of the event source.
Type: String
Required: No
CreatedBy
The name of the partner that created the event source.
Type: String
Required: No
CreationTime
The date and time the event source was created.
Type: Timestamp
Required: No
ExpirationTime
The date and time that the event source will expire, if the AWS account doesn't create a matchingevent bus for it.
Type: Timestamp
Required: No
Name
The name of the event source.
Type: String
Required: No
State
The state of the event source. If it is ACTIVE, you have already created a matching event bus for thisevent source, and that event bus is active. If it is PENDING, either you haven't yet created a matchingevent bus, or that event bus is deactivated. If it is DELETED, you have created a matching event bus,but the event source has since been deleted.
Type: String
Valid Values: PENDING | ACTIVE | DELETED
Required: No
API Version 2015-10-07146
Amazon EventBridge API ReferenceSee Also
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2015-10-07147
Amazon EventBridge API ReferenceHttpParameters
HttpParametersThese are custom parameter to be used when the target is an API Gateway REST APIs.
ContentsHeaderParameters
The headers that need to be sent as part of request invoking the API Gateway REST API.
Type: String to string map
Key Length Constraints: Maximum length of 512.
Key Pattern: ^[!#$%&'*+-.^_`|~0-9a-zA-Z]+$
Value Length Constraints: Maximum length of 512.
Value Pattern: ^[ \t]*[\x20-\x7E]+([ \t]+[\x20-\x7E]+)*[ \t]*$
Required: NoPathParameterValues
The path parameter values to be used to populate API Gateway REST API path wildcards ("*").
Type: Array of strings
Pattern: ^(?!\s*$).+
Required: NoQueryStringParameters
The query string keys/values that need to be sent as part of request invoking the API Gateway RESTAPI.
Type: String to string map
Key Length Constraints: Maximum length of 512.
Key Pattern: [^\x00-\x1F\x7F]+
Value Length Constraints: Maximum length of 512.
Value Pattern: [^\x00-\x09\x0B\x0C\x0E-\x1F\x7F]+
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2015-10-07148
Amazon EventBridge API ReferenceInputTransformer
InputTransformerContains the parameters needed for you to provide custom input to a target based on one or morepieces of data extracted from the event.
ContentsInputPathsMap
Map of JSON paths to be extracted from the event. You can then insert these in the template inInputTemplate to produce the output you want to be sent to the target.
InputPathsMap is an array key-value pairs, where each value is a valid JSON path. You can have asmany as 10 key-value pairs. You must use JSON dot notation, not bracket notation.
The keys cannot start with "AWS."
Type: String to string map
Map Entries: Maximum number of 10 items.
Key Length Constraints: Minimum length of 1. Maximum length of 256.
Key Pattern: [A-Za-z0-9\_\-]+
Value Length Constraints: Maximum length of 256.
Required: NoInputTemplate
Input template where you specify placeholders that will be filled with the values of the keys fromInputPathsMap to customize the data sent to the target. Enclose each InputPathsMaps value inbrackets: <value> The InputTemplate must be valid JSON.
If InputTemplate is a JSON object (surrounded by curly braces), the following restrictions apply:• The placeholder cannot be used as an object key.• Object values cannot include quote marks.
The following example shows the syntax for using InputPathsMap and InputTemplate.
"InputTransformer":
{
"InputPathsMap": {"instance": "$.detail.instance","status":"$.detail.status"},
"InputTemplate": "<instance> is in state <status>"
}
To have the InputTemplate include quote marks within a JSON string, escape each quote markswith a slash, as in the following example:
"InputTransformer":
{
API Version 2015-10-07149
Amazon EventBridge API ReferenceSee Also
"InputPathsMap": {"instance": "$.detail.instance","status":"$.detail.status"},
"InputTemplate": "<instance> is in state \"<status>\""
}
Type: String
Length Constraints: Minimum length of 1. Maximum length of 8192.
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2015-10-07150
Amazon EventBridge API ReferenceKinesisParameters
KinesisParametersThis object enables you to specify a JSON path to extract from the event and use as the partition key forthe Amazon Kinesis data stream, so that you can control the shard to which the event goes. If you do notinclude this parameter, the default is to use the eventId as the partition key.
ContentsPartitionKeyPath
The JSON path to be extracted from the event and used as the partition key. For more information,see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide.
Type: String
Length Constraints: Maximum length of 256.
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2015-10-07151
Amazon EventBridge API ReferenceNetworkConfiguration
NetworkConfigurationThis structure specifies the network configuration for an ECS task.
ContentsawsvpcConfiguration
Use this structure to specify the VPC subnets and security groups for the task, and whether a publicIP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc networkmode.
Type: AwsVpcConfiguration (p. 137) object
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2015-10-07152
Amazon EventBridge API ReferencePartnerEventSource
PartnerEventSourceA partner event source is created by an SaaS partner. If a customer creates a partner event bus thatmatches this event source, that AWS account can receive events from the partner's applications orservices.
ContentsArn
The ARN of the partner event source.
Type: String
Required: NoName
The name of the partner event source.
Type: String
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2015-10-07153
Amazon EventBridge API ReferencePartnerEventSourceAccount
PartnerEventSourceAccountThe AWS account that a partner event source has been offered to.
ContentsAccount
The AWS account ID that the partner event source was offered to.
Type: String
Length Constraints: Fixed length of 12.
Pattern: \d{12}
Required: NoCreationTime
The date and time the event source was created.
Type: Timestamp
Required: NoExpirationTime
The date and time that the event source will expire, if the AWS account doesn't create a matchingevent bus for it.
Type: Timestamp
Required: NoState
The state of the event source. If it is ACTIVE, you have already created a matching event bus for thisevent source, and that event bus is active. If it is PENDING, either you haven't yet created a matchingevent bus, or that event bus is deactivated. If it is DELETED, you have created a matching event bus,but the event source has since been deleted.
Type: String
Valid Values: PENDING | ACTIVE | DELETED
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2015-10-07154
Amazon EventBridge API ReferencePutEventsRequestEntry
PutEventsRequestEntryRepresents an event to be submitted.
ContentsDetail
A valid JSON string. There is no other schema imposed. The JSON string may contain fields andnested subobjects.
Type: String
Required: NoDetailType
Free-form string used to decide what fields to expect in the event detail.
Type: String
Required: NoEventBusName
The name or ARN of the event bus to receive the event. Only the rules that are associated with thisevent bus are used to match the event. If you omit this, the default event bus is used.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: (arn:aws[\w-]*:events:[a-z]{2}-[a-z]+-[\w-]+:[0-9]{12}:event-bus\/)?[\.\-_A-Za-z0-9]+
Required: NoResources
AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Anynumber, including zero, may be present.
Type: Array of strings
Required: NoSource
The source of the event.
Type: String
Required: NoTime
The time stamp of the event, per RFC3339. If no time stamp is provided, the time stamp of thePutEvents (p. 85) call is used.
Type: Timestamp
Required: No
API Version 2015-10-07155
Amazon EventBridge API ReferenceSee Also
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2015-10-07156
Amazon EventBridge API ReferencePutEventsResultEntry
PutEventsResultEntryRepresents an event that failed to be submitted.
ContentsErrorCode
The error code that indicates why the event submission failed.
Type: String
Required: NoErrorMessage
The error message that explains why the event submission failed.
Type: String
Required: NoEventId
The ID of the event.
Type: String
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2015-10-07157
Amazon EventBridge API ReferencePutPartnerEventsRequestEntry
PutPartnerEventsRequestEntryThe details about an event generated by an SaaS partner.
ContentsDetail
A valid JSON string. There is no other schema imposed. The JSON string may contain fields andnested subobjects.
Type: String
Required: NoDetailType
A free-form string used to decide what fields to expect in the event detail.
Type: String
Required: NoResources
AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Anynumber, including zero, may be present.
Type: Array of strings
Required: NoSource
The event source that is generating the evntry.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: aws\.partner(/[\.\-_A-Za-z0-9]+){2,}
Required: NoTime
The date and time of the event.
Type: Timestamp
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2
API Version 2015-10-07158
Amazon EventBridge API ReferenceSee Also
• AWS SDK for Ruby V3
API Version 2015-10-07159
Amazon EventBridge API ReferencePutPartnerEventsResultEntry
PutPartnerEventsResultEntryRepresents an event that a partner tried to generate, but failed.
ContentsErrorCode
The error code that indicates why the event submission failed.
Type: String
Required: NoErrorMessage
The error message that explains why the event submission failed.
Type: String
Required: NoEventId
The ID of the event.
Type: String
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2015-10-07160
Amazon EventBridge API ReferencePutTargetsResultEntry
PutTargetsResultEntryRepresents a target that failed to be added to a rule.
ContentsErrorCode
The error code that indicates why the target addition failed. If the value isConcurrentModificationException, too many requests were made at the same time.
Type: String
Required: NoErrorMessage
The error message that explains why the target addition failed.
Type: String
Required: NoTargetId
The ID of the target.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [\.\-_A-Za-z0-9]+
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2015-10-07161
Amazon EventBridge API ReferenceRedshiftDataParameters
RedshiftDataParametersThese are custom parameters to be used when the target is a Redshift cluster to invoke the Redshift DataAPI ExecuteStatement based on EventBridge events.
ContentsDatabase
The name of the database. Required when authenticating using temporary credentials.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: ([a-zA-Z0-9]+)|(\$(\.[\w_-]+(\[(\d+|\*)\])*)*)
Required: YesDbUser
The database user name. Required when authenticating using temporary credentials.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ([a-zA-Z0-9]+)|(\$(\.[\w_-]+(\[(\d+|\*)\])*)*)
Required: NoSecretManagerArn
The name or ARN of the secret that enables access to the database. Required when authenticatingusing AWS Secrets Manager.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: (^arn:aws([a-z]|\-)*:secretsmanager:[a-z0-9-.]+:.*)|(\$(\.[\w_-]+(\[(\d+|\*)\])*)*)
Required: NoSql
The SQL statement text to run.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100000.
Required: YesStatementName
The name of the SQL statement. You can name the SQL statement when you create it to identify thequery.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 500.
API Version 2015-10-07162
Amazon EventBridge API ReferenceSee Also
Required: NoWithEvent
Indicates whether to send an event back to EventBridge after the SQL statement runs.
Type: Boolean
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2015-10-07163
Amazon EventBridge API ReferenceRemoveTargetsResultEntry
RemoveTargetsResultEntryRepresents a target that failed to be removed from a rule.
ContentsErrorCode
The error code that indicates why the target removal failed. If the value isConcurrentModificationException, too many requests were made at the same time.
Type: String
Required: NoErrorMessage
The error message that explains why the target removal failed.
Type: String
Required: NoTargetId
The ID of the target.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [\.\-_A-Za-z0-9]+
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2015-10-07164
Amazon EventBridge API ReferenceReplay
ReplayA Replay object that contains details about a replay.
ContentsEventEndTime
A time stamp for the time to start replaying events. Any event with a creation time prior to theEventEndTime specified is replayed.
Type: Timestamp
Required: NoEventLastReplayedTime
A time stamp for the time that the last event was replayed.
Type: Timestamp
Required: NoEventSourceArn
The ARN of the archive to replay event from.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Required: NoEventStartTime
A time stamp for the time to start replaying events. This is determined by the time in the event asdescribed in Time.
Type: Timestamp
Required: NoReplayEndTime
A time stamp for the time that the replay completed.
Type: Timestamp
Required: NoReplayName
The name of the replay.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [\.\-_A-Za-z0-9]+
Required: NoReplayStartTime
A time stamp for the time that the replay started.
API Version 2015-10-07165
Amazon EventBridge API ReferenceSee Also
Type: Timestamp
Required: NoState
The current state of the replay.
Type: String
Valid Values: STARTING | RUNNING | CANCELLING | COMPLETED | CANCELLED | FAILED
Required: NoStateReason
A description of why the replay is in the current state.
Type: String
Length Constraints: Maximum length of 512.
Pattern: .*
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2015-10-07166
Amazon EventBridge API ReferenceReplayDestination
ReplayDestinationA ReplayDestination object that contains details about a replay.
ContentsArn
The ARN of the event bus to replay event to. You can replay events only to the event bus specified tocreate the archive.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Required: YesFilterArns
A list of ARNs for rules to replay events to.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 1600.
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2015-10-07167
Amazon EventBridge API ReferenceRetryPolicy
RetryPolicyA RetryPolicy object that includes information about the retry policy settings.
ContentsMaximumEventAgeInSeconds
The maximum amount of time, in seconds, to continue to make retry attempts.
Type: Integer
Valid Range: Minimum value of 60. Maximum value of 86400.
Required: NoMaximumRetryAttempts
The maximum number of retry attempts to make before the request fails. Retry attemptscontinue until either the maximum number of attempts is made or until the duration of theMaximumEventAgeInSeconds is met.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 185.
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2015-10-07168
Amazon EventBridge API ReferenceRule
RuleContains information about a rule in Amazon EventBridge.
ContentsArn
The Amazon Resource Name (ARN) of the rule.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Required: NoDescription
The description of the rule.
Type: String
Length Constraints: Maximum length of 512.
Required: NoEventBusName
The name or ARN of the event bus associated with the rule. If you omit this, the default event bus isused.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [/\.\-_A-Za-z0-9]+
Required: NoEventPattern
The event pattern of the rule. For more information, see Events and Event Patterns in the AmazonEventBridge User Guide.
Type: String
Required: NoManagedBy
If the rule was created on behalf of your account by an AWS service, this field displays the principalname of the service that created the rule.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: NoName
The name of the rule.
API Version 2015-10-07169
Amazon EventBridge API ReferenceSee Also
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [\.\-_A-Za-z0-9]+
Required: NoRoleArn
The Amazon Resource Name (ARN) of the role that is used for target invocation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Required: NoScheduleExpression
The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
Type: String
Length Constraints: Maximum length of 256.
Required: NoState
The state of the rule.
Type: String
Valid Values: ENABLED | DISABLED
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2015-10-07170
Amazon EventBridge API ReferenceRunCommandParameters
RunCommandParametersThis parameter contains the criteria (either InstanceIds or a tag) used to specify which EC2 instances areto be sent the command.
ContentsRunCommandTargets
Currently, we support including only one RunCommandTarget block, which specifies either an arrayof InstanceIds or a tag.
Type: Array of RunCommandTarget (p. 172) objects
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2015-10-07171
Amazon EventBridge API ReferenceRunCommandTarget
RunCommandTargetInformation about the EC2 instances that are to be sent the command, specified as key-value pairs. EachRunCommandTarget block can include only one key, but this key may specify multiple values.
ContentsKey
Can be either tag: tag-key or InstanceIds.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ^[\p{L}\p{Z}\p{N}_.:/=+\-@]*$
Required: YesValues
If Key is tag: tag-key, Values is a list of tag values. If Key is InstanceIds, Values is a list ofAmazon EC2 instance IDs.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2015-10-07172
Amazon EventBridge API ReferenceSqsParameters
SqsParametersThis structure includes the custom parameter to be used when the target is an SQS FIFO queue.
ContentsMessageGroupId
The FIFO message group ID to use as the target.
Type: String
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2015-10-07173
Amazon EventBridge API ReferenceTag
TagA key-value pair associated with an AWS resource. In EventBridge, rules and event buses support tagging.
ContentsKey
A string you can use to assign a value. The combination of tag keys and values can help you organizeand categorize your resources.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: YesValue
The value for the specified tag key.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2015-10-07174
Amazon EventBridge API ReferenceTarget
TargetTargets are the resources to be invoked when a rule is triggered. For a complete list of services andresources that can be set as a target, see PutTargets (p. 99).
If you are setting the event bus of another account as the target, and that account granted permissionto your account through an organization instead of directly by the account ID, then you must specifya RoleArn with proper permissions in the Target structure. For more information, see Sending andReceiving Events Between AWS Accounts in the Amazon EventBridge User Guide.
ContentsArn
The Amazon Resource Name (ARN) of the target.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Required: YesBatchParameters
If the event target is an AWS Batch job, this contains the job definition, job name, and otherparameters. For more information, see Jobs in the AWS Batch User Guide.
Type: BatchParameters (p. 139) object
Required: NoDeadLetterConfig
The DeadLetterConfig that defines the target queue to send dead-letter queue events to.
Type: DeadLetterConfig (p. 142) object
Required: NoEcsParameters
Contains the Amazon ECS task definition and task count to be used, if the event target is an AmazonECS task. For more information about Amazon ECS tasks, see Task Definitions in the Amazon EC2Container Service Developer Guide.
Type: EcsParameters (p. 143) object
Required: NoHttpParameters
Contains the HTTP parameters to use when the target is a API Gateway REST endpoint.
If you specify an API Gateway REST API as a target, you can use this parameter to specify headers,path parameter, query string keys/values as part of your target invoking request.
Type: HttpParameters (p. 148) object
Required: NoId
The ID of the target.
API Version 2015-10-07175
Amazon EventBridge API ReferenceContents
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [\.\-_A-Za-z0-9]+
Required: YesInput
Valid JSON text passed to the target. In this case, nothing from the event itself is passed to thetarget. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format.
Type: String
Length Constraints: Maximum length of 8192.
Required: NoInputPath
The value of the JSONPath that is used for extracting part of the matched event when passing it tothe target. You must use JSON dot notation, not bracket notation. For more information about JSONpaths, see JSONPath.
Type: String
Length Constraints: Maximum length of 256.
Required: NoInputTransformer
Settings to enable you to provide custom input to a target based on certain event data. You canextract one or more key-value pairs from the event and then use that data to send customized inputto the target.
Type: InputTransformer (p. 149) object
Required: NoKinesisParameters
The custom parameter you can use to control the shard assignment, when the target is a Kinesisdata stream. If you do not include this parameter, the default is to use the eventId as the partitionkey.
Type: KinesisParameters (p. 151) object
Required: NoRedshiftDataParameters
Contains the Redshift Data API parameters to use when the target is a Redshift cluster.
If you specify a Redshift Cluster as a Target, you can use this to specify parameters to invoke theRedshift Data API ExecuteStatement based on EventBridge events.
Type: RedshiftDataParameters (p. 162) object
Required: NoRetryPolicy
The RetryPolicy object that contains the retry policy configuration to use for the dead-letterqueue.
API Version 2015-10-07176
Amazon EventBridge API ReferenceSee Also
Type: RetryPolicy (p. 168) object
Required: NoRoleArn
The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule istriggered. If one rule triggers multiple targets, you can use a different IAM role for each target.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Required: NoRunCommandParameters
Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
Type: RunCommandParameters (p. 171) object
Required: NoSqsParameters
Contains the message group ID to use when the target is a FIFO queue.
If you specify an SQS FIFO queue as a target, the queue must have content-based deduplicationenabled.
Type: SqsParameters (p. 173) object
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3
API Version 2015-10-07177
Amazon EventBridge API ReferenceCloudWatch Events Endpoints
Making API RequestsQuery requests used with CloudWatch Events are HTTP or HTTPS requests that use the HTTP verb GETor POST and a Query parameter named Action or Operation. This documentation uses Action,although Operation is supported for backward compatibility.
CloudWatch Events EndpointsAn endpoint is a URL that serves as an entry point for a web service. You can select a regional endpointwhen you make your requests to reduce latency. For information about the endpoints used withCloudWatch Events, see Regions and Endpoints in the Amazon Web Services General Reference.
Query ParametersEach query request must include some common parameters to handle authentication and selection of anaction. For more information, see Common Parameters (p. 180).
Some API operations take lists of parameters. These lists are specified using the following notation:param.member.n. Values of n are integers starting from 1. All lists of parameters must follow thisnotation, including lists that contain only one parameter. For example, a Query parameter list looks likethis:
&attribute.member.1=this&attribute.member.2=that
Request IdentifiersIn every response from an AWS Query API, there is a ResponseMetadata element, which contains aRequestId element. This string is a unique identifier that AWS assigns to provide tracking information.Although RequestId is included as part of every response, it is not listed on the individual APIdocumentation pages to improve readability and to reduce redundancy.
Query API AuthenticationYou can send query requests over either HTTP or HTTPS. Regardless of which protocol you use, youmust include a signature in every query request. For more information about creating and including asignature, see Signing AWS API Requests in the Amazon Web Services General Reference.
Available LibrariesAWS provides libraries, sample code, tutorials, and other resources for software developers who preferto build applications using language-specific APIs instead of the command-line tools and Query API.These libraries provide basic functions (not included in the APIs), such as request authentication, request
API Version 2015-10-07178
Amazon EventBridge API ReferenceAvailable Libraries
retries, and error handling so that it is easier to get started. Libraries and resources are available for thefollowing languages and platforms:
• AWS Mobile SDK for Android• AWS SDK for Go• AWS Mobile SDK for iOS• AWS SDK for Java 2.x• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for JavaScript in Node.js• AWS SDK for .NET• AWS SDK for PHP• AWS SDK for Python (Boto)• AWS SDK for Ruby
For libraries and sample code in all languages, see Sample Code & Libraries.
API Version 2015-10-07179
Amazon EventBridge API Reference
Common ParametersThe following list contains the parameters that all actions use for signing Signature Version 4 requestswith a query string. Any action-specific parameters are listed in the topic for that action. For moreinformation about Signature Version 4, see Signature Version 4 Signing Process in the Amazon WebServices General Reference.
Action
The action to be performed.
Type: string
Required: YesVersion
The API version that the request is written for, expressed in the format YYYY-MM-DD.
Type: string
Required: YesX-Amz-Algorithm
The hash algorithm that you used to create the request signature.
Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.
Type: string
Valid Values: AWS4-HMAC-SHA256
Required: ConditionalX-Amz-Credential
The credential scope value, which is a string that includes your access key, the date, the region youare targeting, the service you are requesting, and a termination string ("aws4_request"). The value isexpressed in the following format: access_key/YYYYMMDD/region/service/aws4_request.
For more information, see Task 2: Create a String to Sign for Signature Version 4 in the Amazon WebServices General Reference.
Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.
Type: string
Required: ConditionalX-Amz-Date
The date that is used to create the signature. The format must be ISO 8601 basic format(YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value:20120325T120000Z.
Condition: X-Amz-Date is optional for all requests; it can be used to override the date used forsigning requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is
API Version 2015-10-07180
Amazon EventBridge API Reference
not required. When X-Amz-Date is used, it always overrides the value of the Date header. Formore information, see Handling Dates in Signature Version 4 in the Amazon Web Services GeneralReference.
Type: string
Required: ConditionalX-Amz-Security-Token
The temporary security token that was obtained through a call to AWS Security Token Service (AWSSTS). For a list of services that support temporary security credentials from AWS Security TokenService, go to AWS Services That Work with IAM in the IAM User Guide.
Condition: If you're using temporary security credentials from the AWS Security Token Service, youmust include the security token.
Type: string
Required: ConditionalX-Amz-Signature
Specifies the hex-encoded signature that was calculated from the string to sign and the derivedsigning key.
Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.
Type: string
Required: ConditionalX-Amz-SignedHeaders
Specifies all the HTTP headers that were included as part of the canonical request. For moreinformation about specifying signed headers, see Task 1: Create a Canonical Request For SignatureVersion 4 in the Amazon Web Services General Reference.
Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.
Type: string
Required: Conditional
API Version 2015-10-07181
Amazon EventBridge API Reference
Common ErrorsThis section lists the errors common to the API actions of all AWS services. For errors specific to an APIaction for this service, see the topic for that API action.
AccessDeniedException
You do not have sufficient access to perform this action.
HTTP Status Code: 400IncompleteSignature
The request signature does not conform to AWS standards.
HTTP Status Code: 400InternalFailure
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500InvalidAction
The action or operation requested is invalid. Verify that the action is typed correctly.
HTTP Status Code: 400InvalidClientTokenId
The X.509 certificate or AWS access key ID provided does not exist in our records.
HTTP Status Code: 403InvalidParameterCombination
Parameters that must not be used together were used together.
HTTP Status Code: 400InvalidParameterValue
An invalid or out-of-range value was supplied for the input parameter.
HTTP Status Code: 400InvalidQueryParameter
The AWS query string is malformed or does not adhere to AWS standards.
HTTP Status Code: 400MalformedQueryString
The query string contains a syntax error.
HTTP Status Code: 404MissingAction
The request is missing an action or a required parameter.
HTTP Status Code: 400
API Version 2015-10-07182
Amazon EventBridge API Reference
MissingAuthenticationToken
The request must contain either a valid (registered) AWS access key ID or X.509 certificate.
HTTP Status Code: 403MissingParameter
A required parameter for the specified action is not supplied.
HTTP Status Code: 400NotAuthorized
You do not have permission to perform this action.
HTTP Status Code: 400OptInRequired
The AWS access key ID needs a subscription for the service.
HTTP Status Code: 403RequestExpired
The request reached the service more than 15 minutes after the date stamp on the request or morethan 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stampon the request is more than 15 minutes in the future.
HTTP Status Code: 400ServiceUnavailable
The request has failed due to a temporary failure of the server.
HTTP Status Code: 503ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 400ValidationError
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
API Version 2015-10-07183