API Reference

Amazon EventBridge

API Version 2015-10-07

Copyright © 2024 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.
Amazon EventBridge API Reference

Amazon EventBridge: API Reference

Copyright © 2024 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 not Amazon's, in any manner that is likely to cause confusion among customers, or in any
manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are
the property of their respective owners, who may or may not be affiliated with, connected to, or
sponsored by Amazon.
Amazon EventBridge API Reference

Table of Contents
Amazon EventBridge API Reference ............................................................................................... 1
Actions .............................................................................................................................................. 2
ActivateEventSource ..................................................................................................................................... 5
Request Syntax ........................................................................................................................................ 5
Request Parameters ................................................................................................................................ 5
Response Elements ................................................................................................................................. 5
Errors .......................................................................................................................................................... 5
See Also ..................................................................................................................................................... 6
CancelReplay .................................................................................................................................................. 7
Request Syntax ........................................................................................................................................ 7
Request Parameters ................................................................................................................................ 7
Response Syntax ...................................................................................................................................... 7
Response Elements ................................................................................................................................. 7
Errors .......................................................................................................................................................... 8
See Also ..................................................................................................................................................... 9
CreateApiDestination ................................................................................................................................. 10
Request Syntax ...................................................................................................................................... 10
Request Parameters .............................................................................................................................. 10
Response Syntax ................................................................................................................................... 12
Response Elements ............................................................................................................................... 12
Errors ....................................................................................................................................................... 13
See Also .................................................................................................................................................. 13
CreateArchive .............................................................................................................................................. 15
Request Syntax ...................................................................................................................................... 15
Request Parameters .............................................................................................................................. 15
Response Syntax ................................................................................................................................... 17
Response Elements ............................................................................................................................... 17
Errors ....................................................................................................................................................... 18
See Also .................................................................................................................................................. 19
CreateConnection ....................................................................................................................................... 20
Request Syntax ...................................................................................................................................... 20
Request Parameters .............................................................................................................................. 21
Response Syntax ................................................................................................................................... 23
Response Elements ............................................................................................................................... 23

API Version 2015-10-07 iii

Amazon EventBridge API Reference

Errors ....................................................................................................................................................... 24
See Also .................................................................................................................................................. 24
CreateEndpoint ........................................................................................................................................... 25
Request Syntax ...................................................................................................................................... 25
Request Parameters .............................................................................................................................. 25
Response Syntax ................................................................................................................................... 27
Response Elements ............................................................................................................................... 28
Errors ....................................................................................................................................................... 29
See Also .................................................................................................................................................. 30
CreateEventBus ........................................................................................................................................... 31
Request Syntax ...................................................................................................................................... 31
Request Parameters .............................................................................................................................. 31
Response Syntax ................................................................................................................................... 33
Response Elements ............................................................................................................................... 34
Errors ....................................................................................................................................................... 35
See Also .................................................................................................................................................. 36
CreatePartnerEventSource ........................................................................................................................ 37
Request Syntax ...................................................................................................................................... 37
Request Parameters .............................................................................................................................. 38
Response Syntax ................................................................................................................................... 38
Response Elements ............................................................................................................................... 39
Errors ....................................................................................................................................................... 39
See Also .................................................................................................................................................. 40
DeactivateEventSource .............................................................................................................................. 41
Request Syntax ...................................................................................................................................... 41
Request Parameters .............................................................................................................................. 41
Response Elements ............................................................................................................................... 41
Errors ....................................................................................................................................................... 41
See Also .................................................................................................................................................. 42
DeauthorizeConnection ............................................................................................................................. 44
Request Syntax ...................................................................................................................................... 44
Request Parameters .............................................................................................................................. 44
Response Syntax ................................................................................................................................... 44
Response Elements ............................................................................................................................... 45
Errors ....................................................................................................................................................... 46
See Also .................................................................................................................................................. 46

API Version 2015-10-07 iv

Amazon EventBridge API Reference

DeleteApiDestination ................................................................................................................................. 47
Request Syntax ...................................................................................................................................... 47
Request Parameters .............................................................................................................................. 47
Response Elements ............................................................................................................................... 47
Errors ....................................................................................................................................................... 47
See Also .................................................................................................................................................. 48
DeleteArchive .............................................................................................................................................. 49
Request Syntax ...................................................................................................................................... 49
Request Parameters .............................................................................................................................. 49
Response Elements ............................................................................................................................... 49
Errors ....................................................................................................................................................... 49
See Also .................................................................................................................................................. 50
DeleteConnection ....................................................................................................................................... 51
Request Syntax ...................................................................................................................................... 51
Request Parameters .............................................................................................................................. 51
Response Syntax ................................................................................................................................... 51
Response Elements ............................................................................................................................... 51
Errors ....................................................................................................................................................... 52
See Also .................................................................................................................................................. 53
DeleteEndpoint ........................................................................................................................................... 54
Request Syntax ...................................................................................................................................... 54
Request Parameters .............................................................................................................................. 54
Response Elements ............................................................................................................................... 54
Errors ....................................................................................................................................................... 54
See Also .................................................................................................................................................. 55
DeleteEventBus ........................................................................................................................................... 56
Request Syntax ...................................................................................................................................... 56
Request Parameters .............................................................................................................................. 56
Response Elements ............................................................................................................................... 56
Errors ....................................................................................................................................................... 56
See Also .................................................................................................................................................. 57
DeletePartnerEventSource ........................................................................................................................ 58
Request Syntax ...................................................................................................................................... 58
Request Parameters .............................................................................................................................. 58
Response Elements ............................................................................................................................... 59
Errors ....................................................................................................................................................... 59

API Version 2015-10-07 v

Amazon EventBridge API Reference

See Also .................................................................................................................................................. 59

DeleteRule .................................................................................................................................................... 61
Request Syntax ...................................................................................................................................... 61
Request Parameters .............................................................................................................................. 61
Response Elements ............................................................................................................................... 62
Errors ....................................................................................................................................................... 62
Examples ................................................................................................................................................. 63
See Also .................................................................................................................................................. 64
DescribeApiDestination ............................................................................................................................. 65
Request Syntax ...................................................................................................................................... 65
Request Parameters .............................................................................................................................. 65
Response Syntax ................................................................................................................................... 65
Response Elements ............................................................................................................................... 66
Errors ....................................................................................................................................................... 68
See Also .................................................................................................................................................. 68
DescribeArchive ........................................................................................................................................... 70
Request Syntax ...................................................................................................................................... 70
Request Parameters .............................................................................................................................. 70
Response Syntax ................................................................................................................................... 70
Response Elements ............................................................................................................................... 71
Errors ....................................................................................................................................................... 73
See Also .................................................................................................................................................. 73
DescribeConnection ................................................................................................................................... 75
Request Syntax ...................................................................................................................................... 75
Request Parameters .............................................................................................................................. 75
Response Syntax ................................................................................................................................... 75
Response Elements ............................................................................................................................... 77
Errors ....................................................................................................................................................... 79
See Also .................................................................................................................................................. 79
DescribeEndpoint ....................................................................................................................................... 81
Request Syntax ...................................................................................................................................... 81
Request Parameters .............................................................................................................................. 81
Response Syntax ................................................................................................................................... 82
Response Elements ............................................................................................................................... 82
Errors ....................................................................................................................................................... 85
See Also .................................................................................................................................................. 85

API Version 2015-10-07 vi

Amazon EventBridge API Reference

DescribeEventBus ....................................................................................................................................... 87
Request Syntax ...................................................................................................................................... 87
Request Parameters .............................................................................................................................. 87
Response Syntax ................................................................................................................................... 87
Response Elements ............................................................................................................................... 88
Errors ....................................................................................................................................................... 89
Examples ................................................................................................................................................. 90
See Also .................................................................................................................................................. 91
DescribeEventSource .................................................................................................................................. 92
Request Syntax ...................................................................................................................................... 92
Request Parameters .............................................................................................................................. 92
Response Syntax ................................................................................................................................... 92
Response Elements ............................................................................................................................... 93
Errors ....................................................................................................................................................... 94
See Also .................................................................................................................................................. 94
DescribePartnerEventSource .................................................................................................................... 95
Request Syntax ...................................................................................................................................... 95
Request Parameters .............................................................................................................................. 95
Response Syntax ................................................................................................................................... 95
Response Elements ............................................................................................................................... 95
Errors ....................................................................................................................................................... 96
See Also .................................................................................................................................................. 96
DescribeReplay ............................................................................................................................................ 98
Request Syntax ...................................................................................................................................... 98
Request Parameters .............................................................................................................................. 98
Response Syntax ................................................................................................................................... 98
Response Elements ............................................................................................................................... 99
Errors ..................................................................................................................................................... 101
See Also ................................................................................................................................................ 101
DescribeRule .............................................................................................................................................. 103
Request Syntax .................................................................................................................................... 103
Request Parameters ........................................................................................................................... 103
Response Syntax ................................................................................................................................. 104
Response Elements ............................................................................................................................ 104
Errors ..................................................................................................................................................... 106
Examples ............................................................................................................................................... 106

API Version 2015-10-07 vii

Amazon EventBridge API Reference

See Also ................................................................................................................................................ 107

DisableRule ................................................................................................................................................ 109
Request Syntax .................................................................................................................................... 109
Request Parameters ........................................................................................................................... 109
Response Elements ............................................................................................................................ 110
Errors ..................................................................................................................................................... 110
Examples ............................................................................................................................................... 110
See Also ................................................................................................................................................ 111
EnableRule ................................................................................................................................................. 113
Request Syntax .................................................................................................................................... 113
Request Parameters ........................................................................................................................... 113
Response Elements ............................................................................................................................ 114
Errors ..................................................................................................................................................... 114
Examples ............................................................................................................................................... 114
See Also ................................................................................................................................................ 115
ListApiDestinations .................................................................................................................................. 117
Request Syntax .................................................................................................................................... 117
Request Parameters ........................................................................................................................... 117
Response Syntax ................................................................................................................................. 118
Response Elements ............................................................................................................................ 119
Errors ..................................................................................................................................................... 119
See Also ................................................................................................................................................ 120
ListArchives ................................................................................................................................................ 121
Request Syntax .................................................................................................................................... 121
Request Parameters ........................................................................................................................... 121
Response Syntax ................................................................................................................................. 122
Response Elements ............................................................................................................................ 123
Errors ..................................................................................................................................................... 123
See Also ................................................................................................................................................ 124
ListConnections ........................................................................................................................................ 125
Request Syntax .................................................................................................................................... 125
Request Parameters ........................................................................................................................... 125
Response Syntax ................................................................................................................................. 126
Response Elements ............................................................................................................................ 126
Errors ..................................................................................................................................................... 127
See Also ................................................................................................................................................ 127

API Version 2015-10-07 viii

Amazon EventBridge API Reference

ListEndpoints ............................................................................................................................................ 129

Request Syntax .................................................................................................................................... 129
Request Parameters ........................................................................................................................... 129
Response Syntax ................................................................................................................................. 130
Response Elements ............................................................................................................................ 131
Errors ..................................................................................................................................................... 132
See Also ................................................................................................................................................ 132
ListEventBuses .......................................................................................................................................... 133
Request Syntax .................................................................................................................................... 133
Request Parameters ........................................................................................................................... 133
Response Syntax ................................................................................................................................. 134
Response Elements ............................................................................................................................ 134
Errors ..................................................................................................................................................... 135
See Also ................................................................................................................................................ 135
ListEventSources ....................................................................................................................................... 137
Request Syntax .................................................................................................................................... 137
Request Parameters ........................................................................................................................... 137
Response Syntax ................................................................................................................................. 138
Response Elements ............................................................................................................................ 138
Errors ..................................................................................................................................................... 139
See Also ................................................................................................................................................ 139
ListPartnerEventSourceAccounts .......................................................................................................... 141
Request Syntax .................................................................................................................................... 141
Request Parameters ........................................................................................................................... 141
Response Syntax ................................................................................................................................. 142
Response Elements ............................................................................................................................ 142
Errors ..................................................................................................................................................... 143
See Also ................................................................................................................................................ 143
ListPartnerEventSources ......................................................................................................................... 145
Request Syntax .................................................................................................................................... 145
Request Parameters ........................................................................................................................... 145
Response Syntax ................................................................................................................................. 146
Response Elements ............................................................................................................................ 146
Errors ..................................................................................................................................................... 147
See Also ................................................................................................................................................ 147
ListReplays ................................................................................................................................................. 149

API Version 2015-10-07 ix

Amazon EventBridge API Reference

Request Syntax .................................................................................................................................... 149

Request Parameters ........................................................................................................................... 149
Response Syntax ................................................................................................................................. 150
Response Elements ............................................................................................................................ 151
Errors ..................................................................................................................................................... 151
See Also ................................................................................................................................................ 152
ListRuleNamesByTarget .......................................................................................................................... 153
Request Syntax .................................................................................................................................... 153
Request Parameters ........................................................................................................................... 153
Response Syntax ................................................................................................................................. 154
Response Elements ............................................................................................................................ 154
Errors ..................................................................................................................................................... 155
Examples ............................................................................................................................................... 155
See Also ................................................................................................................................................ 156
ListRules ..................................................................................................................................................... 158
Request Syntax .................................................................................................................................... 158
Request Parameters ........................................................................................................................... 158
Response Syntax ................................................................................................................................. 159
Response Elements ............................................................................................................................ 160
Errors ..................................................................................................................................................... 160
Examples ............................................................................................................................................... 161
See Also ................................................................................................................................................ 162
ListTagsForResource ................................................................................................................................ 163
Request Syntax .................................................................................................................................... 163
Request Parameters ........................................................................................................................... 163
Response Syntax ................................................................................................................................. 163
Response Elements ............................................................................................................................ 163
Errors ..................................................................................................................................................... 164
Examples ............................................................................................................................................... 164
See Also ................................................................................................................................................ 165
ListTargetsByRule ..................................................................................................................................... 167
Request Syntax .................................................................................................................................... 167
Request Parameters ........................................................................................................................... 167
Response Syntax ................................................................................................................................. 168
Response Elements ............................................................................................................................ 171
Errors ..................................................................................................................................................... 172

API Version 2015-10-07 x

Amazon EventBridge API Reference

Examples ............................................................................................................................................... 172

See Also ................................................................................................................................................ 173
PutEvents ................................................................................................................................................... 174
Request Syntax .................................................................................................................................... 174
Request Parameters ........................................................................................................................... 174
Response Syntax ................................................................................................................................. 175
Response Elements ............................................................................................................................ 176
Errors ..................................................................................................................................................... 176
Examples ............................................................................................................................................... 176
See Also ................................................................................................................................................ 178
PutPartnerEvents ..................................................................................................................................... 179
Request Syntax .................................................................................................................................... 179
Request Parameters ........................................................................................................................... 179
Response Syntax ................................................................................................................................. 179
Response Elements ............................................................................................................................ 180
Errors ..................................................................................................................................................... 180
See Also ................................................................................................................................................ 181
PutPermission ........................................................................................................................................... 182
Request Syntax .................................................................................................................................... 182
Request Parameters ........................................................................................................................... 182
Response Elements ............................................................................................................................ 184
Errors ..................................................................................................................................................... 185
Examples ............................................................................................................................................... 185
See Also ................................................................................................................................................ 187
PutRule ....................................................................................................................................................... 188
Request Syntax .................................................................................................................................... 189
Request Parameters ........................................................................................................................... 189
Response Syntax ................................................................................................................................. 192
Response Elements ............................................................................................................................ 192
Errors ..................................................................................................................................................... 192
Examples ............................................................................................................................................... 193
See Also ................................................................................................................................................ 194
PutTargets .................................................................................................................................................. 196
Request Syntax .................................................................................................................................... 198
Request Parameters ........................................................................................................................... 201
Response Syntax ................................................................................................................................. 202

API Version 2015-10-07 xi

Amazon EventBridge API Reference

Response Elements ............................................................................................................................ 202

Errors ..................................................................................................................................................... 203
Examples ............................................................................................................................................... 203
See Also ................................................................................................................................................ 214
RemovePermission ................................................................................................................................... 216
Request Syntax .................................................................................................................................... 216
Request Parameters ........................................................................................................................... 216
Response Elements ............................................................................................................................ 217
Errors ..................................................................................................................................................... 217
See Also ................................................................................................................................................ 218
RemoveTargets ......................................................................................................................................... 219
Request Syntax .................................................................................................................................... 219
Request Parameters ........................................................................................................................... 219
Response Syntax ................................................................................................................................. 221
Response Elements ............................................................................................................................ 221
Errors ..................................................................................................................................................... 221
Examples ............................................................................................................................................... 222
See Also ................................................................................................................................................ 223
StartReplay ................................................................................................................................................ 224
Request Syntax .................................................................................................................................... 224
Request Parameters ........................................................................................................................... 224
Response Syntax ................................................................................................................................. 226
Response Elements ............................................................................................................................ 226
Errors ..................................................................................................................................................... 227
See Also ................................................................................................................................................ 228
TagResource .............................................................................................................................................. 229
Request Syntax .................................................................................................................................... 229
Request Parameters ........................................................................................................................... 229
Response Elements ............................................................................................................................ 230
Errors ..................................................................................................................................................... 230
Examples ............................................................................................................................................... 231
See Also ................................................................................................................................................ 231
TestEventPattern ...................................................................................................................................... 233
Request Syntax .................................................................................................................................... 233
Request Parameters ........................................................................................................................... 233
Response Syntax ................................................................................................................................. 234

API Version 2015-10-07 xii

Amazon EventBridge API Reference

Response Elements ............................................................................................................................ 234

Errors ..................................................................................................................................................... 234
Examples ............................................................................................................................................... 235
See Also ................................................................................................................................................ 236
UntagResource .......................................................................................................................................... 237
Request Syntax .................................................................................................................................... 237
Request Parameters ........................................................................................................................... 237
Response Elements ............................................................................................................................ 237
Errors ..................................................................................................................................................... 238
Examples ............................................................................................................................................... 238
See Also ................................................................................................................................................ 239
UpdateApiDestination ............................................................................................................................. 240
Request Syntax .................................................................................................................................... 240
Request Parameters ........................................................................................................................... 240
Response Syntax ................................................................................................................................. 242
Response Elements ............................................................................................................................ 242
Errors ..................................................................................................................................................... 243
See Also ................................................................................................................................................ 243
UpdateArchive .......................................................................................................................................... 245
Request Syntax .................................................................................................................................... 245
Request Parameters ........................................................................................................................... 245
Response Syntax ................................................................................................................................. 246
Response Elements ............................................................................................................................ 246
Errors ..................................................................................................................................................... 247
See Also ................................................................................................................................................ 248
UpdateConnection ................................................................................................................................... 249
Request Syntax .................................................................................................................................... 249
Request Parameters ........................................................................................................................... 250
Response Syntax ................................................................................................................................. 251
Response Elements ............................................................................................................................ 252
Errors ..................................................................................................................................................... 253
See Also ................................................................................................................................................ 253
UpdateEndpoint ....................................................................................................................................... 255
Request Syntax .................................................................................................................................... 255
Request Parameters ........................................................................................................................... 255
Response Syntax ................................................................................................................................. 257

API Version 2015-10-07 xiii

Amazon EventBridge API Reference

Response Elements ............................................................................................................................ 257

Errors ..................................................................................................................................................... 259
See Also ................................................................................................................................................ 260
UpdateEventBus ....................................................................................................................................... 261
Request Syntax .................................................................................................................................... 261
Request Parameters ........................................................................................................................... 261
Response Syntax ................................................................................................................................. 263
Response Elements ............................................................................................................................ 263
Errors ..................................................................................................................................................... 264
See Also ................................................................................................................................................ 265
Data Types ................................................................................................................................... 266
ApiDestination .......................................................................................................................................... 269
Contents ............................................................................................................................................... 269
See Also ................................................................................................................................................ 271
AppSyncParameters ................................................................................................................................. 272
Contents ............................................................................................................................................... 272
See Also ................................................................................................................................................ 272
Archive ........................................................................................................................................................ 273
Contents ............................................................................................................................................... 273
See Also ................................................................................................................................................ 274
AwsVpcConfiguration .............................................................................................................................. 276
Contents ............................................................................................................................................... 276
See Also ................................................................................................................................................ 276
BatchArrayProperties ............................................................................................................................... 278
Contents ............................................................................................................................................... 278
See Also ................................................................................................................................................ 278
BatchParameters ...................................................................................................................................... 279
Contents ............................................................................................................................................... 279
See Also ................................................................................................................................................ 280
BatchRetryStrategy .................................................................................................................................. 281
Contents ............................................................................................................................................... 281
See Also ................................................................................................................................................ 281
CapacityProviderStrategyItem ............................................................................................................... 282
Contents ............................................................................................................................................... 282
See Also ................................................................................................................................................ 283
Condition ................................................................................................................................................... 284

API Version 2015-10-07 xiv

Amazon EventBridge API Reference

Contents ............................................................................................................................................... 284

See Also ................................................................................................................................................ 284
Connection ................................................................................................................................................ 286
Contents ............................................................................................................................................... 286
See Also ................................................................................................................................................ 288
ConnectionApiKeyAuthResponseParameters ..................................................................................... 289
Contents ............................................................................................................................................... 289
See Also ................................................................................................................................................ 289
ConnectionAuthResponseParameters .................................................................................................. 290
Contents ............................................................................................................................................... 290
See Also ................................................................................................................................................ 290
ConnectionBasicAuthResponseParameters ......................................................................................... 292
Contents ............................................................................................................................................... 292
See Also ................................................................................................................................................ 292
ConnectionBodyParameter .................................................................................................................... 293
Contents ............................................................................................................................................... 293
See Also ................................................................................................................................................ 293
ConnectionHeaderParameter ................................................................................................................ 294
Contents ............................................................................................................................................... 294
See Also ................................................................................................................................................ 294
ConnectionHttpParameters ................................................................................................................... 296
Contents ............................................................................................................................................... 296
See Also ................................................................................................................................................ 296
ConnectionOAuthClientResponseParameters .................................................................................... 298
Contents ............................................................................................................................................... 298
See Also ................................................................................................................................................ 298
ConnectionOAuthResponseParameters ............................................................................................... 299
Contents ............................................................................................................................................... 299
See Also ................................................................................................................................................ 300
ConnectionQueryStringParameter ....................................................................................................... 301
Contents ............................................................................................................................................... 301
See Also ................................................................................................................................................ 301
CreateConnectionApiKeyAuthRequestParameters ............................................................................ 303
Contents ............................................................................................................................................... 303
See Also ................................................................................................................................................ 303
CreateConnectionAuthRequestParameters ......................................................................................... 304

API Version 2015-10-07 xv

Amazon EventBridge API Reference

Contents ............................................................................................................................................... 304

See Also ................................................................................................................................................ 305
CreateConnectionBasicAuthRequestParameters ................................................................................ 306
Contents ............................................................................................................................................... 306
See Also ................................................................................................................................................ 306
CreateConnectionOAuthClientRequestParameters ........................................................................... 307
Contents ............................................................................................................................................... 307
See Also ................................................................................................................................................ 307
CreateConnectionOAuthRequestParameters ...................................................................................... 308
Contents ............................................................................................................................................... 308
See Also ................................................................................................................................................ 309
DeadLetterConfig ..................................................................................................................................... 310
Contents ............................................................................................................................................... 310
See Also ................................................................................................................................................ 310
EcsParameters ........................................................................................................................................... 311
Contents ............................................................................................................................................... 311
See Also ................................................................................................................................................ 314
Endpoint ..................................................................................................................................................... 315
Contents ............................................................................................................................................... 315
See Also ................................................................................................................................................ 318
EndpointEventBus .................................................................................................................................... 319
Contents ............................................................................................................................................... 319
See Also ................................................................................................................................................ 319
EventBus .................................................................................................................................................... 320
Contents ............................................................................................................................................... 320
See Also ................................................................................................................................................ 321
EventSource ............................................................................................................................................... 322
Contents ............................................................................................................................................... 322
See Also ................................................................................................................................................ 323
FailoverConfig ........................................................................................................................................... 324
Contents ............................................................................................................................................... 324
See Also ................................................................................................................................................ 324
HttpParameters ........................................................................................................................................ 325
Contents ............................................................................................................................................... 325
See Also ................................................................................................................................................ 326
InputTransformer ..................................................................................................................................... 327

API Version 2015-10-07 xvi

Amazon EventBridge API Reference

Contents ............................................................................................................................................... 327

See Also ................................................................................................................................................ 329
KinesisParameters .................................................................................................................................... 330
Contents ............................................................................................................................................... 330
See Also ................................................................................................................................................ 330
NetworkConfiguration ............................................................................................................................. 331
Contents ............................................................................................................................................... 331
See Also ................................................................................................................................................ 331
PartnerEventSource ................................................................................................................................. 332
Contents ............................................................................................................................................... 332
See Also ................................................................................................................................................ 332
PartnerEventSourceAccount .................................................................................................................. 333
Contents ............................................................................................................................................... 333
See Also ................................................................................................................................................ 334
PlacementConstraint ............................................................................................................................... 335
Contents ............................................................................................................................................... 335
See Also ................................................................................................................................................ 335
PlacementStrategy ................................................................................................................................... 336
Contents ............................................................................................................................................... 336
See Also ................................................................................................................................................ 336
Primary ....................................................................................................................................................... 338
Contents ............................................................................................................................................... 338
See Also ................................................................................................................................................ 338
PutEventsRequestEntry ........................................................................................................................... 339
Contents ............................................................................................................................................... 339
See Also ................................................................................................................................................ 341
PutEventsResultEntry .............................................................................................................................. 342
Contents ............................................................................................................................................... 342
See Also ................................................................................................................................................ 343
PutPartnerEventsRequestEntry ............................................................................................................. 344
Contents ............................................................................................................................................... 344
See Also ................................................................................................................................................ 345
PutPartnerEventsResultEntry ................................................................................................................ 347
Contents ............................................................................................................................................... 347
See Also ................................................................................................................................................ 347
PutTargetsResultEntry ............................................................................................................................. 349

API Version 2015-10-07 xvii

Amazon EventBridge API Reference

Contents ............................................................................................................................................... 349

