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