@aws-sdk/client-eventbridge 3.315.0 → 3.319.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/EventBridge.js +60 -784
- package/dist-es/EventBridge.js +60 -784
- package/dist-types/EventBridge.d.ts +83 -499
- package/dist-types/ts3.4/EventBridge.d.ts +4 -1
- package/package.json +8 -8
|
@@ -56,783 +56,367 @@ import { UpdateArchiveCommandInput, UpdateArchiveCommandOutput } from "./command
|
|
|
56
56
|
import { UpdateConnectionCommandInput, UpdateConnectionCommandOutput } from "./commands/UpdateConnectionCommand";
|
|
57
57
|
import { UpdateEndpointCommandInput, UpdateEndpointCommandOutput } from "./commands/UpdateEndpointCommand";
|
|
58
58
|
import { EventBridgeClient } from "./EventBridgeClient";
|
|
59
|
-
|
|
60
|
-
* @public
|
|
61
|
-
* <p>Amazon EventBridge helps you to respond to state changes in your Amazon Web Services resources. When your
|
|
62
|
-
* resources change state, they automatically send events to an event stream. You can create
|
|
63
|
-
* rules that match selected events in the stream and route them to targets to take action. You
|
|
64
|
-
* can also use rules to take action on a predetermined schedule. For example, you can configure
|
|
65
|
-
* rules to:</p>
|
|
66
|
-
* <ul>
|
|
67
|
-
* <li>
|
|
68
|
-
* <p>Automatically invoke an Lambda function to update DNS entries when an event
|
|
69
|
-
* notifies you that Amazon EC2 instance enters the running state.</p>
|
|
70
|
-
* </li>
|
|
71
|
-
* <li>
|
|
72
|
-
* <p>Direct specific API records from CloudTrail to an Amazon Kinesis data stream for
|
|
73
|
-
* detailed analysis of potential security or availability risks.</p>
|
|
74
|
-
* </li>
|
|
75
|
-
* <li>
|
|
76
|
-
* <p>Periodically invoke a built-in target to create a snapshot of an Amazon EBS
|
|
77
|
-
* volume.</p>
|
|
78
|
-
* </li>
|
|
79
|
-
* </ul>
|
|
80
|
-
* <p>For more information about the features of Amazon EventBridge, see the <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide">Amazon EventBridge User
|
|
81
|
-
* Guide</a>.</p>
|
|
82
|
-
*/
|
|
83
|
-
export declare class EventBridge extends EventBridgeClient {
|
|
59
|
+
export interface EventBridge {
|
|
84
60
|
/**
|
|
85
|
-
* @
|
|
86
|
-
* <p>Activates a partner event source that has been deactivated. Once activated, your matching
|
|
87
|
-
* event bus will start receiving events from the event source.</p>
|
|
61
|
+
* @see {@link ActivateEventSourceCommand}
|
|
88
62
|
*/
|
|
89
63
|
activateEventSource(args: ActivateEventSourceCommandInput, options?: __HttpHandlerOptions): Promise<ActivateEventSourceCommandOutput>;
|
|
90
64
|
activateEventSource(args: ActivateEventSourceCommandInput, cb: (err: any, data?: ActivateEventSourceCommandOutput) => void): void;
|
|
91
65
|
activateEventSource(args: ActivateEventSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ActivateEventSourceCommandOutput) => void): void;
|
|
92
66
|
/**
|
|
93
|
-
* @
|
|
94
|
-
* <p>Cancels the specified replay.</p>
|
|
67
|
+
* @see {@link CancelReplayCommand}
|
|
95
68
|
*/
|
|
96
69
|
cancelReplay(args: CancelReplayCommandInput, options?: __HttpHandlerOptions): Promise<CancelReplayCommandOutput>;
|
|
97
70
|
cancelReplay(args: CancelReplayCommandInput, cb: (err: any, data?: CancelReplayCommandOutput) => void): void;
|
|
98
71
|
cancelReplay(args: CancelReplayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelReplayCommandOutput) => void): void;
|
|
99
72
|
/**
|
|
100
|
-
* @
|
|
101
|
-
* <p>Creates an API destination, which is an HTTP invocation endpoint configured as a target
|
|
102
|
-
* for events.</p>
|
|
73
|
+
* @see {@link CreateApiDestinationCommand}
|
|
103
74
|
*/
|
|
104
75
|
createApiDestination(args: CreateApiDestinationCommandInput, options?: __HttpHandlerOptions): Promise<CreateApiDestinationCommandOutput>;
|
|
105
76
|
createApiDestination(args: CreateApiDestinationCommandInput, cb: (err: any, data?: CreateApiDestinationCommandOutput) => void): void;
|
|
106
77
|
createApiDestination(args: CreateApiDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateApiDestinationCommandOutput) => void): void;
|
|
107
78
|
/**
|
|
108
|
-
* @
|
|
109
|
-
* <p>Creates an archive of events with the specified settings. When you create an archive,
|
|
110
|
-
* incoming events might not immediately start being sent to the archive. Allow a short period of
|
|
111
|
-
* time for changes to take effect. If you do not specify a pattern to filter events sent to the
|
|
112
|
-
* archive, all events are sent to the archive except replayed events. Replayed events are not
|
|
113
|
-
* sent to an archive.</p>
|
|
79
|
+
* @see {@link CreateArchiveCommand}
|
|
114
80
|
*/
|
|
115
81
|
createArchive(args: CreateArchiveCommandInput, options?: __HttpHandlerOptions): Promise<CreateArchiveCommandOutput>;
|
|
116
82
|
createArchive(args: CreateArchiveCommandInput, cb: (err: any, data?: CreateArchiveCommandOutput) => void): void;
|
|
117
83
|
createArchive(args: CreateArchiveCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateArchiveCommandOutput) => void): void;
|
|
118
84
|
/**
|
|
119
|
-
* @
|
|
120
|
-
* <p>Creates a connection. A connection defines the authorization type and credentials to use
|
|
121
|
-
* for authorization with an API destination HTTP endpoint.</p>
|
|
85
|
+
* @see {@link CreateConnectionCommand}
|
|
122
86
|
*/
|
|
123
87
|
createConnection(args: CreateConnectionCommandInput, options?: __HttpHandlerOptions): Promise<CreateConnectionCommandOutput>;
|
|
124
88
|
createConnection(args: CreateConnectionCommandInput, cb: (err: any, data?: CreateConnectionCommandOutput) => void): void;
|
|
125
89
|
createConnection(args: CreateConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConnectionCommandOutput) => void): void;
|
|
126
90
|
/**
|
|
127
|
-
* @
|
|
128
|
-
* <p>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
|
|
129
|
-
* 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
|
|
130
|
-
* is encountered and events will be routed back to the primary Region when the health check reports a "healthy" state.</p>
|
|
91
|
+
* @see {@link CreateEndpointCommand}
|
|
131
92
|
*/
|
|
132
93
|
createEndpoint(args: CreateEndpointCommandInput, options?: __HttpHandlerOptions): Promise<CreateEndpointCommandOutput>;
|
|
133
94
|
createEndpoint(args: CreateEndpointCommandInput, cb: (err: any, data?: CreateEndpointCommandOutput) => void): void;
|
|
134
95
|
createEndpoint(args: CreateEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEndpointCommandOutput) => void): void;
|
|
135
96
|
/**
|
|
136
|
-
* @
|
|
137
|
-
* <p>Creates a new event bus within your account. This can be a custom event bus which you can
|
|
138
|
-
* use to receive events from your custom applications and services, or it can be a partner event
|
|
139
|
-
* bus which can be matched to a partner event source.</p>
|
|
97
|
+
* @see {@link CreateEventBusCommand}
|
|
140
98
|
*/
|
|
141
99
|
createEventBus(args: CreateEventBusCommandInput, options?: __HttpHandlerOptions): Promise<CreateEventBusCommandOutput>;
|
|
142
100
|
createEventBus(args: CreateEventBusCommandInput, cb: (err: any, data?: CreateEventBusCommandOutput) => void): void;
|
|
143
101
|
createEventBus(args: CreateEventBusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEventBusCommandOutput) => void): void;
|
|
144
102
|
/**
|
|
145
|
-
* @
|
|
146
|
-
* <p>Called by an SaaS partner to create a partner event source. This operation is not used by
|
|
147
|
-
* Amazon Web Services customers.</p>
|
|
148
|
-
* <p>Each partner event source can be used by one Amazon Web Services account to create a matching partner
|
|
149
|
-
* event bus in that Amazon Web Services account. A SaaS partner must create one partner event source for each
|
|
150
|
-
* Amazon Web Services account that wants to receive those event types. </p>
|
|
151
|
-
* <p>A partner event source creates events based on resources within the SaaS partner's service
|
|
152
|
-
* or application.</p>
|
|
153
|
-
* <p>An Amazon Web Services account that creates a partner event bus that matches the partner event source can
|
|
154
|
-
* use that event bus to receive events from the partner, and then process them using Amazon Web Services Events
|
|
155
|
-
* rules and targets.</p>
|
|
156
|
-
* <p>Partner event source names follow this format:</p>
|
|
157
|
-
* <p>
|
|
158
|
-
* <code>
|
|
159
|
-
* <i>partner_name</i>/<i>event_namespace</i>/<i>event_name</i>
|
|
160
|
-
* </code>
|
|
161
|
-
* </p>
|
|
162
|
-
* <p>
|
|
163
|
-
* <i>partner_name</i> is determined during partner registration and identifies
|
|
164
|
-
* the partner to Amazon Web Services customers. <i>event_namespace</i> is determined by the
|
|
165
|
-
* partner and is a way for the partner to categorize their events.
|
|
166
|
-
* <i>event_name</i> is determined by the partner, and should uniquely identify
|
|
167
|
-
* an event-generating resource within the partner system. The combination of
|
|
168
|
-
* <i>event_namespace</i> and <i>event_name</i> should help Amazon Web Services
|
|
169
|
-
* customers decide whether to create an event bus to receive these events.</p>
|
|
103
|
+
* @see {@link CreatePartnerEventSourceCommand}
|
|
170
104
|
*/
|
|
171
105
|
createPartnerEventSource(args: CreatePartnerEventSourceCommandInput, options?: __HttpHandlerOptions): Promise<CreatePartnerEventSourceCommandOutput>;
|
|
172
106
|
createPartnerEventSource(args: CreatePartnerEventSourceCommandInput, cb: (err: any, data?: CreatePartnerEventSourceCommandOutput) => void): void;
|
|
173
107
|
createPartnerEventSource(args: CreatePartnerEventSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePartnerEventSourceCommandOutput) => void): void;
|
|
174
108
|
/**
|
|
175
|
-
* @
|
|
176
|
-
* <p>You can use this operation to temporarily stop receiving events from the specified partner
|
|
177
|
-
* event source. The matching event bus is not deleted. </p>
|
|
178
|
-
* <p>When you deactivate a partner event source, the source goes into PENDING state. If it
|
|
179
|
-
* remains in PENDING state for more than two weeks, it is deleted.</p>
|
|
180
|
-
* <p>To activate a deactivated partner event source, use <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ActivateEventSource.html">ActivateEventSource</a>.</p>
|
|
109
|
+
* @see {@link DeactivateEventSourceCommand}
|
|
181
110
|
*/
|
|
182
111
|
deactivateEventSource(args: DeactivateEventSourceCommandInput, options?: __HttpHandlerOptions): Promise<DeactivateEventSourceCommandOutput>;
|
|
183
112
|
deactivateEventSource(args: DeactivateEventSourceCommandInput, cb: (err: any, data?: DeactivateEventSourceCommandOutput) => void): void;
|
|
184
113
|
deactivateEventSource(args: DeactivateEventSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeactivateEventSourceCommandOutput) => void): void;
|
|
185
114
|
/**
|
|
186
|
-
* @
|
|
187
|
-
* <p>Removes all authorization parameters from the connection. This lets you remove the secret
|
|
188
|
-
* from the connection so you can reuse it without having to create a new connection.</p>
|
|
115
|
+
* @see {@link DeauthorizeConnectionCommand}
|
|
189
116
|
*/
|
|
190
117
|
deauthorizeConnection(args: DeauthorizeConnectionCommandInput, options?: __HttpHandlerOptions): Promise<DeauthorizeConnectionCommandOutput>;
|
|
191
118
|
deauthorizeConnection(args: DeauthorizeConnectionCommandInput, cb: (err: any, data?: DeauthorizeConnectionCommandOutput) => void): void;
|
|
192
119
|
deauthorizeConnection(args: DeauthorizeConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeauthorizeConnectionCommandOutput) => void): void;
|
|
193
120
|
/**
|
|
194
|
-
* @
|
|
195
|
-
* <p>Deletes the specified API destination.</p>
|
|
121
|
+
* @see {@link DeleteApiDestinationCommand}
|
|
196
122
|
*/
|
|
197
123
|
deleteApiDestination(args: DeleteApiDestinationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteApiDestinationCommandOutput>;
|
|
198
124
|
deleteApiDestination(args: DeleteApiDestinationCommandInput, cb: (err: any, data?: DeleteApiDestinationCommandOutput) => void): void;
|
|
199
125
|
deleteApiDestination(args: DeleteApiDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApiDestinationCommandOutput) => void): void;
|
|
200
126
|
/**
|
|
201
|
-
* @
|
|
202
|
-
* <p>Deletes the specified archive.</p>
|
|
127
|
+
* @see {@link DeleteArchiveCommand}
|
|
203
128
|
*/
|
|
204
129
|
deleteArchive(args: DeleteArchiveCommandInput, options?: __HttpHandlerOptions): Promise<DeleteArchiveCommandOutput>;
|
|
205
130
|
deleteArchive(args: DeleteArchiveCommandInput, cb: (err: any, data?: DeleteArchiveCommandOutput) => void): void;
|
|
206
131
|
deleteArchive(args: DeleteArchiveCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteArchiveCommandOutput) => void): void;
|
|
207
132
|
/**
|
|
208
|
-
* @
|
|
209
|
-
* <p>Deletes a connection.</p>
|
|
133
|
+
* @see {@link DeleteConnectionCommand}
|
|
210
134
|
*/
|
|
211
135
|
deleteConnection(args: DeleteConnectionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteConnectionCommandOutput>;
|
|
212
136
|
deleteConnection(args: DeleteConnectionCommandInput, cb: (err: any, data?: DeleteConnectionCommandOutput) => void): void;
|
|
213
137
|
deleteConnection(args: DeleteConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConnectionCommandOutput) => void): void;
|
|
214
138
|
/**
|
|
215
|
-
* @
|
|
216
|
-
* <p>Delete an existing global endpoint. For more information about global endpoints, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html">Making applications Regional-fault tolerant with global endpoints and event replication</a> in the Amazon EventBridge User Guide.</p>
|
|
139
|
+
* @see {@link DeleteEndpointCommand}
|
|
217
140
|
*/
|
|
218
141
|
deleteEndpoint(args: DeleteEndpointCommandInput, options?: __HttpHandlerOptions): Promise<DeleteEndpointCommandOutput>;
|
|
219
142
|
deleteEndpoint(args: DeleteEndpointCommandInput, cb: (err: any, data?: DeleteEndpointCommandOutput) => void): void;
|
|
220
143
|
deleteEndpoint(args: DeleteEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEndpointCommandOutput) => void): void;
|
|
221
144
|
/**
|
|
222
|
-
* @
|
|
223
|
-
* <p>Deletes the specified custom event bus or partner event bus. All rules associated with
|
|
224
|
-
* this event bus need to be deleted. You can't delete your account's default event bus.</p>
|
|
145
|
+
* @see {@link DeleteEventBusCommand}
|
|
225
146
|
*/
|
|
226
147
|
deleteEventBus(args: DeleteEventBusCommandInput, options?: __HttpHandlerOptions): Promise<DeleteEventBusCommandOutput>;
|
|
227
148
|
deleteEventBus(args: DeleteEventBusCommandInput, cb: (err: any, data?: DeleteEventBusCommandOutput) => void): void;
|
|
228
149
|
deleteEventBus(args: DeleteEventBusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEventBusCommandOutput) => void): void;
|
|
229
150
|
/**
|
|
230
|
-
* @
|
|
231
|
-
* <p>This operation is used by SaaS partners to delete a partner event source. This operation
|
|
232
|
-
* is not used by Amazon Web Services customers.</p>
|
|
233
|
-
* <p>When you delete an event source, the status of the corresponding partner event bus in the
|
|
234
|
-
* Amazon Web Services customer account becomes DELETED.</p>
|
|
235
|
-
* <p></p>
|
|
151
|
+
* @see {@link DeletePartnerEventSourceCommand}
|
|
236
152
|
*/
|
|
237
153
|
deletePartnerEventSource(args: DeletePartnerEventSourceCommandInput, options?: __HttpHandlerOptions): Promise<DeletePartnerEventSourceCommandOutput>;
|
|
238
154
|
deletePartnerEventSource(args: DeletePartnerEventSourceCommandInput, cb: (err: any, data?: DeletePartnerEventSourceCommandOutput) => void): void;
|
|
239
155
|
deletePartnerEventSource(args: DeletePartnerEventSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePartnerEventSourceCommandOutput) => void): void;
|
|
240
156
|
/**
|
|
241
|
-
* @
|
|
242
|
-
* <p>Deletes the specified rule.</p>
|
|
243
|
-
* <p>Before you can delete the rule, you must remove all targets, using <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemoveTargets.html">RemoveTargets</a>.</p>
|
|
244
|
-
* <p>When you delete a rule, incoming events might continue to match to the deleted rule. Allow
|
|
245
|
-
* a short period of time for changes to take effect.</p>
|
|
246
|
-
* <p>If you call delete rule multiple times for the same rule, all calls will succeed. When you
|
|
247
|
-
* call delete rule for a non-existent custom eventbus, <code>ResourceNotFoundException</code> is
|
|
248
|
-
* returned.</p>
|
|
249
|
-
* <p>Managed rules are rules created and managed by another Amazon Web Services service on your behalf. These
|
|
250
|
-
* rules are created by those other Amazon Web Services services to support functionality in those services. You
|
|
251
|
-
* can delete these rules using the <code>Force</code> option, but you should do so only if you
|
|
252
|
-
* are sure the other service is not still using that rule.</p>
|
|
157
|
+
* @see {@link DeleteRuleCommand}
|
|
253
158
|
*/
|
|
254
159
|
deleteRule(args: DeleteRuleCommandInput, options?: __HttpHandlerOptions): Promise<DeleteRuleCommandOutput>;
|
|
255
160
|
deleteRule(args: DeleteRuleCommandInput, cb: (err: any, data?: DeleteRuleCommandOutput) => void): void;
|
|
256
161
|
deleteRule(args: DeleteRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRuleCommandOutput) => void): void;
|
|
257
162
|
/**
|
|
258
|
-
* @
|
|
259
|
-
* <p>Retrieves details about an API destination.</p>
|
|
163
|
+
* @see {@link DescribeApiDestinationCommand}
|
|
260
164
|
*/
|
|
261
165
|
describeApiDestination(args: DescribeApiDestinationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeApiDestinationCommandOutput>;
|
|
262
166
|
describeApiDestination(args: DescribeApiDestinationCommandInput, cb: (err: any, data?: DescribeApiDestinationCommandOutput) => void): void;
|
|
263
167
|
describeApiDestination(args: DescribeApiDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeApiDestinationCommandOutput) => void): void;
|
|
264
168
|
/**
|
|
265
|
-
* @
|
|
266
|
-
* <p>Retrieves details about an archive.</p>
|
|
169
|
+
* @see {@link DescribeArchiveCommand}
|
|
267
170
|
*/
|
|
268
171
|
describeArchive(args: DescribeArchiveCommandInput, options?: __HttpHandlerOptions): Promise<DescribeArchiveCommandOutput>;
|
|
269
172
|
describeArchive(args: DescribeArchiveCommandInput, cb: (err: any, data?: DescribeArchiveCommandOutput) => void): void;
|
|
270
173
|
describeArchive(args: DescribeArchiveCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeArchiveCommandOutput) => void): void;
|
|
271
174
|
/**
|
|
272
|
-
* @
|
|
273
|
-
* <p>Retrieves details about a connection.</p>
|
|
175
|
+
* @see {@link DescribeConnectionCommand}
|
|
274
176
|
*/
|
|
275
177
|
describeConnection(args: DescribeConnectionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeConnectionCommandOutput>;
|
|
276
178
|
describeConnection(args: DescribeConnectionCommandInput, cb: (err: any, data?: DescribeConnectionCommandOutput) => void): void;
|
|
277
179
|
describeConnection(args: DescribeConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConnectionCommandOutput) => void): void;
|
|
278
180
|
/**
|
|
279
|
-
* @
|
|
280
|
-
* <p>Get the information about an existing global endpoint. For more information about global endpoints, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html">Making applications Regional-fault tolerant with global endpoints and event replication</a> in the Amazon EventBridge User Guide..</p>
|
|
181
|
+
* @see {@link DescribeEndpointCommand}
|
|
281
182
|
*/
|
|
282
183
|
describeEndpoint(args: DescribeEndpointCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEndpointCommandOutput>;
|
|
283
184
|
describeEndpoint(args: DescribeEndpointCommandInput, cb: (err: any, data?: DescribeEndpointCommandOutput) => void): void;
|
|
284
185
|
describeEndpoint(args: DescribeEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEndpointCommandOutput) => void): void;
|
|
285
186
|
/**
|
|
286
|
-
* @
|
|
287
|
-
* <p>Displays details about an event bus in your account. This can include the external Amazon Web Services
|
|
288
|
-
* accounts that are permitted to write events to your default event bus, and the associated
|
|
289
|
-
* policy. For custom event buses and partner event buses, it displays the name, ARN, policy,
|
|
290
|
-
* state, and creation time.</p>
|
|
291
|
-
* <p> To enable your account to receive events from other accounts on its default event bus,
|
|
292
|
-
* use <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html">PutPermission</a>.</p>
|
|
293
|
-
* <p>For more information about partner event buses, see <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html">CreateEventBus</a>.</p>
|
|
187
|
+
* @see {@link DescribeEventBusCommand}
|
|
294
188
|
*/
|
|
295
189
|
describeEventBus(args: DescribeEventBusCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEventBusCommandOutput>;
|
|
296
190
|
describeEventBus(args: DescribeEventBusCommandInput, cb: (err: any, data?: DescribeEventBusCommandOutput) => void): void;
|
|
297
191
|
describeEventBus(args: DescribeEventBusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventBusCommandOutput) => void): void;
|
|
298
192
|
/**
|
|
299
|
-
* @
|
|
300
|
-
* <p>This operation lists details about a partner event source that is shared with your
|
|
301
|
-
* account.</p>
|
|
193
|
+
* @see {@link DescribeEventSourceCommand}
|
|
302
194
|
*/
|
|
303
195
|
describeEventSource(args: DescribeEventSourceCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEventSourceCommandOutput>;
|
|
304
196
|
describeEventSource(args: DescribeEventSourceCommandInput, cb: (err: any, data?: DescribeEventSourceCommandOutput) => void): void;
|
|
305
197
|
describeEventSource(args: DescribeEventSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventSourceCommandOutput) => void): void;
|
|
306
198
|
/**
|
|
307
|
-
* @
|
|
308
|
-
* <p>An SaaS partner can use this operation to list details about a partner event source that
|
|
309
|
-
* they have created. Amazon Web Services customers do not use this operation. Instead, Amazon Web Services customers can use <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DescribeEventSource.html">DescribeEventSource</a>
|
|
310
|
-
* to see details about a partner event source that is
|
|
311
|
-
* shared with them.</p>
|
|
199
|
+
* @see {@link DescribePartnerEventSourceCommand}
|
|
312
200
|
*/
|
|
313
201
|
describePartnerEventSource(args: DescribePartnerEventSourceCommandInput, options?: __HttpHandlerOptions): Promise<DescribePartnerEventSourceCommandOutput>;
|
|
314
202
|
describePartnerEventSource(args: DescribePartnerEventSourceCommandInput, cb: (err: any, data?: DescribePartnerEventSourceCommandOutput) => void): void;
|
|
315
203
|
describePartnerEventSource(args: DescribePartnerEventSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePartnerEventSourceCommandOutput) => void): void;
|
|
316
204
|
/**
|
|
317
|
-
* @
|
|
318
|
-
* <p>Retrieves details about a replay. Use <code>DescribeReplay</code> to determine the
|
|
319
|
-
* progress of a running replay. A replay processes events to replay based on the time in the
|
|
320
|
-
* event, and replays them using 1 minute intervals. If you use <code>StartReplay</code> and
|
|
321
|
-
* specify an <code>EventStartTime</code> and an <code>EventEndTime</code> that covers a 20
|
|
322
|
-
* minute time range, the events are replayed from the first minute of that 20 minute range
|
|
323
|
-
* first. Then the events from the second minute are replayed. You can use
|
|
324
|
-
* <code>DescribeReplay</code> to determine the progress of a replay. The value returned for
|
|
325
|
-
* <code>EventLastReplayedTime</code> indicates the time within the specified time range
|
|
326
|
-
* associated with the last event replayed.</p>
|
|
205
|
+
* @see {@link DescribeReplayCommand}
|
|
327
206
|
*/
|
|
328
207
|
describeReplay(args: DescribeReplayCommandInput, options?: __HttpHandlerOptions): Promise<DescribeReplayCommandOutput>;
|
|
329
208
|
describeReplay(args: DescribeReplayCommandInput, cb: (err: any, data?: DescribeReplayCommandOutput) => void): void;
|
|
330
209
|
describeReplay(args: DescribeReplayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReplayCommandOutput) => void): void;
|
|
331
210
|
/**
|
|
332
|
-
* @
|
|
333
|
-
* <p>Describes the specified rule.</p>
|
|
334
|
-
* <p>DescribeRule does not list the targets of a rule. To see the targets associated with a
|
|
335
|
-
* rule, use <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ListTargetsByRule.html">ListTargetsByRule</a>.</p>
|
|
211
|
+
* @see {@link DescribeRuleCommand}
|
|
336
212
|
*/
|
|
337
213
|
describeRule(args: DescribeRuleCommandInput, options?: __HttpHandlerOptions): Promise<DescribeRuleCommandOutput>;
|
|
338
214
|
describeRule(args: DescribeRuleCommandInput, cb: (err: any, data?: DescribeRuleCommandOutput) => void): void;
|
|
339
215
|
describeRule(args: DescribeRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRuleCommandOutput) => void): void;
|
|
340
216
|
/**
|
|
341
|
-
* @
|
|
342
|
-
* <p>Disables the specified rule. A disabled rule won't match any events, and won't
|
|
343
|
-
* self-trigger if it has a schedule expression.</p>
|
|
344
|
-
* <p>When you disable a rule, incoming events might continue to match to the disabled rule.
|
|
345
|
-
* Allow a short period of time for changes to take effect.</p>
|
|
217
|
+
* @see {@link DisableRuleCommand}
|
|
346
218
|
*/
|
|
347
219
|
disableRule(args: DisableRuleCommandInput, options?: __HttpHandlerOptions): Promise<DisableRuleCommandOutput>;
|
|
348
220
|
disableRule(args: DisableRuleCommandInput, cb: (err: any, data?: DisableRuleCommandOutput) => void): void;
|
|
349
221
|
disableRule(args: DisableRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableRuleCommandOutput) => void): void;
|
|
350
222
|
/**
|
|
351
|
-
* @
|
|
352
|
-
* <p>Enables the specified rule. If the rule does not exist, the operation fails.</p>
|
|
353
|
-
* <p>When you enable a rule, incoming events might not immediately start matching to a newly
|
|
354
|
-
* enabled rule. Allow a short period of time for changes to take effect.</p>
|
|
223
|
+
* @see {@link EnableRuleCommand}
|
|
355
224
|
*/
|
|
356
225
|
enableRule(args: EnableRuleCommandInput, options?: __HttpHandlerOptions): Promise<EnableRuleCommandOutput>;
|
|
357
226
|
enableRule(args: EnableRuleCommandInput, cb: (err: any, data?: EnableRuleCommandOutput) => void): void;
|
|
358
227
|
enableRule(args: EnableRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableRuleCommandOutput) => void): void;
|
|
359
228
|
/**
|
|
360
|
-
* @
|
|
361
|
-
* <p>Retrieves a list of API destination in the account in the current Region.</p>
|
|
229
|
+
* @see {@link ListApiDestinationsCommand}
|
|
362
230
|
*/
|
|
363
231
|
listApiDestinations(args: ListApiDestinationsCommandInput, options?: __HttpHandlerOptions): Promise<ListApiDestinationsCommandOutput>;
|
|
364
232
|
listApiDestinations(args: ListApiDestinationsCommandInput, cb: (err: any, data?: ListApiDestinationsCommandOutput) => void): void;
|
|
365
233
|
listApiDestinations(args: ListApiDestinationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApiDestinationsCommandOutput) => void): void;
|
|
366
234
|
/**
|
|
367
|
-
* @
|
|
368
|
-
* <p>Lists your archives. You can either list all the archives or you can provide a prefix to
|
|
369
|
-
* match to the archive names. Filter parameters are exclusive.</p>
|
|
235
|
+
* @see {@link ListArchivesCommand}
|
|
370
236
|
*/
|
|
371
237
|
listArchives(args: ListArchivesCommandInput, options?: __HttpHandlerOptions): Promise<ListArchivesCommandOutput>;
|
|
372
238
|
listArchives(args: ListArchivesCommandInput, cb: (err: any, data?: ListArchivesCommandOutput) => void): void;
|
|
373
239
|
listArchives(args: ListArchivesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListArchivesCommandOutput) => void): void;
|
|
374
240
|
/**
|
|
375
|
-
* @
|
|
376
|
-
* <p>Retrieves a list of connections from the account.</p>
|
|
241
|
+
* @see {@link ListConnectionsCommand}
|
|
377
242
|
*/
|
|
378
243
|
listConnections(args: ListConnectionsCommandInput, options?: __HttpHandlerOptions): Promise<ListConnectionsCommandOutput>;
|
|
379
244
|
listConnections(args: ListConnectionsCommandInput, cb: (err: any, data?: ListConnectionsCommandOutput) => void): void;
|
|
380
245
|
listConnections(args: ListConnectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConnectionsCommandOutput) => void): void;
|
|
381
246
|
/**
|
|
382
|
-
* @
|
|
383
|
-
* <p>List the global endpoints associated with this account. For more information about global endpoints, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html">Making applications Regional-fault tolerant with global endpoints and event replication</a> in the Amazon EventBridge User Guide..</p>
|
|
247
|
+
* @see {@link ListEndpointsCommand}
|
|
384
248
|
*/
|
|
385
249
|
listEndpoints(args: ListEndpointsCommandInput, options?: __HttpHandlerOptions): Promise<ListEndpointsCommandOutput>;
|
|
386
250
|
listEndpoints(args: ListEndpointsCommandInput, cb: (err: any, data?: ListEndpointsCommandOutput) => void): void;
|
|
387
251
|
listEndpoints(args: ListEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEndpointsCommandOutput) => void): void;
|
|
388
252
|
/**
|
|
389
|
-
* @
|
|
390
|
-
* <p>Lists all the event buses in your account, including the default event bus, custom event
|
|
391
|
-
* buses, and partner event buses.</p>
|
|
253
|
+
* @see {@link ListEventBusesCommand}
|
|
392
254
|
*/
|
|
393
255
|
listEventBuses(args: ListEventBusesCommandInput, options?: __HttpHandlerOptions): Promise<ListEventBusesCommandOutput>;
|
|
394
256
|
listEventBuses(args: ListEventBusesCommandInput, cb: (err: any, data?: ListEventBusesCommandOutput) => void): void;
|
|
395
257
|
listEventBuses(args: ListEventBusesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEventBusesCommandOutput) => void): void;
|
|
396
258
|
/**
|
|
397
|
-
* @
|
|
398
|
-
* <p>You can use this to see all the partner event sources that have been shared with your Amazon Web Services
|
|
399
|
-
* account. For more information about partner event sources, see <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html">CreateEventBus</a>.</p>
|
|
259
|
+
* @see {@link ListEventSourcesCommand}
|
|
400
260
|
*/
|
|
401
261
|
listEventSources(args: ListEventSourcesCommandInput, options?: __HttpHandlerOptions): Promise<ListEventSourcesCommandOutput>;
|
|
402
262
|
listEventSources(args: ListEventSourcesCommandInput, cb: (err: any, data?: ListEventSourcesCommandOutput) => void): void;
|
|
403
263
|
listEventSources(args: ListEventSourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEventSourcesCommandOutput) => void): void;
|
|
404
264
|
/**
|
|
405
|
-
* @
|
|
406
|
-
* <p>An SaaS partner can use this operation to display the Amazon Web Services account ID that a particular
|
|
407
|
-
* partner event source name is associated with. This operation is not used by Amazon Web Services
|
|
408
|
-
* customers.</p>
|
|
265
|
+
* @see {@link ListPartnerEventSourceAccountsCommand}
|
|
409
266
|
*/
|
|
410
267
|
listPartnerEventSourceAccounts(args: ListPartnerEventSourceAccountsCommandInput, options?: __HttpHandlerOptions): Promise<ListPartnerEventSourceAccountsCommandOutput>;
|
|
411
268
|
listPartnerEventSourceAccounts(args: ListPartnerEventSourceAccountsCommandInput, cb: (err: any, data?: ListPartnerEventSourceAccountsCommandOutput) => void): void;
|
|
412
269
|
listPartnerEventSourceAccounts(args: ListPartnerEventSourceAccountsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPartnerEventSourceAccountsCommandOutput) => void): void;
|
|
413
270
|
/**
|
|
414
|
-
* @
|
|
415
|
-
* <p>An SaaS partner can use this operation to list all the partner event source names that
|
|
416
|
-
* they have created. This operation is not used by Amazon Web Services customers.</p>
|
|
271
|
+
* @see {@link ListPartnerEventSourcesCommand}
|
|
417
272
|
*/
|
|
418
273
|
listPartnerEventSources(args: ListPartnerEventSourcesCommandInput, options?: __HttpHandlerOptions): Promise<ListPartnerEventSourcesCommandOutput>;
|
|
419
274
|
listPartnerEventSources(args: ListPartnerEventSourcesCommandInput, cb: (err: any, data?: ListPartnerEventSourcesCommandOutput) => void): void;
|
|
420
275
|
listPartnerEventSources(args: ListPartnerEventSourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPartnerEventSourcesCommandOutput) => void): void;
|
|
421
276
|
/**
|
|
422
|
-
* @
|
|
423
|
-
* <p>Lists your replays. You can either list all the replays or you can provide a prefix to
|
|
424
|
-
* match to the replay names. Filter parameters are exclusive.</p>
|
|
277
|
+
* @see {@link ListReplaysCommand}
|
|
425
278
|
*/
|
|
426
279
|
listReplays(args: ListReplaysCommandInput, options?: __HttpHandlerOptions): Promise<ListReplaysCommandOutput>;
|
|
427
280
|
listReplays(args: ListReplaysCommandInput, cb: (err: any, data?: ListReplaysCommandOutput) => void): void;
|
|
428
281
|
listReplays(args: ListReplaysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListReplaysCommandOutput) => void): void;
|
|
429
282
|
/**
|
|
430
|
-
* @
|
|
431
|
-
* <p>Lists the rules for the specified target. You can see which of the rules in Amazon
|
|
432
|
-
* EventBridge can invoke a specific target in your account.</p>
|
|
283
|
+
* @see {@link ListRuleNamesByTargetCommand}
|
|
433
284
|
*/
|
|
434
285
|
listRuleNamesByTarget(args: ListRuleNamesByTargetCommandInput, options?: __HttpHandlerOptions): Promise<ListRuleNamesByTargetCommandOutput>;
|
|
435
286
|
listRuleNamesByTarget(args: ListRuleNamesByTargetCommandInput, cb: (err: any, data?: ListRuleNamesByTargetCommandOutput) => void): void;
|
|
436
287
|
listRuleNamesByTarget(args: ListRuleNamesByTargetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRuleNamesByTargetCommandOutput) => void): void;
|
|
437
288
|
/**
|
|
438
|
-
* @
|
|
439
|
-
* <p>Lists your Amazon EventBridge rules. You can either list all the rules or you can provide
|
|
440
|
-
* a prefix to match to the rule names.</p>
|
|
441
|
-
* <p>ListRules does not list the targets of a rule. To see the targets associated with a rule,
|
|
442
|
-
* use <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ListTargetsByRule.html">ListTargetsByRule</a>.</p>
|
|
289
|
+
* @see {@link ListRulesCommand}
|
|
443
290
|
*/
|
|
444
291
|
listRules(args: ListRulesCommandInput, options?: __HttpHandlerOptions): Promise<ListRulesCommandOutput>;
|
|
445
292
|
listRules(args: ListRulesCommandInput, cb: (err: any, data?: ListRulesCommandOutput) => void): void;
|
|
446
293
|
listRules(args: ListRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRulesCommandOutput) => void): void;
|
|
447
294
|
/**
|
|
448
|
-
* @
|
|
449
|
-
* <p>Displays the tags associated with an EventBridge resource. In EventBridge, rules and event
|
|
450
|
-
* buses can be tagged.</p>
|
|
295
|
+
* @see {@link ListTagsForResourceCommand}
|
|
451
296
|
*/
|
|
452
297
|
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
453
298
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
454
299
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
455
300
|
/**
|
|
456
|
-
* @
|
|
457
|
-
* <p>Lists the targets assigned to the specified rule.</p>
|
|
301
|
+
* @see {@link ListTargetsByRuleCommand}
|
|
458
302
|
*/
|
|
459
303
|
listTargetsByRule(args: ListTargetsByRuleCommandInput, options?: __HttpHandlerOptions): Promise<ListTargetsByRuleCommandOutput>;
|
|
460
304
|
listTargetsByRule(args: ListTargetsByRuleCommandInput, cb: (err: any, data?: ListTargetsByRuleCommandOutput) => void): void;
|
|
461
305
|
listTargetsByRule(args: ListTargetsByRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTargetsByRuleCommandOutput) => void): void;
|
|
462
306
|
/**
|
|
463
|
-
* @
|
|
464
|
-
* <p>Sends custom events to Amazon EventBridge so that they can be matched to rules.</p>
|
|
465
|
-
* <note>
|
|
466
|
-
* <p>PutEvents will only process nested JSON up to 1100 levels deep.</p>
|
|
467
|
-
* </note>
|
|
307
|
+
* @see {@link PutEventsCommand}
|
|
468
308
|
*/
|
|
469
309
|
putEvents(args: PutEventsCommandInput, options?: __HttpHandlerOptions): Promise<PutEventsCommandOutput>;
|
|
470
310
|
putEvents(args: PutEventsCommandInput, cb: (err: any, data?: PutEventsCommandOutput) => void): void;
|
|
471
311
|
putEvents(args: PutEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutEventsCommandOutput) => void): void;
|
|
472
312
|
/**
|
|
473
|
-
* @
|
|
474
|
-
* <p>This is used by SaaS partners to write events to a customer's partner event bus. Amazon Web Services
|
|
475
|
-
* customers do not use this operation.</p>
|
|
313
|
+
* @see {@link PutPartnerEventsCommand}
|
|
476
314
|
*/
|
|
477
315
|
putPartnerEvents(args: PutPartnerEventsCommandInput, options?: __HttpHandlerOptions): Promise<PutPartnerEventsCommandOutput>;
|
|
478
316
|
putPartnerEvents(args: PutPartnerEventsCommandInput, cb: (err: any, data?: PutPartnerEventsCommandOutput) => void): void;
|
|
479
317
|
putPartnerEvents(args: PutPartnerEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutPartnerEventsCommandOutput) => void): void;
|
|
480
318
|
/**
|
|
481
|
-
* @
|
|
482
|
-
* <p>Running <code>PutPermission</code> permits the specified Amazon Web Services account or Amazon Web Services organization
|
|
483
|
-
* to put events to the specified <i>event bus</i>. Amazon EventBridge (CloudWatch
|
|
484
|
-
* Events) rules in your account are triggered by these events arriving to an event bus in your
|
|
485
|
-
* account. </p>
|
|
486
|
-
* <p>For another account to send events to your account, that external account must have an
|
|
487
|
-
* EventBridge rule with your account's event bus as a target.</p>
|
|
488
|
-
* <p>To enable multiple Amazon Web Services accounts to put events to your event bus, run
|
|
489
|
-
* <code>PutPermission</code> once for each of these accounts. Or, if all the accounts are
|
|
490
|
-
* members of the same Amazon Web Services organization, you can run <code>PutPermission</code> once specifying
|
|
491
|
-
* <code>Principal</code> as "*" and specifying the Amazon Web Services organization ID in
|
|
492
|
-
* <code>Condition</code>, to grant permissions to all accounts in that organization.</p>
|
|
493
|
-
* <p>If you grant permissions using an organization, then accounts in that organization must
|
|
494
|
-
* specify a <code>RoleArn</code> with proper permissions when they use <code>PutTarget</code> to
|
|
495
|
-
* add your account's event bus as a target. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html">Sending and
|
|
496
|
-
* Receiving Events Between Amazon Web Services Accounts</a> in the <i>Amazon EventBridge User
|
|
497
|
-
* Guide</i>.</p>
|
|
498
|
-
* <p>The permission policy on the event bus cannot exceed 10 KB in size.</p>
|
|
319
|
+
* @see {@link PutPermissionCommand}
|
|
499
320
|
*/
|
|
500
321
|
putPermission(args: PutPermissionCommandInput, options?: __HttpHandlerOptions): Promise<PutPermissionCommandOutput>;
|
|
501
322
|
putPermission(args: PutPermissionCommandInput, cb: (err: any, data?: PutPermissionCommandOutput) => void): void;
|
|
502
323
|
putPermission(args: PutPermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutPermissionCommandOutput) => void): void;
|
|
503
324
|
/**
|
|
504
|
-
* @
|
|
505
|
-
* <p>Creates or updates the specified rule. Rules are enabled by default, or based on value of
|
|
506
|
-
* the state. You can disable a rule using <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DisableRule.html">DisableRule</a>.</p>
|
|
507
|
-
* <p>A single rule watches for events from a single event bus. Events generated by Amazon Web Services services
|
|
508
|
-
* go to your account's default event bus. Events generated by SaaS partner services or
|
|
509
|
-
* applications go to the matching partner event bus. If you have custom applications or
|
|
510
|
-
* services, you can specify whether their events go to your default event bus or a custom event
|
|
511
|
-
* bus that you have created. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html">CreateEventBus</a>.</p>
|
|
512
|
-
* <p>If you are updating an existing rule, the rule is replaced with what you specify in this
|
|
513
|
-
* <code>PutRule</code> command. If you omit arguments in <code>PutRule</code>, the old values
|
|
514
|
-
* for those arguments are not kept. Instead, they are replaced with null values.</p>
|
|
515
|
-
* <p>When you create or update a rule, incoming events might not immediately start matching to
|
|
516
|
-
* new or updated rules. Allow a short period of time for changes to take effect.</p>
|
|
517
|
-
* <p>A rule must contain at least an EventPattern or ScheduleExpression. Rules with
|
|
518
|
-
* EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions
|
|
519
|
-
* self-trigger based on the given schedule. A rule can have both an EventPattern and a
|
|
520
|
-
* ScheduleExpression, in which case the rule triggers on matching events as well as on a
|
|
521
|
-
* schedule.</p>
|
|
522
|
-
* <p>When you initially create a rule, you can optionally assign one or more tags to the rule.
|
|
523
|
-
* Tags can help you organize and categorize your resources. You can also use them to scope user
|
|
524
|
-
* permissions, by granting a user permission to access or change only rules with certain tag
|
|
525
|
-
* values. To use the <code>PutRule</code> operation and assign tags, you must have both the
|
|
526
|
-
* <code>events:PutRule</code> and <code>events:TagResource</code> permissions.</p>
|
|
527
|
-
* <p>If you are updating an existing rule, any tags you specify in the <code>PutRule</code>
|
|
528
|
-
* operation are ignored. To update the tags of an existing rule, use <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_TagResource.html">TagResource</a> and <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_UntagResource.html">UntagResource</a>.</p>
|
|
529
|
-
* <p>Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs).
|
|
530
|
-
* However, EventBridge uses an exact match in event patterns and rules. Be sure to use the
|
|
531
|
-
* correct ARN characters when creating event patterns so that they match the ARN syntax in the
|
|
532
|
-
* event you want to match.</p>
|
|
533
|
-
* <p>In EventBridge, it is possible to create rules that lead to infinite loops, where a rule
|
|
534
|
-
* is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket,
|
|
535
|
-
* and trigger software to change them to the desired state. If the rule is not written
|
|
536
|
-
* carefully, the subsequent change to the ACLs fires the rule again, creating an infinite
|
|
537
|
-
* loop.</p>
|
|
538
|
-
* <p>To prevent this, write the rules so that the triggered actions do not re-fire the same
|
|
539
|
-
* rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead
|
|
540
|
-
* of after any change. </p>
|
|
541
|
-
* <p>An infinite loop can quickly cause higher than expected charges. We recommend that you use
|
|
542
|
-
* budgeting, which alerts you when charges exceed your specified limit. For more information,
|
|
543
|
-
* see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/budgets-managing-costs.html">Managing Your Costs with
|
|
544
|
-
* Budgets</a>.</p>
|
|
325
|
+
* @see {@link PutRuleCommand}
|
|
545
326
|
*/
|
|
546
327
|
putRule(args: PutRuleCommandInput, options?: __HttpHandlerOptions): Promise<PutRuleCommandOutput>;
|
|
547
328
|
putRule(args: PutRuleCommandInput, cb: (err: any, data?: PutRuleCommandOutput) => void): void;
|
|
548
329
|
putRule(args: PutRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRuleCommandOutput) => void): void;
|
|
549
330
|
/**
|
|
550
|
-
* @
|
|
551
|
-
* <p>Adds the specified targets to the specified rule, or updates the targets if they are
|
|
552
|
-
* already associated with the rule.</p>
|
|
553
|
-
* <p>Targets are the resources that are invoked when a rule is triggered.</p>
|
|
554
|
-
* <note>
|
|
555
|
-
* <p>Each rule can have up to five (5) targets associated with it at one time.</p>
|
|
556
|
-
* </note>
|
|
557
|
-
* <p>You can configure the following as targets for Events:</p>
|
|
558
|
-
* <ul>
|
|
559
|
-
* <li>
|
|
560
|
-
* <p>
|
|
561
|
-
* <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-destinations.html">API destination</a>
|
|
562
|
-
* </p>
|
|
563
|
-
* </li>
|
|
564
|
-
* <li>
|
|
565
|
-
* <p>
|
|
566
|
-
* <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-gateway-target.html">API Gateway</a>
|
|
567
|
-
* </p>
|
|
568
|
-
* </li>
|
|
569
|
-
* <li>
|
|
570
|
-
* <p>Batch job queue</p>
|
|
571
|
-
* </li>
|
|
572
|
-
* <li>
|
|
573
|
-
* <p>CloudWatch group</p>
|
|
574
|
-
* </li>
|
|
575
|
-
* <li>
|
|
576
|
-
* <p>CodeBuild project</p>
|
|
577
|
-
* </li>
|
|
578
|
-
* <li>
|
|
579
|
-
* <p>CodePipeline</p>
|
|
580
|
-
* </li>
|
|
581
|
-
* <li>
|
|
582
|
-
* <p>EC2 <code>CreateSnapshot</code> API call</p>
|
|
583
|
-
* </li>
|
|
584
|
-
* <li>
|
|
585
|
-
* <p>EC2 Image Builder</p>
|
|
586
|
-
* </li>
|
|
587
|
-
* <li>
|
|
588
|
-
* <p>EC2 <code>RebootInstances</code> API call</p>
|
|
589
|
-
* </li>
|
|
590
|
-
* <li>
|
|
591
|
-
* <p>EC2 <code>StopInstances</code> API call</p>
|
|
592
|
-
* </li>
|
|
593
|
-
* <li>
|
|
594
|
-
* <p>EC2 <code>TerminateInstances</code> API call</p>
|
|
595
|
-
* </li>
|
|
596
|
-
* <li>
|
|
597
|
-
* <p>ECS task</p>
|
|
598
|
-
* </li>
|
|
599
|
-
* <li>
|
|
600
|
-
* <p>
|
|
601
|
-
* <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-cross-account.html">Event bus in a different account or
|
|
602
|
-
* Region</a>
|
|
603
|
-
* </p>
|
|
604
|
-
* </li>
|
|
605
|
-
* <li>
|
|
606
|
-
* <p>
|
|
607
|
-
* <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-bus-to-bus.html">Event bus in the same account and
|
|
608
|
-
* Region</a>
|
|
609
|
-
* </p>
|
|
610
|
-
* </li>
|
|
611
|
-
* <li>
|
|
612
|
-
* <p>Firehose delivery stream</p>
|
|
613
|
-
* </li>
|
|
614
|
-
* <li>
|
|
615
|
-
* <p>Glue workflow</p>
|
|
616
|
-
* </li>
|
|
617
|
-
* <li>
|
|
618
|
-
* <p>
|
|
619
|
-
* <a href="https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-creation.html#incident-tracking-auto-eventbridge">Incident Manager response plan</a>
|
|
620
|
-
* </p>
|
|
621
|
-
* </li>
|
|
622
|
-
* <li>
|
|
623
|
-
* <p>Inspector assessment template</p>
|
|
624
|
-
* </li>
|
|
625
|
-
* <li>
|
|
626
|
-
* <p>Kinesis stream</p>
|
|
627
|
-
* </li>
|
|
628
|
-
* <li>
|
|
629
|
-
* <p>Lambda function</p>
|
|
630
|
-
* </li>
|
|
631
|
-
* <li>
|
|
632
|
-
* <p>Redshift cluster</p>
|
|
633
|
-
* </li>
|
|
634
|
-
* <li>
|
|
635
|
-
* <p>Redshift Serverless workgroup</p>
|
|
636
|
-
* </li>
|
|
637
|
-
* <li>
|
|
638
|
-
* <p>SageMaker Pipeline</p>
|
|
639
|
-
* </li>
|
|
640
|
-
* <li>
|
|
641
|
-
* <p>SNS topic</p>
|
|
642
|
-
* </li>
|
|
643
|
-
* <li>
|
|
644
|
-
* <p>SQS queue</p>
|
|
645
|
-
* </li>
|
|
646
|
-
* <li>
|
|
647
|
-
* <p>Step Functions state machine</p>
|
|
648
|
-
* </li>
|
|
649
|
-
* <li>
|
|
650
|
-
* <p>Systems Manager Automation</p>
|
|
651
|
-
* </li>
|
|
652
|
-
* <li>
|
|
653
|
-
* <p>Systems Manager OpsItem</p>
|
|
654
|
-
* </li>
|
|
655
|
-
* <li>
|
|
656
|
-
* <p>Systems Manager Run Command</p>
|
|
657
|
-
* </li>
|
|
658
|
-
* </ul>
|
|
659
|
-
* <p>Creating rules with built-in targets is supported only in the Amazon Web Services Management Console. The
|
|
660
|
-
* built-in targets are <code>EC2 CreateSnapshot API call</code>, <code>EC2 RebootInstances API
|
|
661
|
-
* call</code>, <code>EC2 StopInstances API call</code>, and <code>EC2 TerminateInstances API
|
|
662
|
-
* call</code>. </p>
|
|
663
|
-
* <p>For some target types, <code>PutTargets</code> provides target-specific parameters. If the
|
|
664
|
-
* target is a Kinesis data stream, you can optionally specify which shard the event goes to by
|
|
665
|
-
* using the <code>KinesisParameters</code> argument. To invoke a command on multiple EC2
|
|
666
|
-
* instances with one rule, you can use the <code>RunCommandParameters</code> field.</p>
|
|
667
|
-
* <p>To be able to make API calls against the resources that you own, Amazon EventBridge
|
|
668
|
-
* needs the appropriate permissions. For Lambda and Amazon SNS
|
|
669
|
-
* resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis Data Streams,
|
|
670
|
-
* Step Functions state machines and API Gateway APIs, EventBridge relies on
|
|
671
|
-
* IAM roles that you specify in the <code>RoleARN</code> argument in <code>PutTargets</code>.
|
|
672
|
-
* For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html">Authentication
|
|
673
|
-
* and Access Control</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
674
|
-
* <p>If another Amazon Web Services account is in the same region and has granted you permission (using
|
|
675
|
-
* <code>PutPermission</code>), you can send events to that account. Set that account's event
|
|
676
|
-
* bus as a target of the rules in your account. To send the matched events to the other account,
|
|
677
|
-
* specify that account's event bus as the <code>Arn</code> value when you run
|
|
678
|
-
* <code>PutTargets</code>. If your account sends events to another account, your account is
|
|
679
|
-
* charged for each sent event. Each event sent to another account is charged as a custom event.
|
|
680
|
-
* The account receiving the event is not charged. For more information, see <a href="http://aws.amazon.com/eventbridge/pricing/">Amazon EventBridge
|
|
681
|
-
* Pricing</a>.</p>
|
|
682
|
-
* <note>
|
|
683
|
-
* <p>
|
|
684
|
-
* <code>Input</code>, <code>InputPath</code>, and <code>InputTransformer</code> are not
|
|
685
|
-
* available with <code>PutTarget</code> if the target is an event bus of a different Amazon Web Services
|
|
686
|
-
* account.</p>
|
|
687
|
-
* </note>
|
|
688
|
-
* <p>If you are setting the event bus of another account as the target, and that account
|
|
689
|
-
* granted permission to your account through an organization instead of directly by the account
|
|
690
|
-
* ID, then you must specify a <code>RoleArn</code> with proper permissions in the
|
|
691
|
-
* <code>Target</code> structure. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html">Sending and
|
|
692
|
-
* Receiving Events Between Amazon Web Services Accounts</a> in the <i>Amazon EventBridge User
|
|
693
|
-
* Guide</i>.</p>
|
|
694
|
-
* <p>For more information about enabling cross-account events, see <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html">PutPermission</a>.</p>
|
|
695
|
-
* <p>
|
|
696
|
-
* <b>Input</b>, <b>InputPath</b>, and
|
|
697
|
-
* <b>InputTransformer</b> are mutually exclusive and optional
|
|
698
|
-
* parameters of a target. When a rule is triggered due to a matched event:</p>
|
|
699
|
-
* <ul>
|
|
700
|
-
* <li>
|
|
701
|
-
* <p>If none of the following arguments are specified for a target, then the entire event
|
|
702
|
-
* is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or
|
|
703
|
-
* Amazon ECS task, in which case nothing from the event is passed to the target).</p>
|
|
704
|
-
* </li>
|
|
705
|
-
* <li>
|
|
706
|
-
* <p>If <b>Input</b> is specified in the form of valid JSON, then
|
|
707
|
-
* the matched event is overridden with this constant.</p>
|
|
708
|
-
* </li>
|
|
709
|
-
* <li>
|
|
710
|
-
* <p>If <b>InputPath</b> is specified in the form of JSONPath
|
|
711
|
-
* (for example, <code>$.detail</code>), then only the part of the event specified in the
|
|
712
|
-
* path is passed to the target (for example, only the detail part of the event is
|
|
713
|
-
* passed).</p>
|
|
714
|
-
* </li>
|
|
715
|
-
* <li>
|
|
716
|
-
* <p>If <b>InputTransformer</b> is specified, then one or more
|
|
717
|
-
* specified JSONPaths are extracted from the event and used as values in a template that you
|
|
718
|
-
* specify as the input to the target.</p>
|
|
719
|
-
* </li>
|
|
720
|
-
* </ul>
|
|
721
|
-
* <p>When you specify <code>InputPath</code> or <code>InputTransformer</code>, you must use
|
|
722
|
-
* JSON dot notation, not bracket notation.</p>
|
|
723
|
-
* <p>When you add targets to a rule and the associated rule triggers soon after, new or updated
|
|
724
|
-
* targets might not be immediately invoked. Allow a short period of time for changes to take
|
|
725
|
-
* effect.</p>
|
|
726
|
-
* <p>This action can partially fail if too many requests are made at the same time. If that
|
|
727
|
-
* happens, <code>FailedEntryCount</code> is non-zero in the response and each entry in
|
|
728
|
-
* <code>FailedEntries</code> provides the ID of the failed target and the error code.</p>
|
|
331
|
+
* @see {@link PutTargetsCommand}
|
|
729
332
|
*/
|
|
730
333
|
putTargets(args: PutTargetsCommandInput, options?: __HttpHandlerOptions): Promise<PutTargetsCommandOutput>;
|
|
731
334
|
putTargets(args: PutTargetsCommandInput, cb: (err: any, data?: PutTargetsCommandOutput) => void): void;
|
|
732
335
|
putTargets(args: PutTargetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutTargetsCommandOutput) => void): void;
|
|
733
336
|
/**
|
|
734
|
-
* @
|
|
735
|
-
* <p>Revokes the permission of another Amazon Web Services account to be able to put events to the specified
|
|
736
|
-
* event bus. Specify the account to revoke by the <code>StatementId</code> value that you
|
|
737
|
-
* associated with the account when you granted it permission with <code>PutPermission</code>.
|
|
738
|
-
* You can find the <code>StatementId</code> by using <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DescribeEventBus.html">DescribeEventBus</a>.</p>
|
|
337
|
+
* @see {@link RemovePermissionCommand}
|
|
739
338
|
*/
|
|
740
339
|
removePermission(args: RemovePermissionCommandInput, options?: __HttpHandlerOptions): Promise<RemovePermissionCommandOutput>;
|
|
741
340
|
removePermission(args: RemovePermissionCommandInput, cb: (err: any, data?: RemovePermissionCommandOutput) => void): void;
|
|
742
341
|
removePermission(args: RemovePermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemovePermissionCommandOutput) => void): void;
|
|
743
342
|
/**
|
|
744
|
-
* @
|
|
745
|
-
* <p>Removes the specified targets from the specified rule. When the rule is triggered, those
|
|
746
|
-
* targets are no longer be invoked.</p>
|
|
747
|
-
* <note>
|
|
748
|
-
* <p>A successful execution of <code>RemoveTargets</code> doesn't guarantee all targets are removed from the rule, it means that the target(s) listed in the request are removed.</p>
|
|
749
|
-
* </note>
|
|
750
|
-
* <p>When you remove a target, when the associated rule triggers, removed targets might
|
|
751
|
-
* continue to be invoked. Allow a short period of time for changes to take effect.</p>
|
|
752
|
-
* <p>This action can partially fail if too many requests are made at the same time. If that
|
|
753
|
-
* happens, <code>FailedEntryCount</code> is non-zero in the response and each entry in
|
|
754
|
-
* <code>FailedEntries</code> provides the ID of the failed target and the error code.</p>
|
|
343
|
+
* @see {@link RemoveTargetsCommand}
|
|
755
344
|
*/
|
|
756
345
|
removeTargets(args: RemoveTargetsCommandInput, options?: __HttpHandlerOptions): Promise<RemoveTargetsCommandOutput>;
|
|
757
346
|
removeTargets(args: RemoveTargetsCommandInput, cb: (err: any, data?: RemoveTargetsCommandOutput) => void): void;
|
|
758
347
|
removeTargets(args: RemoveTargetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveTargetsCommandOutput) => void): void;
|
|
759
348
|
/**
|
|
760
|
-
* @
|
|
761
|
-
* <p>Starts the specified replay. Events are not necessarily replayed in the exact same order
|
|
762
|
-
* that they were added to the archive. A replay processes events to replay based on the time in
|
|
763
|
-
* the event, and replays them using 1 minute intervals. If you specify an
|
|
764
|
-
* <code>EventStartTime</code> and an <code>EventEndTime</code> that covers a 20 minute time
|
|
765
|
-
* range, the events are replayed from the first minute of that 20 minute range first. Then the
|
|
766
|
-
* events from the second minute are replayed. You can use <code>DescribeReplay</code> to
|
|
767
|
-
* determine the progress of a replay. The value returned for <code>EventLastReplayedTime</code>
|
|
768
|
-
* indicates the time within the specified time range associated with the last event
|
|
769
|
-
* replayed.</p>
|
|
349
|
+
* @see {@link StartReplayCommand}
|
|
770
350
|
*/
|
|
771
351
|
startReplay(args: StartReplayCommandInput, options?: __HttpHandlerOptions): Promise<StartReplayCommandOutput>;
|
|
772
352
|
startReplay(args: StartReplayCommandInput, cb: (err: any, data?: StartReplayCommandOutput) => void): void;
|
|
773
353
|
startReplay(args: StartReplayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartReplayCommandOutput) => void): void;
|
|
774
354
|
/**
|
|
775
|
-
* @
|
|
776
|
-
* <p>Assigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can
|
|
777
|
-
* help you organize and categorize your resources. You can also use them to scope user
|
|
778
|
-
* permissions by granting a user permission to access or change only resources with certain tag
|
|
779
|
-
* values. In EventBridge, rules and event buses can be tagged.</p>
|
|
780
|
-
* <p>Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of
|
|
781
|
-
* characters.</p>
|
|
782
|
-
* <p>You can use the <code>TagResource</code> action with a resource that already has tags. If
|
|
783
|
-
* you specify a new tag key, this tag is appended to the list of tags associated with the
|
|
784
|
-
* resource. If you specify a tag key that is already associated with the resource, the new tag
|
|
785
|
-
* value that you specify replaces the previous value for that tag.</p>
|
|
786
|
-
* <p>You can associate as many as 50 tags with a resource.</p>
|
|
355
|
+
* @see {@link TagResourceCommand}
|
|
787
356
|
*/
|
|
788
357
|
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
789
358
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
790
359
|
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
791
360
|
/**
|
|
792
|
-
* @
|
|
793
|
-
* <p>Tests whether the specified event pattern matches the provided event.</p>
|
|
794
|
-
* <p>Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs).
|
|
795
|
-
* However, EventBridge uses an exact match in event patterns and rules. Be sure to use the
|
|
796
|
-
* correct ARN characters when creating event patterns so that they match the ARN syntax in the
|
|
797
|
-
* event you want to match.</p>
|
|
361
|
+
* @see {@link TestEventPatternCommand}
|
|
798
362
|
*/
|
|
799
363
|
testEventPattern(args: TestEventPatternCommandInput, options?: __HttpHandlerOptions): Promise<TestEventPatternCommandOutput>;
|
|
800
364
|
testEventPattern(args: TestEventPatternCommandInput, cb: (err: any, data?: TestEventPatternCommandOutput) => void): void;
|
|
801
365
|
testEventPattern(args: TestEventPatternCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestEventPatternCommandOutput) => void): void;
|
|
802
366
|
/**
|
|
803
|
-
* @
|
|
804
|
-
* <p>Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge
|
|
805
|
-
* (CloudWatch Events), rules and event buses can be tagged.</p>
|
|
367
|
+
* @see {@link UntagResourceCommand}
|
|
806
368
|
*/
|
|
807
369
|
untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
|
|
808
370
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
809
371
|
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
810
372
|
/**
|
|
811
|
-
* @
|
|
812
|
-
* <p>Updates an API destination.</p>
|
|
373
|
+
* @see {@link UpdateApiDestinationCommand}
|
|
813
374
|
*/
|
|
814
375
|
updateApiDestination(args: UpdateApiDestinationCommandInput, options?: __HttpHandlerOptions): Promise<UpdateApiDestinationCommandOutput>;
|
|
815
376
|
updateApiDestination(args: UpdateApiDestinationCommandInput, cb: (err: any, data?: UpdateApiDestinationCommandOutput) => void): void;
|
|
816
377
|
updateApiDestination(args: UpdateApiDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApiDestinationCommandOutput) => void): void;
|
|
817
378
|
/**
|
|
818
|
-
* @
|
|
819
|
-
* <p>Updates the specified archive.</p>
|
|
379
|
+
* @see {@link UpdateArchiveCommand}
|
|
820
380
|
*/
|
|
821
381
|
updateArchive(args: UpdateArchiveCommandInput, options?: __HttpHandlerOptions): Promise<UpdateArchiveCommandOutput>;
|
|
822
382
|
updateArchive(args: UpdateArchiveCommandInput, cb: (err: any, data?: UpdateArchiveCommandOutput) => void): void;
|
|
823
383
|
updateArchive(args: UpdateArchiveCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateArchiveCommandOutput) => void): void;
|
|
824
384
|
/**
|
|
825
|
-
* @
|
|
826
|
-
* <p>Updates settings for a connection.</p>
|
|
385
|
+
* @see {@link UpdateConnectionCommand}
|
|
827
386
|
*/
|
|
828
387
|
updateConnection(args: UpdateConnectionCommandInput, options?: __HttpHandlerOptions): Promise<UpdateConnectionCommandOutput>;
|
|
829
388
|
updateConnection(args: UpdateConnectionCommandInput, cb: (err: any, data?: UpdateConnectionCommandOutput) => void): void;
|
|
830
389
|
updateConnection(args: UpdateConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConnectionCommandOutput) => void): void;
|
|
831
390
|
/**
|
|
832
|
-
* @
|
|
833
|
-
* <p>Update an existing endpoint. For more information about global endpoints, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html">Making applications Regional-fault tolerant with global endpoints and event replication</a> in the Amazon EventBridge User Guide..</p>
|
|
391
|
+
* @see {@link UpdateEndpointCommand}
|
|
834
392
|
*/
|
|
835
393
|
updateEndpoint(args: UpdateEndpointCommandInput, options?: __HttpHandlerOptions): Promise<UpdateEndpointCommandOutput>;
|
|
836
394
|
updateEndpoint(args: UpdateEndpointCommandInput, cb: (err: any, data?: UpdateEndpointCommandOutput) => void): void;
|
|
837
395
|
updateEndpoint(args: UpdateEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEndpointCommandOutput) => void): void;
|
|
838
396
|
}
|
|
397
|
+
/**
|
|
398
|
+
* @public
|
|
399
|
+
* <p>Amazon EventBridge helps you to respond to state changes in your Amazon Web Services resources. When your
|
|
400
|
+
* resources change state, they automatically send events to an event stream. You can create
|
|
401
|
+
* rules that match selected events in the stream and route them to targets to take action. You
|
|
402
|
+
* can also use rules to take action on a predetermined schedule. For example, you can configure
|
|
403
|
+
* rules to:</p>
|
|
404
|
+
* <ul>
|
|
405
|
+
* <li>
|
|
406
|
+
* <p>Automatically invoke an Lambda function to update DNS entries when an event
|
|
407
|
+
* notifies you that Amazon EC2 instance enters the running state.</p>
|
|
408
|
+
* </li>
|
|
409
|
+
* <li>
|
|
410
|
+
* <p>Direct specific API records from CloudTrail to an Amazon Kinesis data stream for
|
|
411
|
+
* detailed analysis of potential security or availability risks.</p>
|
|
412
|
+
* </li>
|
|
413
|
+
* <li>
|
|
414
|
+
* <p>Periodically invoke a built-in target to create a snapshot of an Amazon EBS
|
|
415
|
+
* volume.</p>
|
|
416
|
+
* </li>
|
|
417
|
+
* </ul>
|
|
418
|
+
* <p>For more information about the features of Amazon EventBridge, see the <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide">Amazon EventBridge User
|
|
419
|
+
* Guide</a>.</p>
|
|
420
|
+
*/
|
|
421
|
+
export declare class EventBridge extends EventBridgeClient implements EventBridge {
|
|
422
|
+
}
|