See Also ................................................................................................................................................ 349
RedshiftDataParameters ......................................................................................................................... 351
Contents ............................................................................................................................................... 351
See Also ................................................................................................................................................ 352
RemoveTargetsResultEntry .................................................................................................................... 354
Contents ............................................................................................................................................... 354
See Also ................................................................................................................................................ 354
Replay ......................................................................................................................................................... 356
Contents ............................................................................................................................................... 356
See Also ................................................................................................................................................ 358
ReplayDestination .................................................................................................................................... 359
Contents ............................................................................................................................................... 359
See Also ................................................................................................................................................ 359
ReplicationConfig ..................................................................................................................................... 360
Contents ............................................................................................................................................... 360
See Also ................................................................................................................................................ 360
RetryPolicy ................................................................................................................................................. 361
Contents ............................................................................................................................................... 361
See Also ................................................................................................................................................ 361
RoutingConfig ........................................................................................................................................... 362
Contents ............................................................................................................................................... 362
See Also ................................................................................................................................................ 362
Rule ............................................................................................................................................................. 363
Contents ............................................................................................................................................... 363
See Also ................................................................................................................................................ 365
RunCommandParameters ....................................................................................................................... 367
Contents ............................................................................................................................................... 367
See Also ................................................................................................................................................ 367
RunCommandTarget ................................................................................................................................ 368
Contents ............................................................................................................................................... 368
See Also ................................................................................................................................................ 368
SageMakerPipelineParameter ................................................................................................................ 369
Contents ............................................................................................................................................... 369
See Also ................................................................................................................................................ 369
SageMakerPipelineParameters .............................................................................................................. 370

API Version 2015-10-07 xviii

Amazon EventBridge API Reference

Contents ............................................................................................................................................... 370

See Also ................................................................................................................................................ 370
Secondary .................................................................................................................................................. 371
Contents ............................................................................................................................................... 371
See Also ................................................................................................................................................ 371
SqsParameters .......................................................................................................................................... 372
Contents ............................................................................................................................................... 372
See Also ................................................................................................................................................ 372
Tag ............................................................................................................................................................... 373
Contents ............................................................................................................................................... 373
See Also ................................................................................................................................................ 373
Target .......................................................................................................................................................... 374
Contents ............................................................................................................................................... 374
See Also ................................................................................................................................................ 378
UpdateConnectionApiKeyAuthRequestParameters ........................................................................... 379
Contents ............................................................................................................................................... 379
See Also ................................................................................................................................................ 379
UpdateConnectionAuthRequestParameters ....................................................................................... 380
Contents ............................................................................................................................................... 380
See Also ................................................................................................................................................ 381
UpdateConnectionBasicAuthRequestParameters .............................................................................. 382
Contents ............................................................................................................................................... 382
See Also ................................................................................................................................................ 382
UpdateConnectionOAuthClientRequestParameters .......................................................................... 383
Contents ............................................................................................................................................... 383
See Also ................................................................................................................................................ 383
UpdateConnectionOAuthRequestParameters .................................................................................... 384
Contents ............................................................................................................................................... 384
See Also ................................................................................................................................................ 385
Making API Requests ................................................................................................................... 386
EventBridge Endpoints ........................................................................................................................... 386
Query Parameters .................................................................................................................................... 386
Request Identifiers ................................................................................................................................... 386
Query API Authentication ...................................................................................................................... 386
Available Libraries .................................................................................................................................... 387
Common Parameters ................................................................................................................... 388

API Version 2015-10-07 xix

Amazon EventBridge API Reference

Common Errors ............................................................................................................................ 391

API Version 2015-10-07 xx

Amazon EventBridge API Reference

Amazon EventBridge API Reference

Amazon EventBridge is a serverless event bus service that makes it easy to connect your
applications with data from a variety of sources.

EventBridge was formerly known as Amazon CloudWatch Events. EventBridge expands on the
capabilities 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 also offers more functionality both in the API and on the console.

Use the following links to get started using the EventBridge API:

• Actions: An alphabetical list of all EventBridge actions

• Data Types: An alphabetical list of all EventBridge data types
• Common Parameters: Parameters that all Query actions can use
• Common Errors: 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
to your programming language or platform.

Developers in the AWS developer community also provide their own libraries, which you can find at
the following 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-07 1

Amazon EventBridge API Reference

Actions
The following actions are supported:

• ActivateEventSource
• CancelReplay
• CreateApiDestination
• CreateArchive
• CreateConnection
• CreateEndpoint
• CreateEventBus
• CreatePartnerEventSource
• DeactivateEventSource
• DeauthorizeConnection
• DeleteApiDestination
• DeleteArchive
• DeleteConnection
• DeleteEndpoint
• DeleteEventBus
• DeletePartnerEventSource
• DeleteRule
• DescribeApiDestination
• DescribeArchive
• DescribeConnection
• DescribeEndpoint
• DescribeEventBus
• DescribeEventSource
• DescribePartnerEventSource
• DescribeReplay
• DescribeRule
• DisableRule

API Version 2015-10-07 2

Amazon EventBridge API Reference

• EnableRule
• ListApiDestinations
• ListArchives
• ListConnections
• ListEndpoints
• ListEventBuses
• ListEventSources
• ListPartnerEventSourceAccounts
• ListPartnerEventSources
• ListReplays
• ListRuleNamesByTarget
• ListRules
• ListTagsForResource
• ListTargetsByRule
• PutEvents
• PutPartnerEvents
• PutPermission
• PutRule
• PutTargets
• RemovePermission
• RemoveTargets
• StartReplay
• TagResource
• TestEventPattern
• UntagResource
• UpdateApiDestination
• UpdateArchive
• UpdateConnection
• UpdateEndpoint
• UpdateEventBus

API Version 2015-10-07 3

Amazon EventBridge API Reference

API Version 2015-10-07 4

Amazon EventBridge API Reference

ActivateEventSource
Activates a partner event source that has been deactivated. Once activated, your matching event
bus will start receiving events from the event source.

Request Syntax

{
"Name": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Name

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 Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

ConcurrentModificationException

There is concurrent modification on a rule, target, archive, or replay.

ActivateEventSource API Version 2015-10-07 5

Amazon EventBridge API Reference

HTTP Status Code: 400

InternalException

This exception occurs due to unexpected causes.

HTTP Status Code: 500

InvalidStateException

The specified state is not a valid state for an event source.

HTTP Status Code: 400

OperationDisabledException

The operation you are attempting is not available in this region.

HTTP Status Code: 400

ResourceNotFoundException

An entity that you specified does not exist.

HTTP Status Code: 400

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 6

Amazon EventBridge API Reference

CancelReplay
Cancels the specified replay.

Request Syntax

{
"ReplayName": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ReplayName

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 Elements

If the action is successful, the service sends back an HTTP 200 response.

CancelReplay API Version 2015-10-07 7

Amazon EventBridge API Reference

The following data is returned in JSON format by the service.

ReplayArn

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]+$
State

The current state of the replay.

Type: String

Valid Values: STARTING | RUNNING | CANCELLING | COMPLETED | CANCELLED |

FAILED
StateReason

The reason that the replay is in the current state.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Errors
For information about the errors that are common to all actions, see Common Errors.

ConcurrentModificationException

There is concurrent modification on a rule, target, archive, or replay.

HTTP Status Code: 400

IllegalStatusException

An error occurred because a replay can be canceled only when the state is Running or Starting.

Errors API Version 2015-10-07 8

Amazon EventBridge API Reference

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

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 9

Amazon EventBridge API Reference

CreateApiDestination
Creates an API destination, which is an HTTP invocation endpoint configured as a target for events.

API destinations do not support private destinations, such as interface VPC endpoints.

For more information, see API destinations in the EventBridge User Guide.

Request Syntax

{
"ConnectionArn": "string",
"Description": "string",
"HttpMethod": "string",
"InvocationEndpoint": "string",
"InvocationRateLimitPerSecond": number,
"Name": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ConnectionArn

The ARN of the connection to use for the API destination. The destination endpoint must
support the authorization type specified for the connection.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:connection
\/[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$

Required: Yes
Description

A description for the API destination to create.

CreateApiDestination API Version 2015-10-07 10

Amazon EventBridge API Reference

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Required: No
HttpMethod

The method to use for the request to the HTTP invocation endpoint.

Type: String

Valid Values: POST | GET | HEAD | OPTIONS | PUT | PATCH | DELETE

Required: Yes
InvocationEndpoint

The URL to the HTTP invocation endpoint for the API destination.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^((%[0-9A-Fa-f]{2}|[-()_.!~*';/?:@\x26=+$,A-Za-z0-9])+)
([).!';/?:,])?$

Required: Yes
InvocationRateLimitPerSecond

The maximum number of requests per second to send to the HTTP invocation endpoint.

Type: Integer

Valid Range: Minimum value of 1.

Required: No
Name

The name for the API destination to create.

Type: String

Request Parameters API Version 2015-10-07 11

Amazon EventBridge API Reference

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

Required: Yes

Response Syntax

{
"ApiDestinationArn": "string",
"ApiDestinationState": "string",
"CreationTime": number,
"LastModifiedTime": number
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ApiDestinationArn

The ARN of the API destination that was created by the request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:api-
destination\/[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$
ApiDestinationState

The state of the API destination that was created by the request.

Type: String

Valid Values: ACTIVE | INACTIVE

CreationTime

A time stamp indicating the time that the API destination was created.

Response Syntax API Version 2015-10-07 12

Amazon EventBridge API Reference

Type: Timestamp
LastModifiedTime

A time stamp indicating the time that the API destination was last modified.

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalException

This exception occurs due to unexpected causes.

HTTP Status Code: 500

LimitExceededException

The request failed because it attempted to create resource beyond the allowed service quota.

HTTP Status Code: 400

ResourceAlreadyExistsException

The resource you are trying to create already exists.

HTTP Status Code: 400

ResourceNotFoundException

An entity that you specified does not exist.

HTTP Status Code: 400

See Also

For 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

Errors API Version 2015-10-07 13

Amazon EventBridge API Reference

• AWS SDK for C++

• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 14

Amazon EventBridge API Reference

CreateArchive
Creates an archive of events with the specified settings. When you create an archive, incoming
events might not immediately start being sent to the archive. Allow a short period of time for
changes to take effect. If you do not specify a pattern to filter events sent to the archive, all events
are sent to the archive except replayed events. Replayed events are not sent to an archive.

Note
Archives and schema discovery are not supported for event buses encrypted using a
customer managed key. EventBridge returns an error if:

• You call CreateArchive on an event bus set to use a customer managed key for
encryption.
• You call CreateDiscoverer on an event bus set to use a customer managed key for
encryption.
• You call UpdatedEventBus to set a customer managed key on an event bus with an
archives or schema discovery enabled.

To enable archives or schema discovery on an event bus, choose to use an AWS owned key.
For more information, see Data encryption in EventBridge in the Amazon EventBridge User
Guide.

Request Syntax

{
"ArchiveName": "string",
"Description": "string",
"EventPattern": "string",
"EventSourceArn": "string",
"RetentionDays": number
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

CreateArchive API Version 2015-10-07 15

Amazon EventBridge API Reference

The request accepts the following data in JSON format.

ArchiveName

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: Yes
Description

A description for the archive.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Required: No
EventPattern

An event pattern to use to filter events sent to the archive.

Type: String

Length Constraints: Maximum length of 4096.

Required: No
EventSourceArn

The ARN of the event bus that sends events to the archive.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Required: Yes

Request Parameters API Version 2015-10-07 16

Amazon EventBridge API Reference

RetentionDays

The number of days to retain events for. Default value is 0. If set to 0, events are retained
indefinitely

Type: Integer

Valid Range: Minimum value of 0.

Required: No

Response Syntax

{
"ArchiveArn": "string",
"CreationTime": number,
"State": "string",
"StateReason": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ArchiveArn

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

The time at which the archive was created.

Type: Timestamp

Response Syntax API Version 2015-10-07 17

Amazon EventBridge API Reference

State

The state of the archive that was created.

Type: String

Valid Values: ENABLED | DISABLED | CREATING | UPDATING | CREATE_FAILED |

UPDATE_FAILED
StateReason

The reason that the archive is in the state.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Errors

For information about the errors that are common to all actions, see Common Errors.

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

InvalidEventPatternException

The event pattern is not valid.

HTTP Status Code: 400

LimitExceededException

The request failed because it attempted to create resource beyond the allowed service quota.

Errors API Version 2015-10-07 18

Amazon EventBridge API Reference

HTTP Status Code: 400

ResourceAlreadyExistsException

The resource you are trying to create already exists.

HTTP Status Code: 400

ResourceNotFoundException

An entity that you specified does not exist.

HTTP Status Code: 400

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 19

Amazon EventBridge API Reference

CreateConnection
Creates a connection. A connection defines the authorization type and credentials to use for
authorization with an API destination HTTP endpoint.

Request Syntax

{
"AuthorizationType": "string",
"AuthParameters": {
"ApiKeyAuthParameters": {
"ApiKeyName": "string",
"ApiKeyValue": "string"
},
"BasicAuthParameters": {
"Password": "string",
"Username": "string"
},
"InvocationHttpParameters": {
"BodyParameters": [
{
"IsValueSecret": boolean,
"Key": "string",
"Value": "string"
}
],
"HeaderParameters": [
{
"IsValueSecret": boolean,
"Key": "string",
"Value": "string"
}
],
"QueryStringParameters": [
{
"IsValueSecret": boolean,
"Key": "string",
"Value": "string"
}
]
},
"OAuthParameters": {
"AuthorizationEndpoint": "string",

CreateConnection API Version 2015-10-07 20

Amazon EventBridge API Reference

"ClientParameters": {
"ClientID": "string",
"ClientSecret": "string"
},
"HttpMethod": "string",
"OAuthHttpParameters": {
"BodyParameters": [
{
"IsValueSecret": boolean,
"Key": "string",
"Value": "string"
}
],
"HeaderParameters": [
{
"IsValueSecret": boolean,
"Key": "string",
"Value": "string"
}
],
"QueryStringParameters": [
{
"IsValueSecret": boolean,
"Key": "string",
"Value": "string"
}
]
}
}
},
"Description": "string",
"Name": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AuthorizationType

The type of authorization to use for the connection.

Request Parameters API Version 2015-10-07 21

Amazon EventBridge API Reference

Note
OAUTH tokens are refreshed when a 401 or 407 response is returned.

Type: String

Valid Values: BASIC | OAUTH_CLIENT_CREDENTIALS | API_KEY

Required: Yes
AuthParameters

A CreateConnectionAuthRequestParameters object that contains the authorization

parameters to use to authorize with the endpoint.

Type: CreateConnectionAuthRequestParameters object

Required: Yes
Description

A description for the connection to create.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Required: No
Name

The name for the connection to create.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

Required: Yes

Request Parameters API Version 2015-10-07 22

Amazon EventBridge API Reference

Response Syntax

{
"ConnectionArn": "string",
"ConnectionState": "string",
"CreationTime": number,
"LastModifiedTime": number
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ConnectionArn

The ARN of the connection that was created by the request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:connection
\/[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$
ConnectionState

The state of the connection that was created by the request.

Type: String

Valid Values: CREATING | UPDATING | DELETING | AUTHORIZED | DEAUTHORIZED |

AUTHORIZING | DEAUTHORIZING
CreationTime

A time stamp for the time that the connection was created.

Type: Timestamp
LastModifiedTime

A time stamp for the time that the connection was last updated.

Response Syntax API Version 2015-10-07 23

Amazon EventBridge API Reference

Type: Timestamp

Errors
For information about the errors that are common to all actions, see Common Errors.

InternalException

This exception occurs due to unexpected causes.

HTTP Status Code: 500

LimitExceededException

The request failed because it attempted to create resource beyond the allowed service quota.

HTTP Status Code: 400

ResourceAlreadyExistsException

The resource you are trying to create already exists.

HTTP Status Code: 400

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

Errors API Version 2015-10-07 24

Amazon EventBridge API Reference

CreateEndpoint
Creates a global endpoint. Global endpoints improve your application's availability by making it
regional-fault tolerant. To do this, you define a primary and secondary Region with event buses
in each Region. You also create a Amazon Route 53 health check that will tell EventBridge to
route events to the secondary Region when an "unhealthy" state is encountered and events will be
routed back to the primary Region when the health check reports a "healthy" state.

Request Syntax

{
"Description": "string",
"EventBuses": [
{
"EventBusArn": "string"
}
],
"Name": "string",
"ReplicationConfig": {
"State": "string"
},
"RoleArn": "string",
"RoutingConfig": {
"FailoverConfig": {
"Primary": {
"HealthCheck": "string"
},
"Secondary": {
"Route": "string"
}
}
}
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

CreateEndpoint API Version 2015-10-07 25

Amazon EventBridge API Reference

Description

A description of the global endpoint.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Required: No
EventBuses

Define the event buses used.

Important
The names of the event buses must be identical in each Region.

Type: Array of EndpointEventBus objects

Array Members: Fixed number of 2 items.

Required: Yes
Name

The name of the global endpoint. For example, "Name":"us-east-2-custom_bus_A-

endpoint".

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

Required: Yes
ReplicationConfig

Enable or disable event replication. The default state is ENABLED which means you must supply
a RoleArn. If you don't have a RoleArn or you don't want event replication enabled, set the
state to DISABLED.

Request Parameters API Version 2015-10-07 26

Amazon EventBridge API Reference

Type: ReplicationConfig object

Required: No
RoleArn

The ARN of the role used for replication.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^arn:aws[a-z-]*:iam::\d{12}:role\/[\w+=,.@/-]+$

Required: No
RoutingConfig

Configure the routing policy, including the health check and secondary Region..

Type: RoutingConfig object

Required: Yes

Response Syntax

{
"Arn": "string",
"EventBuses": [
{
"EventBusArn": "string"
}
],
"Name": "string",
"ReplicationConfig": {
"State": "string"
},
"RoleArn": "string",
"RoutingConfig": {
"FailoverConfig": {
"Primary": {
"HealthCheck": "string"
},
"Secondary": {

Response Syntax API Version 2015-10-07 27

Amazon EventBridge API Reference

"Route": "string"
}
}
},
"State": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Arn

The ARN of the endpoint that was created by this request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:endpoint\/
[/\.\-_A-Za-z0-9]+$
EventBuses

The event buses used by this request.

Type: Array of EndpointEventBus objects

Array Members: Fixed number of 2 items.

Name

The name of the endpoint that was created by this request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+
ReplicationConfig

Whether event replication was enabled or disabled by this request.

Response Elements API Version 2015-10-07 28

Amazon EventBridge API Reference

Type: ReplicationConfig object

RoleArn

The ARN of the role used by event replication for this request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^arn:aws[a-z-]*:iam::\d{12}:role\/[\w+=,.@/-]+$
RoutingConfig

The routing configuration defined by this request.

Type: RoutingConfig object

State

The state of the endpoint that was created by this request.

Type: String

Valid Values: ACTIVE | CREATING | UPDATING | DELETING | CREATE_FAILED |

UPDATE_FAILED | DELETE_FAILED

Errors
For information about the errors that are common to all actions, see Common Errors.

InternalException

This exception occurs due to unexpected causes.

HTTP Status Code: 500

LimitExceededException

The request failed because it attempted to create resource beyond the allowed service quota.

HTTP Status Code: 400

ResourceAlreadyExistsException

The resource you are trying to create already exists.

Errors API Version 2015-10-07 29

Amazon EventBridge API Reference

HTTP Status Code: 400

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 30

Amazon EventBridge API Reference

CreateEventBus
Creates a new event bus within your account. This can be a custom event bus which you can use to
receive events from your custom applications and services, or it can be a partner event bus which
can be matched to a partner event source.

Request Syntax

{
"DeadLetterConfig": {
"Arn": "string"
},
"Description": "string",
"EventSourceName": "string",
"KmsKeyIdentifier": "string",
"Name": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

DeadLetterConfig

Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue
(DLQ).

For more information, see Using dead-letter queues to process undelivered events in the
EventBridge User Guide.

Type: DeadLetterConfig object

Required: No

CreateEventBus API Version 2015-10-07 31

Amazon EventBridge API Reference

Description

The event bus description.

Type: String

Length Constraints: Maximum length of 512.

Required: No
EventSourceName

If you are creating a partner event bus, this specifies the partner event source that the new
event bus 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: No
KmsKeyIdentifier

The identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to
use a customer managed key to encrypt events on this event bus. The identifier can be the key
Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

If you do not specify a customer managed key identifier, EventBridge uses an AWS owned key to
encrypt events on the event bus.

For more information, see Managing keys in the AWS Key Management Service Developer Guide.

Note
Archives and schema discovery are not supported for event buses encrypted using a
customer managed key. EventBridge returns an error if:
• You call CreateArchive on an event bus set to use a customer managed key for
encryption.
• You call CreateDiscoverer on an event bus set to use a customer managed key
for encryption.

Request Parameters API Version 2015-10-07 32

Amazon EventBridge API Reference

• You call UpdatedEventBus to set a customer managed key on an event bus with
an archives or schema discovery enabled.
To enable archives or schema discovery on an event bus, choose to use an AWS
owned key. For more information, see Data encryption in EventBridge in the Amazon
EventBridge User Guide.

Type: String

Length Constraints: Maximum length of 2048.

Required: No
Name

The name of the new event bus.

Custom event bus names can't contain the / character, but you can use the / character in
partner event bus names. In addition, for partner event buses, the name must exactly match the
name of the partner event source that this event bus is matched to.

You can't use the name default for a custom event bus, as this name is already used for your
account's default event bus.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [/\.\-_A-Za-z0-9]+

Required: Yes
Tags

Tags to associate with the event bus.

Type: Array of Tag objects

Required: No

Response Syntax

Response Syntax API Version 2015-10-07 33

Amazon EventBridge API Reference

"DeadLetterConfig": {
"Arn": "string"
},
"Description": "string",
"EventBusArn": "string",
"KmsKeyIdentifier": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

DeadLetterConfig

Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue
(DLQ).

For more information, see Using dead-letter queues to process undelivered events in the
EventBridge User Guide.

Type: DeadLetterConfig object

Description

The event bus description.

Type: String

Length Constraints: Maximum length of 512.

EventBusArn

The ARN of the new event bus.

Type: String
KmsKeyIdentifier

The identifier of the AWS KMS customer managed key for EventBridge to use to encrypt events
on this event bus, if one has been specified.

For more information, see Data encryption in EventBridge in the Amazon EventBridge User
Guide.

Response Elements API Version 2015-10-07 34

Amazon EventBridge API Reference

Type: String

Length Constraints: Maximum length of 2048.

Errors
For information about the errors that are common to all actions, see Common Errors.

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

InvalidStateException

The specified state is not a valid state for an event source.

HTTP Status Code: 400

LimitExceededException

The request failed because it attempted to create resource beyond the allowed service quota.

HTTP Status Code: 400

OperationDisabledException

The operation you are attempting is not available in this region.

HTTP Status Code: 400

ResourceAlreadyExistsException

The resource you are trying to create already exists.

HTTP Status Code: 400

ResourceNotFoundException

An entity that you specified does not exist.

Errors API Version 2015-10-07 35

Amazon EventBridge API Reference

HTTP Status Code: 400

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 36

Amazon EventBridge API Reference

CreatePartnerEventSource
Called 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 bus
in that AWS account. A SaaS partner must create one partner event source for each AWS account
that wants 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
that event 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
resource within the partner system.

The event_name must be unique across all AWS customers. This is because the event source is
a shared resource between the partner and customer accounts, and each partner event source
unique in the partner account.

The combination of event_namespace and event_name should help AWS customers decide whether
to create an event bus to receive these events.

Request Syntax

{
"Account": "string",
"Name": "string"

CreatePartnerEventSource API Version 2015-10-07 37

Amazon EventBridge API Reference

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Account

The AWS account ID that is permitted to create a matching partner event bus for this partner
event source.

Type: String

Length Constraints: Fixed length of 12.

Pattern: \d{12}

Required: Yes
Name

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 this
partner event source must create a partner event bus with a name that matches the name of
the partner event source.

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"
}

Request Parameters API Version 2015-10-07 38

Amazon EventBridge API Reference

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

EventSourceArn

The ARN of the partner event source.

Type: String

Errors
For information about the errors that are common to all actions, see Common Errors.

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

LimitExceededException

The request failed because it attempted to create resource beyond the allowed service quota.

HTTP Status Code: 400

OperationDisabledException

The operation you are attempting is not available in this region.

HTTP Status Code: 400

ResourceAlreadyExistsException

The resource you are trying to create already exists.

HTTP Status Code: 400

Response Elements API Version 2015-10-07 39

Amazon EventBridge API Reference

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 40

Amazon EventBridge API Reference

DeactivateEventSource
You 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 in
PENDING state for more than two weeks, it is deleted.

To activate a deactivated partner event source, use ActivateEventSource.

Request Syntax

{
"Name": "string"
}

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Name

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 Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors.

DeactivateEventSource API Version 2015-10-07 41

Amazon EventBridge API Reference

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

InvalidStateException

The specified state is not a valid state for an event source.

HTTP Status Code: 400

OperationDisabledException

The operation you are attempting is not available in this region.

HTTP Status Code: 400

ResourceNotFoundException

An entity that you specified does not exist.

HTTP Status Code: 400

See Also

For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3

See Also API Version 2015-10-07 42

Amazon EventBridge API Reference

• AWS SDK for Python

• AWS SDK for Ruby V3

See Also API Version 2015-10-07 43

Amazon EventBridge API Reference

DeauthorizeConnection
Removes all authorization parameters from the connection. This lets you remove the secret from
the connection so you can reuse it without having to create a new connection.

Request Syntax

{
"Name": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Name

The name of the connection to remove authorization from.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

Required: Yes

Response Syntax

{
"ConnectionArn": "string",
"ConnectionState": "string",
"CreationTime": number,
"LastAuthorizedTime": number,
"LastModifiedTime": number
}

DeauthorizeConnection API Version 2015-10-07 44

Amazon EventBridge API Reference

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ConnectionArn

The ARN of the connection that authorization was removed from.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:connection
\/[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$
ConnectionState

The state of the connection.

Type: String

Valid Values: CREATING | UPDATING | DELETING | AUTHORIZED | DEAUTHORIZED |

AUTHORIZING | DEAUTHORIZING
CreationTime

A time stamp for the time that the connection was created.

Type: Timestamp
LastAuthorizedTime

A time stamp for the time that the connection was last authorized.

Type: Timestamp
LastModifiedTime

A time stamp for the time that the connection was last updated.

Type: Timestamp

Response Elements API Version 2015-10-07 45

Amazon EventBridge API Reference

Errors
For information about the errors that are common to all actions, see Common Errors.

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

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

Errors API Version 2015-10-07 46

Amazon EventBridge API Reference

DeleteApiDestination
Deletes the specified API destination.

Request Syntax

{
"Name": "string"
}

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Name

The name of the destination to delete.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

Required: Yes

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors.

ConcurrentModificationException

There is concurrent modification on a rule, target, archive, or replay.

HTTP Status Code: 400

DeleteApiDestination API Version 2015-10-07 47

Amazon EventBridge API Reference

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

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 48

Amazon EventBridge API Reference

DeleteArchive
Deletes the specified archive.

Request Syntax

{
"ArchiveName": "string"
}

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ArchiveName

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 Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors.

ConcurrentModificationException

There is concurrent modification on a rule, target, archive, or replay.

HTTP Status Code: 400

DeleteArchive API Version 2015-10-07 49

Amazon EventBridge API Reference

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

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 50

Amazon EventBridge API Reference

DeleteConnection
Deletes a connection.

Request Syntax

{
"Name": "string"
}

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Name

The name of the connection to delete.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

Required: Yes

Response Syntax

{
"ConnectionArn": "string",
"ConnectionState": "string",
"CreationTime": number,
"LastAuthorizedTime": number,
"LastModifiedTime": number
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

DeleteConnection API Version 2015-10-07 51

Amazon EventBridge API Reference

The following data is returned in JSON format by the service.

ConnectionArn

The ARN of the connection that was deleted.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:connection
\/[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$
ConnectionState

The state of the connection before it was deleted.

Type: String

Valid Values: CREATING | UPDATING | DELETING | AUTHORIZED | DEAUTHORIZED |

AUTHORIZING | DEAUTHORIZING
CreationTime

A time stamp for the time that the connection was created.

Type: Timestamp
LastAuthorizedTime

A time stamp for the time that the connection was last authorized before it wa deleted.

Type: Timestamp
LastModifiedTime

A time stamp for the time that the connection was last modified before it was deleted.

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

Errors API Version 2015-10-07 52

Amazon EventBridge API Reference

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

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 53

Amazon EventBridge API Reference

DeleteEndpoint
Delete an existing global endpoint. For more information about global endpoints, see Making
applications Regional-fault tolerant with global endpoints and event replication in the Amazon
EventBridge User Guide .

Request Syntax

{
"Name": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Name

The name of the endpoint you want to delete. For example, "Name":"us-east-2-
custom_bus_A-endpoint"..

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

DeleteEndpoint API Version 2015-10-07 54

Amazon EventBridge API Reference

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

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 55

Amazon EventBridge API Reference

DeleteEventBus
Deletes the specified custom event bus or partner event bus. All rules associated with this event
bus need to be deleted. You can't delete your account's default event bus.

Request Syntax

{
"Name": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Name

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 Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

ConcurrentModificationException

There is concurrent modification on a rule, target, archive, or replay.

DeleteEventBus API Version 2015-10-07 56

Amazon EventBridge API Reference

HTTP Status Code: 400

InternalException

This exception occurs due to unexpected causes.

HTTP Status Code: 500

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 57

Amazon EventBridge API Reference

DeletePartnerEventSource
This operation is used by SaaS partners to delete a partner event source. This operation is not used
by AWS customers.

When you delete an event source, the status of the corresponding partner event bus in the AWS
customer account becomes DELETED.

Request Syntax

{
"Account": "string",
"Name": "string"
}

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Account

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

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,}

DeletePartnerEventSource API Version 2015-10-07 58

Amazon EventBridge API Reference

Required: Yes

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors.

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

OperationDisabledException

The operation you are attempting is not available in this region.

HTTP Status Code: 400

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3

Response Elements API Version 2015-10-07 59

Amazon EventBridge API Reference

• AWS SDK for Python

• AWS SDK for Ruby V3

See Also API Version 2015-10-07 60

Amazon EventBridge API Reference

DeleteRule
Deletes the specified rule.

Before you can delete the rule, you must remove all targets, using RemoveTargets.

When you delete a rule, incoming events might continue to match to the deleted rule. Allow a
short period of time for changes to take effect.

If you call delete rule multiple times for the same rule, all calls will succeed. When you call delete
rule for a non-existent custom eventbus, ResourceNotFoundException is returned.

Managed rules are rules created and managed by another AWS service on your behalf. These rules
are created by those other AWS services to support functionality in those services. You can delete
these rules using the Force option, but you should do so only if you are sure the other service is
not still using that rule.

Request Syntax

{
"EventBusName": "string",
"Force": boolean,
"Name": "string"
}

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

EventBusName

The name or ARN 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 1600.

Pattern: (arn:aws[\w-]*:events:[a-z]{2}-[a-z]+-[\w-]+:[0-9]{12}:event-bus
\/)?[/\.\-_A-Za-z0-9]+

DeleteRule API Version 2015-10-07 61

Amazon EventBridge API Reference

Required: No
Force

If this is a managed rule, created by an AWS service on your behalf, you must specify Force as
True to delete the rule. This parameter is ignored for rules that are not managed rules. You can
check whether a rule is a managed rule by using DescribeRule or ListRules and checking
the ManagedBy field of the response.

Type: Boolean

Required: No
Name

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 Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

ConcurrentModificationException

There is concurrent modification on a rule, target, archive, or replay.

HTTP Status Code: 400

InternalException

This exception occurs due to unexpected causes.

Response Elements API Version 2015-10-07 62

Amazon EventBridge API Reference

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
Force parameter in those calls to delete the rule or remove targets from the rule. You cannot
modify these managed rules by using DisableRule, EnableRule, PutTargets, PutRule,
TagResource, or UntagResource.

HTTP Status Code: 400

ResourceNotFoundException

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.1
Host: 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.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
X-Amz-Target: AWSEvents.DeleteRule

{
"Name": "test"
}

Examples API Version 2015-10-07 63

Amazon EventBridge API Reference

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 64

Amazon EventBridge API Reference

DescribeApiDestination
Retrieves details about an API destination.

Request Syntax

{
"Name": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Name

The name of the API destination to retrieve.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

Required: Yes

Response Syntax

{
"ApiDestinationArn": "string",
"ApiDestinationState": "string",
"ConnectionArn": "string",
"CreationTime": number,
"Description": "string",
"HttpMethod": "string",
"InvocationEndpoint": "string",
"InvocationRateLimitPerSecond": number,
"LastModifiedTime": number,

DescribeApiDestination API Version 2015-10-07 65

Amazon EventBridge API Reference

"Name": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ApiDestinationArn

The ARN of the API destination retrieved.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:api-
destination\/[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$
ApiDestinationState

The state of the API destination retrieved.

Type: String

Valid Values: ACTIVE | INACTIVE

ConnectionArn

The ARN of the connection specified for the API destination retrieved.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:connection
\/[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$
CreationTime

A time stamp for the time that the API destination was created.

Type: Timestamp

Response Elements API Version 2015-10-07 66

Amazon EventBridge API Reference

Description

The description for the API destination retrieved.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*
HttpMethod

The method to use to connect to the HTTP endpoint.

Type: String

Valid Values: POST | GET | HEAD | OPTIONS | PUT | PATCH | DELETE

InvocationEndpoint

The URL to use to connect to the HTTP endpoint.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^((%[0-9A-Fa-f]{2}|[-()_.!~*';/?:@\x26=+$,A-Za-z0-9])+)
([).!';/?:,])?$
InvocationRateLimitPerSecond

The maximum number of invocations per second to specified for the API destination. Note that
if you set the invocation rate maximum to a value lower the rate necessary to send all events
received on to the destination HTTP endpoint, some events may not be delivered within the 24-
hour retry window. If you plan to set the rate lower than the rate necessary to deliver all events,
consider using a dead-letter queue to catch events that are not delivered within 24 hours.

Type: Integer

Valid Range: Minimum value of 1.

LastModifiedTime

A time stamp for the time that the API destination was last modified.

Type: Timestamp

Response Elements API Version 2015-10-07 67

Amazon EventBridge API Reference

Name

The name of the API destination retrieved.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

Errors
For information about the errors that are common to all actions, see Common Errors.

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

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python

Errors API Version 2015-10-07 68

Amazon EventBridge API Reference

• AWS SDK for Ruby V3

See Also API Version 2015-10-07 69

Amazon EventBridge API Reference

DescribeArchive
Retrieves details about an archive.

Request Syntax

{
"ArchiveName": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ArchiveName

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,

DescribeArchive API Version 2015-10-07 70

Amazon EventBridge API Reference

"State": "string",
"StateReason": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ArchiveArn

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})?:.+\/.+$
ArchiveName

The name of the archive.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 48.

Pattern: [\.\-_A-Za-z0-9]+
CreationTime

The time at which the archive was created.

Type: Timestamp
Description

The description of the archive.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Response Elements API Version 2015-10-07 71

Amazon EventBridge API Reference

EventCount

The number of events in the archive.

Type: Long
EventPattern

The event pattern used to filter events sent to the archive.

Type: String

Length Constraints: Maximum length of 4096.

EventSourceArn

The ARN of the event source associated with the archive.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

RetentionDays

The number of days to retain events for in the archive.

Type: Integer

Valid Range: Minimum value of 0.

SizeBytes

The size of the archive in bytes.

Type: Long
State

The state of the archive.

Type: String

Valid Values: ENABLED | DISABLED | CREATING | UPDATING | CREATE_FAILED |

UPDATE_FAILED
StateReason

The reason that the archive is in the state.

Response Elements API Version 2015-10-07 72

Amazon EventBridge API Reference

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Errors
For information about the errors that are common to all actions, see Common Errors.

InternalException

This exception occurs due to unexpected causes.

HTTP Status Code: 500

ResourceAlreadyExistsException

The resource you are trying to create already exists.

HTTP Status Code: 400

ResourceNotFoundException

An entity that you specified does not exist.

HTTP Status Code: 400

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3

Errors API Version 2015-10-07 73

Amazon EventBridge API Reference

• AWS SDK for Python

• AWS SDK for Ruby V3

See Also API Version 2015-10-07 74

Amazon EventBridge API Reference

DescribeConnection
Retrieves details about a connection.

Request Syntax

{
"Name": "string"
}

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Name

The name of the connection to retrieve.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

Required: Yes

Response Syntax

{
"AuthorizationType": "string",
"AuthParameters": {
"ApiKeyAuthParameters": {
"ApiKeyName": "string"
},
"BasicAuthParameters": {
"Username": "string"
},
"InvocationHttpParameters": {
"BodyParameters": [
{

DescribeConnection API Version 2015-10-07 75

Amazon EventBridge API Reference

"IsValueSecret": boolean,
"Key": "string",
"Value": "string"
}
],
"HeaderParameters": [
{
"IsValueSecret": boolean,
"Key": "string",
"Value": "string"
}
],
"QueryStringParameters": [
{
"IsValueSecret": boolean,
"Key": "string",
"Value": "string"
}
]
},
"OAuthParameters": {
"AuthorizationEndpoint": "string",
"ClientParameters": {
"ClientID": "string"
},
"HttpMethod": "string",
"OAuthHttpParameters": {
"BodyParameters": [
{
"IsValueSecret": boolean,
"Key": "string",
"Value": "string"
}
],
"HeaderParameters": [
{
"IsValueSecret": boolean,
"Key": "string",
"Value": "string"
}
],
"QueryStringParameters": [
{
"IsValueSecret": boolean,

Response Syntax API Version 2015-10-07 76

Amazon EventBridge API Reference

"Key": "string",
"Value": "string"
}
]
}
}
},
"ConnectionArn": "string",
"ConnectionState": "string",
"CreationTime": number,
"Description": "string",
"LastAuthorizedTime": number,
"LastModifiedTime": number,
"Name": "string",
"SecretArn": "string",
"StateReason": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AuthorizationType

The type of authorization specified for the connection.

Type: String

Valid Values: BASIC | OAUTH_CLIENT_CREDENTIALS | API_KEY

AuthParameters

The parameters to use for authorization for the connection.

Type: ConnectionAuthResponseParameters object

ConnectionArn

The ARN of the connection retrieved.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Response Elements API Version 2015-10-07 77

Amazon EventBridge API Reference

Pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:connection
\/[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$
ConnectionState

The state of the connection retrieved.

Type: String

Valid Values: CREATING | UPDATING | DELETING | AUTHORIZED | DEAUTHORIZED |

AUTHORIZING | DEAUTHORIZING
CreationTime

A time stamp for the time that the connection was created.

Type: Timestamp
Description

The description for the connection retrieved.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*
LastAuthorizedTime

A time stamp for the time that the connection was last authorized.

Type: Timestamp
LastModifiedTime

A time stamp for the time that the connection was last modified.

Type: Timestamp
Name

The name of the connection retrieved.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Response Elements API Version 2015-10-07 78

Amazon EventBridge API Reference

Pattern: [\.\-_A-Za-z0-9]+
SecretArn

The ARN of the secret created from the authorization parameters specified for the connection.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:aws([a-z]|\-)*:secretsmanager:([a-z]|\d|\-)*:([0-9]
{12})?:secret:[\/_+=\.@\-A-Za-z0-9]+$
StateReason

The reason that the connection is in the current connection state.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Errors
For information about the errors that are common to all actions, see Common Errors.

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

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

Errors API Version 2015-10-07 79

Amazon EventBridge API Reference

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 80

Amazon EventBridge API Reference

DescribeEndpoint
Get the information about an existing global endpoint. For more information about global
endpoints, see Making applications Regional-fault tolerant with global endpoints and event
replication in the Amazon EventBridge User Guide .

Request Syntax

{
"HomeRegion": "string",
"Name": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

HomeRegion

The primary Region of the endpoint you want to get information about. For example
"HomeRegion": "us-east-1".

Type: String

Length Constraints: Minimum length of 9. Maximum length of 20.

Pattern: ^[\-a-z0-9]+$

Required: No
Name

The name of the endpoint you want to get information about. For example, "Name":"us-
east-2-custom_bus_A-endpoint".

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

DescribeEndpoint API Version 2015-10-07 81

Amazon EventBridge API Reference

Pattern: [\.\-_A-Za-z0-9]+

Required: Yes

Response Syntax

{
"Arn": "string",
"CreationTime": number,
"Description": "string",
"EndpointId": "string",
"EndpointUrl": "string",
"EventBuses": [
{
"EventBusArn": "string"
}
],
"LastModifiedTime": number,
"Name": "string",
"ReplicationConfig": {
"State": "string"
},
"RoleArn": "string",
"RoutingConfig": {
"FailoverConfig": {
"Primary": {
"HealthCheck": "string"
},
"Secondary": {
"Route": "string"
}
}
},
"State": "string",
"StateReason": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Response Syntax API Version 2015-10-07 82

Amazon EventBridge API Reference

Arn

The ARN of the endpoint you asked for information about.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:endpoint\/
[/\.\-_A-Za-z0-9]+$
CreationTime

The time the endpoint you asked for information about was created.

Type: Timestamp
Description

The description of the endpoint you asked for information about.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*
EndpointId

The ID of the endpoint you asked for information about.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

Pattern: ^[A-Za-z0-9\-]+[\.][A-Za-z0-9\-]+$
EndpointUrl

The URL of the endpoint you asked for information about.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^(https://)?[\.\-a-z0-9]+$

Response Elements API Version 2015-10-07 83

Amazon EventBridge API Reference

EventBuses

The event buses being used by the endpoint you asked for information about.

Type: Array of EndpointEventBus objects

Array Members: Fixed number of 2 items.

LastModifiedTime

The last time the endpoint you asked for information about was modified.

Type: Timestamp
Name

The name of the endpoint you asked for information about.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+
ReplicationConfig

Whether replication is enabled or disabled for the endpoint you asked for information about.

Type: ReplicationConfig object

RoleArn

The ARN of the role used by the endpoint you asked for information about.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^arn:aws[a-z-]*:iam::\d{12}:role\/[\w+=,.@/-]+$
RoutingConfig

The routing configuration of the endpoint you asked for information about.

Type: RoutingConfig object

State

The current state of the endpoint you asked for information about.

Response Elements API Version 2015-10-07 84

Amazon EventBridge API Reference

Type: String

Valid Values: ACTIVE | CREATING | UPDATING | DELETING | CREATE_FAILED |

UPDATE_FAILED | DELETE_FAILED
StateReason

The reason the endpoint you asked for information about is in its current state.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: .*

Errors
For information about the errors that are common to all actions, see Common Errors.

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

See Also
For 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 v2
• AWS SDK for Java V2

Errors API Version 2015-10-07 85

Amazon EventBridge API Reference

• AWS SDK for JavaScript V3

• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 86

Amazon EventBridge API Reference

DescribeEventBus
Displays details about an event bus in your account. This can include the external AWS accounts
that are permitted to write events to your default event bus, and the associated policy. For custom
event buses and 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, use
PutPermission.

For more information about partner event buses, see CreateEventBus.

Request Syntax

{
"Name": "string"
}

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Name

The name or ARN of the event bus to show details for. If you omit this, the default event bus is
displayed.

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

DescribeEventBus API Version 2015-10-07 87

Amazon EventBridge API Reference

"Arn": "string",
"CreationTime": number,
"DeadLetterConfig": {
"Arn": "string"
},
"Description": "string",
"KmsKeyIdentifier": "string",
"LastModifiedTime": number,
"Name": "string",
"Policy": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Arn

The Amazon Resource Name (ARN) of the account permitted to write events to the current
account.

Type: String
CreationTime

The time the event bus was created.

Type: Timestamp
DeadLetterConfig

Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue
(DLQ).

For more information, see Using dead-letter queues to process undelivered events in the
EventBridge User Guide.

Type: DeadLetterConfig object

Description

The event bus description.

Response Elements API Version 2015-10-07 88

Amazon EventBridge API Reference

Type: String

Length Constraints: Maximum length of 512.

KmsKeyIdentifier

The identifier of the AWS KMS customer managed key for EventBridge to use to encrypt events
on this event bus, if one has been specified.

For more information, see Data encryption in EventBridge in the Amazon EventBridge User
Guide.

Type: String

Length Constraints: Maximum length of 2048.

LastModifiedTime

The time the event bus was last modified.

Type: Timestamp
Name

The name of the event bus. Currently, this is always default.

Type: String
Policy

The policy that enables the external account to send events to your account.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalException

This exception occurs due to unexpected causes.

HTTP Status Code: 500

Errors API Version 2015-10-07 89

Amazon EventBridge API Reference

ResourceNotFoundException

An entity that you specified does not exist.

HTTP Status Code: 400

Examples

Example

The following example is run in account 444455556666, which has granted permission to AWS
account 111122223333 to send events to 444455556666.

Sample Request

POST / HTTP/1.1
Host: 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.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
X-Amz-Target: AWSEvents.DescribeEventBus

Example

This example illustrates one usage of DescribeEventBus.

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>

Examples API Version 2015-10-07 90

Amazon EventBridge API Reference

"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 Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 91

Amazon EventBridge API Reference

DescribeEventSource
This operation lists details about a partner event source that is shared with your account.

Request Syntax

{
"Name": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Name

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"
}

DescribeEventSource API Version 2015-10-07 92

Amazon EventBridge API Reference

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Arn

The ARN of the partner event source.

Type: String
CreatedBy

The name of the SaaS partner that created the event source.

Type: String
CreationTime

The date and time that the event source was created.

Type: Timestamp
ExpirationTime

The date and time that the event source will expire if you do not create a matching event bus.

Type: Timestamp
Name

The name of the partner event source.

Type: String
State

The state of the event source. If it is ACTIVE, you have already created a matching event bus for
this event source, and that event bus is active. If it is PENDING, either you haven't yet created
a matching event 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

Response Elements API Version 2015-10-07 93

Amazon EventBridge API Reference

Errors
For information about the errors that are common to all actions, see Common Errors.

InternalException

This exception occurs due to unexpected causes.

HTTP Status Code: 500

OperationDisabledException

The operation you are attempting is not available in this region.

HTTP Status Code: 400

ResourceNotFoundException

An entity that you specified does not exist.

HTTP Status Code: 400

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

Errors API Version 2015-10-07 94

Amazon EventBridge API Reference

DescribePartnerEventSource
An SaaS partner can use this operation to list details about a partner event source that they
have created. AWS customers do not use this operation. Instead, AWS customers can use
DescribeEventSource to see details about a partner event source that is shared with them.

Request Syntax

{
"Name": "string"
}

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Name

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 Elements
If the action is successful, the service sends back an HTTP 200 response.

DescribePartnerEventSource API Version 2015-10-07 95

Amazon EventBridge API Reference

The following data is returned in JSON format by the service.

Arn

The ARN of the event source.

Type: String
Name

The name of the event source.

Type: String

Errors
For information about the errors that are common to all actions, see Common Errors.

InternalException

This exception occurs due to unexpected causes.

HTTP Status Code: 500

OperationDisabledException

The operation you are attempting is not available in this region.

HTTP Status Code: 400

ResourceNotFoundException

An entity that you specified does not exist.

HTTP Status Code: 400

See Also
For 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

Errors API Version 2015-10-07 96

Amazon EventBridge API Reference

• AWS SDK for C++

• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 97

Amazon EventBridge API Reference

DescribeReplay
Retrieves 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 minute intervals. If you use StartReplay and specify an EventStartTime and an
EventEndTime that covers a 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 the progress of a replay. The value returned for
EventLastReplayedTime indicates the time within the specified time range associated with the
last event replayed.

Request Syntax

{
"ReplayName": "string"
}

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ReplayName

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": {

DescribeReplay API Version 2015-10-07 98

Amazon EventBridge API Reference

"Arn": "string",
"FilterArns": [ "string" ]
},
"EventEndTime": number,
"EventLastReplayedTime": number,
"EventSourceArn": "string",
"EventStartTime": number,
"ReplayArn": "string",
"ReplayEndTime": number,
"ReplayName": "string",
"ReplayStartTime": number,
"State": "string",
"StateReason": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Description

The description of the replay.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*
Destination

A ReplayDestination object that contains details about the replay.

Type: ReplayDestination object

EventEndTime

The time stamp for the last event that was replayed from the archive.

Type: Timestamp
EventLastReplayedTime

The time that the event was last replayed.

Response Elements API Version 2015-10-07 99

Amazon EventBridge API Reference

Type: Timestamp
EventSourceArn

The ARN of the archive events were replayed from.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

EventStartTime

The time stamp of the first event that was last replayed from the archive.

Type: Timestamp
ReplayArn

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

A time stamp for the time that the replay stopped.

Type: Timestamp
ReplayName

The name of the replay.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+
ReplayStartTime

A time stamp for the time that the replay started.

Type: Timestamp

Response Elements API Version 2015-10-07 100

Amazon EventBridge API Reference

State

The current state of the replay.

Type: String

Valid Values: STARTING | RUNNING | CANCELLING | COMPLETED | CANCELLED |

FAILED
StateReason

The reason that the replay is in the current state.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Errors
For information about the errors that are common to all actions, see Common Errors.

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

See Also
For 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

Errors API Version 2015-10-07 101

Amazon EventBridge API Reference

• AWS SDK for C++

• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 102

Amazon EventBridge API Reference

DescribeRule
Describes the specified rule.

DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use
ListTargetsByRule.

Request Syntax

{
"EventBusName": "string",
"Name": "string"
}

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

EventBusName

The name or ARN 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 1600.

Pattern: (arn:aws[\w-]*:events:[a-z]{2}-[a-z]+-[\w-]+:[0-9]{12}:event-bus
\/)?[/\.\-_A-Za-z0-9]+

Required: No
Name

The name of the rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

DescribeRule API Version 2015-10-07 103

Amazon EventBridge API Reference

Required: Yes

Response Syntax

{
"Arn": "string",
"CreatedBy": "string",
"Description": "string",
"EventBusName": "string",
"EventPattern": "string",
"ManagedBy": "string",
"Name": "string",
"RoleArn": "string",
"ScheduleExpression": "string",
"State": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Arn

The Amazon Resource Name (ARN) of the rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

CreatedBy

The account ID of the user that created the rule. If you use PutRule to put a rule on an event
bus in another account, the other account is the owner of the rule, and the rule ARN includes
the account ID for that account. However, the value for CreatedBy is the account ID as the
account that created the rule in the other account.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Response Syntax API Version 2015-10-07 104

Amazon EventBridge API Reference

Description

The description of the rule.

Type: String

Length Constraints: Maximum length of 512.

EventBusName

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

The event pattern. For more information, see Events and Event Patterns in the Amazon
EventBridge User Guide .

Type: String

Length Constraints: Maximum length of 4096.

ManagedBy

If this is a managed rule, created by an AWS service on your behalf, this field displays the
principal name of the AWS service that created the rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Name

The name of the rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+
RoleArn

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

Response Elements API Version 2015-10-07 105

Amazon EventBridge API Reference

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

ScheduleExpression

The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".

Type: String

Length Constraints: Maximum length of 256.

State

Specifies whether the rule is enabled or disabled.

Type: String

Valid Values: ENABLED | DISABLED |

ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS

Errors

For information about the errors that are common to all actions, see Common Errors.

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

Examples

Describes a rule named "test"

The following is an example of a DescribeRule request and response.

Errors API Version 2015-10-07 106

Amazon EventBridge API Reference

Sample Request

POST / HTTP/1.1
Host: 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.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
X-Amz-Target: AWSEvents.DescribeRule

{
"Name": "test"
}

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-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 Also

For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

See Also API Version 2015-10-07 107

Amazon EventBridge API Reference

• AWS SDK for .NET

• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 108

Amazon EventBridge API Reference

DisableRule
Disables the specified rule. A disabled rule won't match any events, and won't self-trigger if it has a
schedule expression.

When you disable a rule, incoming events might continue to match to the disabled rule. Allow a
short period of time for changes to take effect.

Request Syntax

{
"EventBusName": "string",
"Name": "string"
}

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

EventBusName

The name or ARN 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 1600.

Pattern: (arn:aws[\w-]*:events:[a-z]{2}-[a-z]+-[\w-]+:[0-9]{12}:event-bus
\/)?[/\.\-_A-Za-z0-9]+

Required: No
Name

The name of the rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

DisableRule API Version 2015-10-07 109

Amazon EventBridge API Reference

Required: Yes

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors.

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
Force parameter in those calls to delete the rule or remove targets from the rule. You cannot
modify these managed rules by using DisableRule, EnableRule, PutTargets, PutRule,
TagResource, or UntagResource.

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.

Response Elements API Version 2015-10-07 110

Amazon EventBridge API Reference

Sample Request

POST / HTTP/1.1
Host: 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.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
X-Amz-Target: AWSEvents.DisableRule

{
"Name": "test"
}

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python

See Also API Version 2015-10-07 111

Amazon EventBridge API Reference

• AWS SDK for Ruby V3

See Also API Version 2015-10-07 112

Amazon EventBridge API Reference

EnableRule
Enables 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 Parameters
For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

EventBusName

The name or ARN 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 1600.

Pattern: (arn:aws[\w-]*:events:[a-z]{2}-[a-z]+-[\w-]+:[0-9]{12}:event-bus
\/)?[/\.\-_A-Za-z0-9]+

Required: No
Name

The name of the rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

EnableRule API Version 2015-10-07 113

Amazon EventBridge API Reference

Required: Yes

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors.

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
Force parameter in those calls to delete the rule or remove targets from the rule. You cannot
modify these managed rules by using DisableRule, EnableRule, PutTargets, PutRule,
TagResource, or UntagResource.

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.

Response Elements API Version 2015-10-07 114

Amazon EventBridge API Reference

Sample Request

POST / HTTP/1.1
Host: 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.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
X-Amz-Target: AWSEvents.EnableRule

{
"Name": "test"
}

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python

See Also API Version 2015-10-07 115

Amazon EventBridge API Reference

• AWS SDK for Ruby V3

See Also API Version 2015-10-07 116

Amazon EventBridge API Reference

ListApiDestinations
Retrieves a list of API destination in the account in the current Region.

Request Syntax

{
"ConnectionArn": "string",
"Limit": number,
"NamePrefix": "string",
"NextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ConnectionArn

The ARN of the connection specified for the API destination.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:connection
\/[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$

Required: No
Limit

The maximum number of API destinations to include in the response.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

ListApiDestinations API Version 2015-10-07 117

Amazon EventBridge API Reference

NamePrefix

A name prefix to filter results returned. Only API destinations with a name that starts with the
prefix are returned.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

Required: No
NextToken

The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken is a unique pagination token for each page. To retrieve the next page
of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an HTTP 400 InvalidToken error.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

Response Syntax

{
"ApiDestinations": [
{
"ApiDestinationArn": "string",
"ApiDestinationState": "string",
"ConnectionArn": "string",
"CreationTime": number,
"HttpMethod": "string",
"InvocationEndpoint": "string",
"InvocationRateLimitPerSecond": number,
"LastModifiedTime": number,

Response Syntax API Version 2015-10-07 118

Amazon EventBridge API Reference

"Name": "string"
}
],
"NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ApiDestinations

An array of ApiDestination objects that include information about an API destination.

Type: Array of ApiDestination objects

NextToken

A token indicating there are more results available. If there are no more results, no token is
included in the response.

The value of nextToken is a unique pagination token for each page. To retrieve the next page
of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an HTTP 400 InvalidToken error.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalException

This exception occurs due to unexpected causes.

HTTP Status Code: 500

Response Elements API Version 2015-10-07 119

Amazon EventBridge API Reference

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 120

Amazon EventBridge API Reference

ListArchives
Lists your archives. You can either list all the archives or you can provide a prefix to match to the
archive names. Filter parameters are exclusive.

Request Syntax

{
"EventSourceArn": "string",
"Limit": number,
"NamePrefix": "string",
"NextToken": "string",
"State": "string"
}

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

EventSourceArn

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

The maximum number of results to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No
NamePrefix

A name prefix to filter the archives returned. Only archives with name that match the prefix are
returned.

ListArchives API Version 2015-10-07 121

Amazon EventBridge API Reference

Type: String

Length Constraints: Minimum length of 1. Maximum length of 48.

Pattern: [\.\-_A-Za-z0-9]+

Required: No
NextToken

The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken is a unique pagination token for each page. To retrieve the next page
of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an HTTP 400 InvalidToken error.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No
State

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",

Response Syntax API Version 2015-10-07 122

Amazon EventBridge API Reference

"RetentionDays": number,
"SizeBytes": number,
"State": "string",
"StateReason": "string"
}
],
"NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Archives

An array of Archive objects that include details about an archive.

Type: Array of Archive objects

NextToken

A token indicating there are more results available. If there are no more results, no token is
included in the response.

The value of nextToken is a unique pagination token for each page. To retrieve the next page
of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an HTTP 400 InvalidToken error.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalException

This exception occurs due to unexpected causes.

Response Elements API Version 2015-10-07 123

Amazon EventBridge API Reference

HTTP Status Code: 500

ResourceNotFoundException

An entity that you specified does not exist.

HTTP Status Code: 400

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 124

Amazon EventBridge API Reference

ListConnections
Retrieves a list of connections from the account.

Request Syntax

{
"ConnectionState": "string",
"Limit": number,
"NamePrefix": "string",
"NextToken": "string"
}

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ConnectionState

The state of the connection.

Type: String

Valid Values: CREATING | UPDATING | DELETING | AUTHORIZED | DEAUTHORIZED |

AUTHORIZING | DEAUTHORIZING

Required: No
Limit

The maximum number of connections to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No
NamePrefix

A name prefix to filter results returned. Only connections with a name that starts with the prefix
are returned.

ListConnections API Version 2015-10-07 125

Amazon EventBridge API Reference

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

Required: No
NextToken

The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken is a unique pagination token for each page. To retrieve the next page
of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an HTTP 400 InvalidToken error.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

Response Syntax

{
"Connections": [
{
"AuthorizationType": "string",
"ConnectionArn": "string",
"ConnectionState": "string",
"CreationTime": number,
"LastAuthorizedTime": number,
"LastModifiedTime": number,
"Name": "string",
"StateReason": "string"
}
],
"NextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

Response Syntax API Version 2015-10-07 126

Amazon EventBridge API Reference

The following data is returned in JSON format by the service.

Connections

An array of connections objects that include details about the connections.

Type: Array of Connection objects

NextToken

A token indicating there are more results available. If there are no more results, no token is
included in the response.

The value of nextToken is a unique pagination token for each page. To retrieve the next page
of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an HTTP 400 InvalidToken error.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Errors
For information about the errors that are common to all actions, see Common Errors.

InternalException

This exception occurs due to unexpected causes.

HTTP Status Code: 500

See Also
For 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 v2

Errors API Version 2015-10-07 127

Amazon EventBridge API Reference

• AWS SDK for Java V2

• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 128

Amazon EventBridge API Reference

ListEndpoints
List the global endpoints associated with this account. For more information about global
endpoints, see Making applications Regional-fault tolerant with global endpoints and event
replication in the Amazon EventBridge User Guide .

Request Syntax

{
"HomeRegion": "string",
"MaxResults": number,
"NamePrefix": "string",
"NextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

HomeRegion

The primary Region of the endpoints associated with this account. For example
"HomeRegion": "us-east-1".

Type: String

Length Constraints: Minimum length of 9. Maximum length of 20.

Pattern: ^[\-a-z0-9]+$

Required: No
MaxResults

The maximum number of results returned by the call.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

ListEndpoints API Version 2015-10-07 129

Amazon EventBridge API Reference

Required: No
NamePrefix

A value that will return a subset of the endpoints associated with this account. For example,
"NamePrefix": "ABC" will return all endpoints with "ABC" in the name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

Required: No
NextToken

The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken is a unique pagination token for each page. To retrieve the next page
of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an HTTP 400 InvalidToken error.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

Response Syntax

{
"Endpoints": [
{
"Arn": "string",
"CreationTime": number,
"Description": "string",
"EndpointId": "string",
"EndpointUrl": "string",
"EventBuses": [
{
"EventBusArn": "string"

Response Syntax API Version 2015-10-07 130

Amazon EventBridge API Reference

}
],
"LastModifiedTime": number,
"Name": "string",
"ReplicationConfig": {
"State": "string"
},
"RoleArn": "string",
"RoutingConfig": {
"FailoverConfig": {
"Primary": {
"HealthCheck": "string"
},
"Secondary": {
"Route": "string"
}
}
},
"State": "string",
"StateReason": "string"
}
],
"NextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Endpoints

The endpoints returned by the call.

Type: Array of Endpoint objects

NextToken

A token indicating there are more results available. If there are no more results, no token is
included in the response.

The value of nextToken is a unique pagination token for each page. To retrieve the next page
of results, make the call again using the returned token. Keep all other arguments unchanged.

Response Elements API Version 2015-10-07 131

Amazon EventBridge API Reference

Using an expired pagination token results in an HTTP 400 InvalidToken error.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Errors
For information about the errors that are common to all actions, see Common Errors.

InternalException

This exception occurs due to unexpected causes.

HTTP Status Code: 500

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

Errors API Version 2015-10-07 132

Amazon EventBridge API Reference

ListEventBuses
Lists all the event buses in your account, including the default event bus, custom event buses, and
partner event buses.

Request Syntax

{
"Limit": number,
"NamePrefix": "string",
"NextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Limit

Specifying this limits the number of results returned by this operation. The operation also
returns a NextToken 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: No
NamePrefix

Specifying this limits the results to only those event buses with names that start with the
specified prefix.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [/\.\-_A-Za-z0-9]+

ListEventBuses API Version 2015-10-07 133

Amazon EventBridge API Reference

Required: No
NextToken

The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken is a unique pagination token for each page. To retrieve the next page
of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an HTTP 400 InvalidToken error.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

Response Syntax

{
"EventBuses": [
{
"Arn": "string",
"CreationTime": number,
"Description": "string",
"LastModifiedTime": number,
"Name": "string",
"Policy": "string"
}
],
"NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

EventBuses

This list of event buses.

Response Syntax API Version 2015-10-07 134

Amazon EventBridge API Reference

Type: Array of EventBus objects

NextToken

A token indicating there are more results available. If there are no more results, no token is
included in the response.

The value of nextToken is a unique pagination token for each page. To retrieve the next page
of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an HTTP 400 InvalidToken error.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Errors
For information about the errors that are common to all actions, see Common Errors.

InternalException

This exception occurs due to unexpected causes.

HTTP Status Code: 500

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python

Errors API Version 2015-10-07 135

Amazon EventBridge API Reference

• AWS SDK for Ruby V3

See Also API Version 2015-10-07 136

Amazon EventBridge API Reference

ListEventSources
You can use this to see all the partner event sources that have been shared with your AWS account.
For more information about partner event sources, see CreateEventBus.

Request Syntax

{
"Limit": number,
"NamePrefix": "string",
"NextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Limit

Specifying this limits the number of results returned by this operation. The operation also
returns a NextToken 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: No
NamePrefix

Specifying this limits the results to only those partner event sources with names that start with
the specified prefix.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [/\.\-_A-Za-z0-9]+

ListEventSources API Version 2015-10-07 137

Amazon EventBridge API Reference

Required: No
NextToken

The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken is a unique pagination token for each page. To retrieve the next page
of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an HTTP 400 InvalidToken error.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

Response Syntax

{
"EventSources": [
{
"Arn": "string",
"CreatedBy": "string",
"CreationTime": number,
"ExpirationTime": number,
"Name": "string",
"State": "string"
}
],
"NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

EventSources

The list of event sources.

Response Syntax API Version 2015-10-07 138

Amazon EventBridge API Reference

Type: Array of EventSource objects

NextToken

A token indicating there are more results available. If there are no more results, no token is
included in the response.

The value of nextToken is a unique pagination token for each page. To retrieve the next page
of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an HTTP 400 InvalidToken error.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Errors
For information about the errors that are common to all actions, see Common Errors.

InternalException

This exception occurs due to unexpected causes.

HTTP Status Code: 500

OperationDisabledException

The operation you are attempting is not available in this region.

HTTP Status Code: 400

See Also
For 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 v2

Errors API Version 2015-10-07 139

Amazon EventBridge API Reference

• AWS SDK for Java V2

• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 140

Amazon EventBridge API Reference

ListPartnerEventSourceAccounts
An SaaS partner can use this operation to display the AWS account ID that a particular partner
event source name is associated with. This operation is not used by AWS customers.

Request Syntax

{
"EventSourceName": "string",
"Limit": number,
"NextToken": "string"
}

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

EventSourceName

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: Yes
Limit

Specifying this limits the number of results returned by this operation. The operation also
returns a NextToken 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: No

ListPartnerEventSourceAccounts API Version 2015-10-07 141

Amazon EventBridge API Reference

NextToken

The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken is a unique pagination token for each page. To retrieve the next page
of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an HTTP 400 InvalidToken error.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

Response Syntax

{
"NextToken": "string",
"PartnerEventSourceAccounts": [
{
"Account": "string",
"CreationTime": number,
"ExpirationTime": number,
"State": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

A token indicating there are more results available. If there are no more results, no token is
included in the response.

The value of nextToken is a unique pagination token for each page. To retrieve the next page
of results, make the call again using the returned token. Keep all other arguments unchanged.

Response Syntax API Version 2015-10-07 142

Amazon EventBridge API Reference

Using an expired pagination token results in an HTTP 400 InvalidToken error.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

PartnerEventSourceAccounts

The list of partner event sources returned by the operation.

Type: Array of PartnerEventSourceAccount objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalException

This exception occurs due to unexpected causes.

HTTP Status Code: 500

OperationDisabledException

The operation you are attempting is not available in this region.

HTTP Status Code: 400

ResourceNotFoundException

An entity that you specified does not exist.

HTTP Status Code: 400

See Also

For 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++

Errors API Version 2015-10-07 143

Amazon EventBridge API Reference

• AWS SDK for Go v2

• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 144

Amazon EventBridge API Reference

ListPartnerEventSources
An 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 Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Limit

pecifying this limits the number of results returned by this operation. The operation also
returns a NextToken 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: No
NamePrefix

If you specify this, the results are limited to only those partner event sources that start with the
string 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]*

ListPartnerEventSources API Version 2015-10-07 145

Amazon EventBridge API Reference

Required: Yes
NextToken

The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken is a unique pagination token for each page. To retrieve the next page
of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an HTTP 400 InvalidToken error.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

Response Syntax

{
"NextToken": "string",
"PartnerEventSources": [
{
"Arn": "string",
"Name": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

A token indicating there are more results available. If there are no more results, no token is
included in the response.

The value of nextToken is a unique pagination token for each page. To retrieve the next page
of results, make the call again using the returned token. Keep all other arguments unchanged.

Response Syntax API Version 2015-10-07 146

Amazon EventBridge API Reference

Using an expired pagination token results in an HTTP 400 InvalidToken error.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

PartnerEventSources

The list of partner event sources returned by the operation.

Type: Array of PartnerEventSource objects

Errors
For information about the errors that are common to all actions, see Common Errors.

InternalException

This exception occurs due to unexpected causes.

HTTP Status Code: 500

OperationDisabledException

The operation you are attempting is not available in this region.

HTTP Status Code: 400

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3

Errors API Version 2015-10-07 147

Amazon EventBridge API Reference

• AWS SDK for Python

• AWS SDK for Ruby V3

See Also API Version 2015-10-07 148

Amazon EventBridge API Reference

ListReplays
Lists your replays. You can either list all the replays or you can provide a prefix to match to the
replay names. Filter parameters are exclusive.

Request Syntax

{
"EventSourceArn": "string",
"Limit": number,
"NamePrefix": "string",
"NextToken": "string",
"State": "string"
}

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

EventSourceArn

The ARN of the archive from which the events are replayed.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Required: No
Limit

The maximum number of replays to retrieve.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No
NamePrefix

A name prefix to filter the replays returned. Only replays with name that match the prefix are
returned.

ListReplays API Version 2015-10-07 149

Amazon EventBridge API Reference

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

Required: No
NextToken

The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken is a unique pagination token for each page. To retrieve the next page
of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an HTTP 400 InvalidToken error.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No
State

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,

Response Syntax API Version 2015-10-07 150

Amazon EventBridge API Reference

"ReplayEndTime": number,
"ReplayName": "string",
"ReplayStartTime": number,
"State": "string",
"StateReason": "string"
}
]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

A token indicating there are more results available. If there are no more results, no token is
included in the response.

The value of nextToken is a unique pagination token for each page. To retrieve the next page
of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an HTTP 400 InvalidToken error.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Replays

An array of Replay objects that contain information about the replay.

Type: Array of Replay objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalException

This exception occurs due to unexpected causes.

Response Elements API Version 2015-10-07 151

Amazon EventBridge API Reference

HTTP Status Code: 500

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 152

Amazon EventBridge API Reference

ListRuleNamesByTarget
Lists the rules for the specified target. You can see which of the rules in Amazon EventBridge can
invoke a specific target in your account.

The maximum number of results per page for requests is 100.

Request Syntax

{
"EventBusName": "string",
"Limit": number,
"NextToken": "string",
"TargetArn": "string"
}

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

EventBusName

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: No
Limit

The maximum number of results to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

ListRuleNamesByTarget API Version 2015-10-07 153

Amazon EventBridge API Reference

Required: No
NextToken

The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken is a unique pagination token for each page. To retrieve the next page
of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an HTTP 400 InvalidToken error.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No
TargetArn

The Amazon Resource Name (ARN) of the target resource.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Required: Yes

Response Syntax

{
"NextToken": "string",
"RuleNames": [ "string" ]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

A token indicating there are more results available. If there are no more results, no token is
included in the response.

Response Syntax API Version 2015-10-07 154

Amazon EventBridge API Reference

The value of nextToken is a unique pagination token for each page. To retrieve the next page
of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an HTTP 400 InvalidToken error.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

RuleNames

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]+

Errors
For information about the errors that are common to all actions, see Common Errors.

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

Examples

Lists rule names by target with the specified ARN

The following is an example of a ListRuleNamesByTarget request and response.

Sample Request

POST / HTTP/1.1

Errors API Version 2015-10-07 155

Amazon EventBridge API Reference

Host: 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.1
Content-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 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>

{
"RuleNames": [
"test1",
"test2",
"test3",
"test4",
"test5"
]
}

See Also
For 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

See Also API Version 2015-10-07 156

Amazon EventBridge API Reference

• AWS SDK for C++

• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 157

Amazon EventBridge API Reference

ListRules
Lists your Amazon EventBridge rules. You can either list all the rules or you can provide a prefix to
match to the rule names.

The maximum number of results per page for requests is 100.

ListRules does not list the targets of a rule. To see the targets associated with a rule, use
ListTargetsByRule.

Request Syntax

{
"EventBusName": "string",
"Limit": number,
"NamePrefix": "string",
"NextToken": "string"
}

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

EventBusName

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: No
Limit

The maximum number of results to return.

ListRules API Version 2015-10-07 158

Amazon EventBridge API Reference

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No
NamePrefix

The prefix matching the rule name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

Required: No
NextToken

The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken is a unique pagination token for each page. To retrieve the next page
of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an HTTP 400 InvalidToken error.

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",

Response Syntax API Version 2015-10-07 159

Amazon EventBridge API Reference

"ManagedBy": "string",
"Name": "string",
"RoleArn": "string",
"ScheduleExpression": "string",
"State": "string"
}
]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

A token indicating there are more results available. If there are no more results, no token is
included in the response.

The value of nextToken is a unique pagination token for each page. To retrieve the next page
of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an HTTP 400 InvalidToken error.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Rules

The rules that match the specified criteria.

Type: Array of Rule objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalException

This exception occurs due to unexpected causes.

Response Elements API Version 2015-10-07 160

Amazon EventBridge API Reference

HTTP Status Code: 500

ResourceNotFoundException

An entity that you specified does not exist.

HTTP Status Code: 400

Examples

Lists all the rules that start with the letter "t" with a page size of 1

The following is an example of a ListRules request and response.

Sample Request

POST / HTTP/1.1
Host: 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.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
X-Amz-Target: AWSEvents.ListRules

{
"NamePrefix": "t",
"Limit": 1
}

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>

Examples API Version 2015-10-07 161

Amazon EventBridge API Reference

"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 Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 162

Amazon EventBridge API Reference

ListTagsForResource
Displays the tags associated with an EventBridge resource. In EventBridge, rules and event buses
can be tagged.

Request Syntax

{
"ResourceARN": "string"
}

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ResourceARN

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 Elements
If the action is successful, the service sends back an HTTP 200 response.

ListTagsForResource API Version 2015-10-07 163

Amazon EventBridge API Reference

The following data is returned in JSON format by the service.

Tags

The list of tag keys and values associated with the resource you specified

Type: Array of Tag objects

Errors

For information about the errors that are common to all actions, see Common Errors.

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

Examples

Removes two tags from an EventBridge rule

The following is an example of an UntagResource request.

Sample Request

POST / HTTP/1.1
Host: 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.1
Content-Length: <PayloadSizeBytes>

Errors API Version 2015-10-07 164

Amazon EventBridge API Reference

Connection: Keep-Alive
X-Amz-Target: AWSEvents.ListTagsForResource

{
"ResourceARN": "arn:aws:events:us-west-1:123456789012:rule/test",
}

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>

{
"Tags": [
{
"Key": "Stack",
"Value": "Prod"
},
{
"Key": "CostCenter",
"Value": "12345"
}
]
}

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3

See Also API Version 2015-10-07 165

Amazon EventBridge API Reference

• AWS SDK for Python

• AWS SDK for Ruby V3

See Also API Version 2015-10-07 166

Amazon EventBridge API Reference

ListTargetsByRule
Lists the targets assigned to the specified rule.

The maximum number of results per page for requests is 100.

Request Syntax

{
"EventBusName": "string",
"Limit": number,
"NextToken": "string",
"Rule": "string"
}

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

EventBusName

The name or ARN 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 1600.

Pattern: (arn:aws[\w-]*:events:[a-z]{2}-[a-z]+-[\w-]+:[0-9]{12}:event-bus
\/)?[/\.\-_A-Za-z0-9]+

Required: No
Limit

The maximum number of results to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

ListTargetsByRule API Version 2015-10-07 167

Amazon EventBridge API Reference

NextToken

The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken is a unique pagination token for each page. To retrieve the next page
of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an HTTP 400 InvalidToken error.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No
Rule

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

{
"NextToken": "string",
"Targets": [
{
"AppSyncParameters": {
"GraphQLOperation": "string"
},
"Arn": "string",
"BatchParameters": {
"ArrayProperties": {
"Size": number
},
"JobDefinition": "string",
"JobName": "string",
"RetryStrategy": {

Response Syntax API Version 2015-10-07 168

Amazon EventBridge API Reference

"Attempts": number
}
},
"DeadLetterConfig": {
"Arn": "string"
},
"EcsParameters": {
"CapacityProviderStrategy": [
{
"base": number,
"capacityProvider": "string",
"weight": number
}
],
"EnableECSManagedTags": boolean,
"EnableExecuteCommand": boolean,
"Group": "string",
"LaunchType": "string",
"NetworkConfiguration": {
"awsvpcConfiguration": {
"AssignPublicIp": "string",
"SecurityGroups": [ "string" ],
"Subnets": [ "string" ]
}
},
"PlacementConstraints": [
{
"expression": "string",
"type": "string"
}
],
"PlacementStrategy": [
{
"field": "string",
"type": "string"
}
],
"PlatformVersion": "string",
"PropagateTags": "string",
"ReferenceId": "string",
"Tags": [
{
"Key": "string",
"Value": "string"

Response Syntax API Version 2015-10-07 169

Amazon EventBridge API Reference

}
],
"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",
"Sqls": [ "string" ],
"StatementName": "string",
"WithEvent": boolean
},
"RetryPolicy": {
"MaximumEventAgeInSeconds": number,
"MaximumRetryAttempts": number
},
"RoleArn": "string",
"RunCommandParameters": {
"RunCommandTargets": [
{
"Key": "string",

Response Syntax API Version 2015-10-07 170

Amazon EventBridge API Reference

"Values": [ "string" ]
}
]
},
"SageMakerPipelineParameters": {
"PipelineParameterList": [
{
"Name": "string",
"Value": "string"
}
]
},
"SqsParameters": {
"MessageGroupId": "string"
}
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

A token indicating there are more results available. If there are no more results, no token is
included in the response.

The value of nextToken is a unique pagination token for each page. To retrieve the next page
of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an HTTP 400 InvalidToken error.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Targets

The targets assigned to the rule.

Type: Array of Target objects

Response Elements API Version 2015-10-07 171

Amazon EventBridge API Reference

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Errors

For information about the errors that are common to all actions, see Common Errors.

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

Examples

Lists the targets associated with a rule named "test"

The following is an example of a ListTargetsByRule request and response.

Sample Request

POST / HTTP/1.1
Host: 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.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
X-Amz-Target: AWSEvents.ListTargetsByRule

{
"Rule": "test"
}

Errors API Version 2015-10-07 172

Amazon EventBridge API Reference

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>

{
"Targets": [
{
"Id": "MyTargetId",
"Arn": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction"
}
]
}

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 173

Amazon EventBridge API Reference

PutEvents
Sends custom events to Amazon EventBridge so that they can be matched to rules.

The maximum size for a PutEvents event entry is 256 KB. Entry size is calculated including the
event and any necessary characters and keys of the JSON representation of the event. To learn
more, see Calculating PutEvents event entry size in the Amazon EventBridge User Guide

PutEvents accepts the data in JSON format. For the JSON number (integer) data type, the
constraints are: a minimum value of -9,223,372,036,854,775,808 and a maximum value of
9,223,372,036,854,775,807.

Note
PutEvents will only process nested JSON up to 1000 levels deep.

Request Syntax

{
"EndpointId": "string",
"Entries": [
{
"Detail": "string",
"DetailType": "string",
"EventBusName": "string",
"Resources": [ "string" ],
"Source": "string",
"Time": number,
"TraceHeader": "string"
}
]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

PutEvents API Version 2015-10-07 174

Amazon EventBridge API Reference

EndpointId

The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://
abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.

Important
When using Java, you must include auth-crt on the class path.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

Pattern: ^[A-Za-z0-9\-]+[\.][A-Za-z0-9\-]+$

Required: No
Entries

The entry that defines an event in your system. You can specify several parameters for the entry
such as the source and type of the event, resources associated with the event, and so on.

Type: Array of PutEventsRequestEntry 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 Syntax API Version 2015-10-07 175

Amazon EventBridge API Reference

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Entries

The successfully and unsuccessfully ingested events results. If the ingestion was successful, the
entry has the event ID in it. Otherwise, you can use the error code and error message to identify
the problem with the entry.

For each record, the index of the response element is the same as the index in the request array.

Type: Array of PutEventsResultEntry objects

FailedEntryCount

The number of failed entries.

Type: Integer

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalException

This exception occurs due to unexpected causes.

HTTP Status Code: 500

Examples

Sends two custom events

The following is an example of a PutEvents request and response.

Response Elements API Version 2015-10-07 176

Amazon EventBridge API Reference

Sample Request

POST / HTTP/1.1
Host: 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.1
Content-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",
"resource2"
],
"DetailType":"myDetailType"
}
]
}

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>

Examples API Version 2015-10-07 177

Amazon EventBridge API Reference

Date: <Date>

{
"FailedEntryCount": 0,
"Entries": [
{
"EventId": "11710aed-b79e-4468-a20b-bb3c0c3b4860"
},
{
"EventId": "d804d26a-88db-4b66-9eaf-9a11c708ae82"
}
]
}

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 178

Amazon EventBridge API Reference

PutPartnerEvents
This is used by SaaS partners to write events to a customer's partner event bus. AWS customers do
not use this operation.

For information on calculating event batch size, see Calculating EventBridge PutEvents event entry
size in the EventBridge User Guide.

Request Syntax

{
"Entries": [
{
"Detail": "string",
"DetailType": "string",
"Resources": [ "string" ],
"Source": "string",
"Time": number
}
]
}

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Entries

The list of events to write to the event bus.

Type: Array of PutPartnerEventsRequestEntry objects

Array Members: Minimum number of 1 item. Maximum number of 20 items.

Required: Yes

Response Syntax

PutPartnerEvents API Version 2015-10-07 179

Amazon EventBridge API Reference

"Entries": [
{
"ErrorCode": "string",
"ErrorMessage": "string",
"EventId": "string"
}
],
"FailedEntryCount": number
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Entries

The results for each event entry the partner submitted in this request. If the event was
successfully submitted, the entry has the event ID in it. Otherwise, you can use the error code
and error message to identify the problem with the entry.

For each record, the index of the response element is the same as the index in the request array.

Type: Array of PutPartnerEventsResultEntry objects

FailedEntryCount

The number of events from this operation that could not be written to the partner event bus.

Type: Integer

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalException

This exception occurs due to unexpected causes.

HTTP Status Code: 500

Response Elements API Version 2015-10-07 180

Amazon EventBridge API Reference

OperationDisabledException

The operation you are attempting is not available in this region.

HTTP Status Code: 400

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 181

Amazon EventBridge API Reference

PutPermission
Running PutPermission permits the specified AWS account or AWS organization to put events
to the specified event bus. Amazon EventBridge rules in your account are triggered by these 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 rule with your account's event bus as a target.

To enable multiple AWS accounts to put events to your event bus, run PutPermission once for
each of these accounts. Or, if all the accounts are members of the same AWS organization, you can
run PutPermission once specifying Principal as "*" and specifying the AWS organization ID in
Condition, to grant permissions to all accounts in that organization.

If you grant permissions using an organization, then accounts in that organization must specify a
RoleArn with proper permissions when they use PutTarget to add your account's event bus as
a target. For more information, see Sending and Receiving Events Between AWS Accounts in the
Amazon EventBridge User Guide.

The permission policy on the 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 Parameters
For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

PutPermission API Version 2015-10-07 182

Amazon EventBridge API Reference

Action

The action that you are enabling the other account to perform.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: events:[a-zA-Z]+

Required: No
Condition

This parameter enables you to limit the permission to accounts that fulfill a certain condition,
such as 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 object

Required: No
EventBusName

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: No
Policy

A JSON string that describes the permission policy statement. You can include a Policy
parameter in the request instead of using the StatementId, Action, Principal, or
Condition parameters.

Type: String

Request Parameters API Version 2015-10-07 183

Amazon EventBridge API Reference

Required: No
Principal

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
undesirable events. To create more secure rules, make sure that the event pattern for each rule
contains an account field with a specific account ID from which to receive events. Rules with an
account field do not match any events sent from other accounts.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 12.

Pattern: (\d{12}|\*)

Required: No
StatementId

An identifier string for the external account that you are granting permissions to. If you later
want to revoke the permission for this external account, specify this StatementId when you
run RemovePermission.

Note
Each StatementId must be unique.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9-_]+

Required: No

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Response Elements API Version 2015-10-07 184

Amazon EventBridge API Reference

Errors
For information about the errors that are common to all actions, see Common Errors.

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

OperationDisabledException

The operation you are attempting is not available in this region.

HTTP Status Code: 400

PolicyLengthExceededException

The event bus policy is too long. For more information, see the limits.

HTTP Status Code: 400

ResourceNotFoundException

An entity that you specified does not exist.

HTTP Status Code: 400

Examples
The following example enables the current account to receive events from account
111122223333.

Example

This example illustrates one usage of PutPermission.

Sample Request

POST / HTTP/1.1

Errors API Version 2015-10-07 185

Amazon EventBridge API Reference

Host: 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.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
X-Amz-Target: AWSEvents.PutPermission

{
"Action":"events:PutEvents"
"Principal":"111122223333"
"StatementId":"MyStatement"

Example

The following example grants permissions to all accounts in the organization with an ID of
o-1234567890

Sample Request

POST / HTTP/1.1
Host: 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.1
Content-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"

Examples API Version 2015-10-07 186

Amazon EventBridge API Reference

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 187

Amazon EventBridge API Reference

PutRule
Creates or updates the specified rule. Rules are enabled by default, or based on value of the state.
You can disable a rule using DisableRule.

A single rule watches for events from a single event bus. Events generated by AWS services go to
your account's default event bus. Events generated by SaaS partner services or applications go
to the matching partner event bus. If you have custom applications or services, you can specify
whether their events go to your default event bus or a custom event bus that you have created. For
more information, see CreateEventBus.

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 are replaced with null values.

When you create or update a rule, incoming events might not immediately start matching to new
or updated 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 are
triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on
the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case
the rule triggers 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 you organize and categorize your resources. You can also use them to scope user
permissions, by granting a user permission to access or change only rules with certain tag values.
To use the PutRule operation and assign 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. To
update the tags of an existing rule, use TagResource and UntagResource.

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 characters when 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

PutRule API Version 2015-10-07 188

Amazon EventBridge API Reference

software to change them to the desired state. If the rule is not written carefully, the subsequent
change to the ACLs fires 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 Your Costs with Budgets.

Request Syntax

{
"Description": "string",
"EventBusName": "string",
"EventPattern": "string",
"Name": "string",
"RoleArn": "string",
"ScheduleExpression": "string",
"State": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Description

A description of the rule.

Type: String

Length Constraints: Maximum length of 512.

Request Syntax API Version 2015-10-07 189

Amazon EventBridge API Reference

Required: No
EventBusName

The name or ARN of the event bus to associate with this rule. 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: No
EventPattern

The event pattern. For more information, see Amazon EventBridge event patterns in the
Amazon EventBridge User Guide .

Type: String

Length Constraints: Maximum length of 4096.

Required: No
Name

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: Yes
RoleArn

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

If you're setting an event bus in another account as the target and that account granted
permission to your account through an organization instead of directly by the account ID, you

Request Parameters API Version 2015-10-07 190

Amazon EventBridge API Reference

must specify a RoleArn with proper permissions in the Target structure, instead of here in
this parameter.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Required: No
ScheduleExpression

The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".

Type: String

Length Constraints: Maximum length of 256.

Required: No
State

The state of the rule.

Valid values include:

• DISABLED: The rule is disabled. EventBridge does not match any events against the rule.
• ENABLED: The rule is enabled. EventBridge matches events against the rule, except for AWS
management events delivered through CloudTrail.
• ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all events,
including AWS management events delivered through CloudTrail.

Management events provide visibility into management operations that are performed on
resources in your AWS account. These are also known as control plane operations. For more
information, see Logging management events in the CloudTrail User Guide, and Filtering
management events from AWS services in the Amazon EventBridge User Guide .

This value is only valid for rules on the default event bus or custom event buses. It does not
apply to partner event buses.

Type: String

Valid Values: ENABLED | DISABLED |

ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS

Request Parameters API Version 2015-10-07 191

Amazon EventBridge API Reference

Required: No
Tags

The list of key-value pairs to associate with the rule.

Type: Array of Tag objects

Required: No

Response Syntax

{
"RuleArn": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

RuleArn

The Amazon Resource Name (ARN) of the rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Errors
For information about the errors that are common to all actions, see Common Errors.

ConcurrentModificationException

There is concurrent modification on a rule, target, archive, or replay.

HTTP Status Code: 400

InternalException

This exception occurs due to unexpected causes.

Response Syntax API Version 2015-10-07 192

Amazon EventBridge API Reference

HTTP Status Code: 500

InvalidEventPatternException

The event pattern is not valid.

HTTP Status Code: 400

LimitExceededException

The request failed because it attempted to create resource beyond the allowed service quota.

HTTP Status Code: 400

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
Force parameter in those calls to delete the rule or remove targets from the rule. You cannot
modify these managed rules by using DisableRule, EnableRule, PutTargets, PutRule,
TagResource, or UntagResource.

HTTP Status Code: 400

ResourceNotFoundException

An entity that you specified does not exist.

HTTP Status Code: 400

Examples

Creates a rule named "test" that matches events from Amazon EC2. The rule is
also given two tags.

The following is an example of a PutRule request and response.

Sample Request

POST / HTTP/1.1
Host: events.<region>.<domain>
x-amz-Date: <Date>

Examples API Version 2015-10-07 193

Amazon EventBridge API Reference

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.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
X-Amz-Target: AWSEvents.PutRule

{
"Name": "test",
"EventPattern": "{ \"source\": [\"aws.ec2\"] }",
"Tags": [
{
"Key": "Stack",
"Value": "Prod"
},
{
"Key": "CostCenter",
"Value": "12345"
}
]
}

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>

{
"RuleArn": "arn:aws:events:us-east-1:123456789012:rule/test"
}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

See Also API Version 2015-10-07 194

Amazon EventBridge API Reference

• AWS SDK for .NET

• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 195

Amazon EventBridge API Reference

PutTargets
Adds the specified targets to the specified rule, or updates the targets if they are already
associated with the rule.

Targets are the resources that are invoked when a rule is triggered.

The maximum number of entries per request is 10.

Note
Each rule can have up to five (5) targets associated with it at one time.

For a list of services you can configure as targets for events, see EventBridge targets in the Amazon
EventBridge User Guide .

Creating rules with built-in targets is supported only in the AWS Management Console. The built-in
targets are:

• Amazon EBS CreateSnapshot API call

• Amazon EC2 RebootInstances API call

• Amazon EC2 StopInstances API call

• Amazon EC2 TerminateInstances API call

For some target types, PutTargets provides target-specific parameters. If the target is a
Kinesis data stream, you can optionally specify which shard the event goes to by using the
KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule,
you can use the RunCommandParameters field.

To be able to make API calls against the resources that you own, Amazon EventBridge needs the
appropriate permissions:

• For AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies.

• For EC2 instances, Kinesis Data Streams, AWS Step Functions state machines and API Gateway
APIs, EventBridge relies on IAM roles that you specify in the RoleARN argument in PutTargets.

PutTargets API Version 2015-10-07 196

Amazon EventBridge API Reference

For more information, see Authentication and Access Control in the Amazon EventBridge 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 when you run PutTargets. If your account sends events to another
account, your account is charged for each sent event. Each event sent to another account is
charged as a custom event. The account receiving the event is not charged. For more information,
see Amazon EventBridge Pricing.

Note
Input, InputPath, and InputTransformer are not available with PutTarget if the
target is an event bus of a different AWS account.

If you are setting the event bus of another account as the target, and that account granted
permission to your account through an organization instead of directly by the account ID, then you
must specify a RoleArn with proper permissions in the Target structure. For more information,
see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide.

Note
If you have an IAM role on a cross-account event bus target, a PutTargets call without a
role on the same target (same Id and Arn) will not remove the role.

For more information about enabling cross-account events, see PutPermission.

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
the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task,
in which case 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.

PutTargets API Version 2015-10-07 197

Amazon EventBridge API Reference

• If InputPath is specified in the form of JSONPath (for example, $.detail), then only the part
of the event specified in the path is passed to the target (for example, only the detail part of the
event is passed).
• If InputTransformer is specified, then one or more specified JSONPaths are extracted from the
event and 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
bracket notation.

When you add targets to a rule and the associated rule triggers soon after, new or updated targets
might not 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 of the failed target and the error code.

Request Syntax

{
"EventBusName": "string",
"Rule": "string",
"Targets": [
{
"AppSyncParameters": {
"GraphQLOperation": "string"
},
"Arn": "string",
"BatchParameters": {
"ArrayProperties": {
"Size": number
},
"JobDefinition": "string",
"JobName": "string",
"RetryStrategy": {
"Attempts": number
}
},
"DeadLetterConfig": {
"Arn": "string"
},
"EcsParameters": {

Request Syntax API Version 2015-10-07 198

Amazon EventBridge API Reference

"CapacityProviderStrategy": [
{
"base": number,
"capacityProvider": "string",
"weight": number
}
],
"EnableECSManagedTags": boolean,
"EnableExecuteCommand": boolean,
"Group": "string",
"LaunchType": "string",
"NetworkConfiguration": {
"awsvpcConfiguration": {
"AssignPublicIp": "string",
"SecurityGroups": [ "string" ],
"Subnets": [ "string" ]
}
},
"PlacementConstraints": [
{
"expression": "string",
"type": "string"
}
],
"PlacementStrategy": [
{
"field": "string",
"type": "string"
}
],
"PlatformVersion": "string",
"PropagateTags": "string",
"ReferenceId": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"TaskCount": number,
"TaskDefinitionArn": "string"
},
"HttpParameters": {
"HeaderParameters": {

Request Syntax API Version 2015-10-07 199

Amazon EventBridge API Reference

"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",
"Sqls": [ "string" ],
"StatementName": "string",
"WithEvent": boolean
},
"RetryPolicy": {
"MaximumEventAgeInSeconds": number,
"MaximumRetryAttempts": number
},
"RoleArn": "string",
"RunCommandParameters": {
"RunCommandTargets": [
{
"Key": "string",
"Values": [ "string" ]
}
]
},
"SageMakerPipelineParameters": {
"PipelineParameterList": [
{

Request Syntax API Version 2015-10-07 200

Amazon EventBridge API Reference

"Name": "string",
"Value": "string"
}
]
},
"SqsParameters": {
"MessageGroupId": "string"
}
}
]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

EventBusName

The name or ARN 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 1600.

Pattern: (arn:aws[\w-]*:events:[a-z]{2}-[a-z]+-[\w-]+:[0-9]{12}:event-bus
\/)?[/\.\-_A-Za-z0-9]+

Required: No
Rule

The name of the rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

Required: Yes

Request Parameters API Version 2015-10-07 201

Amazon EventBridge API Reference

Targets

The targets to update or add to the rule.

Type: Array of Target 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 Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

FailedEntries

The failed target entries.

Type: Array of PutTargetsResultEntry objects

FailedEntryCount

The number of failed entries.

Type: Integer

Response Syntax API Version 2015-10-07 202

Amazon EventBridge API Reference

Errors
For information about the errors that are common to all actions, see Common Errors.

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

LimitExceededException

The request failed because it attempted to create resource beyond the allowed service quota.

HTTP Status Code: 400

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
Force parameter in those calls to delete the rule or remove targets from the rule. You cannot
modify these managed rules by using DisableRule, EnableRule, PutTargets, PutRule,
TagResource, or UntagResource.

HTTP Status Code: 400

ResourceNotFoundException

An entity that you specified does not exist.

HTTP Status Code: 400

Examples

Adds a target to a Lambda function with the ID "MyTargetId" to the rule named
"test"

The following is an example of a PutTargets request.

Errors API Version 2015-10-07 203

Amazon EventBridge API Reference

Sample Request

POST / HTTP/1.1
Host: 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.1
Content-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 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>

{
"FailedEntries": [],
"FailedEntryCount": 0
}

Use Input Transformer to extract data from an event and input that data to the
target

This example extracts the instance and state from an event, puts them into a simple text template,
and passes this data to a Lambda function called MyFunction.

Examples API Version 2015-10-07 204

Amazon EventBridge API Reference

Note
If your are using InputTransformer with CloudWatch Logs as a target, the Template
must be {"timestamp":<timestamp>,"message":<version-id>}.

Sample Request

POST / HTTP/1.1
Host: 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.1
Content-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"},
"InputTemplate": "<instance> is in state <status>"
}
}
]
}

Example

Here is another sample request using InputTransformer. The input to the Lambda function is in
JSON format, with an array substituted. Below that sample request are examples of an event and
the resulting output to the target, using this sample request.

Examples API Version 2015-10-07 205

Amazon EventBridge API Reference

POST / HTTP/1.1
Host: 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.1
Content-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!"]
}
}

Examples API Version 2015-10-07 206

Amazon EventBridge API Reference

Output sent to the target:

{
"commands" : ["ls -lrt", "echo HelloWorld!"]
}

Sends a command to a list of EC2 instances specified by InstanceIds, using

Amazon EC2 Run Command

This example illustrates one usage of PutTargets.

POST / HTTP/1.1
Host: 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.1
Content-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"]
}
]
}

Examples API Version 2015-10-07 207

Amazon EventBridge API Reference

]
}

Sends a batch job command to an job queue

When the target is an AWS Batch job queue, the Arn field specifies the ARN of the job queue, while
JobDefinition specifies the ARN of the job definition.

POST / HTTP/1.1
Host: 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.1
Content-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":{
"ArrayProperties":{
"Size":25
},
"JobDefinition":"arn:aws:batch:us-west-2:012345678910:job-definition/
nvidia-smi:1",
"JobName":"unique-job-name",
"RetryStrategy":{
"Attempts":5
}
}
}
]
}

Examples API Version 2015-10-07 208

Amazon EventBridge API Reference

Uses KinesisParameters to control the shard assignment

In this example, KinesisParameters is used to specify that events related to status changes are
sent to a shard specific to the affected instance ID.

POST / HTTP/1.1
Host: 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.1
Content-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 Data Firehose data delivery stream as a target

This example sets a Kinesis data delivery stream named target-stream-name as a target.

POST / HTTP/1.1
Host: 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.1
Content-Length: <PayloadSizeBytes>

Examples API Version 2015-10-07 209

Amazon EventBridge API Reference

Connection: Keep-Alive
X-Amz-Target: AWSEvents.PutTargets

{
"Rule": "FirehoseExample",
"Targets": [
{
"RoleArn": "arn:aws:iam::123456789012:role/MyRoleToAccessKinesis"
"Id" : "FirehoseStream",
"Arn": "arn:aws:firehose:us-east-1:123456789012:deliverystream/target-stream-
name",
}
]
}

Adds a Step Functions state machine as a target

This example targets a state machine called "HelloWorld", and sends the input constant "Hello
World!" to that target.

POST / HTTP/1.1
Host: 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.1
Content-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!"
}
]
}

Examples API Version 2015-10-07 210

Amazon EventBridge API Reference

Adds a target that creates three Amazon ECS tasks based on a task definition

This example uses Amazon ECS as the target. You must have already created the task definition
and cluster in Amazon ECS.

POST / HTTP/1.1
Host: 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.1
Content-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",
"TaskCount": 3
}
}
]
}

Specifying two targets with one command

This example sets two simple targets with one command. In this example, both targets are AWS
Lambda functions, but the two targets could be different AWS services as well.

Sample Request

Examples API Version 2015-10-07 211

Amazon EventBridge API Reference

POST / HTTP/1.1
Host: 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.1
Content-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 account as a target

This example shows cross-account event delivery. The target being added is the event bus of a
separate AWS account, which has the AWS account ID of 444455556666.

Note
Input, InputPath, and InputTransformer are not available with PutTarget if the
target is an event bus of a different AWS account.

Sample Request

POST / HTTP/1.1

Examples API Version 2015-10-07 212

Amazon EventBridge API Reference

Host: 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.1
Content-Length: <PayloadSizeBytes>
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 API as a target

This example targets an API Gateway API with static and dynamic HTTP parameters.

Note
HTTP parameters with static values are passed through to API Gateway as-is. If you provide
a JSON Path (prefixed with "$."), it will be dynamically replaced at runtime with a value
from the event payload (before input transformation).

Sample Request

POST / HTTP/1.1
Host: 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>

Examples API Version 2015-10-07 213

Amazon EventBridge API Reference

User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-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 Also

For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 214

Amazon EventBridge API Reference

See Also API Version 2015-10-07 215

Amazon EventBridge API Reference

RemovePermission
Revokes the permission of another AWS account to be able to put events to the specified event
bus. Specify the account to revoke by the StatementId value that you associated with the
account when you granted it permission with PutPermission. You can find the StatementId by
using DescribeEventBus.

Request Syntax

{
"EventBusName": "string",
"RemoveAllPermissions": boolean,
"StatementId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

EventBusName

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: No
RemoveAllPermissions

Specifies whether to remove all permissions.

Type: Boolean

Required: No

RemovePermission API Version 2015-10-07 216

Amazon EventBridge API Reference

StatementId

The statement ID corresponding to the account that is no longer allowed to put events to the
default event bus.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9-_]+

Required: No

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors.

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

OperationDisabledException

The operation you are attempting is not available in this region.

HTTP Status Code: 400

ResourceNotFoundException

An entity that you specified does not exist.

HTTP Status Code: 400

Response Elements API Version 2015-10-07 217

Amazon EventBridge API Reference

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 218

Amazon EventBridge API Reference

RemoveTargets
Removes the specified targets from the specified rule. When the rule is triggered, those targets are
no longer be invoked.

Note
A successful execution of RemoveTargets doesn't guarantee all targets are removed from
the rule, it means that the target(s) listed in the request are removed.

When you remove a target, when the associated rule triggers, removed targets might continue to
be 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 of the failed target and the error code.

The maximum number of entries per request is 10.

Request Syntax

{
"EventBusName": "string",
"Force": boolean,
"Ids": [ "string" ],
"Rule": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

EventBusName

The name or ARN of the event bus associated with the rule. If you omit this, the default event
bus is used.

RemoveTargets API Version 2015-10-07 219

Amazon EventBridge API Reference

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
Force

If this is a managed rule, created by an AWS service on your behalf, you must specify Force as
True to remove targets. This parameter is ignored for rules that are not managed rules. You can
check whether a rule is a managed rule by using DescribeRule or ListRules and checking
the ManagedBy field of the response.

Type: Boolean

Required: No
Ids

The IDs of the targets to remove from the rule.

Type: Array of strings

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: Yes
Rule

The name of the rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

Request Parameters API Version 2015-10-07 220

Amazon EventBridge API Reference

Required: Yes

Response Syntax

{
"FailedEntries": [
{
"ErrorCode": "string",
"ErrorMessage": "string",
"TargetId": "string"
}
],
"FailedEntryCount": number
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

FailedEntries

The failed target entries.

Type: Array of RemoveTargetsResultEntry objects

FailedEntryCount

The number of failed entries.

Type: Integer

Errors
For information about the errors that are common to all actions, see Common Errors.

ConcurrentModificationException

There is concurrent modification on a rule, target, archive, or replay.

HTTP Status Code: 400

Response Syntax API Version 2015-10-07 221

Amazon EventBridge API Reference

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
Force parameter in those calls to delete the rule or remove targets from the rule. You cannot
modify these managed rules by using DisableRule, EnableRule, PutTargets, PutRule,
TagResource, or UntagResource.

HTTP Status Code: 400

ResourceNotFoundException

An entity that you specified does not exist.

HTTP Status Code: 400

Examples

Removes a target with ID "MyTargetId" from a rule named "test"

The following is an example of a RemoveTargets request.

Sample Request

POST / HTTP/1.1
Host: 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.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
X-Amz-Target: AWSEvents.RemoveTargets

Examples API Version 2015-10-07 222

Amazon EventBridge API Reference

"Rule": "test",
"Ids": [
"MyTargetId"
]
}

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>

{
"FailedEntries": [],
"FailedEntryCount": 0
}

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 223

Amazon EventBridge API Reference

StartReplay
Starts the specified replay. Events are not necessarily replayed in the exact same order that
they were added to the archive. A replay processes events to replay based on the time in the
event, and replays them using 1 minute intervals. If you specify an EventStartTime and an
EventEndTime that covers a 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 the progress of a replay. The value returned for
EventLastReplayedTime indicates the time within the specified 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 Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Description

A description for the replay to start.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

StartReplay API Version 2015-10-07 224

Amazon EventBridge API Reference

Required: No
Destination

A ReplayDestination object that includes details about the destination for the replay.

Type: ReplayDestination object

Required: Yes
EventEndTime

A time stamp for the time to stop replaying events. Only events that occurred between the
EventStartTime and EventEndTime are replayed.

Type: Timestamp

Required: Yes
EventSourceArn

The ARN of the archive to replay events from.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Required: Yes
EventStartTime

A time stamp for the time to start replaying events. Only events that occurred between the
EventStartTime and EventEndTime are replayed.

Type: Timestamp

Required: Yes
ReplayName

The name of the replay to start.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Request Parameters API Version 2015-10-07 225

Amazon EventBridge API Reference

Pattern: [\.\-_A-Za-z0-9]+

Required: Yes

Response Syntax

{
"ReplayArn": "string",
"ReplayStartTime": number,
"State": "string",
"StateReason": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ReplayArn

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

The time at which the replay started.

Type: Timestamp
State

The state of the replay.

Type: String

Response Syntax API Version 2015-10-07 226

Amazon EventBridge API Reference

Valid Values: STARTING | RUNNING | CANCELLING | COMPLETED | CANCELLED |

FAILED
StateReason

The reason that the replay is in the state.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Errors
For information about the errors that are common to all actions, see Common Errors.

InternalException

This exception occurs due to unexpected causes.

HTTP Status Code: 500

InvalidEventPatternException

The event pattern is not valid.

HTTP Status Code: 400

LimitExceededException

The request failed because it attempted to create resource beyond the allowed service quota.

HTTP Status Code: 400

ResourceAlreadyExistsException

The resource you are trying to create already exists.

HTTP Status Code: 400

ResourceNotFoundException

An entity that you specified does not exist.

HTTP Status Code: 400

Errors API Version 2015-10-07 227

Amazon EventBridge API Reference

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 228

Amazon EventBridge API Reference

TagResource
Assigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can help
you organize and categorize your resources. You can also use them to scope user permissions
by granting a user permission to access or change only resources with certain tag values. In
EventBridge, rules and event 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
tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag
key that is already associated with the resource, the new tag value that you specify replaces the
previous value for that tag.

You can associate as many as 50 tags with a resource.

Request Syntax

{
"ResourceARN": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ResourceARN

The ARN of the EventBridge resource that you're adding tags to.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

TagResource API Version 2015-10-07 229

Amazon EventBridge API Reference

Required: Yes
Tags

The list of key-value pairs to associate with the resource.

Type: Array of Tag objects

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

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
Force parameter in those calls to delete the rule or remove targets from the rule. You cannot
modify these managed rules by using DisableRule, EnableRule, PutTargets, PutRule,
TagResource, or UntagResource.

HTTP Status Code: 400

ResourceNotFoundException

An entity that you specified does not exist.

Response Elements API Version 2015-10-07 230

Amazon EventBridge API Reference

HTTP Status Code: 400

Examples

Adds two tags to a EventBridge rule

The following is an example of a TagResource request.

Sample Request

POST / HTTP/1.1
Host: 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.1
Content-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"
}
]
}

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS Command Line Interface

Examples API Version 2015-10-07 231

Amazon EventBridge API Reference

• AWS SDK for .NET

• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 232

Amazon EventBridge API Reference

TestEventPattern
Tests 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 characters when creating event patterns so that they match the ARN syntax in the event you
want to match.

Request Syntax

{
"Event": "string",
"EventPattern": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Event

The event, in JSON format, to test against the event pattern. The JSON must follow the format
specified in AWS Events, and the following fields are mandatory:
• id
• account
• source
• time
• region
• resources
• detail-type

Type: String

Required: Yes

TestEventPattern API Version 2015-10-07 233

Amazon EventBridge API Reference

EventPattern

The event pattern. For more information, see Events and Event Patterns in the Amazon
EventBridge User Guide .

Type: String

Length Constraints: Maximum length of 4096.

Required: Yes

Response Syntax

{
"Result": boolean
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Result

Indicates whether the event matches the event pattern.

Type: Boolean

Errors
For information about the errors that are common to all actions, see Common Errors.

InternalException

This exception occurs due to unexpected causes.

HTTP Status Code: 500

InvalidEventPatternException

The event pattern is not valid.

Response Syntax API Version 2015-10-07 234

Amazon EventBridge API Reference

HTTP Status Code: 400

Examples

Tests that a given event matches a given event pattern

The following is an example of a TestEventPattern request and response.

Sample Request

POST / HTTP/1.1
Host: 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.1
Content-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 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>

{
"Result": true

Examples API Version 2015-10-07 235

Amazon EventBridge API Reference

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 236

Amazon EventBridge API Reference

UntagResource
Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge, rules
and event buses can be tagged.

Request Syntax

{
"ResourceARN": "string",
"TagKeys": [ "string" ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ResourceARN

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: Yes
TagKeys

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 Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

UntagResource API Version 2015-10-07 237

Amazon EventBridge API Reference

Errors
For information about the errors that are common to all actions, see Common Errors.

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
Force parameter in those calls to delete the rule or remove targets from the rule. You cannot
modify these managed rules by using DisableRule, EnableRule, PutTargets, PutRule,
TagResource, or UntagResource.

HTTP Status Code: 400

ResourceNotFoundException

An entity that you specified does not exist.

HTTP Status Code: 400

Examples

Removes two tags from an EventBridge rule

The following is an example of an UntagResource request.

Sample Request

POST / HTTP/1.1
Host: events.<region>.<domain>
x-amz-Date: <Date>

Errors API Version 2015-10-07 238

Amazon EventBridge API Reference

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.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
X-Amz-Target: AWSEvents.UntagResource

{
"ResourceARN": "arn:aws:events:us-west-1:123456789012:rule/test",
"TagKeys": [ "CostCenter", "Team" ]
}

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 239

Amazon EventBridge API Reference

UpdateApiDestination
Updates an API destination.

Request Syntax

{
"ConnectionArn": "string",
"Description": "string",
"HttpMethod": "string",
"InvocationEndpoint": "string",
"InvocationRateLimitPerSecond": number,
"Name": "string"
}

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ConnectionArn

The ARN of the connection to use for the API destination.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:connection
\/[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$

Required: No
Description

The name of the API destination to update.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

UpdateApiDestination API Version 2015-10-07 240

Amazon EventBridge API Reference

Required: No
HttpMethod

The method to use for the API destination.

Type: String

Valid Values: POST | GET | HEAD | OPTIONS | PUT | PATCH | DELETE

Required: No
InvocationEndpoint

The URL to the endpoint to use for the API destination.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^((%[0-9A-Fa-f]{2}|[-()_.!~*';/?:@\x26=+$,A-Za-z0-9])+)
([).!';/?:,])?$

Required: No
InvocationRateLimitPerSecond

The maximum number of invocations per second to send to the API destination.

Type: Integer

Valid Range: Minimum value of 1.

Required: No
Name

The name of the API destination to update.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

Required: Yes

Request Parameters API Version 2015-10-07 241

Amazon EventBridge API Reference

Response Syntax

{
"ApiDestinationArn": "string",
"ApiDestinationState": "string",
"CreationTime": number,
"LastModifiedTime": number
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ApiDestinationArn

The ARN of the API destination that was updated.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:api-
destination\/[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$
ApiDestinationState

The state of the API destination that was updated.

Type: String

Valid Values: ACTIVE | INACTIVE

CreationTime

A time stamp for the time that the API destination was created.

Type: Timestamp
LastModifiedTime

A time stamp for the time that the API destination was last modified.

Response Syntax API Version 2015-10-07 242

Amazon EventBridge API Reference

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

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

LimitExceededException

The request failed because it attempted to create resource beyond the allowed service quota.

HTTP Status Code: 400

ResourceNotFoundException

An entity that you specified does not exist.

HTTP Status Code: 400

See Also

For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3

Errors API Version 2015-10-07 243

Amazon EventBridge API Reference

• AWS SDK for PHP V3

• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 244

Amazon EventBridge API Reference

UpdateArchive
Updates the specified archive.

Request Syntax

{
"ArchiveName": "string",
"Description": "string",
"EventPattern": "string",
"RetentionDays": number
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ArchiveName

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: Yes
Description

The description for the archive.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Required: No

UpdateArchive API Version 2015-10-07 245

Amazon EventBridge API Reference

EventPattern

The event pattern to use to filter events sent to the archive.

Type: String

Length Constraints: Maximum length of 4096.

Required: No
RetentionDays

The number of days to retain events in the archive.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

Response Syntax

{
"ArchiveArn": "string",
"CreationTime": number,
"State": "string",
"StateReason": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ArchiveArn

The ARN of the archive.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Response Syntax API Version 2015-10-07 246

Amazon EventBridge API Reference

Pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:.+\/.+$
CreationTime

The time at which the archive was updated.

Type: Timestamp
State

The state of the archive.

Type: String

Valid Values: ENABLED | DISABLED | CREATING | UPDATING | CREATE_FAILED |

UPDATE_FAILED
StateReason

The reason that the archive is in the current state.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Errors
For information about the errors that are common to all actions, see Common Errors.

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

InvalidEventPatternException

The event pattern is not valid.

Errors API Version 2015-10-07 247

Amazon EventBridge API Reference

HTTP Status Code: 400

LimitExceededException

The request failed because it attempted to create resource beyond the allowed service quota.

HTTP Status Code: 400

ResourceNotFoundException

An entity that you specified does not exist.

HTTP Status Code: 400

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 248

Amazon EventBridge API Reference

UpdateConnection
Updates settings for a connection.

Request Syntax

{
"AuthorizationType": "string",
"AuthParameters": {
"ApiKeyAuthParameters": {
"ApiKeyName": "string",
"ApiKeyValue": "string"
},
"BasicAuthParameters": {
"Password": "string",
"Username": "string"
},
"InvocationHttpParameters": {
"BodyParameters": [
{
"IsValueSecret": boolean,
"Key": "string",
"Value": "string"
}
],
"HeaderParameters": [
{
"IsValueSecret": boolean,
"Key": "string",
"Value": "string"
}
],
"QueryStringParameters": [
{
"IsValueSecret": boolean,
"Key": "string",
"Value": "string"
}
]
},
"OAuthParameters": {
"AuthorizationEndpoint": "string",
"ClientParameters": {

UpdateConnection API Version 2015-10-07 249

Amazon EventBridge API Reference

"ClientID": "string",
"ClientSecret": "string"
},
"HttpMethod": "string",
"OAuthHttpParameters": {
"BodyParameters": [
{
"IsValueSecret": boolean,
"Key": "string",
"Value": "string"
}
],
"HeaderParameters": [
{
"IsValueSecret": boolean,
"Key": "string",
"Value": "string"
}
],
"QueryStringParameters": [
{
"IsValueSecret": boolean,
"Key": "string",
"Value": "string"
}
]
}
}
},
"Description": "string",
"Name": "string"
}

Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AuthorizationType

The type of authorization to use for the connection.

Type: String

Request Parameters API Version 2015-10-07 250

Amazon EventBridge API Reference

Valid Values: BASIC | OAUTH_CLIENT_CREDENTIALS | API_KEY

Required: No
AuthParameters

The authorization parameters to use for the connection.

Type: UpdateConnectionAuthRequestParameters object

Required: No
Description

A description for the connection.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Required: No
Name

The name of the connection to update.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

Required: Yes

Response Syntax

{
"ConnectionArn": "string",
"ConnectionState": "string",
"CreationTime": number,
"LastAuthorizedTime": number,
"LastModifiedTime": number

Response Syntax API Version 2015-10-07 251

Amazon EventBridge API Reference

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ConnectionArn

The ARN of the connection that was updated.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:connection
\/[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$
ConnectionState

The state of the connection that was updated.

Type: String

Valid Values: CREATING | UPDATING | DELETING | AUTHORIZED | DEAUTHORIZED |

AUTHORIZING | DEAUTHORIZING
CreationTime

A time stamp for the time that the connection was created.

Type: Timestamp
LastAuthorizedTime

A time stamp for the time that the connection was last authorized.

Type: Timestamp
LastModifiedTime

A time stamp for the time that the connection was last modified.

Type: Timestamp

Response Elements API Version 2015-10-07 252

Amazon EventBridge API Reference

Errors
For information about the errors that are common to all actions, see Common Errors.

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

LimitExceededException

The request failed because it attempted to create resource beyond the allowed service quota.

HTTP Status Code: 400

ResourceNotFoundException

An entity that you specified does not exist.

HTTP Status Code: 400

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python

Errors API Version 2015-10-07 253

Amazon EventBridge API Reference

• AWS SDK for Ruby V3

See Also API Version 2015-10-07 254

Amazon EventBridge API Reference

UpdateEndpoint
Update an existing endpoint. For more information about global endpoints, see Making
applications Regional-fault tolerant with global endpoints and event replication in the Amazon
EventBridge User Guide .

Request Syntax

{
"Description": "string",
"EventBuses": [
{
"EventBusArn": "string"
}
],
"Name": "string",
"ReplicationConfig": {
"State": "string"
},
"RoleArn": "string",
"RoutingConfig": {
"FailoverConfig": {
"Primary": {
"HealthCheck": "string"
},
"Secondary": {
"Route": "string"
}
}
}
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Description

A description for the endpoint.

UpdateEndpoint API Version 2015-10-07 255

Amazon EventBridge API Reference

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Required: No
EventBuses

Define event buses used for replication.

Type: Array of EndpointEventBus objects

Array Members: Fixed number of 2 items.

Required: No
Name

The name of the endpoint you want to update.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

Required: Yes
ReplicationConfig

Whether event replication was enabled or disabled by this request.

Type: ReplicationConfig object

Required: No
RoleArn

The ARN of the role used by event replication for this request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^arn:aws[a-z-]*:iam::\d{12}:role\/[\w+=,.@/-]+$

Request Parameters API Version 2015-10-07 256

Amazon EventBridge API Reference

Required: No
RoutingConfig

Configure the routing policy, including the health check and secondary Region.

Type: RoutingConfig object

Required: No

Response Syntax

{
"Arn": "string",
"EndpointId": "string",
"EndpointUrl": "string",
"EventBuses": [
{
"EventBusArn": "string"
}
],
"Name": "string",
"ReplicationConfig": {
"State": "string"
},
"RoleArn": "string",
"RoutingConfig": {
"FailoverConfig": {
"Primary": {
"HealthCheck": "string"
},
"Secondary": {
"Route": "string"
}
}
},
"State": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

Response Syntax API Version 2015-10-07 257

Amazon EventBridge API Reference

The following data is returned in JSON format by the service.

Arn

The ARN of the endpoint you updated in this request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:endpoint\/
[/\.\-_A-Za-z0-9]+$
EndpointId

The ID of the endpoint you updated in this request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

Pattern: ^[A-Za-z0-9\-]+[\.][A-Za-z0-9\-]+$
EndpointUrl

The URL of the endpoint you updated in this request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^(https://)?[\.\-a-z0-9]+$
EventBuses

The event buses used for replication for the endpoint you updated in this request.

Type: Array of EndpointEventBus objects

Array Members: Fixed number of 2 items.

Name

The name of the endpoint you updated in this request.

Type: String

Response Elements API Version 2015-10-07 258

Amazon EventBridge API Reference

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+
ReplicationConfig

Whether event replication was enabled or disabled for the endpoint you updated in this
request.

Type: ReplicationConfig object

RoleArn

The ARN of the role used by event replication for the endpoint you updated in this request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^arn:aws[a-z-]*:iam::\d{12}:role\/[\w+=,.@/-]+$
RoutingConfig

The routing configuration you updated in this request.

Type: RoutingConfig object

State

The state of the endpoint you updated in this request.

Type: String

Valid Values: ACTIVE | CREATING | UPDATING | DELETING | CREATE_FAILED |

UPDATE_FAILED | DELETE_FAILED

Errors
For information about the errors that are common to all actions, see Common Errors.

ConcurrentModificationException

There is concurrent modification on a rule, target, archive, or replay.

HTTP Status Code: 400

Errors API Version 2015-10-07 259

Amazon EventBridge API Reference

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

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 260

Amazon EventBridge API Reference

UpdateEventBus
Updates the specified event bus.

Request Syntax

{
"DeadLetterConfig": {
"Arn": "string"
},
"Description": "string",
"KmsKeyIdentifier": "string",
"Name": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

DeadLetterConfig

Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue
(DLQ).

For more information, see Using dead-letter queues to process undelivered events in the
EventBridge User Guide.

Type: DeadLetterConfig object

Required: No
Description

The event bus description.

Type: String

Length Constraints: Maximum length of 512.

Required: No

UpdateEventBus API Version 2015-10-07 261

Amazon EventBridge API Reference

KmsKeyIdentifier

The identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to
use a customer managed key to encrypt events on this event bus. The identifier can be the key
Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

If you do not specify a customer managed key identifier, EventBridge uses an AWS owned key to
encrypt events on the event bus.

For more information, see Managing keys in the AWS Key Management Service Developer Guide.

Note
Archives and schema discovery are not supported for event buses encrypted using a
customer managed key. EventBridge returns an error if:
• You call CreateArchive on an event bus set to use a customer managed key for
encryption.
• You call CreateDiscoverer on an event bus set to use a customer managed key
for encryption.
• You call UpdatedEventBus to set a customer managed key on an event bus with
an archives or schema discovery enabled.
To enable archives or schema discovery on an event bus, choose to use an AWS
owned key. For more information, see Data encryption in EventBridge in the Amazon
EventBridge User Guide.

Type: String

Length Constraints: Maximum length of 2048.

Required: No
Name

The name of the event bus.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [/\.\-_A-Za-z0-9]+

Request Parameters API Version 2015-10-07 262

Amazon EventBridge API Reference

Required: No

Response Syntax

{
"Arn": "string",
"DeadLetterConfig": {
"Arn": "string"
},
"Description": "string",
"KmsKeyIdentifier": "string",
"Name": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Arn

The event bus Amazon Resource Name (ARN).

Type: String
DeadLetterConfig

Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue
(DLQ).

For more information, see Using dead-letter queues to process undelivered events in the
EventBridge User Guide.

Type: DeadLetterConfig object

Description

The event bus description.

Type: String

Length Constraints: Maximum length of 512.

Response Syntax API Version 2015-10-07 263

Amazon EventBridge API Reference

KmsKeyIdentifier

The identifier of the AWS KMS customer managed key for EventBridge to use to encrypt events
on this event bus, if one has been specified.

For more information, see Data encryption in EventBridge in the Amazon EventBridge User
Guide.

Type: String

Length Constraints: Maximum length of 2048.

Name

The event bus name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [/\.\-_A-Za-z0-9]+

Errors

For information about the errors that are common to all actions, see Common Errors.

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

OperationDisabledException

The operation you are attempting is not available in this region.

HTTP Status Code: 400

Errors API Version 2015-10-07 264

Amazon EventBridge API Reference

ResourceNotFoundException

An entity that you specified does not exist.

HTTP Status Code: 400

See Also
For 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 v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 265

Amazon EventBridge API Reference

Data Types
The Amazon EventBridge API contains several data types that various actions use. This section
describes each data type in detail.

Note
The order of each element in a data type structure is not guaranteed. Applications should
not assume a particular order.

The following data types are supported:

• ApiDestination
• AppSyncParameters
• Archive
• AwsVpcConfiguration
• BatchArrayProperties
• BatchParameters
• BatchRetryStrategy
• CapacityProviderStrategyItem
• Condition
• Connection
• ConnectionApiKeyAuthResponseParameters
• ConnectionAuthResponseParameters
• ConnectionBasicAuthResponseParameters
• ConnectionBodyParameter
• ConnectionHeaderParameter
• ConnectionHttpParameters
• ConnectionOAuthClientResponseParameters
• ConnectionOAuthResponseParameters
• ConnectionQueryStringParameter
• CreateConnectionApiKeyAuthRequestParameters

API Version 2015-10-07 266

Amazon EventBridge API Reference

• CreateConnectionAuthRequestParameters
• CreateConnectionBasicAuthRequestParameters
• CreateConnectionOAuthClientRequestParameters
• CreateConnectionOAuthRequestParameters
• DeadLetterConfig
• EcsParameters
• Endpoint
• EndpointEventBus
• EventBus
• EventSource
• FailoverConfig
• HttpParameters
• InputTransformer
• KinesisParameters
• NetworkConfiguration
• PartnerEventSource
• PartnerEventSourceAccount
• PlacementConstraint
• PlacementStrategy
• Primary
• PutEventsRequestEntry
• PutEventsResultEntry
• PutPartnerEventsRequestEntry
• PutPartnerEventsResultEntry
• PutTargetsResultEntry
• RedshiftDataParameters
• RemoveTargetsResultEntry
• Replay
• ReplayDestination
• ReplicationConfig

API Version 2015-10-07 267

Amazon EventBridge API Reference

• RetryPolicy
• RoutingConfig
• Rule
• RunCommandParameters
• RunCommandTarget
• SageMakerPipelineParameter
• SageMakerPipelineParameters
• Secondary
• SqsParameters
• Tag
• Target
• UpdateConnectionApiKeyAuthRequestParameters
• UpdateConnectionAuthRequestParameters
• UpdateConnectionBasicAuthRequestParameters
• UpdateConnectionOAuthClientRequestParameters
• UpdateConnectionOAuthRequestParameters

API Version 2015-10-07 268

Amazon EventBridge API Reference

ApiDestination
Contains details about an API destination.

Contents
ApiDestinationArn

The ARN of the API destination.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:api-
destination\/[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$

Required: No
ApiDestinationState

The state of the API destination.

Type: String

Valid Values: ACTIVE | INACTIVE

Required: No
ConnectionArn

The ARN of the connection specified for the API destination.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:connection
\/[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$

Required: No
CreationTime

A time stamp for the time that the API destination was created.

ApiDestination API Version 2015-10-07 269

Amazon EventBridge API Reference

Type: Timestamp

Required: No
HttpMethod

The method to use to connect to the HTTP endpoint.

Type: String

Valid Values: POST | GET | HEAD | OPTIONS | PUT | PATCH | DELETE

Required: No
InvocationEndpoint

The URL to the endpoint for the API destination.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^((%[0-9A-Fa-f]{2}|[-()_.!~*';/?:@\x26=+$,A-Za-z0-9])+)
([).!';/?:,])?$

Required: No
InvocationRateLimitPerSecond

The maximum number of invocations per second to send to the HTTP endpoint.

Type: Integer

Valid Range: Minimum value of 1.

Required: No
LastModifiedTime

A time stamp for the time that the API destination was last modified.

Type: Timestamp

Required: No
Name

The name of the API destination.

Contents API Version 2015-10-07 270

Amazon EventBridge API Reference

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 271

Amazon EventBridge API Reference

AppSyncParameters
Contains the GraphQL operation to be parsed and executed, if the event target is an AWS AppSync
API.

Contents
GraphQLOperation

The GraphQL operation; that is, the query, mutation, or subscription to be parsed and executed
by the GraphQL service.

For more information, see Operations in the AWS AppSync User Guide.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1048576.

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

AppSyncParameters API Version 2015-10-07 272

Amazon EventBridge API Reference

Archive
An Archive object that contains details about an archive.

Contents
ArchiveName

The name of the archive.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 48.

Pattern: [\.\-_A-Za-z0-9]+

Required: No
CreationTime

The time stamp for the time that the archive was created.

Type: Timestamp

Required: No
EventCount

The number of events in the archive.

Type: Long

Required: No
EventSourceArn

The ARN of the event bus associated with the archive. Only events from this event bus are sent
to the archive.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Required: No

Archive API Version 2015-10-07 273

Amazon EventBridge API Reference

RetentionDays

The number of days to retain events in the archive before they are deleted.

Type: Integer

Valid Range: Minimum value of 0.

Required: No
SizeBytes

The size of the archive, in bytes.

Type: Long

Required: No
State

The current state of the archive.

Type: String

Valid Values: ENABLED | DISABLED | CREATING | UPDATING | CREATE_FAILED |

UPDATE_FAILED

Required: No
StateReason

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 Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

See Also API Version 2015-10-07 274

Amazon EventBridge API Reference

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 275

Amazon EventBridge API Reference

AwsVpcConfiguration
This structure specifies the VPC subnets and security groups for the task, and whether a public IP
address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network
mode.

Contents
Subnets

Specifies the subnets associated with the task. These subnets must all be in the same VPC. You
can specify as many as 16 subnets.

Type: Array of strings

Required: Yes
AssignPublicIp

Specifies whether the task's elastic network interface receives a public IP address. You can
specify ENABLED only when LaunchType in EcsParameters is set to FARGATE.

Type: String

Valid Values: ENABLED | DISABLED

Required: No
SecurityGroups

Specifies the security groups associated with the task. These security groups must all be in
the same VPC. You can specify as many as five security groups. If you do not specify a security
group, the default security group for the VPC is used.

Type: Array of strings

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

AwsVpcConfiguration API Version 2015-10-07 276

Amazon EventBridge API Reference

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 277

Amazon EventBridge API Reference

BatchArrayProperties
The array properties for the submitted job, such as the size of the array. The array size can be
between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This
parameter is used only if the target is an AWS Batch job.

Contents
Size

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 Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

BatchArrayProperties API Version 2015-10-07 278

Amazon EventBridge API Reference

BatchParameters
The custom parameters to be used when the target is an AWS Batch job.

Contents
JobDefinition

The ARN or name of the job definition to use if the event target is an AWS Batch job. This job
definition must already exist.

Type: String

Required: Yes
JobName

The name to use for this execution of the job, if the target is an AWS Batch job.

Type: String

Required: Yes
ArrayProperties

The array properties for the submitted job, such as the size of the array. The array size can be
between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This
parameter is used only if the target is an AWS Batch job.

Type: BatchArrayProperties object

Required: No
RetryStrategy

The retry strategy to use for failed jobs, if the target is an AWS Batch job. The retry strategy is
the number of times to retry the failed job execution. Valid values are 1–10. When you specify a
retry strategy here, it overrides the retry strategy defined in the job definition.

Type: BatchRetryStrategy object

Required: No

BatchParameters API Version 2015-10-07 279

Amazon EventBridge API Reference

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 280

Amazon EventBridge API Reference

BatchRetryStrategy
The retry strategy to use for failed jobs, if the target is an AWS Batch job. If you specify a retry
strategy here, it overrides the retry strategy defined in the job definition.

Contents
Attempts

The number of times to attempt to retry, if the job fails. Valid values are 1–10.

Type: Integer

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

BatchRetryStrategy API Version 2015-10-07 281

Amazon EventBridge API Reference

CapacityProviderStrategyItem
The details of a capacity provider strategy. To learn more, see CapacityProviderStrategyItem in the
Amazon ECS API Reference.

Contents
capacityProvider

The short name of the capacity provider.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

base

The base value designates how many tasks, at a minimum, to run on the specified capacity
provider. Only one capacity provider in a capacity provider strategy can have a base defined. If
no value is specified, the default value of 0 is used.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 100000.

Required: No
weight

The weight value designates the relative percentage of the total number of tasks launched that
should use the specified capacity provider. The weight value is taken into consideration after
the base value, if defined, is satisfied.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 1000.

Required: No

CapacityProviderStrategyItem API Version 2015-10-07 282

Amazon EventBridge API Reference

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 283

Amazon EventBridge API Reference

Condition
A JSON string which you can use to limit the event bus permissions you are granting to only
accounts that fulfill the condition. Currently, the only supported condition is membership in a
certain AWS organization. The string must contain Type, Key, and Value fields. The Value field
specifies the ID of the AWS organization. Following is an example value for Condition:

'{"Type" : "StringEquals", "Key": "aws:PrincipalOrgID", "Value":

"o-1234567890"}'

Contents
Key

Specifies the key for the condition. Currently the only supported key is aws:PrincipalOrgID.

Type: String

Required: Yes
Type

Specifies the type of condition. Currently the only supported value is StringEquals.

Type: String

Required: Yes
Value

Specifies the value for the key. Currently, this must be the ID of the organization.

Type: String

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

Condition API Version 2015-10-07 284

Amazon EventBridge API Reference

• AWS SDK for Java V2

• AWS SDK for Ruby V3

See Also API Version 2015-10-07 285

Amazon EventBridge API Reference

Connection
Contains information about a connection.

Contents
AuthorizationType

The authorization type specified for the connection.

Note
OAUTH tokens are refreshed when a 401 or 407 response is returned.

Type: String

Valid Values: BASIC | OAUTH_CLIENT_CREDENTIALS | API_KEY

Required: No
ConnectionArn

The ARN of the connection.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:connection
\/[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$

Required: No
ConnectionState

The state of the connection.

Type: String

Valid Values: CREATING | UPDATING | DELETING | AUTHORIZED | DEAUTHORIZED |

AUTHORIZING | DEAUTHORIZING

Connection API Version 2015-10-07 286

Amazon EventBridge API Reference

Required: No
CreationTime

A time stamp for the time that the connection was created.

Type: Timestamp

Required: No
LastAuthorizedTime

A time stamp for the time that the connection was last authorized.

Type: Timestamp

Required: No
LastModifiedTime

A time stamp for the time that the connection was last modified.

Type: Timestamp

Required: No
Name

The name of the connection.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

Required: No
StateReason

The reason that the connection is in the connection state.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Contents API Version 2015-10-07 287

Amazon EventBridge API Reference

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 288

Amazon EventBridge API Reference

ConnectionApiKeyAuthResponseParameters
Contains the authorization parameters for the connection if API Key is specified as the
authorization type.

Contents
ApiKeyName

The name of the header to use for the APIKeyValue used for authorization.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: ^[ \t]*[^\x00-\x1F:\x7F]+([ \t]+[^\x00-\x1F:\x7F]+)*[ \t]*$

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

ConnectionApiKeyAuthResponseParameters API Version 2015-10-07 289

Amazon EventBridge API Reference

ConnectionAuthResponseParameters
Contains the authorization parameters to use for the connection.

Contents
ApiKeyAuthParameters

The API Key parameters to use for authorization.

Type: ConnectionApiKeyAuthResponseParameters object

Required: No
BasicAuthParameters

The authorization parameters for Basic authorization.

Type: ConnectionBasicAuthResponseParameters object

Required: No
InvocationHttpParameters

Additional parameters for the connection that are passed through with every invocation to the
HTTP endpoint.

Type: ConnectionHttpParameters object

Required: No
OAuthParameters

The OAuth parameters to use for authorization.

Type: ConnectionOAuthResponseParameters object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the
following:

ConnectionAuthResponseParameters API Version 2015-10-07 290

Amazon EventBridge API Reference

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 291

Amazon EventBridge API Reference

ConnectionBasicAuthResponseParameters
Contains the authorization parameters for the connection if Basic is specified as the authorization
type.

Contents
Username

The user name to use for Basic authorization.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: ^[ \t]*[^\x00-\x1F:\x7F]+([ \t]+[^\x00-\x1F:\x7F]+)*[ \t]*$

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

ConnectionBasicAuthResponseParameters API Version 2015-10-07 292

Amazon EventBridge API Reference

ConnectionBodyParameter
Additional parameter included in the body. You can include up to 100 additional body parameters
per request. An event payload cannot exceed 64 KB.

Contents
IsValueSecret

Specified whether the value is secret.

Type: Boolean

Required: No
Key

The key for the parameter.

Type: String

Required: No
Value

The value associated with the key.

Type: String

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

ConnectionBodyParameter API Version 2015-10-07 293

Amazon EventBridge API Reference

ConnectionHeaderParameter
Additional parameter included in the header. You can include up to 100 additional header
parameters per request. An event payload cannot exceed 64 KB.

Contents
IsValueSecret

Specified whether the value is a secret.

Type: Boolean

Required: No
Key

The key for the parameter.

Type: String

Length Constraints: Maximum length of 512.

Pattern: ^[!#$%&'*+-.^_`|~0-9a-zA-Z]+$

Required: No
Value

The value associated with the key.

Type: String

Length Constraints: Maximum length of 512.

Pattern: ^[ \t]*[\x20-\x7E]+([ \t]+[\x20-\x7E]+)*[ \t]*$

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

ConnectionHeaderParameter API Version 2015-10-07 294

Amazon EventBridge API Reference

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 295

Amazon EventBridge API Reference

ConnectionHttpParameters
Contains additional parameters for the connection.

Contents
BodyParameters

Contains additional body string parameters for the connection.

Type: Array of ConnectionBodyParameter objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Required: No
HeaderParameters

Contains additional header parameters for the connection.

Type: Array of ConnectionHeaderParameter objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Required: No
QueryStringParameters

Contains additional query string parameters for the connection.

Type: Array of ConnectionQueryStringParameter objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2

ConnectionHttpParameters API Version 2015-10-07 296

Amazon EventBridge API Reference

• AWS SDK for Ruby V3

See Also API Version 2015-10-07 297

Amazon EventBridge API Reference

ConnectionOAuthClientResponseParameters
Contains the client response parameters for the connection when OAuth is specified as the
authorization type.

Contents
ClientID

The client ID associated with the response to the connection request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: ^[ \t]*[^\x00-\x1F:\x7F]+([ \t]+[^\x00-\x1F:\x7F]+)*[ \t]*$

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

ConnectionOAuthClientResponseParameters API Version 2015-10-07 298

Amazon EventBridge API Reference

ConnectionOAuthResponseParameters
Contains the response parameters when OAuth is specified as the authorization type.

Contents
AuthorizationEndpoint

The URL to the HTTP endpoint that authorized the request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^((%[0-9A-Fa-f]{2}|[-()_.!~*';/?:@\x26=+$,A-Za-z0-9])+)
([).!';/?:,])?$

Required: No
ClientParameters

A ConnectionOAuthClientResponseParameters object that contains details about the

client parameters returned when OAuth is specified as the authorization type.

Type: ConnectionOAuthClientResponseParameters object

Required: No
HttpMethod

The method used to connect to the HTTP endpoint.

Type: String

Valid Values: GET | POST | PUT

Required: No
OAuthHttpParameters

The additional HTTP parameters used for the OAuth authorization request.

Type: ConnectionHttpParameters object

Required: No

ConnectionOAuthResponseParameters API Version 2015-10-07 299

Amazon EventBridge API Reference

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 300

Amazon EventBridge API Reference

ConnectionQueryStringParameter
Additional query string parameter for the connection. You can include up to 100 additional query
string parameters per request. Each additional parameter counts towards the event payload size,
which cannot exceed 64 KB.

Contents
IsValueSecret

Specifies whether the value is secret.

Type: Boolean

Required: No
Key

The key for a query string parameter.

Type: String

Length Constraints: Maximum length of 512.

Pattern: [^\x00-\x1F\x7F]+

Required: No
Value

The value associated with the key for the query string parameter.

Type: String

Length Constraints: Maximum length of 512.

Pattern: [^\x00-\x09\x0B\x0C\x0E-\x1F\x7F]+

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

ConnectionQueryStringParameter API Version 2015-10-07 301

Amazon EventBridge API Reference

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 302

Amazon EventBridge API Reference

CreateConnectionApiKeyAuthRequestParameters
Contains the API key authorization parameters for the connection.

Contents
ApiKeyName

The name of the API key to use for authorization.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: ^[ \t]*[^\x00-\x1F:\x7F]+([ \t]+[^\x00-\x1F:\x7F]+)*[ \t]*$

Required: Yes
ApiKeyValue

The value for the API key to use for authorization.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: ^[ \t]*[^\x00-\x1F:\x7F]+([ \t]+[^\x00-\x1F:\x7F]+)*[ \t]*$

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

CreateConnectionApiKeyAuthRequestParameters API Version 2015-10-07 303

Amazon EventBridge API Reference

CreateConnectionAuthRequestParameters
Contains the authorization parameters for the connection.

Contents
ApiKeyAuthParameters

A CreateConnectionApiKeyAuthRequestParameters object that contains the API key

authorization parameters to use for the connection.

Type: CreateConnectionApiKeyAuthRequestParameters object

Required: No
BasicAuthParameters

A CreateConnectionBasicAuthRequestParameters object that contains the Basic

authorization parameters to use for the connection.

Type: CreateConnectionBasicAuthRequestParameters object

Required: No
InvocationHttpParameters

A ConnectionHttpParameters object that contains the API key authorization parameters to

use for the connection. Note that if you include additional parameters for the target of a rule
via HttpParameters, including query strings, the parameters added for the connection take
precedence.

Type: ConnectionHttpParameters object

Required: No
OAuthParameters

A CreateConnectionOAuthRequestParameters object that contains the OAuth

authorization parameters to use for the connection.

Type: CreateConnectionOAuthRequestParameters object

Required: No

CreateConnectionAuthRequestParameters API Version 2015-10-07 304

Amazon EventBridge API Reference

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 305

Amazon EventBridge API Reference

CreateConnectionBasicAuthRequestParameters
Contains the Basic authorization parameters to use for the connection.

Contents
Password

The password associated with the user name to use for Basic authorization.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: ^[ \t]*[^\x00-\x1F:\x7F]+([ \t]+[^\x00-\x1F:\x7F]+)*[ \t]*$

Required: Yes
Username

The user name to use for Basic authorization.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: ^[ \t]*[^\x00-\x1F:\x7F]+([ \t]+[^\x00-\x1F:\x7F]+)*[ \t]*$

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

CreateConnectionBasicAuthRequestParameters API Version 2015-10-07 306

Amazon EventBridge API Reference

CreateConnectionOAuthClientRequestParameters
Contains the Basic authorization parameters to use for the connection.

Contents
ClientID

The client ID to use for OAuth authorization for the connection.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: ^[ \t]*[^\x00-\x1F:\x7F]+([ \t]+[^\x00-\x1F:\x7F]+)*[ \t]*$

Required: Yes
ClientSecret

The client secret associated with the client ID to use for OAuth authorization for the connection.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: ^[ \t]*[^\x00-\x1F:\x7F]+([ \t]+[^\x00-\x1F:\x7F]+)*[ \t]*$

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

CreateConnectionOAuthClientRequestParameters API Version 2015-10-07 307

Amazon EventBridge API Reference

CreateConnectionOAuthRequestParameters
Contains the OAuth authorization parameters to use for the connection.

Contents
AuthorizationEndpoint

The URL to the authorization endpoint when OAuth is specified as the authorization type.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^((%[0-9A-Fa-f]{2}|[-()_.!~*';/?:@\x26=+$,A-Za-z0-9])+)
([).!';/?:,])?$

Required: Yes
ClientParameters

A CreateConnectionOAuthClientRequestParameters object that contains the client

parameters for OAuth authorization.

Type: CreateConnectionOAuthClientRequestParameters object

Required: Yes
HttpMethod

The method to use for the authorization request.

Type: String

Valid Values: GET | POST | PUT

Required: Yes
OAuthHttpParameters

A ConnectionHttpParameters object that contains details about the additional parameters

to use for the connection.

Type: ConnectionHttpParameters object

CreateConnectionOAuthRequestParameters API Version 2015-10-07 308

Amazon EventBridge API Reference

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 309

Amazon EventBridge API Reference

DeadLetterConfig
Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue
(DLQ).

For more information, see Using dead-letter queues to process undelivered events in the
EventBridge User Guide.

Contents
Arn

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 Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

DeadLetterConfig API Version 2015-10-07 310

Amazon EventBridge API Reference

EcsParameters
The custom parameters to be used when the target is an Amazon ECS task.

Contents
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
CapacityProviderStrategy

The capacity provider strategy to use for the task.

If a capacityProviderStrategy is specified, the launchType parameter must

be omitted. If no capacityProviderStrategy or launchType is specified, the
defaultCapacityProviderStrategy for the cluster is used.

Type: Array of CapacityProviderStrategyItem objects

Array Members: Maximum number of 6 items.

Required: No
EnableECSManagedTags

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see
Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

Type: Boolean

Required: No
EnableExecuteCommand

Whether or not to enable the execute command functionality for the containers in this task. If
true, this enables execute command functionality on all containers in the task.

EcsParameters API Version 2015-10-07 311

Amazon EventBridge API Reference

Type: Boolean

Required: No
Group

Specifies an ECS task group for the task. The maximum length is 255 characters.

Type: String

Required: No
LaunchType

Specifies the launch type on which your task is running. The launch type that you specify here
must match one of the launch type (compatibilities) of the target task. The FARGATE value is
supported only in the Regions where AWS Fargate with Amazon ECS is supported. For more
information, see AWS Fargate on Amazon ECS in the Amazon Elastic Container Service Developer
Guide.

Type: String

Valid Values: EC2 | FARGATE | EXTERNAL

Required: No
NetworkConfiguration

Use this structure if the Amazon ECS task uses the awsvpc network mode. This structure
specifies the VPC subnets 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 for Fargate tasks.

If you specify NetworkConfiguration when the target ECS task does not use the awsvpc
network mode, the task fails.

Type: NetworkConfiguration object

Required: No
PlacementConstraints

An array of placement constraint objects to use for the task. You can specify up to 10
constraints per task (including constraints in the task definition and those specified at runtime).

Contents API Version 2015-10-07 312

Amazon EventBridge API Reference

Type: Array of PlacementConstraint objects

Array Members: Maximum number of 10 items.

Required: No
PlacementStrategy

The placement strategy objects to use for the task. You can specify a maximum of five strategy
rules per task.

Type: Array of PlacementStrategy objects

Array Members: Maximum number of 5 items.

Required: No
PlatformVersion

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
platform versions, see AWS Fargate Platform Versions in the Amazon Elastic Container Service
Developer Guide.

Type: String

Required: No
PropagateTags

Specifies whether to propagate the tags from the task definition to the task. If no value is
specified, the tags are not propagated. Tags can only be propagated to the task during task
creation. To add tags to a task after task creation, use the TagResource API action.

Type: String

Valid Values: TASK_DEFINITION

Required: No
ReferenceId

The reference ID to use for the task.

Contents API Version 2015-10-07 313

Amazon EventBridge API Reference

Type: String

Length Constraints: Maximum length of 1024.

Required: No
Tags

The metadata that you apply to the task to help you categorize and organize them. Each tag
consists of a key and an optional value, both of which you define. To learn more, see RunTask in
the Amazon ECS API Reference.

Type: Array of Tag objects

Required: No
TaskCount

The number of tasks to create based on TaskDefinition. The default is 1.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 314

Amazon EventBridge API Reference

Endpoint
A global endpoint used to improve your application's availability by making it regional-fault
tolerant. For more information about global endpoints, see Making applications Regional-fault
tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .

Contents
Arn

The ARN of the endpoint.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:endpoint\/
[/\.\-_A-Za-z0-9]+$

Required: No
CreationTime

The time the endpoint was created.

Type: Timestamp

Required: No
Description

A description for the endpoint.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Required: No
EndpointId

The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://
abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.

Endpoint API Version 2015-10-07 315

Amazon EventBridge API Reference

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

Pattern: ^[A-Za-z0-9\-]+[\.][A-Za-z0-9\-]+$

Required: No
EndpointUrl

The URL of the endpoint.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^(https://)?[\.\-a-z0-9]+$

Required: No
EventBuses

The event buses being used by the endpoint.

Type: Array of EndpointEventBus objects

Array Members: Fixed number of 2 items.

Required: No
LastModifiedTime

The last time the endpoint was modified.

Type: Timestamp

Required: No
Name

The name of the endpoint.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

Contents API Version 2015-10-07 316

Amazon EventBridge API Reference

Required: No
ReplicationConfig

Whether event replication was enabled or disabled for this endpoint. The default state is
ENABLED which means you must supply a RoleArn. If you don't have a RoleArn or you don't
want event replication enabled, set the state to DISABLED.

Type: ReplicationConfig object

Required: No
RoleArn

The ARN of the role used by event replication for the endpoint.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^arn:aws[a-z-]*:iam::\d{12}:role\/[\w+=,.@/-]+$

Required: No
RoutingConfig

The routing configuration of the endpoint.

Type: RoutingConfig object

Required: No
State

The current state of the endpoint.

Type: String

Valid Values: ACTIVE | CREATING | UPDATING | DELETING | CREATE_FAILED |

UPDATE_FAILED | DELETE_FAILED

Required: No
StateReason

The reason the endpoint is in its current state.

Contents API Version 2015-10-07 317

Amazon EventBridge API Reference

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: .*

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 318

Amazon EventBridge API Reference

EndpointEventBus
The event buses the endpoint is associated with.

Contents
EventBusArn

The ARN of the event bus the endpoint is associated with.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: ^arn:aws[a-z-]*:events:[a-z]{2}-[a-z-]+-\d+:\d{12}:event-bus/
[\w.-]+$

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

EndpointEventBus API Version 2015-10-07 319

Amazon EventBridge API Reference

EventBus
An event bus receives events from a source, uses rules to evaluate them, applies any configured
input transformation, and routes them to the appropriate target(s). Your account's default event
bus receives events from AWS services. A custom event bus can receive events from your custom
applications and services. A partner event bus receives events from an event source created by an
SaaS partner. These events come from the partners services or applications.

Contents
Arn

The ARN of the event bus.

Type: String

Required: No
CreationTime

The time the event bus was created.

Type: Timestamp

Required: No
Description

The event bus description.

Type: String

Length Constraints: Maximum length of 512.

Required: No
LastModifiedTime

The time the event bus was last modified.

Type: Timestamp

Required: No

EventBus API Version 2015-10-07 320

Amazon EventBridge API Reference

Name

The name of the event bus.

Type: String

Required: No
Policy

The permissions policy of the event bus, describing which other AWS accounts can write events
to this event bus.

Type: String

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 321

Amazon EventBridge API Reference

EventSource
A partner event source is created by an SaaS partner. If a customer creates a partner event bus that
matches this event source, that AWS account can receive events from the partner's applications or
services.

Contents
Arn

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
matching event bus for it.

Type: Timestamp

Required: No
Name

The name of the event source.

EventSource API Version 2015-10-07 322

Amazon EventBridge API Reference

Type: String

Required: No
State

The state of the event source. If it is ACTIVE, you have already created a matching event bus for
this event source, and that event bus is active. If it is PENDING, either you haven't yet created
a matching event 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 Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 323

Amazon EventBridge API Reference

FailoverConfig
The failover configuration for an endpoint. This includes what triggers failover and what happens
when it's triggered.

Contents
Primary

The main Region of the endpoint.

Type: Primary object

Required: Yes
Secondary

The Region that events are routed to when failover is triggered or event replication is enabled.

Type: Secondary object

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

FailoverConfig API Version 2015-10-07 324

Amazon EventBridge API Reference

HttpParameters
These are custom parameter to be used when the target is an API Gateway APIs or EventBridge
ApiDestinations. In the latter case, these are merged with any InvocationParameters specified on
the Connection, with any values from the Connection taking precedence.

Contents
HeaderParameters

The headers that need to be sent as part of request invoking the API Gateway API or
EventBridge ApiDestination.

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: No
PathParameterValues

The path parameter values to be used to populate API Gateway API or EventBridge
ApiDestination path wildcards ("*").

Type: Array of strings

Pattern: ^(?!\s*$).+

Required: No
QueryStringParameters

The query string keys/values that need to be sent as part of request invoking the API Gateway
API or EventBridge ApiDestination.

Type: String to string map

Key Length Constraints: Maximum length of 512.

HttpParameters API Version 2015-10-07 325

Amazon EventBridge API Reference

Key Pattern: [^\x00-\x1F\x7F]+

Value Length Constraints: Maximum length of 512.

Value Pattern: [^\x00-\x09\x0B\x0C\x0E-\x1F\x7F]+

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 326

Amazon EventBridge API Reference

InputTransformer
Contains the parameters needed for you to provide custom input to a target based on one or more
pieces of data extracted from the event.

Contents
InputTemplate

Input template where you specify placeholders that will be filled with the values of
the keys from InputPathsMap to customize the data sent to the target. Enclose each
InputPathsMaps value in brackets: <value>

If InputTemplate is a JSON object (surrounded by curly braces), the following restrictions

apply:
• The placeholder cannot be used as an object key.

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
marks with a slash, as in the following example:

"InputTransformer":

"InputPathsMap": {"instance": "$.detail.instance","status":

"$.detail.status"},

"InputTemplate": "<instance> is in state \"<status>\""

InputTransformer API Version 2015-10-07 327

Amazon EventBridge API Reference

The InputTemplate can also be valid JSON with varibles in quotes or out, as in the following
example:

"InputTransformer":

"InputPathsMap": {"instance": "$.detail.instance","status":

"$.detail.status"},

"InputTemplate": '{"myInstance": <instance>,"myStatus": "<instance> is

in state \"<status>\""}'

Type: String

Length Constraints: Minimum length of 1. Maximum length of 8192.

Required: Yes
InputPathsMap

Map of JSON paths to be extracted from the event. You can then insert these in the template in
InputTemplate 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 as many as 100 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 100 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: No

Contents API Version 2015-10-07 328

Amazon EventBridge API Reference

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 329

Amazon EventBridge API Reference

KinesisParameters
This object enables you to specify a JSON path to extract from the event and use as the partition
key for the Amazon Kinesis data stream, so that you can control the shard to which the event goes.
If you do not include this parameter, the default is to use the eventId as the partition key.

Contents
PartitionKeyPath

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 Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

KinesisParameters API Version 2015-10-07 330

Amazon EventBridge API Reference

NetworkConfiguration
This structure specifies the network configuration for an ECS task.

Contents
awsvpcConfiguration

Use this structure to specify the VPC subnets and security groups for the task, and whether a
public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc
network mode.

Type: AwsVpcConfiguration object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

NetworkConfiguration API Version 2015-10-07 331

Amazon EventBridge API Reference

PartnerEventSource
A partner event source is created by an SaaS partner. If a customer creates a partner event bus that
matches this event source, that AWS account can receive events from the partner's applications or
services.

Contents
Arn

The ARN of the partner event source.

Type: String

Required: No
Name

The name of the partner event source.

Type: String

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

PartnerEventSource API Version 2015-10-07 332

Amazon EventBridge API Reference

PartnerEventSourceAccount
The AWS account that a partner event source has been offered to.

Contents
Account

The AWS account ID that the partner event source was offered to.

Type: String

Length Constraints: Fixed length of 12.

Pattern: \d{12}

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
matching event bus for it.

Type: Timestamp

Required: No
State

The state of the event source. If it is ACTIVE, you have already created a matching event bus for
this event source, and that event bus is active. If it is PENDING, either you haven't yet created
a matching event 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

PartnerEventSourceAccount API Version 2015-10-07 333

Amazon EventBridge API Reference

Valid Values: PENDING | ACTIVE | DELETED

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 334

Amazon EventBridge API Reference

PlacementConstraint
An object representing a constraint on task placement. To learn more, see Task Placement
Constraints in the Amazon Elastic Container Service Developer Guide.

Contents
expression

A cluster query language expression to apply to the constraint. You cannot specify an
expression if the constraint type is distinctInstance. To learn more, see Cluster Query
Language in the Amazon Elastic Container Service Developer Guide.

Type: String

Length Constraints: Maximum length of 2000.

Required: No
type

The type of constraint. Use distinctInstance to ensure that each task in a particular group is
running on a different container instance. Use memberOf to restrict the selection to a group of
valid candidates.

Type: String

Valid Values: distinctInstance | memberOf

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

PlacementConstraint API Version 2015-10-07 335

Amazon EventBridge API Reference

PlacementStrategy
The task placement strategy for a task or service. To learn more, see Task Placement Strategies in
the Amazon Elastic Container Service Service Developer Guide.

Contents
field

The field to apply the placement strategy against. For the spread placement strategy, valid
values are instanceId (or host, which has the same effect), or any platform or custom attribute
that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack
placement strategy, valid values are cpu and memory. For the random placement strategy, this
field is not used.

Type: String

Length Constraints: Maximum length of 255.

Required: No
type

The type of placement strategy. The random placement strategy randomly places tasks on
available candidates. The spread placement strategy spreads placement across available
candidates evenly based on the field parameter. The binpack strategy places tasks on available
candidates that have the least available amount of the resource that is specified with the field
parameter. For example, if you binpack on memory, a task is placed on the instance with the
least amount of remaining memory (but still enough to run the task).

Type: String

Valid Values: random | spread | binpack

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the
following:

PlacementStrategy API Version 2015-10-07 336

Amazon EventBridge API Reference

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 337

Amazon EventBridge API Reference

Primary
The primary Region of the endpoint.

Contents
HealthCheck

The ARN of the health check used by the endpoint to determine whether failover is triggered.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:aws([a-z]|\-)*:route53:::healthcheck/[\-a-z0-9]+$

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Primary API Version 2015-10-07 338

Amazon EventBridge API Reference

PutEventsRequestEntry
Represents an event to be submitted.

Contents
Detail

A valid JSON object. There is no other schema imposed. The JSON object may contain fields and
nested sub-objects.

Note
Detail, DetailType, and Source are required for EventBridge to successfully send an
event to an event bus. If you include event entries in a request that do not include each
of those properties, EventBridge fails that entry. If you submit a request in which none
of the entries have each of these properties, EventBridge fails the entire request.

Type: String

Required: No
DetailType

Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the
event detail.

Note
Detail, DetailType, and Source are required for EventBridge to successfully send an
event to an event bus. If you include event entries in a request that do not include each
of those properties, EventBridge fails that entry. If you submit a request in which none
of the entries have each of these properties, EventBridge fails the entire request.

Type: String

Required: No

PutEventsRequestEntry API Version 2015-10-07 339

Amazon EventBridge API Reference

EventBusName

The name or ARN of the event bus to receive the event. Only the rules that are associated with
this event bus are used to match the event. If you omit this, the default event bus is used.

Note
If you're using a global endpoint with a custom bus, you can enter either the name
or Amazon Resource Name (ARN) of the event bus in either the primary or secondary
Region here. EventBridge then determines the corresponding event bus in the other
Region based on the endpoint referenced by the EndpointId. Specifying the event bus
ARN is preferred.

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
Resources

AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns.
Any number, including zero, may be present.

Type: Array of strings

Length Constraints: Maximum length of 2048.

Required: No
Source

The source of the event.

Note
Detail, DetailType, and Source are required for EventBridge to successfully send an
event to an event bus. If you include event entries in a request that do not include each

Contents API Version 2015-10-07 340

Amazon EventBridge API Reference

of those properties, EventBridge fails that entry. If you submit a request in which none
of the entries have each of these properties, EventBridge fails the entire request.

Type: String

Required: No
Time

The time stamp of the event, per RFC3339. If no time stamp is provided, the time stamp of the
PutEvents call is used.

Type: Timestamp

Required: No
TraceHeader

An AWS X-Ray trace header, which is an http header (X-Amzn-Trace-Id) that contains the trace-
id associated with the event.

To learn more about X-Ray trace headers, see Tracing header in the AWS X-Ray Developer
Guide.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 500.

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 341

Amazon EventBridge API Reference

PutEventsResultEntry
Represents the results of an event submitted to an event bus.

If the submission was successful, the entry has the event ID in it. Otherwise, you can use the error
code and error message to identify the problem with the entry.

For information about the errors that are common to all actions, see Common Errors.

Contents
ErrorCode

The error code that indicates why the event submission failed.

Retryable errors include:

• InternalFailure

The request processing has failed because of an unknown error, exception or failure.
• ThrottlingException

The request was denied due to request throttling.

Non-retryable errors include:

• AccessDeniedException

You do not have sufficient access to perform this action.

• InvalidAccountIdException

The account ID provided is not valid.

• InvalidArgument

A specified parameter is not valid.

• MalformedDetail

The JSON provided is not valid.

• RedactionFailure

Redacting the CloudTrail event failed.

PutEventsResultEntry API Version 2015-10-07 342

Amazon EventBridge API Reference

• NotAuthorizedForSourceException

You do not have permissions to publish events with this source onto this event bus.
• NotAuthorizedForDetailTypeException

You do not have permissions to publish events with this detail type onto this event bus.

Type: String

Required: No
ErrorMessage

The error message that explains why the event submission failed.

Type: String

Required: No
EventId

The ID of the event.

Type: String

Length Constraints: Maximum length of 64.

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 343

Amazon EventBridge API Reference

PutPartnerEventsRequestEntry
The details about an event generated by an SaaS partner.

Contents
Detail

A valid JSON string. There is no other schema imposed. The JSON string may contain fields and
nested sub-objects.

Note
Detail, DetailType, and Source are required for EventBridge to successfully send an
event to an event bus. If you include event entries in a request that do not include each
of those properties, EventBridge fails that entry. If you submit a request in which none
of the entries have each of these properties, EventBridge fails the entire request.

Type: String

Required: No
DetailType

A free-form string, with a maximum of 128 characters, used to decide what fields to expect in
the event detail.

Note
Detail, DetailType, and Source are required for EventBridge to successfully send an
event to an event bus. If you include event entries in a request that do not include each
of those properties, EventBridge fails that entry. If you submit a request in which none
of the entries have each of these properties, EventBridge fails the entire request.

Type: String

Required: No

PutPartnerEventsRequestEntry API Version 2015-10-07 344

Amazon EventBridge API Reference

Resources

AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns.
Any number, including zero, may be present.

Type: Array of strings

Length Constraints: Maximum length of 2048.

Required: No
Source

The event source that is generating the entry.

Note
Detail, DetailType, and Source are required for EventBridge to successfully send an
event to an event bus. If you include event entries in a request that do not include each
of those properties, EventBridge fails that entry. If you submit a request in which none
of the entries have each of these properties, EventBridge fails the entire request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: aws\.partner(/[\.\-_A-Za-z0-9]+){2,}

Required: No
Time

The date and time of the event.

Type: Timestamp

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

See Also API Version 2015-10-07 345

Amazon EventBridge API Reference

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 346

Amazon EventBridge API Reference

PutPartnerEventsResultEntry
The result of an event entry the partner submitted in this request. If the event was successfully
submitted, the entry has the event ID in it. Otherwise, you can use the error code and error
message to identify the problem with the entry.

Contents
ErrorCode

The error code that indicates why the event submission failed.

Type: String

Required: No
ErrorMessage

The error message that explains why the event submission failed.

Type: String

Required: No
EventId

The ID of the event.

Type: String

Length Constraints: Maximum length of 64.

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

PutPartnerEventsResultEntry API Version 2015-10-07 347

Amazon EventBridge API Reference

See Also API Version 2015-10-07 348

Amazon EventBridge API Reference

PutTargetsResultEntry
Represents a target that failed to be added to a rule.

Contents
ErrorCode

The error code that indicates why the target addition failed. If the value is
ConcurrentModificationException, too many requests were made at the same time.

Type: String

Required: No
ErrorMessage

The error message that explains why the target addition failed.

Type: String

Required: No
TargetId

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 Also

For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2

PutTargetsResultEntry API Version 2015-10-07 349

Amazon EventBridge API Reference

• AWS SDK for Ruby V3

See Also API Version 2015-10-07 350

Amazon EventBridge API Reference

RedshiftDataParameters
These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke
the Amazon Redshift Data API ExecuteStatement based on EventBridge events.

Contents
Database

The name of the database. Required when authenticating using temporary credentials.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: Yes
DbUser

The database user name. Required when authenticating using temporary credentials.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No
SecretManagerArn

The name or ARN of the secret that enables access to the database. Required when
authenticating using 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: No
Sql

The SQL statement text to run.

RedshiftDataParameters API Version 2015-10-07 351

Amazon EventBridge API Reference

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100000.

Required: No
Sqls

One or more SQL statements to run. The SQL statements are run as a single transaction. They
run serially in the order of the array. Subsequent SQL statements don't start until the previous
statement in the array completes. If any SQL statement fails, then because they are run as one
transaction, all work is rolled back.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 40 items.

Length Constraints: Minimum length of 1. Maximum length of 100000.

Required: No
StatementName

The name of the SQL statement. You can name the SQL statement when you create it to
identify the query.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 500.

Required: No
WithEvent

Indicates whether to send an event back to EventBridge after the SQL statement runs.

Type: Boolean

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

See Also API Version 2015-10-07 352

Amazon EventBridge API Reference

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 353

Amazon EventBridge API Reference

RemoveTargetsResultEntry
Represents a target that failed to be removed from a rule.

Contents
ErrorCode

The error code that indicates why the target removal failed. If the value is
ConcurrentModificationException, too many requests were made at the same time.

Type: String

Required: No
ErrorMessage

The error message that explains why the target removal failed.

Type: String

Required: No
TargetId

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 Also

For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2

RemoveTargetsResultEntry API Version 2015-10-07 354

Amazon EventBridge API Reference

• AWS SDK for Ruby V3

See Also API Version 2015-10-07 355

Amazon EventBridge API Reference

Replay
A Replay object that contains details about a replay.

Contents
EventEndTime

A time stamp for the time to start replaying events. Any event with a creation time prior to the
EventEndTime specified is replayed.

Type: Timestamp

Required: No
EventLastReplayedTime

A time stamp for the time that the last event was replayed.

Type: Timestamp

Required: No
EventSourceArn

The ARN of the archive to replay event from.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Required: No
EventStartTime

A time stamp for the time to start replaying events. This is determined by the time in the event
as described in Time.

Type: Timestamp

Required: No
ReplayEndTime

A time stamp for the time that the replay completed.

Replay API Version 2015-10-07 356

Amazon EventBridge API Reference

Type: Timestamp

Required: No
ReplayName

The name of the replay.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

Required: No
ReplayStartTime

A time stamp for the time that the replay started.

Type: Timestamp

Required: No
State

The current state of the replay.

Type: String

Valid Values: STARTING | RUNNING | CANCELLING | COMPLETED | CANCELLED |

FAILED

Required: No
StateReason

A description of why the replay is in the current state.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Required: No

Contents API Version 2015-10-07 357

Amazon EventBridge API Reference

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 358

Amazon EventBridge API Reference

ReplayDestination
A ReplayDestination object that contains details about a replay.

Contents
Arn

The ARN of the event bus to replay event to. You can replay events only to the event bus
specified to create the archive.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Required: Yes
FilterArns

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 Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

ReplayDestination API Version 2015-10-07 359

Amazon EventBridge API Reference

ReplicationConfig
Endpoints can replicate all events to the secondary Region.

Contents
State

The state of event replication.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

ReplicationConfig API Version 2015-10-07 360

Amazon EventBridge API Reference

RetryPolicy
A RetryPolicy object that includes information about the retry policy settings.

Contents
MaximumEventAgeInSeconds

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: No
MaximumRetryAttempts

The maximum number of retry attempts to make before the request fails. Retry attempts
continue until either the maximum number of attempts is made or until the duration of the
MaximumEventAgeInSeconds is met.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 185.

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

RetryPolicy API Version 2015-10-07 361

Amazon EventBridge API Reference

RoutingConfig
The routing configuration of the endpoint.

Contents
FailoverConfig

The failover configuration for an endpoint. This includes what triggers failover and what
happens when it's triggered.

Type: FailoverConfig object

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

RoutingConfig API Version 2015-10-07 362

Amazon EventBridge API Reference

Rule
Contains information about a rule in Amazon EventBridge.

Contents
Arn

The Amazon Resource Name (ARN) of the rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Required: No
Description

The description of the rule.

Type: String

Length Constraints: Maximum length of 512.

Required: No
EventBusName

The name or ARN 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: No
EventPattern

The event pattern of the rule. For more information, see Events and Event Patterns in the
Amazon EventBridge User Guide .

Type: String

Rule API Version 2015-10-07 363

Amazon EventBridge API Reference

Length Constraints: Maximum length of 4096.

Required: No
ManagedBy

If the rule was created on behalf of your account by an AWS service, this field displays the
principal name of the service that created the rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No
Name

The name of the rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

Required: No
RoleArn

The Amazon Resource Name (ARN) of the role that is used for target invocation.

If you're setting an event bus in another account as the target and that account granted
permission to your account through an organization instead of directly by the account ID, you
must specify a RoleArn with proper permissions in the Target structure, instead of here in
this parameter.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Required: No
ScheduleExpression

The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more
information, see Creating an Amazon EventBridge rule that runs on a schedule.

Contents API Version 2015-10-07 364

Amazon EventBridge API Reference

Type: String

Length Constraints: Maximum length of 256.

Required: No
State

The state of the rule.

Valid values include:

• DISABLED: The rule is disabled. EventBridge does not match any events against the rule.
• ENABLED: The rule is enabled. EventBridge matches events against the rule, except for AWS
management events delivered through CloudTrail.
• ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all events,
including AWS management events delivered through CloudTrail.

Management events provide visibility into management operations that are performed on
resources in your AWS account. These are also known as control plane operations. For more
information, see Logging management events in the CloudTrail User Guide, and Filtering
management events from AWS services in the Amazon EventBridge User Guide .

This value is only valid for rules on the default event bus or custom event buses. It does not
apply to partner event buses.

Type: String

Valid Values: ENABLED | DISABLED |

ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 365

Amazon EventBridge API Reference

See Also API Version 2015-10-07 366

Amazon EventBridge API Reference

RunCommandParameters
This parameter contains the criteria (either InstanceIds or a tag) used to specify which EC2
instances are to be sent the command.

Contents
RunCommandTargets

Currently, we support including only one RunCommandTarget block, which specifies either an
array of InstanceIds or a tag.

Type: Array of RunCommandTarget objects

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

RunCommandParameters API Version 2015-10-07 367

Amazon EventBridge API Reference

RunCommandTarget
Information about the EC2 instances that are to be sent the command, specified as key-value pairs.
Each RunCommandTarget block can include only one key, but this key may specify multiple values.

Contents
Key

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: Yes
Values

If Key is tag: tag-key, Values is a list of tag values. If Key is InstanceIds, Values is a list of
Amazon 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 Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

RunCommandTarget API Version 2015-10-07 368

Amazon EventBridge API Reference

SageMakerPipelineParameter
Name/Value pair of a parameter to start execution of a SageMaker Model Building Pipeline.

Contents
Name

Name of parameter to start execution of a SageMaker Model Building Pipeline.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$

Required: Yes
Value

Value of parameter to start execution of a SageMaker Model Building Pipeline.

Type: String

Length Constraints: Maximum length of 1024.

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

SageMakerPipelineParameter API Version 2015-10-07 369

Amazon EventBridge API Reference

SageMakerPipelineParameters
These are custom parameters to use when the target is a SageMaker Model Building Pipeline that
starts based on EventBridge events.

Contents
PipelineParameterList

List of Parameter names and values for SageMaker Model Building Pipeline execution.

Type: Array of SageMakerPipelineParameter objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

SageMakerPipelineParameters API Version 2015-10-07 370

Amazon EventBridge API Reference

Secondary
The secondary Region that processes events when failover is triggered or replication is enabled.

Contents
Route

Defines the secondary Region.

Type: String

Length Constraints: Minimum length of 9. Maximum length of 20.

Pattern: ^[\-a-z0-9]+$

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Secondary API Version 2015-10-07 371

Amazon EventBridge API Reference

SqsParameters
This structure includes the custom parameter to be used when the target is an SQS FIFO queue.

Contents
MessageGroupId

The FIFO message group ID to use as the target.

Type: String

Length Constraints: Maximum length of 100.

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

SqsParameters API Version 2015-10-07 372

Amazon EventBridge API Reference

Tag
A key-value pair associated with an AWS resource. In EventBridge, rules and event buses support
tagging.

Contents
Key

A string you can use to assign a value. The combination of tag keys and values can help you
organize and categorize your resources.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes
Value

The value for the specified tag key.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Required: Yes

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Tag API Version 2015-10-07 373

Amazon EventBridge API Reference

Target
Targets are the resources to be invoked when a rule is triggered. For a complete list of services and
resources that can be set as a target, see PutTargets.

If you are setting the event bus of another account as the target, and that account granted
permission to your account through an organization instead of directly by the account ID, then you
must specify a RoleArn with proper permissions in the Target structure. For more information,
see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide.

Contents
Arn

The Amazon Resource Name (ARN) of the target.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Required: Yes
Id

The ID of the target within the specified rule. Use this ID to reference the target when updating
the rule. We recommend using a memorable and unique string.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

Required: Yes
AppSyncParameters

Contains the GraphQL operation to be parsed and executed, if the event target is an AWS
AppSync API.

Type: AppSyncParameters object

Target API Version 2015-10-07 374

Amazon EventBridge API Reference

Required: No
BatchParameters

If the event target is an AWS Batch job, this contains the job definition, job name, and other
parameters. For more information, see Jobs in the AWS Batch User Guide.

Type: BatchParameters object

Required: No
DeadLetterConfig

The DeadLetterConfig that defines the target queue to send dead-letter queue events to.

Type: DeadLetterConfig object

Required: No
EcsParameters

Contains the Amazon ECS task definition and task count to be used, if the event target is an
Amazon ECS task. For more information about Amazon ECS tasks, see Task Definitions in the
Amazon EC2 Container Service Developer Guide.

Type: EcsParameters object

Required: No
HttpParameters

Contains the HTTP parameters to use when the target is a API Gateway endpoint or EventBridge
ApiDestination.

If you specify an API Gateway API or EventBridge ApiDestination as a target, you can use this
parameter to specify headers, path parameters, and query string keys/values as part of your
target invoking request. If you're using ApiDestinations, the corresponding Connection can also
have these values configured. In case of any conflicting keys, values from the Connection take
precedence.

Type: HttpParameters object

Required: No

Contents API Version 2015-10-07 375

Amazon EventBridge API Reference

Input

Valid JSON text passed to the target. In this case, nothing from the event itself is passed to
the target. For more information, see The JavaScript Object Notation (JSON) Data Interchange
Format.

Type: String

Length Constraints: Maximum length of 8192.

Required: No
InputPath

The value of the JSONPath that is used for extracting part of the matched event when passing
it to the target. You may use JSON dot notation or bracket notation. For more information
about JSON paths, see JSONPath.

Type: String

Length Constraints: Maximum length of 256.

Required: No
InputTransformer

Settings to enable you to provide custom input to a target based on certain event data. You can
extract one or more key-value pairs from the event and then use that data to send customized
input to the target.

Type: InputTransformer object

Required: No
KinesisParameters

The custom parameter you can use to control the shard assignment, when the target is a Kinesis
data stream. If you do not include this parameter, the default is to use the eventId as the
partition key.

Type: KinesisParameters object

Required: No

Contents API Version 2015-10-07 376

Amazon EventBridge API Reference

RedshiftDataParameters

Contains the Amazon Redshift Data API parameters to use when the target is a Amazon
Redshift cluster.

If you specify a Amazon Redshift Cluster as a Target, you can use this to specify parameters to
invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.

Type: RedshiftDataParameters object

Required: No
RetryPolicy

The RetryPolicy object that contains the retry policy configuration to use for the dead-letter
queue.

Type: RetryPolicy object

Required: No
RoleArn

The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is
triggered. 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: No
RunCommandParameters

Parameters used when you are using the rule to invoke Amazon EC2 Run Command.

Type: RunCommandParameters object

Required: No
SageMakerPipelineParameters

Contains the SageMaker Model Building Pipeline parameters to start execution of a SageMaker
Model Building Pipeline.

Contents API Version 2015-10-07 377

Amazon EventBridge API Reference

If you specify a SageMaker Model Building Pipeline as a target, you can use this to specify
parameters to start a pipeline execution based on EventBridge events.

Type: SageMakerPipelineParameters object

Required: No
SqsParameters

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 deduplication
enabled.

Type: SqsParameters object

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 378

Amazon EventBridge API Reference

UpdateConnectionApiKeyAuthRequestParameters
Contains the API key authorization parameters to use to update the connection.

Contents
ApiKeyName

The name of the API key to use for authorization.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: ^[ \t]*[^\x00-\x1F:\x7F]+([ \t]+[^\x00-\x1F:\x7F]+)*[ \t]*$

Required: No
ApiKeyValue

The value associated with teh API key to use for authorization.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: ^[ \t]*[^\x00-\x1F:\x7F]+([ \t]+[^\x00-\x1F:\x7F]+)*[ \t]*$

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

UpdateConnectionApiKeyAuthRequestParameters API Version 2015-10-07 379

Amazon EventBridge API Reference

UpdateConnectionAuthRequestParameters
Contains the additional parameters to use for the connection.

Contents
ApiKeyAuthParameters

A UpdateConnectionApiKeyAuthRequestParameters object that contains the

authorization parameters for API key authorization.

Type: UpdateConnectionApiKeyAuthRequestParameters object

Required: No

BasicAuthParameters

A UpdateConnectionBasicAuthRequestParameters object that contains the authorization

parameters for Basic authorization.

Type: UpdateConnectionBasicAuthRequestParameters object

Required: No

InvocationHttpParameters

A ConnectionHttpParameters object that contains the additional parameters to use for the
connection.

Type: ConnectionHttpParameters object

Required: No

OAuthParameters

A UpdateConnectionOAuthRequestParameters object that contains the authorization

parameters for OAuth authorization.

Type: UpdateConnectionOAuthRequestParameters object

Required: No

UpdateConnectionAuthRequestParameters API Version 2015-10-07 380

Amazon EventBridge API Reference

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 381

Amazon EventBridge API Reference

UpdateConnectionBasicAuthRequestParameters
Contains the Basic authorization parameters for the connection.

Contents
Password

The password associated with the user name to use for Basic authorization.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: ^[ \t]*[^\x00-\x1F:\x7F]+([ \t]+[^\x00-\x1F:\x7F]+)*[ \t]*$

Required: No
Username

The user name to use for Basic authorization.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: ^[ \t]*[^\x00-\x1F:\x7F]+([ \t]+[^\x00-\x1F:\x7F]+)*[ \t]*$

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

UpdateConnectionBasicAuthRequestParameters API Version 2015-10-07 382

Amazon EventBridge API Reference

UpdateConnectionOAuthClientRequestParameters
Contains the OAuth authorization parameters to use for the connection.

Contents
ClientID

The client ID to use for OAuth authorization.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: ^[ \t]*[^\x00-\x1F:\x7F]+([ \t]+[^\x00-\x1F:\x7F]+)*[ \t]*$

Required: No
ClientSecret

The client secret assciated with the client ID to use for OAuth authorization.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: ^[ \t]*[^\x00-\x1F:\x7F]+([ \t]+[^\x00-\x1F:\x7F]+)*[ \t]*$

Required: No

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

UpdateConnectionOAuthClientRequestParameters API Version 2015-10-07 383

Amazon EventBridge API Reference

UpdateConnectionOAuthRequestParameters
Contains the OAuth request parameters to use for the connection.

Contents
AuthorizationEndpoint

The URL to the authorization endpoint when OAuth is specified as the authorization type.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^((%[0-9A-Fa-f]{2}|[-()_.!~*';/?:@\x26=+$,A-Za-z0-9])+)
([).!';/?:,])?$

Required: No
ClientParameters

A UpdateConnectionOAuthClientRequestParameters object that contains the client

parameters to use for the connection when OAuth is specified as the authorization type.

Type: UpdateConnectionOAuthClientRequestParameters object

Required: No
HttpMethod

The method used to connect to the HTTP endpoint.

Type: String

Valid Values: GET | POST | PUT

Required: No
OAuthHttpParameters

The additional HTTP parameters used for the OAuth authorization request.

Type: ConnectionHttpParameters object

Required: No

UpdateConnectionOAuthRequestParameters API Version 2015-10-07 384

Amazon EventBridge API Reference

See Also
For more information about using this API in one of the language-specific AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

See Also API Version 2015-10-07 385

Amazon EventBridge API Reference

Making API Requests

Query requests used with EventBridge are HTTP or HTTPS requests that use the HTTP verb GET or
POST and a Query parameter named Action or Operation. This documentation uses Action,
although Operation is supported for backward compatibility.

EventBridge Endpoints
An endpoint is a URL that serves as an entry point for a web service. You can select a regional
endpoint when you make your requests to reduce latency. For information about the endpoints
used with EventBridge, see Regions and Endpoints in the Amazon Web Services General Reference.

Query Parameters
Each query request must include some common parameters to handle authentication and selection
of an action. For more information, see Common Parameters.

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
this notation, including lists that contain only one parameter. For example, a Query parameter list
looks like this:

&attribute.member.1=this
&attribute.member.2=that

Request Identifiers
In every response from an AWS Query API, there is a ResponseMetadata element, which contains
a RequestId 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 API documentation pages to improve readability and to reduce redundancy.

Query API Authentication

You can send query requests over either HTTP or HTTPS. Regardless of which protocol you use,
you must include a signature in every query request. For more information about creating and
including a signature, see Signing AWS API Requests in the Amazon Web Services General Reference.

EventBridge Endpoints API Version 2015-10-07 386

Amazon EventBridge API Reference

Available Libraries
AWS provides libraries, sample code, tutorials, and other resources for software developers who
prefer to 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 retries, and error handling so that it is easier to get started. Libraries and
resources are available for the following 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.

Available Libraries API Version 2015-10-07 387

Amazon EventBridge API Reference

Common Parameters
The following list contains the parameters that all actions use for signing Signature Version 4
requests with a query string. Any action-specific parameters are listed in the topic for that action.
For more information about Signature Version 4, see Signing AWS API requests in the IAM User
Guide.

Action

The action to be performed.

Type: string

Required: Yes
Version

The API version that the request is written for, expressed in the format YYYY-MM-DD.

Type: string

Required: Yes
X-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
string instead of in the HTTP authorization header.

Type: string

Valid Values: AWS4-HMAC-SHA256

Required: Conditional
X-Amz-Credential

The credential scope value, which is a string that includes your access key, the date, the region
you are targeting, the service you are requesting, and a termination string ("aws4_request").
The value is expressed in the following format: access_key/YYYYMMDD/region/service/
aws4_request.

API Version 2015-10-07 388

Amazon EventBridge API Reference

For more information, see Create a signed AWS API request in the IAM User Guide.

Condition: Specify this parameter when you include authentication information in a query
string instead of in the HTTP authorization header.

Type: string

Required: Conditional
X-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 for
signing requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is not
required. When X-Amz-Date is used, it always overrides the value of the Date header. For more
information, see Elements of an AWS API request signature in the IAM User Guide.

Type: string

Required: Conditional
X-Amz-Security-Token

The temporary security token that was obtained through a call to AWS Security Token Service
(AWS STS). For a list of services that support temporary security credentials from AWS STS, see
AWS services that work with IAM in the IAM User Guide.

Condition: If you're using temporary security credentials from AWS STS, you must include the
security token.

Type: string

Required: Conditional
X-Amz-Signature

Specifies the hex-encoded signature that was calculated from the string to sign and the derived
signing key.

Condition: Specify this parameter when you include authentication information in a query
string instead of in the HTTP authorization header.

API Version 2015-10-07 389

Amazon EventBridge API Reference

Type: string

Required: Conditional
X-Amz-SignedHeaders

Specifies all the HTTP headers that were included as part of the canonical request. For more
information about specifying signed headers, see Create a signed AWS API request in the IAM
User Guide.

Condition: Specify this parameter when you include authentication information in a query
string instead of in the HTTP authorization header.

Type: string

Required: Conditional

API Version 2015-10-07 390

Amazon EventBridge API Reference

Common Errors
This section lists the errors common to the API actions of all AWS services. For errors specific to an
API action for this service, see the topic for that API action.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400

IncompleteSignature

The request signature does not conform to AWS standards.

HTTP Status Code: 400

InternalFailure

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

InvalidAction

The action or operation requested is invalid. Verify that the action is typed correctly.

HTTP Status Code: 400

InvalidClientTokenId

The X.509 certificate or AWS access key ID provided does not exist in our records.

HTTP Status Code: 403

NotAuthorized

You do not have permission to perform this action.

HTTP Status Code: 400

OptInRequired

The AWS access key ID needs a subscription for the service.

HTTP Status Code: 403

API Version 2015-10-07 391

Amazon EventBridge API Reference

RequestExpired

The request reached the service more than 15 minutes after the date stamp on the request or
more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the
date stamp on the request is more than 15 minutes in the future.

HTTP Status Code: 400

ServiceUnavailable

The request has failed due to a temporary failure of the server.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationError

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

API Version 2015-10-07 392