@aws-sdk/client-eventbridge 3.379.1 → 3.382.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-types/models/models_0.d.ts +564 -0
- package/package.json +5 -5
|
@@ -5,6 +5,7 @@ import { EventBridgeServiceException as __BaseException } from "./EventBridgeSer
|
|
|
5
5
|
*/
|
|
6
6
|
export interface ActivateEventSourceRequest {
|
|
7
7
|
/**
|
|
8
|
+
* @public
|
|
8
9
|
* <p>The name of the partner event source to activate.</p>
|
|
9
10
|
*/
|
|
10
11
|
Name: string | undefined;
|
|
@@ -104,38 +105,47 @@ export type ApiDestinationHttpMethod = (typeof ApiDestinationHttpMethod)[keyof t
|
|
|
104
105
|
*/
|
|
105
106
|
export interface ApiDestination {
|
|
106
107
|
/**
|
|
108
|
+
* @public
|
|
107
109
|
* <p>The ARN of the API destination.</p>
|
|
108
110
|
*/
|
|
109
111
|
ApiDestinationArn?: string;
|
|
110
112
|
/**
|
|
113
|
+
* @public
|
|
111
114
|
* <p>The name of the API destination.</p>
|
|
112
115
|
*/
|
|
113
116
|
Name?: string;
|
|
114
117
|
/**
|
|
118
|
+
* @public
|
|
115
119
|
* <p>The state of the API destination.</p>
|
|
116
120
|
*/
|
|
117
121
|
ApiDestinationState?: ApiDestinationState | string;
|
|
118
122
|
/**
|
|
123
|
+
* @public
|
|
119
124
|
* <p>The ARN of the connection specified for the API destination.</p>
|
|
120
125
|
*/
|
|
121
126
|
ConnectionArn?: string;
|
|
122
127
|
/**
|
|
128
|
+
* @public
|
|
123
129
|
* <p>The URL to the endpoint for the API destination.</p>
|
|
124
130
|
*/
|
|
125
131
|
InvocationEndpoint?: string;
|
|
126
132
|
/**
|
|
133
|
+
* @public
|
|
127
134
|
* <p>The method to use to connect to the HTTP endpoint.</p>
|
|
128
135
|
*/
|
|
129
136
|
HttpMethod?: ApiDestinationHttpMethod | string;
|
|
130
137
|
/**
|
|
138
|
+
* @public
|
|
131
139
|
* <p>The maximum number of invocations per second to send to the HTTP endpoint.</p>
|
|
132
140
|
*/
|
|
133
141
|
InvocationRateLimitPerSecond?: number;
|
|
134
142
|
/**
|
|
143
|
+
* @public
|
|
135
144
|
* <p>A time stamp for the time that the API destination was created.</p>
|
|
136
145
|
*/
|
|
137
146
|
CreationTime?: Date;
|
|
138
147
|
/**
|
|
148
|
+
* @public
|
|
139
149
|
* <p>A time stamp for the time that the API destination was last modified.</p>
|
|
140
150
|
*/
|
|
141
151
|
LastModifiedTime?: Date;
|
|
@@ -162,35 +172,43 @@ export type ArchiveState = (typeof ArchiveState)[keyof typeof ArchiveState];
|
|
|
162
172
|
*/
|
|
163
173
|
export interface Archive {
|
|
164
174
|
/**
|
|
175
|
+
* @public
|
|
165
176
|
* <p>The name of the archive.</p>
|
|
166
177
|
*/
|
|
167
178
|
ArchiveName?: string;
|
|
168
179
|
/**
|
|
180
|
+
* @public
|
|
169
181
|
* <p>The ARN of the event bus associated with the archive. Only events from this event bus are
|
|
170
182
|
* sent to the archive.</p>
|
|
171
183
|
*/
|
|
172
184
|
EventSourceArn?: string;
|
|
173
185
|
/**
|
|
186
|
+
* @public
|
|
174
187
|
* <p>The current state of the archive.</p>
|
|
175
188
|
*/
|
|
176
189
|
State?: ArchiveState | string;
|
|
177
190
|
/**
|
|
191
|
+
* @public
|
|
178
192
|
* <p>A description for the reason that the archive is in the current state.</p>
|
|
179
193
|
*/
|
|
180
194
|
StateReason?: string;
|
|
181
195
|
/**
|
|
196
|
+
* @public
|
|
182
197
|
* <p>The number of days to retain events in the archive before they are deleted.</p>
|
|
183
198
|
*/
|
|
184
199
|
RetentionDays?: number;
|
|
185
200
|
/**
|
|
201
|
+
* @public
|
|
186
202
|
* <p>The size of the archive, in bytes.</p>
|
|
187
203
|
*/
|
|
188
204
|
SizeBytes?: number;
|
|
189
205
|
/**
|
|
206
|
+
* @public
|
|
190
207
|
* <p>The number of events in the archive.</p>
|
|
191
208
|
*/
|
|
192
209
|
EventCount?: number;
|
|
193
210
|
/**
|
|
211
|
+
* @public
|
|
194
212
|
* <p>The time stamp for the time that the archive was created.</p>
|
|
195
213
|
*/
|
|
196
214
|
CreationTime?: Date;
|
|
@@ -212,6 +230,7 @@ export type AssignPublicIp = (typeof AssignPublicIp)[keyof typeof AssignPublicIp
|
|
|
212
230
|
*/
|
|
213
231
|
export interface CancelReplayRequest {
|
|
214
232
|
/**
|
|
233
|
+
* @public
|
|
215
234
|
* <p>The name of the replay to cancel.</p>
|
|
216
235
|
*/
|
|
217
236
|
ReplayName: string | undefined;
|
|
@@ -237,14 +256,17 @@ export type ReplayState = (typeof ReplayState)[keyof typeof ReplayState];
|
|
|
237
256
|
*/
|
|
238
257
|
export interface CancelReplayResponse {
|
|
239
258
|
/**
|
|
259
|
+
* @public
|
|
240
260
|
* <p>The ARN of the replay to cancel.</p>
|
|
241
261
|
*/
|
|
242
262
|
ReplayArn?: string;
|
|
243
263
|
/**
|
|
264
|
+
* @public
|
|
244
265
|
* <p>The current state of the replay.</p>
|
|
245
266
|
*/
|
|
246
267
|
State?: ReplayState | string;
|
|
247
268
|
/**
|
|
269
|
+
* @public
|
|
248
270
|
* <p>The reason that the replay is in the current state.</p>
|
|
249
271
|
*/
|
|
250
272
|
StateReason?: string;
|
|
@@ -267,27 +289,33 @@ export declare class IllegalStatusException extends __BaseException {
|
|
|
267
289
|
*/
|
|
268
290
|
export interface CreateApiDestinationRequest {
|
|
269
291
|
/**
|
|
292
|
+
* @public
|
|
270
293
|
* <p>The name for the API destination to create.</p>
|
|
271
294
|
*/
|
|
272
295
|
Name: string | undefined;
|
|
273
296
|
/**
|
|
297
|
+
* @public
|
|
274
298
|
* <p>A description for the API destination to create.</p>
|
|
275
299
|
*/
|
|
276
300
|
Description?: string;
|
|
277
301
|
/**
|
|
302
|
+
* @public
|
|
278
303
|
* <p>The ARN of the connection to use for the API destination. The destination endpoint must
|
|
279
304
|
* support the authorization type specified for the connection.</p>
|
|
280
305
|
*/
|
|
281
306
|
ConnectionArn: string | undefined;
|
|
282
307
|
/**
|
|
308
|
+
* @public
|
|
283
309
|
* <p>The URL to the HTTP invocation endpoint for the API destination.</p>
|
|
284
310
|
*/
|
|
285
311
|
InvocationEndpoint: string | undefined;
|
|
286
312
|
/**
|
|
313
|
+
* @public
|
|
287
314
|
* <p>The method to use for the request to the HTTP invocation endpoint.</p>
|
|
288
315
|
*/
|
|
289
316
|
HttpMethod: ApiDestinationHttpMethod | string | undefined;
|
|
290
317
|
/**
|
|
318
|
+
* @public
|
|
291
319
|
* <p>The maximum number of requests per second to send to the HTTP invocation endpoint.</p>
|
|
292
320
|
*/
|
|
293
321
|
InvocationRateLimitPerSecond?: number;
|
|
@@ -297,18 +325,22 @@ export interface CreateApiDestinationRequest {
|
|
|
297
325
|
*/
|
|
298
326
|
export interface CreateApiDestinationResponse {
|
|
299
327
|
/**
|
|
328
|
+
* @public
|
|
300
329
|
* <p>The ARN of the API destination that was created by the request.</p>
|
|
301
330
|
*/
|
|
302
331
|
ApiDestinationArn?: string;
|
|
303
332
|
/**
|
|
333
|
+
* @public
|
|
304
334
|
* <p>The state of the API destination that was created by the request.</p>
|
|
305
335
|
*/
|
|
306
336
|
ApiDestinationState?: ApiDestinationState | string;
|
|
307
337
|
/**
|
|
338
|
+
* @public
|
|
308
339
|
* <p>A time stamp indicating the time that the API destination was created.</p>
|
|
309
340
|
*/
|
|
310
341
|
CreationTime?: Date;
|
|
311
342
|
/**
|
|
343
|
+
* @public
|
|
312
344
|
* <p>A time stamp indicating the time that the API destination was last modified.</p>
|
|
313
345
|
*/
|
|
314
346
|
LastModifiedTime?: Date;
|
|
@@ -343,22 +375,27 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
|
|
|
343
375
|
*/
|
|
344
376
|
export interface CreateArchiveRequest {
|
|
345
377
|
/**
|
|
378
|
+
* @public
|
|
346
379
|
* <p>The name for the archive to create.</p>
|
|
347
380
|
*/
|
|
348
381
|
ArchiveName: string | undefined;
|
|
349
382
|
/**
|
|
383
|
+
* @public
|
|
350
384
|
* <p>The ARN of the event bus that sends events to the archive.</p>
|
|
351
385
|
*/
|
|
352
386
|
EventSourceArn: string | undefined;
|
|
353
387
|
/**
|
|
388
|
+
* @public
|
|
354
389
|
* <p>A description for the archive.</p>
|
|
355
390
|
*/
|
|
356
391
|
Description?: string;
|
|
357
392
|
/**
|
|
393
|
+
* @public
|
|
358
394
|
* <p>An event pattern to use to filter events sent to the archive.</p>
|
|
359
395
|
*/
|
|
360
396
|
EventPattern?: string;
|
|
361
397
|
/**
|
|
398
|
+
* @public
|
|
362
399
|
* <p>The number of days to retain events for. Default value is 0. If set to 0, events are
|
|
363
400
|
* retained indefinitely</p>
|
|
364
401
|
*/
|
|
@@ -369,18 +406,22 @@ export interface CreateArchiveRequest {
|
|
|
369
406
|
*/
|
|
370
407
|
export interface CreateArchiveResponse {
|
|
371
408
|
/**
|
|
409
|
+
* @public
|
|
372
410
|
* <p>The ARN of the archive that was created.</p>
|
|
373
411
|
*/
|
|
374
412
|
ArchiveArn?: string;
|
|
375
413
|
/**
|
|
414
|
+
* @public
|
|
376
415
|
* <p>The state of the archive that was created.</p>
|
|
377
416
|
*/
|
|
378
417
|
State?: ArchiveState | string;
|
|
379
418
|
/**
|
|
419
|
+
* @public
|
|
380
420
|
* <p>The reason that the archive is in the state.</p>
|
|
381
421
|
*/
|
|
382
422
|
StateReason?: string;
|
|
383
423
|
/**
|
|
424
|
+
* @public
|
|
384
425
|
* <p>The time at which the archive was created.</p>
|
|
385
426
|
*/
|
|
386
427
|
CreationTime?: Date;
|
|
@@ -416,10 +457,12 @@ export type ConnectionAuthorizationType = (typeof ConnectionAuthorizationType)[k
|
|
|
416
457
|
*/
|
|
417
458
|
export interface CreateConnectionApiKeyAuthRequestParameters {
|
|
418
459
|
/**
|
|
460
|
+
* @public
|
|
419
461
|
* <p>The name of the API key to use for authorization.</p>
|
|
420
462
|
*/
|
|
421
463
|
ApiKeyName: string | undefined;
|
|
422
464
|
/**
|
|
465
|
+
* @public
|
|
423
466
|
* <p>The value for the API key to use for authorization.</p>
|
|
424
467
|
*/
|
|
425
468
|
ApiKeyValue: string | undefined;
|
|
@@ -430,10 +473,12 @@ export interface CreateConnectionApiKeyAuthRequestParameters {
|
|
|
430
473
|
*/
|
|
431
474
|
export interface CreateConnectionBasicAuthRequestParameters {
|
|
432
475
|
/**
|
|
476
|
+
* @public
|
|
433
477
|
* <p>The user name to use for Basic authorization.</p>
|
|
434
478
|
*/
|
|
435
479
|
Username: string | undefined;
|
|
436
480
|
/**
|
|
481
|
+
* @public
|
|
437
482
|
* <p>The password associated with the user name to use for Basic authorization.</p>
|
|
438
483
|
*/
|
|
439
484
|
Password: string | undefined;
|
|
@@ -445,14 +490,17 @@ export interface CreateConnectionBasicAuthRequestParameters {
|
|
|
445
490
|
*/
|
|
446
491
|
export interface ConnectionBodyParameter {
|
|
447
492
|
/**
|
|
493
|
+
* @public
|
|
448
494
|
* <p>The key for the parameter.</p>
|
|
449
495
|
*/
|
|
450
496
|
Key?: string;
|
|
451
497
|
/**
|
|
498
|
+
* @public
|
|
452
499
|
* <p>The value associated with the key.</p>
|
|
453
500
|
*/
|
|
454
501
|
Value?: string;
|
|
455
502
|
/**
|
|
503
|
+
* @public
|
|
456
504
|
* <p>Specified whether the value is secret.</p>
|
|
457
505
|
*/
|
|
458
506
|
IsValueSecret?: boolean;
|
|
@@ -464,14 +512,17 @@ export interface ConnectionBodyParameter {
|
|
|
464
512
|
*/
|
|
465
513
|
export interface ConnectionHeaderParameter {
|
|
466
514
|
/**
|
|
515
|
+
* @public
|
|
467
516
|
* <p>The key for the parameter.</p>
|
|
468
517
|
*/
|
|
469
518
|
Key?: string;
|
|
470
519
|
/**
|
|
520
|
+
* @public
|
|
471
521
|
* <p>The value associated with the key.</p>
|
|
472
522
|
*/
|
|
473
523
|
Value?: string;
|
|
474
524
|
/**
|
|
525
|
+
* @public
|
|
475
526
|
* <p>Specified whether the value is a secret.</p>
|
|
476
527
|
*/
|
|
477
528
|
IsValueSecret?: boolean;
|
|
@@ -484,14 +535,17 @@ export interface ConnectionHeaderParameter {
|
|
|
484
535
|
*/
|
|
485
536
|
export interface ConnectionQueryStringParameter {
|
|
486
537
|
/**
|
|
538
|
+
* @public
|
|
487
539
|
* <p>The key for a query string parameter.</p>
|
|
488
540
|
*/
|
|
489
541
|
Key?: string;
|
|
490
542
|
/**
|
|
543
|
+
* @public
|
|
491
544
|
* <p>The value associated with the key for the query string parameter.</p>
|
|
492
545
|
*/
|
|
493
546
|
Value?: string;
|
|
494
547
|
/**
|
|
548
|
+
* @public
|
|
495
549
|
* <p>Specifies whether the value is secret.</p>
|
|
496
550
|
*/
|
|
497
551
|
IsValueSecret?: boolean;
|
|
@@ -502,14 +556,17 @@ export interface ConnectionQueryStringParameter {
|
|
|
502
556
|
*/
|
|
503
557
|
export interface ConnectionHttpParameters {
|
|
504
558
|
/**
|
|
559
|
+
* @public
|
|
505
560
|
* <p>Contains additional header parameters for the connection.</p>
|
|
506
561
|
*/
|
|
507
562
|
HeaderParameters?: ConnectionHeaderParameter[];
|
|
508
563
|
/**
|
|
564
|
+
* @public
|
|
509
565
|
* <p>Contains additional query string parameters for the connection.</p>
|
|
510
566
|
*/
|
|
511
567
|
QueryStringParameters?: ConnectionQueryStringParameter[];
|
|
512
568
|
/**
|
|
569
|
+
* @public
|
|
513
570
|
* <p>Contains additional body string parameters for the connection.</p>
|
|
514
571
|
*/
|
|
515
572
|
BodyParameters?: ConnectionBodyParameter[];
|
|
@@ -520,10 +577,12 @@ export interface ConnectionHttpParameters {
|
|
|
520
577
|
*/
|
|
521
578
|
export interface CreateConnectionOAuthClientRequestParameters {
|
|
522
579
|
/**
|
|
580
|
+
* @public
|
|
523
581
|
* <p>The client ID to use for OAuth authorization for the connection.</p>
|
|
524
582
|
*/
|
|
525
583
|
ClientID: string | undefined;
|
|
526
584
|
/**
|
|
585
|
+
* @public
|
|
527
586
|
* <p>The client secret associated with the client ID to use for OAuth authorization for the
|
|
528
587
|
* connection.</p>
|
|
529
588
|
*/
|
|
@@ -548,20 +607,24 @@ export type ConnectionOAuthHttpMethod = (typeof ConnectionOAuthHttpMethod)[keyof
|
|
|
548
607
|
*/
|
|
549
608
|
export interface CreateConnectionOAuthRequestParameters {
|
|
550
609
|
/**
|
|
610
|
+
* @public
|
|
551
611
|
* <p>A <code>CreateConnectionOAuthClientRequestParameters</code> object that contains the
|
|
552
612
|
* client parameters for OAuth authorization.</p>
|
|
553
613
|
*/
|
|
554
614
|
ClientParameters: CreateConnectionOAuthClientRequestParameters | undefined;
|
|
555
615
|
/**
|
|
616
|
+
* @public
|
|
556
617
|
* <p>The URL to the authorization endpoint when OAuth is specified as the authorization
|
|
557
618
|
* type.</p>
|
|
558
619
|
*/
|
|
559
620
|
AuthorizationEndpoint: string | undefined;
|
|
560
621
|
/**
|
|
622
|
+
* @public
|
|
561
623
|
* <p>The method to use for the authorization request.</p>
|
|
562
624
|
*/
|
|
563
625
|
HttpMethod: ConnectionOAuthHttpMethod | string | undefined;
|
|
564
626
|
/**
|
|
627
|
+
* @public
|
|
565
628
|
* <p>A <code>ConnectionHttpParameters</code> object that contains details about the additional
|
|
566
629
|
* parameters to use for the connection.</p>
|
|
567
630
|
*/
|
|
@@ -573,21 +636,25 @@ export interface CreateConnectionOAuthRequestParameters {
|
|
|
573
636
|
*/
|
|
574
637
|
export interface CreateConnectionAuthRequestParameters {
|
|
575
638
|
/**
|
|
639
|
+
* @public
|
|
576
640
|
* <p>A <code>CreateConnectionBasicAuthRequestParameters</code> object that contains the Basic
|
|
577
641
|
* authorization parameters to use for the connection.</p>
|
|
578
642
|
*/
|
|
579
643
|
BasicAuthParameters?: CreateConnectionBasicAuthRequestParameters;
|
|
580
644
|
/**
|
|
645
|
+
* @public
|
|
581
646
|
* <p>A <code>CreateConnectionOAuthRequestParameters</code> object that contains the OAuth
|
|
582
647
|
* authorization parameters to use for the connection.</p>
|
|
583
648
|
*/
|
|
584
649
|
OAuthParameters?: CreateConnectionOAuthRequestParameters;
|
|
585
650
|
/**
|
|
651
|
+
* @public
|
|
586
652
|
* <p>A <code>CreateConnectionApiKeyAuthRequestParameters</code> object that contains the API
|
|
587
653
|
* key authorization parameters to use for the connection.</p>
|
|
588
654
|
*/
|
|
589
655
|
ApiKeyAuthParameters?: CreateConnectionApiKeyAuthRequestParameters;
|
|
590
656
|
/**
|
|
657
|
+
* @public
|
|
591
658
|
* <p>A <code>ConnectionHttpParameters</code> object that contains the API key authorization
|
|
592
659
|
* parameters to use for the connection. Note that if you include additional parameters for the
|
|
593
660
|
* target of a rule via <code>HttpParameters</code>, including query strings, the parameters
|
|
@@ -600,14 +667,17 @@ export interface CreateConnectionAuthRequestParameters {
|
|
|
600
667
|
*/
|
|
601
668
|
export interface CreateConnectionRequest {
|
|
602
669
|
/**
|
|
670
|
+
* @public
|
|
603
671
|
* <p>The name for the connection to create.</p>
|
|
604
672
|
*/
|
|
605
673
|
Name: string | undefined;
|
|
606
674
|
/**
|
|
675
|
+
* @public
|
|
607
676
|
* <p>A description for the connection to create.</p>
|
|
608
677
|
*/
|
|
609
678
|
Description?: string;
|
|
610
679
|
/**
|
|
680
|
+
* @public
|
|
611
681
|
* <p>The type of authorization to use for the connection.</p>
|
|
612
682
|
* <note>
|
|
613
683
|
* <p>OAUTH tokens are refreshed when a 401 or 407 response is returned.</p>
|
|
@@ -615,6 +685,7 @@ export interface CreateConnectionRequest {
|
|
|
615
685
|
*/
|
|
616
686
|
AuthorizationType: ConnectionAuthorizationType | string | undefined;
|
|
617
687
|
/**
|
|
688
|
+
* @public
|
|
618
689
|
* <p>A <code>CreateConnectionAuthRequestParameters</code> object that contains the
|
|
619
690
|
* authorization parameters to use to authorize with the endpoint. </p>
|
|
620
691
|
*/
|
|
@@ -642,18 +713,22 @@ export type ConnectionState = (typeof ConnectionState)[keyof typeof ConnectionSt
|
|
|
642
713
|
*/
|
|
643
714
|
export interface CreateConnectionResponse {
|
|
644
715
|
/**
|
|
716
|
+
* @public
|
|
645
717
|
* <p>The ARN of the connection that was created by the request.</p>
|
|
646
718
|
*/
|
|
647
719
|
ConnectionArn?: string;
|
|
648
720
|
/**
|
|
721
|
+
* @public
|
|
649
722
|
* <p>The state of the connection that was created by the request.</p>
|
|
650
723
|
*/
|
|
651
724
|
ConnectionState?: ConnectionState | string;
|
|
652
725
|
/**
|
|
726
|
+
* @public
|
|
653
727
|
* <p>A time stamp for the time that the connection was created.</p>
|
|
654
728
|
*/
|
|
655
729
|
CreationTime?: Date;
|
|
656
730
|
/**
|
|
731
|
+
* @public
|
|
657
732
|
* <p>A time stamp for the time that the connection was last updated.</p>
|
|
658
733
|
*/
|
|
659
734
|
LastModifiedTime?: Date;
|
|
@@ -664,6 +739,7 @@ export interface CreateConnectionResponse {
|
|
|
664
739
|
*/
|
|
665
740
|
export interface EndpointEventBus {
|
|
666
741
|
/**
|
|
742
|
+
* @public
|
|
667
743
|
* <p>The ARN of the event bus the endpoint is associated with.</p>
|
|
668
744
|
*/
|
|
669
745
|
EventBusArn: string | undefined;
|
|
@@ -686,6 +762,7 @@ export type ReplicationState = (typeof ReplicationState)[keyof typeof Replicatio
|
|
|
686
762
|
*/
|
|
687
763
|
export interface ReplicationConfig {
|
|
688
764
|
/**
|
|
765
|
+
* @public
|
|
689
766
|
* <p>The state of event replication.</p>
|
|
690
767
|
*/
|
|
691
768
|
State?: ReplicationState | string;
|
|
@@ -696,6 +773,7 @@ export interface ReplicationConfig {
|
|
|
696
773
|
*/
|
|
697
774
|
export interface Primary {
|
|
698
775
|
/**
|
|
776
|
+
* @public
|
|
699
777
|
* <p>The ARN of the health check used by the endpoint to determine whether failover is triggered.</p>
|
|
700
778
|
*/
|
|
701
779
|
HealthCheck: string | undefined;
|
|
@@ -706,6 +784,7 @@ export interface Primary {
|
|
|
706
784
|
*/
|
|
707
785
|
export interface Secondary {
|
|
708
786
|
/**
|
|
787
|
+
* @public
|
|
709
788
|
* <p>Defines the secondary Region.</p>
|
|
710
789
|
*/
|
|
711
790
|
Route: string | undefined;
|
|
@@ -716,10 +795,12 @@ export interface Secondary {
|
|
|
716
795
|
*/
|
|
717
796
|
export interface FailoverConfig {
|
|
718
797
|
/**
|
|
798
|
+
* @public
|
|
719
799
|
* <p>The main Region of the endpoint.</p>
|
|
720
800
|
*/
|
|
721
801
|
Primary: Primary | undefined;
|
|
722
802
|
/**
|
|
803
|
+
* @public
|
|
723
804
|
* <p>The Region that events are routed to when failover is triggered or event replication is enabled.</p>
|
|
724
805
|
*/
|
|
725
806
|
Secondary: Secondary | undefined;
|
|
@@ -730,6 +811,7 @@ export interface FailoverConfig {
|
|
|
730
811
|
*/
|
|
731
812
|
export interface RoutingConfig {
|
|
732
813
|
/**
|
|
814
|
+
* @public
|
|
733
815
|
* <p>The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.</p>
|
|
734
816
|
*/
|
|
735
817
|
FailoverConfig: FailoverConfig | undefined;
|
|
@@ -739,23 +821,28 @@ export interface RoutingConfig {
|
|
|
739
821
|
*/
|
|
740
822
|
export interface CreateEndpointRequest {
|
|
741
823
|
/**
|
|
824
|
+
* @public
|
|
742
825
|
* <p>The name of the global endpoint. For example, <code>"Name":"us-east-2-custom_bus_A-endpoint"</code>.</p>
|
|
743
826
|
*/
|
|
744
827
|
Name: string | undefined;
|
|
745
828
|
/**
|
|
829
|
+
* @public
|
|
746
830
|
* <p>A description of the global endpoint.</p>
|
|
747
831
|
*/
|
|
748
832
|
Description?: string;
|
|
749
833
|
/**
|
|
834
|
+
* @public
|
|
750
835
|
* <p>Configure the routing policy, including the health check and secondary Region..</p>
|
|
751
836
|
*/
|
|
752
837
|
RoutingConfig: RoutingConfig | undefined;
|
|
753
838
|
/**
|
|
839
|
+
* @public
|
|
754
840
|
* <p>Enable or disable event replication. The default state is <code>ENABLED</code> which means you must supply a <code>RoleArn</code>. If you don't have a
|
|
755
841
|
* <code>RoleArn</code> or you don't want event replication enabled, set the state to <code>DISABLED</code>.</p>
|
|
756
842
|
*/
|
|
757
843
|
ReplicationConfig?: ReplicationConfig;
|
|
758
844
|
/**
|
|
845
|
+
* @public
|
|
759
846
|
* <p>Define the event buses used. </p>
|
|
760
847
|
* <important>
|
|
761
848
|
* <p>The names of the event buses must be identical in each Region.</p>
|
|
@@ -763,6 +850,7 @@ export interface CreateEndpointRequest {
|
|
|
763
850
|
*/
|
|
764
851
|
EventBuses: EndpointEventBus[] | undefined;
|
|
765
852
|
/**
|
|
853
|
+
* @public
|
|
766
854
|
* <p>The ARN of the role used for replication.</p>
|
|
767
855
|
*/
|
|
768
856
|
RoleArn?: string;
|
|
@@ -789,30 +877,37 @@ export type EndpointState = (typeof EndpointState)[keyof typeof EndpointState];
|
|
|
789
877
|
*/
|
|
790
878
|
export interface CreateEndpointResponse {
|
|
791
879
|
/**
|
|
880
|
+
* @public
|
|
792
881
|
* <p>The name of the endpoint that was created by this request.</p>
|
|
793
882
|
*/
|
|
794
883
|
Name?: string;
|
|
795
884
|
/**
|
|
885
|
+
* @public
|
|
796
886
|
* <p>The ARN of the endpoint that was created by this request.</p>
|
|
797
887
|
*/
|
|
798
888
|
Arn?: string;
|
|
799
889
|
/**
|
|
890
|
+
* @public
|
|
800
891
|
* <p>The routing configuration defined by this request.</p>
|
|
801
892
|
*/
|
|
802
893
|
RoutingConfig?: RoutingConfig;
|
|
803
894
|
/**
|
|
895
|
+
* @public
|
|
804
896
|
* <p>Whether event replication was enabled or disabled by this request.</p>
|
|
805
897
|
*/
|
|
806
898
|
ReplicationConfig?: ReplicationConfig;
|
|
807
899
|
/**
|
|
900
|
+
* @public
|
|
808
901
|
* <p>The event buses used by this request.</p>
|
|
809
902
|
*/
|
|
810
903
|
EventBuses?: EndpointEventBus[];
|
|
811
904
|
/**
|
|
905
|
+
* @public
|
|
812
906
|
* <p>The ARN of the role used by event replication for this request.</p>
|
|
813
907
|
*/
|
|
814
908
|
RoleArn?: string;
|
|
815
909
|
/**
|
|
910
|
+
* @public
|
|
816
911
|
* <p>The state of the endpoint that was created by this request.</p>
|
|
817
912
|
*/
|
|
818
913
|
State?: EndpointState | string;
|
|
@@ -824,11 +919,13 @@ export interface CreateEndpointResponse {
|
|
|
824
919
|
*/
|
|
825
920
|
export interface Tag {
|
|
826
921
|
/**
|
|
922
|
+
* @public
|
|
827
923
|
* <p>A string you can use to assign a value. The combination of tag keys and values can help
|
|
828
924
|
* you organize and categorize your resources.</p>
|
|
829
925
|
*/
|
|
830
926
|
Key: string | undefined;
|
|
831
927
|
/**
|
|
928
|
+
* @public
|
|
832
929
|
* <p>The value for the specified tag key.</p>
|
|
833
930
|
*/
|
|
834
931
|
Value: string | undefined;
|
|
@@ -838,6 +935,7 @@ export interface Tag {
|
|
|
838
935
|
*/
|
|
839
936
|
export interface CreateEventBusRequest {
|
|
840
937
|
/**
|
|
938
|
+
* @public
|
|
841
939
|
* <p>The name of the new event bus. </p>
|
|
842
940
|
* <p>Custom event bus names can't contain the <code>/</code> character, but you can use the <code>/</code> character in partner event bus names. In addition, for partner event buses, the name must exactly match the name of the partner event
|
|
843
941
|
* source that this event bus is matched to.</p>
|
|
@@ -846,11 +944,13 @@ export interface CreateEventBusRequest {
|
|
|
846
944
|
*/
|
|
847
945
|
Name: string | undefined;
|
|
848
946
|
/**
|
|
947
|
+
* @public
|
|
849
948
|
* <p>If you are creating a partner event bus, this specifies the partner event source that the
|
|
850
949
|
* new event bus will be matched with.</p>
|
|
851
950
|
*/
|
|
852
951
|
EventSourceName?: string;
|
|
853
952
|
/**
|
|
953
|
+
* @public
|
|
854
954
|
* <p>Tags to associate with the event bus.</p>
|
|
855
955
|
*/
|
|
856
956
|
Tags?: Tag[];
|
|
@@ -860,6 +960,7 @@ export interface CreateEventBusRequest {
|
|
|
860
960
|
*/
|
|
861
961
|
export interface CreateEventBusResponse {
|
|
862
962
|
/**
|
|
963
|
+
* @public
|
|
863
964
|
* <p>The ARN of the new event bus.</p>
|
|
864
965
|
*/
|
|
865
966
|
EventBusArn?: string;
|
|
@@ -869,6 +970,7 @@ export interface CreateEventBusResponse {
|
|
|
869
970
|
*/
|
|
870
971
|
export interface CreatePartnerEventSourceRequest {
|
|
871
972
|
/**
|
|
973
|
+
* @public
|
|
872
974
|
* <p>The name of the partner event source. This name must be unique and must be in the format
|
|
873
975
|
* <code>
|
|
874
976
|
* <i>partner_name</i>/<i>event_namespace</i>/<i>event_name</i>
|
|
@@ -878,6 +980,7 @@ export interface CreatePartnerEventSourceRequest {
|
|
|
878
980
|
*/
|
|
879
981
|
Name: string | undefined;
|
|
880
982
|
/**
|
|
983
|
+
* @public
|
|
881
984
|
* <p>The Amazon Web Services account ID that is permitted to create a matching partner event bus for this
|
|
882
985
|
* partner event source.</p>
|
|
883
986
|
*/
|
|
@@ -888,6 +991,7 @@ export interface CreatePartnerEventSourceRequest {
|
|
|
888
991
|
*/
|
|
889
992
|
export interface CreatePartnerEventSourceResponse {
|
|
890
993
|
/**
|
|
994
|
+
* @public
|
|
891
995
|
* <p>The ARN of the partner event source.</p>
|
|
892
996
|
*/
|
|
893
997
|
EventSourceArn?: string;
|
|
@@ -897,6 +1001,7 @@ export interface CreatePartnerEventSourceResponse {
|
|
|
897
1001
|
*/
|
|
898
1002
|
export interface DeactivateEventSourceRequest {
|
|
899
1003
|
/**
|
|
1004
|
+
* @public
|
|
900
1005
|
* <p>The name of the partner event source to deactivate.</p>
|
|
901
1006
|
*/
|
|
902
1007
|
Name: string | undefined;
|
|
@@ -906,6 +1011,7 @@ export interface DeactivateEventSourceRequest {
|
|
|
906
1011
|
*/
|
|
907
1012
|
export interface DeauthorizeConnectionRequest {
|
|
908
1013
|
/**
|
|
1014
|
+
* @public
|
|
909
1015
|
* <p>The name of the connection to remove authorization from.</p>
|
|
910
1016
|
*/
|
|
911
1017
|
Name: string | undefined;
|
|
@@ -915,22 +1021,27 @@ export interface DeauthorizeConnectionRequest {
|
|
|
915
1021
|
*/
|
|
916
1022
|
export interface DeauthorizeConnectionResponse {
|
|
917
1023
|
/**
|
|
1024
|
+
* @public
|
|
918
1025
|
* <p>The ARN of the connection that authorization was removed from.</p>
|
|
919
1026
|
*/
|
|
920
1027
|
ConnectionArn?: string;
|
|
921
1028
|
/**
|
|
1029
|
+
* @public
|
|
922
1030
|
* <p>The state of the connection.</p>
|
|
923
1031
|
*/
|
|
924
1032
|
ConnectionState?: ConnectionState | string;
|
|
925
1033
|
/**
|
|
1034
|
+
* @public
|
|
926
1035
|
* <p>A time stamp for the time that the connection was created.</p>
|
|
927
1036
|
*/
|
|
928
1037
|
CreationTime?: Date;
|
|
929
1038
|
/**
|
|
1039
|
+
* @public
|
|
930
1040
|
* <p>A time stamp for the time that the connection was last updated.</p>
|
|
931
1041
|
*/
|
|
932
1042
|
LastModifiedTime?: Date;
|
|
933
1043
|
/**
|
|
1044
|
+
* @public
|
|
934
1045
|
* <p>A time stamp for the time that the connection was last authorized.</p>
|
|
935
1046
|
*/
|
|
936
1047
|
LastAuthorizedTime?: Date;
|
|
@@ -940,6 +1051,7 @@ export interface DeauthorizeConnectionResponse {
|
|
|
940
1051
|
*/
|
|
941
1052
|
export interface DeleteApiDestinationRequest {
|
|
942
1053
|
/**
|
|
1054
|
+
* @public
|
|
943
1055
|
* <p>The name of the destination to delete.</p>
|
|
944
1056
|
*/
|
|
945
1057
|
Name: string | undefined;
|
|
@@ -954,6 +1066,7 @@ export interface DeleteApiDestinationResponse {
|
|
|
954
1066
|
*/
|
|
955
1067
|
export interface DeleteArchiveRequest {
|
|
956
1068
|
/**
|
|
1069
|
+
* @public
|
|
957
1070
|
* <p>The name of the archive to delete.</p>
|
|
958
1071
|
*/
|
|
959
1072
|
ArchiveName: string | undefined;
|
|
@@ -968,6 +1081,7 @@ export interface DeleteArchiveResponse {
|
|
|
968
1081
|
*/
|
|
969
1082
|
export interface DeleteConnectionRequest {
|
|
970
1083
|
/**
|
|
1084
|
+
* @public
|
|
971
1085
|
* <p>The name of the connection to delete.</p>
|
|
972
1086
|
*/
|
|
973
1087
|
Name: string | undefined;
|
|
@@ -977,23 +1091,28 @@ export interface DeleteConnectionRequest {
|
|
|
977
1091
|
*/
|
|
978
1092
|
export interface DeleteConnectionResponse {
|
|
979
1093
|
/**
|
|
1094
|
+
* @public
|
|
980
1095
|
* <p>The ARN of the connection that was deleted.</p>
|
|
981
1096
|
*/
|
|
982
1097
|
ConnectionArn?: string;
|
|
983
1098
|
/**
|
|
1099
|
+
* @public
|
|
984
1100
|
* <p>The state of the connection before it was deleted.</p>
|
|
985
1101
|
*/
|
|
986
1102
|
ConnectionState?: ConnectionState | string;
|
|
987
1103
|
/**
|
|
1104
|
+
* @public
|
|
988
1105
|
* <p>A time stamp for the time that the connection was created.</p>
|
|
989
1106
|
*/
|
|
990
1107
|
CreationTime?: Date;
|
|
991
1108
|
/**
|
|
1109
|
+
* @public
|
|
992
1110
|
* <p>A time stamp for the time that the connection was last modified before it was
|
|
993
1111
|
* deleted.</p>
|
|
994
1112
|
*/
|
|
995
1113
|
LastModifiedTime?: Date;
|
|
996
1114
|
/**
|
|
1115
|
+
* @public
|
|
997
1116
|
* <p>A time stamp for the time that the connection was last authorized before it wa
|
|
998
1117
|
* deleted.</p>
|
|
999
1118
|
*/
|
|
@@ -1004,6 +1123,7 @@ export interface DeleteConnectionResponse {
|
|
|
1004
1123
|
*/
|
|
1005
1124
|
export interface DeleteEndpointRequest {
|
|
1006
1125
|
/**
|
|
1126
|
+
* @public
|
|
1007
1127
|
* <p>The name of the endpoint you want to delete. For example, <code>"Name":"us-east-2-custom_bus_A-endpoint"</code>..</p>
|
|
1008
1128
|
*/
|
|
1009
1129
|
Name: string | undefined;
|
|
@@ -1018,6 +1138,7 @@ export interface DeleteEndpointResponse {
|
|
|
1018
1138
|
*/
|
|
1019
1139
|
export interface DeleteEventBusRequest {
|
|
1020
1140
|
/**
|
|
1141
|
+
* @public
|
|
1021
1142
|
* <p>The name of the event bus to delete.</p>
|
|
1022
1143
|
*/
|
|
1023
1144
|
Name: string | undefined;
|
|
@@ -1027,10 +1148,12 @@ export interface DeleteEventBusRequest {
|
|
|
1027
1148
|
*/
|
|
1028
1149
|
export interface DeletePartnerEventSourceRequest {
|
|
1029
1150
|
/**
|
|
1151
|
+
* @public
|
|
1030
1152
|
* <p>The name of the event source to delete.</p>
|
|
1031
1153
|
*/
|
|
1032
1154
|
Name: string | undefined;
|
|
1033
1155
|
/**
|
|
1156
|
+
* @public
|
|
1034
1157
|
* <p>The Amazon Web Services account ID of the Amazon Web Services customer that the event source was created for.</p>
|
|
1035
1158
|
*/
|
|
1036
1159
|
Account: string | undefined;
|
|
@@ -1040,15 +1163,18 @@ export interface DeletePartnerEventSourceRequest {
|
|
|
1040
1163
|
*/
|
|
1041
1164
|
export interface DeleteRuleRequest {
|
|
1042
1165
|
/**
|
|
1166
|
+
* @public
|
|
1043
1167
|
* <p>The name of the rule.</p>
|
|
1044
1168
|
*/
|
|
1045
1169
|
Name: string | undefined;
|
|
1046
1170
|
/**
|
|
1171
|
+
* @public
|
|
1047
1172
|
* <p>The name or ARN of the event bus associated with the rule. If you omit this, the default
|
|
1048
1173
|
* event bus is used.</p>
|
|
1049
1174
|
*/
|
|
1050
1175
|
EventBusName?: string;
|
|
1051
1176
|
/**
|
|
1177
|
+
* @public
|
|
1052
1178
|
* <p>If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify
|
|
1053
1179
|
* <code>Force</code> as <code>True</code> to delete the rule. This parameter is ignored for
|
|
1054
1180
|
* rules that are not managed rules. You can check whether a rule is a managed rule by using
|
|
@@ -1079,6 +1205,7 @@ export declare class ManagedRuleException extends __BaseException {
|
|
|
1079
1205
|
*/
|
|
1080
1206
|
export interface DescribeApiDestinationRequest {
|
|
1081
1207
|
/**
|
|
1208
|
+
* @public
|
|
1082
1209
|
* <p>The name of the API destination to retrieve.</p>
|
|
1083
1210
|
*/
|
|
1084
1211
|
Name: string | undefined;
|
|
@@ -1088,34 +1215,42 @@ export interface DescribeApiDestinationRequest {
|
|
|
1088
1215
|
*/
|
|
1089
1216
|
export interface DescribeApiDestinationResponse {
|
|
1090
1217
|
/**
|
|
1218
|
+
* @public
|
|
1091
1219
|
* <p>The ARN of the API destination retrieved.</p>
|
|
1092
1220
|
*/
|
|
1093
1221
|
ApiDestinationArn?: string;
|
|
1094
1222
|
/**
|
|
1223
|
+
* @public
|
|
1095
1224
|
* <p>The name of the API destination retrieved.</p>
|
|
1096
1225
|
*/
|
|
1097
1226
|
Name?: string;
|
|
1098
1227
|
/**
|
|
1228
|
+
* @public
|
|
1099
1229
|
* <p>The description for the API destination retrieved.</p>
|
|
1100
1230
|
*/
|
|
1101
1231
|
Description?: string;
|
|
1102
1232
|
/**
|
|
1233
|
+
* @public
|
|
1103
1234
|
* <p>The state of the API destination retrieved.</p>
|
|
1104
1235
|
*/
|
|
1105
1236
|
ApiDestinationState?: ApiDestinationState | string;
|
|
1106
1237
|
/**
|
|
1238
|
+
* @public
|
|
1107
1239
|
* <p>The ARN of the connection specified for the API destination retrieved.</p>
|
|
1108
1240
|
*/
|
|
1109
1241
|
ConnectionArn?: string;
|
|
1110
1242
|
/**
|
|
1243
|
+
* @public
|
|
1111
1244
|
* <p>The URL to use to connect to the HTTP endpoint.</p>
|
|
1112
1245
|
*/
|
|
1113
1246
|
InvocationEndpoint?: string;
|
|
1114
1247
|
/**
|
|
1248
|
+
* @public
|
|
1115
1249
|
* <p>The method to use to connect to the HTTP endpoint.</p>
|
|
1116
1250
|
*/
|
|
1117
1251
|
HttpMethod?: ApiDestinationHttpMethod | string;
|
|
1118
1252
|
/**
|
|
1253
|
+
* @public
|
|
1119
1254
|
* <p>The maximum number of invocations per second to specified for the API destination. Note
|
|
1120
1255
|
* that if you set the invocation rate maximum to a value lower the rate necessary to send all
|
|
1121
1256
|
* events received on to the destination HTTP endpoint, some events may not be delivered within
|
|
@@ -1125,10 +1260,12 @@ export interface DescribeApiDestinationResponse {
|
|
|
1125
1260
|
*/
|
|
1126
1261
|
InvocationRateLimitPerSecond?: number;
|
|
1127
1262
|
/**
|
|
1263
|
+
* @public
|
|
1128
1264
|
* <p>A time stamp for the time that the API destination was created.</p>
|
|
1129
1265
|
*/
|
|
1130
1266
|
CreationTime?: Date;
|
|
1131
1267
|
/**
|
|
1268
|
+
* @public
|
|
1132
1269
|
* <p>A time stamp for the time that the API destination was last modified.</p>
|
|
1133
1270
|
*/
|
|
1134
1271
|
LastModifiedTime?: Date;
|
|
@@ -1138,6 +1275,7 @@ export interface DescribeApiDestinationResponse {
|
|
|
1138
1275
|
*/
|
|
1139
1276
|
export interface DescribeArchiveRequest {
|
|
1140
1277
|
/**
|
|
1278
|
+
* @public
|
|
1141
1279
|
* <p>The name of the archive to retrieve.</p>
|
|
1142
1280
|
*/
|
|
1143
1281
|
ArchiveName: string | undefined;
|
|
@@ -1147,46 +1285,57 @@ export interface DescribeArchiveRequest {
|
|
|
1147
1285
|
*/
|
|
1148
1286
|
export interface DescribeArchiveResponse {
|
|
1149
1287
|
/**
|
|
1288
|
+
* @public
|
|
1150
1289
|
* <p>The ARN of the archive.</p>
|
|
1151
1290
|
*/
|
|
1152
1291
|
ArchiveArn?: string;
|
|
1153
1292
|
/**
|
|
1293
|
+
* @public
|
|
1154
1294
|
* <p>The name of the archive.</p>
|
|
1155
1295
|
*/
|
|
1156
1296
|
ArchiveName?: string;
|
|
1157
1297
|
/**
|
|
1298
|
+
* @public
|
|
1158
1299
|
* <p>The ARN of the event source associated with the archive.</p>
|
|
1159
1300
|
*/
|
|
1160
1301
|
EventSourceArn?: string;
|
|
1161
1302
|
/**
|
|
1303
|
+
* @public
|
|
1162
1304
|
* <p>The description of the archive.</p>
|
|
1163
1305
|
*/
|
|
1164
1306
|
Description?: string;
|
|
1165
1307
|
/**
|
|
1308
|
+
* @public
|
|
1166
1309
|
* <p>The event pattern used to filter events sent to the archive.</p>
|
|
1167
1310
|
*/
|
|
1168
1311
|
EventPattern?: string;
|
|
1169
1312
|
/**
|
|
1313
|
+
* @public
|
|
1170
1314
|
* <p>The state of the archive.</p>
|
|
1171
1315
|
*/
|
|
1172
1316
|
State?: ArchiveState | string;
|
|
1173
1317
|
/**
|
|
1318
|
+
* @public
|
|
1174
1319
|
* <p>The reason that the archive is in the state.</p>
|
|
1175
1320
|
*/
|
|
1176
1321
|
StateReason?: string;
|
|
1177
1322
|
/**
|
|
1323
|
+
* @public
|
|
1178
1324
|
* <p>The number of days to retain events for in the archive.</p>
|
|
1179
1325
|
*/
|
|
1180
1326
|
RetentionDays?: number;
|
|
1181
1327
|
/**
|
|
1328
|
+
* @public
|
|
1182
1329
|
* <p>The size of the archive in bytes.</p>
|
|
1183
1330
|
*/
|
|
1184
1331
|
SizeBytes?: number;
|
|
1185
1332
|
/**
|
|
1333
|
+
* @public
|
|
1186
1334
|
* <p>The number of events in the archive.</p>
|
|
1187
1335
|
*/
|
|
1188
1336
|
EventCount?: number;
|
|
1189
1337
|
/**
|
|
1338
|
+
* @public
|
|
1190
1339
|
* <p>The time at which the archive was created.</p>
|
|
1191
1340
|
*/
|
|
1192
1341
|
CreationTime?: Date;
|
|
@@ -1196,6 +1345,7 @@ export interface DescribeArchiveResponse {
|
|
|
1196
1345
|
*/
|
|
1197
1346
|
export interface DescribeConnectionRequest {
|
|
1198
1347
|
/**
|
|
1348
|
+
* @public
|
|
1199
1349
|
* <p>The name of the connection to retrieve.</p>
|
|
1200
1350
|
*/
|
|
1201
1351
|
Name: string | undefined;
|
|
@@ -1207,6 +1357,7 @@ export interface DescribeConnectionRequest {
|
|
|
1207
1357
|
*/
|
|
1208
1358
|
export interface ConnectionApiKeyAuthResponseParameters {
|
|
1209
1359
|
/**
|
|
1360
|
+
* @public
|
|
1210
1361
|
* <p>The name of the header to use for the <code>APIKeyValue</code> used for
|
|
1211
1362
|
* authorization.</p>
|
|
1212
1363
|
*/
|
|
@@ -1219,6 +1370,7 @@ export interface ConnectionApiKeyAuthResponseParameters {
|
|
|
1219
1370
|
*/
|
|
1220
1371
|
export interface ConnectionBasicAuthResponseParameters {
|
|
1221
1372
|
/**
|
|
1373
|
+
* @public
|
|
1222
1374
|
* <p>The user name to use for Basic authorization.</p>
|
|
1223
1375
|
*/
|
|
1224
1376
|
Username?: string;
|
|
@@ -1230,6 +1382,7 @@ export interface ConnectionBasicAuthResponseParameters {
|
|
|
1230
1382
|
*/
|
|
1231
1383
|
export interface ConnectionOAuthClientResponseParameters {
|
|
1232
1384
|
/**
|
|
1385
|
+
* @public
|
|
1233
1386
|
* <p>The client ID associated with the response to the connection request.</p>
|
|
1234
1387
|
*/
|
|
1235
1388
|
ClientID?: string;
|
|
@@ -1240,19 +1393,23 @@ export interface ConnectionOAuthClientResponseParameters {
|
|
|
1240
1393
|
*/
|
|
1241
1394
|
export interface ConnectionOAuthResponseParameters {
|
|
1242
1395
|
/**
|
|
1396
|
+
* @public
|
|
1243
1397
|
* <p>A <code>ConnectionOAuthClientResponseParameters</code> object that contains details about
|
|
1244
1398
|
* the client parameters returned when OAuth is specified as the authorization type.</p>
|
|
1245
1399
|
*/
|
|
1246
1400
|
ClientParameters?: ConnectionOAuthClientResponseParameters;
|
|
1247
1401
|
/**
|
|
1402
|
+
* @public
|
|
1248
1403
|
* <p>The URL to the HTTP endpoint that authorized the request.</p>
|
|
1249
1404
|
*/
|
|
1250
1405
|
AuthorizationEndpoint?: string;
|
|
1251
1406
|
/**
|
|
1407
|
+
* @public
|
|
1252
1408
|
* <p>The method used to connect to the HTTP endpoint.</p>
|
|
1253
1409
|
*/
|
|
1254
1410
|
HttpMethod?: ConnectionOAuthHttpMethod | string;
|
|
1255
1411
|
/**
|
|
1412
|
+
* @public
|
|
1256
1413
|
* <p>The additional HTTP parameters used for the OAuth authorization request.</p>
|
|
1257
1414
|
*/
|
|
1258
1415
|
OAuthHttpParameters?: ConnectionHttpParameters;
|
|
@@ -1263,18 +1420,22 @@ export interface ConnectionOAuthResponseParameters {
|
|
|
1263
1420
|
*/
|
|
1264
1421
|
export interface ConnectionAuthResponseParameters {
|
|
1265
1422
|
/**
|
|
1423
|
+
* @public
|
|
1266
1424
|
* <p>The authorization parameters for Basic authorization.</p>
|
|
1267
1425
|
*/
|
|
1268
1426
|
BasicAuthParameters?: ConnectionBasicAuthResponseParameters;
|
|
1269
1427
|
/**
|
|
1428
|
+
* @public
|
|
1270
1429
|
* <p>The OAuth parameters to use for authorization.</p>
|
|
1271
1430
|
*/
|
|
1272
1431
|
OAuthParameters?: ConnectionOAuthResponseParameters;
|
|
1273
1432
|
/**
|
|
1433
|
+
* @public
|
|
1274
1434
|
* <p>The API Key parameters to use for authorization.</p>
|
|
1275
1435
|
*/
|
|
1276
1436
|
ApiKeyAuthParameters?: ConnectionApiKeyAuthResponseParameters;
|
|
1277
1437
|
/**
|
|
1438
|
+
* @public
|
|
1278
1439
|
* <p>Additional parameters for the connection that are passed through with every invocation to
|
|
1279
1440
|
* the HTTP endpoint.</p>
|
|
1280
1441
|
*/
|
|
@@ -1285,47 +1446,58 @@ export interface ConnectionAuthResponseParameters {
|
|
|
1285
1446
|
*/
|
|
1286
1447
|
export interface DescribeConnectionResponse {
|
|
1287
1448
|
/**
|
|
1449
|
+
* @public
|
|
1288
1450
|
* <p>The ARN of the connection retrieved.</p>
|
|
1289
1451
|
*/
|
|
1290
1452
|
ConnectionArn?: string;
|
|
1291
1453
|
/**
|
|
1454
|
+
* @public
|
|
1292
1455
|
* <p>The name of the connection retrieved.</p>
|
|
1293
1456
|
*/
|
|
1294
1457
|
Name?: string;
|
|
1295
1458
|
/**
|
|
1459
|
+
* @public
|
|
1296
1460
|
* <p>The description for the connection retrieved.</p>
|
|
1297
1461
|
*/
|
|
1298
1462
|
Description?: string;
|
|
1299
1463
|
/**
|
|
1464
|
+
* @public
|
|
1300
1465
|
* <p>The state of the connection retrieved.</p>
|
|
1301
1466
|
*/
|
|
1302
1467
|
ConnectionState?: ConnectionState | string;
|
|
1303
1468
|
/**
|
|
1469
|
+
* @public
|
|
1304
1470
|
* <p>The reason that the connection is in the current connection state.</p>
|
|
1305
1471
|
*/
|
|
1306
1472
|
StateReason?: string;
|
|
1307
1473
|
/**
|
|
1474
|
+
* @public
|
|
1308
1475
|
* <p>The type of authorization specified for the connection.</p>
|
|
1309
1476
|
*/
|
|
1310
1477
|
AuthorizationType?: ConnectionAuthorizationType | string;
|
|
1311
1478
|
/**
|
|
1479
|
+
* @public
|
|
1312
1480
|
* <p>The ARN of the secret created from the authorization parameters specified for the
|
|
1313
1481
|
* connection.</p>
|
|
1314
1482
|
*/
|
|
1315
1483
|
SecretArn?: string;
|
|
1316
1484
|
/**
|
|
1485
|
+
* @public
|
|
1317
1486
|
* <p>The parameters to use for authorization for the connection.</p>
|
|
1318
1487
|
*/
|
|
1319
1488
|
AuthParameters?: ConnectionAuthResponseParameters;
|
|
1320
1489
|
/**
|
|
1490
|
+
* @public
|
|
1321
1491
|
* <p>A time stamp for the time that the connection was created.</p>
|
|
1322
1492
|
*/
|
|
1323
1493
|
CreationTime?: Date;
|
|
1324
1494
|
/**
|
|
1495
|
+
* @public
|
|
1325
1496
|
* <p>A time stamp for the time that the connection was last modified.</p>
|
|
1326
1497
|
*/
|
|
1327
1498
|
LastModifiedTime?: Date;
|
|
1328
1499
|
/**
|
|
1500
|
+
* @public
|
|
1329
1501
|
* <p>A time stamp for the time that the connection was last authorized.</p>
|
|
1330
1502
|
*/
|
|
1331
1503
|
LastAuthorizedTime?: Date;
|
|
@@ -1335,10 +1507,12 @@ export interface DescribeConnectionResponse {
|
|
|
1335
1507
|
*/
|
|
1336
1508
|
export interface DescribeEndpointRequest {
|
|
1337
1509
|
/**
|
|
1510
|
+
* @public
|
|
1338
1511
|
* <p>The name of the endpoint you want to get information about. For example, <code>"Name":"us-east-2-custom_bus_A-endpoint"</code>.</p>
|
|
1339
1512
|
*/
|
|
1340
1513
|
Name: string | undefined;
|
|
1341
1514
|
/**
|
|
1515
|
+
* @public
|
|
1342
1516
|
* <p>The primary Region of the endpoint you want to get information about. For example <code>"HomeRegion": "us-east-1"</code>.</p>
|
|
1343
1517
|
*/
|
|
1344
1518
|
HomeRegion?: string;
|
|
@@ -1348,54 +1522,67 @@ export interface DescribeEndpointRequest {
|
|
|
1348
1522
|
*/
|
|
1349
1523
|
export interface DescribeEndpointResponse {
|
|
1350
1524
|
/**
|
|
1525
|
+
* @public
|
|
1351
1526
|
* <p>The name of the endpoint you asked for information about.</p>
|
|
1352
1527
|
*/
|
|
1353
1528
|
Name?: string;
|
|
1354
1529
|
/**
|
|
1530
|
+
* @public
|
|
1355
1531
|
* <p>The description of the endpoint you asked for information about.</p>
|
|
1356
1532
|
*/
|
|
1357
1533
|
Description?: string;
|
|
1358
1534
|
/**
|
|
1535
|
+
* @public
|
|
1359
1536
|
* <p>The ARN of the endpoint you asked for information about.</p>
|
|
1360
1537
|
*/
|
|
1361
1538
|
Arn?: string;
|
|
1362
1539
|
/**
|
|
1540
|
+
* @public
|
|
1363
1541
|
* <p>The routing configuration of the endpoint you asked for information about.</p>
|
|
1364
1542
|
*/
|
|
1365
1543
|
RoutingConfig?: RoutingConfig;
|
|
1366
1544
|
/**
|
|
1545
|
+
* @public
|
|
1367
1546
|
* <p>Whether replication is enabled or disabled for the endpoint you asked for information about.</p>
|
|
1368
1547
|
*/
|
|
1369
1548
|
ReplicationConfig?: ReplicationConfig;
|
|
1370
1549
|
/**
|
|
1550
|
+
* @public
|
|
1371
1551
|
* <p>The event buses being used by the endpoint you asked for information about.</p>
|
|
1372
1552
|
*/
|
|
1373
1553
|
EventBuses?: EndpointEventBus[];
|
|
1374
1554
|
/**
|
|
1555
|
+
* @public
|
|
1375
1556
|
* <p>The ARN of the role used by the endpoint you asked for information about.</p>
|
|
1376
1557
|
*/
|
|
1377
1558
|
RoleArn?: string;
|
|
1378
1559
|
/**
|
|
1560
|
+
* @public
|
|
1379
1561
|
* <p>The ID of the endpoint you asked for information about.</p>
|
|
1380
1562
|
*/
|
|
1381
1563
|
EndpointId?: string;
|
|
1382
1564
|
/**
|
|
1565
|
+
* @public
|
|
1383
1566
|
* <p>The URL of the endpoint you asked for information about.</p>
|
|
1384
1567
|
*/
|
|
1385
1568
|
EndpointUrl?: string;
|
|
1386
1569
|
/**
|
|
1570
|
+
* @public
|
|
1387
1571
|
* <p>The current state of the endpoint you asked for information about.</p>
|
|
1388
1572
|
*/
|
|
1389
1573
|
State?: EndpointState | string;
|
|
1390
1574
|
/**
|
|
1575
|
+
* @public
|
|
1391
1576
|
* <p>The reason the endpoint you asked for information about is in its current state.</p>
|
|
1392
1577
|
*/
|
|
1393
1578
|
StateReason?: string;
|
|
1394
1579
|
/**
|
|
1580
|
+
* @public
|
|
1395
1581
|
* <p>The time the endpoint you asked for information about was created.</p>
|
|
1396
1582
|
*/
|
|
1397
1583
|
CreationTime?: Date;
|
|
1398
1584
|
/**
|
|
1585
|
+
* @public
|
|
1399
1586
|
* <p>The last time the endpoint you asked for information about was modified.</p>
|
|
1400
1587
|
*/
|
|
1401
1588
|
LastModifiedTime?: Date;
|
|
@@ -1405,6 +1592,7 @@ export interface DescribeEndpointResponse {
|
|
|
1405
1592
|
*/
|
|
1406
1593
|
export interface DescribeEventBusRequest {
|
|
1407
1594
|
/**
|
|
1595
|
+
* @public
|
|
1408
1596
|
* <p>The name or ARN of the event bus to show details for. If you omit this, the default event
|
|
1409
1597
|
* bus is displayed.</p>
|
|
1410
1598
|
*/
|
|
@@ -1415,15 +1603,18 @@ export interface DescribeEventBusRequest {
|
|
|
1415
1603
|
*/
|
|
1416
1604
|
export interface DescribeEventBusResponse {
|
|
1417
1605
|
/**
|
|
1606
|
+
* @public
|
|
1418
1607
|
* <p>The name of the event bus. Currently, this is always <code>default</code>.</p>
|
|
1419
1608
|
*/
|
|
1420
1609
|
Name?: string;
|
|
1421
1610
|
/**
|
|
1611
|
+
* @public
|
|
1422
1612
|
* <p>The Amazon Resource Name (ARN) of the account permitted to write events to the current
|
|
1423
1613
|
* account.</p>
|
|
1424
1614
|
*/
|
|
1425
1615
|
Arn?: string;
|
|
1426
1616
|
/**
|
|
1617
|
+
* @public
|
|
1427
1618
|
* <p>The policy that enables the external account to send events to your account.</p>
|
|
1428
1619
|
*/
|
|
1429
1620
|
Policy?: string;
|
|
@@ -1433,6 +1624,7 @@ export interface DescribeEventBusResponse {
|
|
|
1433
1624
|
*/
|
|
1434
1625
|
export interface DescribeEventSourceRequest {
|
|
1435
1626
|
/**
|
|
1627
|
+
* @public
|
|
1436
1628
|
* <p>The name of the partner event source to display the details of.</p>
|
|
1437
1629
|
*/
|
|
1438
1630
|
Name: string | undefined;
|
|
@@ -1455,27 +1647,33 @@ export type EventSourceState = (typeof EventSourceState)[keyof typeof EventSourc
|
|
|
1455
1647
|
*/
|
|
1456
1648
|
export interface DescribeEventSourceResponse {
|
|
1457
1649
|
/**
|
|
1650
|
+
* @public
|
|
1458
1651
|
* <p>The ARN of the partner event source.</p>
|
|
1459
1652
|
*/
|
|
1460
1653
|
Arn?: string;
|
|
1461
1654
|
/**
|
|
1655
|
+
* @public
|
|
1462
1656
|
* <p>The name of the SaaS partner that created the event source.</p>
|
|
1463
1657
|
*/
|
|
1464
1658
|
CreatedBy?: string;
|
|
1465
1659
|
/**
|
|
1660
|
+
* @public
|
|
1466
1661
|
* <p>The date and time that the event source was created.</p>
|
|
1467
1662
|
*/
|
|
1468
1663
|
CreationTime?: Date;
|
|
1469
1664
|
/**
|
|
1665
|
+
* @public
|
|
1470
1666
|
* <p>The date and time that the event source will expire if you do not create a matching event
|
|
1471
1667
|
* bus.</p>
|
|
1472
1668
|
*/
|
|
1473
1669
|
ExpirationTime?: Date;
|
|
1474
1670
|
/**
|
|
1671
|
+
* @public
|
|
1475
1672
|
* <p>The name of the partner event source.</p>
|
|
1476
1673
|
*/
|
|
1477
1674
|
Name?: string;
|
|
1478
1675
|
/**
|
|
1676
|
+
* @public
|
|
1479
1677
|
* <p>The state of the event source. If it is ACTIVE, you have already created a matching event
|
|
1480
1678
|
* bus for this event source, and that event bus is active. If it is PENDING, either you haven't
|
|
1481
1679
|
* yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have
|
|
@@ -1488,6 +1686,7 @@ export interface DescribeEventSourceResponse {
|
|
|
1488
1686
|
*/
|
|
1489
1687
|
export interface DescribePartnerEventSourceRequest {
|
|
1490
1688
|
/**
|
|
1689
|
+
* @public
|
|
1491
1690
|
* <p>The name of the event source to display.</p>
|
|
1492
1691
|
*/
|
|
1493
1692
|
Name: string | undefined;
|
|
@@ -1497,10 +1696,12 @@ export interface DescribePartnerEventSourceRequest {
|
|
|
1497
1696
|
*/
|
|
1498
1697
|
export interface DescribePartnerEventSourceResponse {
|
|
1499
1698
|
/**
|
|
1699
|
+
* @public
|
|
1500
1700
|
* <p>The ARN of the event source.</p>
|
|
1501
1701
|
*/
|
|
1502
1702
|
Arn?: string;
|
|
1503
1703
|
/**
|
|
1704
|
+
* @public
|
|
1504
1705
|
* <p>The name of the event source.</p>
|
|
1505
1706
|
*/
|
|
1506
1707
|
Name?: string;
|
|
@@ -1510,6 +1711,7 @@ export interface DescribePartnerEventSourceResponse {
|
|
|
1510
1711
|
*/
|
|
1511
1712
|
export interface DescribeReplayRequest {
|
|
1512
1713
|
/**
|
|
1714
|
+
* @public
|
|
1513
1715
|
* <p>The name of the replay to retrieve.</p>
|
|
1514
1716
|
*/
|
|
1515
1717
|
ReplayName: string | undefined;
|
|
@@ -1520,11 +1722,13 @@ export interface DescribeReplayRequest {
|
|
|
1520
1722
|
*/
|
|
1521
1723
|
export interface ReplayDestination {
|
|
1522
1724
|
/**
|
|
1725
|
+
* @public
|
|
1523
1726
|
* <p>The ARN of the event bus to replay event to. You can replay events only to the event bus
|
|
1524
1727
|
* specified to create the archive.</p>
|
|
1525
1728
|
*/
|
|
1526
1729
|
Arn: string | undefined;
|
|
1527
1730
|
/**
|
|
1731
|
+
* @public
|
|
1528
1732
|
* <p>A list of ARNs for rules to replay events to.</p>
|
|
1529
1733
|
*/
|
|
1530
1734
|
FilterArns?: string[];
|
|
@@ -1534,50 +1738,62 @@ export interface ReplayDestination {
|
|
|
1534
1738
|
*/
|
|
1535
1739
|
export interface DescribeReplayResponse {
|
|
1536
1740
|
/**
|
|
1741
|
+
* @public
|
|
1537
1742
|
* <p>The name of the replay.</p>
|
|
1538
1743
|
*/
|
|
1539
1744
|
ReplayName?: string;
|
|
1540
1745
|
/**
|
|
1746
|
+
* @public
|
|
1541
1747
|
* <p>The ARN of the replay.</p>
|
|
1542
1748
|
*/
|
|
1543
1749
|
ReplayArn?: string;
|
|
1544
1750
|
/**
|
|
1751
|
+
* @public
|
|
1545
1752
|
* <p>The description of the replay.</p>
|
|
1546
1753
|
*/
|
|
1547
1754
|
Description?: string;
|
|
1548
1755
|
/**
|
|
1756
|
+
* @public
|
|
1549
1757
|
* <p>The current state of the replay.</p>
|
|
1550
1758
|
*/
|
|
1551
1759
|
State?: ReplayState | string;
|
|
1552
1760
|
/**
|
|
1761
|
+
* @public
|
|
1553
1762
|
* <p>The reason that the replay is in the current state.</p>
|
|
1554
1763
|
*/
|
|
1555
1764
|
StateReason?: string;
|
|
1556
1765
|
/**
|
|
1766
|
+
* @public
|
|
1557
1767
|
* <p>The ARN of the archive events were replayed from.</p>
|
|
1558
1768
|
*/
|
|
1559
1769
|
EventSourceArn?: string;
|
|
1560
1770
|
/**
|
|
1771
|
+
* @public
|
|
1561
1772
|
* <p>A <code>ReplayDestination</code> object that contains details about the replay.</p>
|
|
1562
1773
|
*/
|
|
1563
1774
|
Destination?: ReplayDestination;
|
|
1564
1775
|
/**
|
|
1776
|
+
* @public
|
|
1565
1777
|
* <p>The time stamp of the first event that was last replayed from the archive.</p>
|
|
1566
1778
|
*/
|
|
1567
1779
|
EventStartTime?: Date;
|
|
1568
1780
|
/**
|
|
1781
|
+
* @public
|
|
1569
1782
|
* <p>The time stamp for the last event that was replayed from the archive.</p>
|
|
1570
1783
|
*/
|
|
1571
1784
|
EventEndTime?: Date;
|
|
1572
1785
|
/**
|
|
1786
|
+
* @public
|
|
1573
1787
|
* <p>The time that the event was last replayed.</p>
|
|
1574
1788
|
*/
|
|
1575
1789
|
EventLastReplayedTime?: Date;
|
|
1576
1790
|
/**
|
|
1791
|
+
* @public
|
|
1577
1792
|
* <p>A time stamp for the time that the replay started.</p>
|
|
1578
1793
|
*/
|
|
1579
1794
|
ReplayStartTime?: Date;
|
|
1580
1795
|
/**
|
|
1796
|
+
* @public
|
|
1581
1797
|
* <p>A time stamp for the time that the replay stopped.</p>
|
|
1582
1798
|
*/
|
|
1583
1799
|
ReplayEndTime?: Date;
|
|
@@ -1587,10 +1803,12 @@ export interface DescribeReplayResponse {
|
|
|
1587
1803
|
*/
|
|
1588
1804
|
export interface DescribeRuleRequest {
|
|
1589
1805
|
/**
|
|
1806
|
+
* @public
|
|
1590
1807
|
* <p>The name of the rule.</p>
|
|
1591
1808
|
*/
|
|
1592
1809
|
Name: string | undefined;
|
|
1593
1810
|
/**
|
|
1811
|
+
* @public
|
|
1594
1812
|
* <p>The name or ARN of the event bus associated with the rule. If you omit this, the default
|
|
1595
1813
|
* event bus is used.</p>
|
|
1596
1814
|
*/
|
|
@@ -1613,44 +1831,54 @@ export type RuleState = (typeof RuleState)[keyof typeof RuleState];
|
|
|
1613
1831
|
*/
|
|
1614
1832
|
export interface DescribeRuleResponse {
|
|
1615
1833
|
/**
|
|
1834
|
+
* @public
|
|
1616
1835
|
* <p>The name of the rule.</p>
|
|
1617
1836
|
*/
|
|
1618
1837
|
Name?: string;
|
|
1619
1838
|
/**
|
|
1839
|
+
* @public
|
|
1620
1840
|
* <p>The Amazon Resource Name (ARN) of the rule.</p>
|
|
1621
1841
|
*/
|
|
1622
1842
|
Arn?: string;
|
|
1623
1843
|
/**
|
|
1844
|
+
* @public
|
|
1624
1845
|
* <p>The event pattern. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html">Events and Event
|
|
1625
1846
|
* Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
1626
1847
|
*/
|
|
1627
1848
|
EventPattern?: string;
|
|
1628
1849
|
/**
|
|
1850
|
+
* @public
|
|
1629
1851
|
* <p>The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".</p>
|
|
1630
1852
|
*/
|
|
1631
1853
|
ScheduleExpression?: string;
|
|
1632
1854
|
/**
|
|
1855
|
+
* @public
|
|
1633
1856
|
* <p>Specifies whether the rule is enabled or disabled.</p>
|
|
1634
1857
|
*/
|
|
1635
1858
|
State?: RuleState | string;
|
|
1636
1859
|
/**
|
|
1860
|
+
* @public
|
|
1637
1861
|
* <p>The description of the rule.</p>
|
|
1638
1862
|
*/
|
|
1639
1863
|
Description?: string;
|
|
1640
1864
|
/**
|
|
1865
|
+
* @public
|
|
1641
1866
|
* <p>The Amazon Resource Name (ARN) of the IAM role associated with the rule.</p>
|
|
1642
1867
|
*/
|
|
1643
1868
|
RoleArn?: string;
|
|
1644
1869
|
/**
|
|
1870
|
+
* @public
|
|
1645
1871
|
* <p>If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays
|
|
1646
1872
|
* the principal name of the Amazon Web Services service that created the rule.</p>
|
|
1647
1873
|
*/
|
|
1648
1874
|
ManagedBy?: string;
|
|
1649
1875
|
/**
|
|
1876
|
+
* @public
|
|
1650
1877
|
* <p>The name of the event bus associated with the rule.</p>
|
|
1651
1878
|
*/
|
|
1652
1879
|
EventBusName?: string;
|
|
1653
1880
|
/**
|
|
1881
|
+
* @public
|
|
1654
1882
|
* <p>The account ID of the user that created the rule. If you use <code>PutRule</code> to put a
|
|
1655
1883
|
* rule on an event bus in another account, the other account is the owner of the rule, and the
|
|
1656
1884
|
* rule ARN includes the account ID for that account. However, the value for
|
|
@@ -1664,10 +1892,12 @@ export interface DescribeRuleResponse {
|
|
|
1664
1892
|
*/
|
|
1665
1893
|
export interface DisableRuleRequest {
|
|
1666
1894
|
/**
|
|
1895
|
+
* @public
|
|
1667
1896
|
* <p>The name of the rule.</p>
|
|
1668
1897
|
*/
|
|
1669
1898
|
Name: string | undefined;
|
|
1670
1899
|
/**
|
|
1900
|
+
* @public
|
|
1671
1901
|
* <p>The name or ARN of the event bus associated with the rule. If you omit this, the default
|
|
1672
1902
|
* event bus is used.</p>
|
|
1673
1903
|
*/
|
|
@@ -1678,10 +1908,12 @@ export interface DisableRuleRequest {
|
|
|
1678
1908
|
*/
|
|
1679
1909
|
export interface EnableRuleRequest {
|
|
1680
1910
|
/**
|
|
1911
|
+
* @public
|
|
1681
1912
|
* <p>The name of the rule.</p>
|
|
1682
1913
|
*/
|
|
1683
1914
|
Name: string | undefined;
|
|
1684
1915
|
/**
|
|
1916
|
+
* @public
|
|
1685
1917
|
* <p>The name or ARN of the event bus associated with the rule. If you omit this, the default
|
|
1686
1918
|
* event bus is used.</p>
|
|
1687
1919
|
*/
|
|
@@ -1692,19 +1924,23 @@ export interface EnableRuleRequest {
|
|
|
1692
1924
|
*/
|
|
1693
1925
|
export interface ListApiDestinationsRequest {
|
|
1694
1926
|
/**
|
|
1927
|
+
* @public
|
|
1695
1928
|
* <p>A name prefix to filter results returned. Only API destinations with a name that starts
|
|
1696
1929
|
* with the prefix are returned.</p>
|
|
1697
1930
|
*/
|
|
1698
1931
|
NamePrefix?: string;
|
|
1699
1932
|
/**
|
|
1933
|
+
* @public
|
|
1700
1934
|
* <p>The ARN of the connection specified for the API destination.</p>
|
|
1701
1935
|
*/
|
|
1702
1936
|
ConnectionArn?: string;
|
|
1703
1937
|
/**
|
|
1938
|
+
* @public
|
|
1704
1939
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
1705
1940
|
*/
|
|
1706
1941
|
NextToken?: string;
|
|
1707
1942
|
/**
|
|
1943
|
+
* @public
|
|
1708
1944
|
* <p>The maximum number of API destinations to include in the response.</p>
|
|
1709
1945
|
*/
|
|
1710
1946
|
Limit?: number;
|
|
@@ -1714,11 +1950,13 @@ export interface ListApiDestinationsRequest {
|
|
|
1714
1950
|
*/
|
|
1715
1951
|
export interface ListApiDestinationsResponse {
|
|
1716
1952
|
/**
|
|
1953
|
+
* @public
|
|
1717
1954
|
* <p>An array of <code>ApiDestination</code> objects that include information about an API
|
|
1718
1955
|
* destination.</p>
|
|
1719
1956
|
*/
|
|
1720
1957
|
ApiDestinations?: ApiDestination[];
|
|
1721
1958
|
/**
|
|
1959
|
+
* @public
|
|
1722
1960
|
* <p>A token you can use in a subsequent request to retrieve the next set of results.</p>
|
|
1723
1961
|
*/
|
|
1724
1962
|
NextToken?: string;
|
|
@@ -1728,23 +1966,28 @@ export interface ListApiDestinationsResponse {
|
|
|
1728
1966
|
*/
|
|
1729
1967
|
export interface ListArchivesRequest {
|
|
1730
1968
|
/**
|
|
1969
|
+
* @public
|
|
1731
1970
|
* <p>A name prefix to filter the archives returned. Only archives with name that match the
|
|
1732
1971
|
* prefix are returned.</p>
|
|
1733
1972
|
*/
|
|
1734
1973
|
NamePrefix?: string;
|
|
1735
1974
|
/**
|
|
1975
|
+
* @public
|
|
1736
1976
|
* <p>The ARN of the event source associated with the archive.</p>
|
|
1737
1977
|
*/
|
|
1738
1978
|
EventSourceArn?: string;
|
|
1739
1979
|
/**
|
|
1980
|
+
* @public
|
|
1740
1981
|
* <p>The state of the archive.</p>
|
|
1741
1982
|
*/
|
|
1742
1983
|
State?: ArchiveState | string;
|
|
1743
1984
|
/**
|
|
1985
|
+
* @public
|
|
1744
1986
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
1745
1987
|
*/
|
|
1746
1988
|
NextToken?: string;
|
|
1747
1989
|
/**
|
|
1990
|
+
* @public
|
|
1748
1991
|
* <p>The maximum number of results to return.</p>
|
|
1749
1992
|
*/
|
|
1750
1993
|
Limit?: number;
|
|
@@ -1754,10 +1997,12 @@ export interface ListArchivesRequest {
|
|
|
1754
1997
|
*/
|
|
1755
1998
|
export interface ListArchivesResponse {
|
|
1756
1999
|
/**
|
|
2000
|
+
* @public
|
|
1757
2001
|
* <p>An array of <code>Archive</code> objects that include details about an archive.</p>
|
|
1758
2002
|
*/
|
|
1759
2003
|
Archives?: Archive[];
|
|
1760
2004
|
/**
|
|
2005
|
+
* @public
|
|
1761
2006
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
1762
2007
|
*/
|
|
1763
2008
|
NextToken?: string;
|
|
@@ -1767,19 +2012,23 @@ export interface ListArchivesResponse {
|
|
|
1767
2012
|
*/
|
|
1768
2013
|
export interface ListConnectionsRequest {
|
|
1769
2014
|
/**
|
|
2015
|
+
* @public
|
|
1770
2016
|
* <p>A name prefix to filter results returned. Only connections with a name that starts with
|
|
1771
2017
|
* the prefix are returned.</p>
|
|
1772
2018
|
*/
|
|
1773
2019
|
NamePrefix?: string;
|
|
1774
2020
|
/**
|
|
2021
|
+
* @public
|
|
1775
2022
|
* <p>The state of the connection.</p>
|
|
1776
2023
|
*/
|
|
1777
2024
|
ConnectionState?: ConnectionState | string;
|
|
1778
2025
|
/**
|
|
2026
|
+
* @public
|
|
1779
2027
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
1780
2028
|
*/
|
|
1781
2029
|
NextToken?: string;
|
|
1782
2030
|
/**
|
|
2031
|
+
* @public
|
|
1783
2032
|
* <p>The maximum number of connections to return.</p>
|
|
1784
2033
|
*/
|
|
1785
2034
|
Limit?: number;
|
|
@@ -1790,22 +2039,27 @@ export interface ListConnectionsRequest {
|
|
|
1790
2039
|
*/
|
|
1791
2040
|
export interface Connection {
|
|
1792
2041
|
/**
|
|
2042
|
+
* @public
|
|
1793
2043
|
* <p>The ARN of the connection.</p>
|
|
1794
2044
|
*/
|
|
1795
2045
|
ConnectionArn?: string;
|
|
1796
2046
|
/**
|
|
2047
|
+
* @public
|
|
1797
2048
|
* <p>The name of the connection.</p>
|
|
1798
2049
|
*/
|
|
1799
2050
|
Name?: string;
|
|
1800
2051
|
/**
|
|
2052
|
+
* @public
|
|
1801
2053
|
* <p>The state of the connection.</p>
|
|
1802
2054
|
*/
|
|
1803
2055
|
ConnectionState?: ConnectionState | string;
|
|
1804
2056
|
/**
|
|
2057
|
+
* @public
|
|
1805
2058
|
* <p>The reason that the connection is in the connection state.</p>
|
|
1806
2059
|
*/
|
|
1807
2060
|
StateReason?: string;
|
|
1808
2061
|
/**
|
|
2062
|
+
* @public
|
|
1809
2063
|
* <p>The authorization type specified for the connection.</p>
|
|
1810
2064
|
* <note>
|
|
1811
2065
|
* <p>OAUTH tokens are refreshed when a 401 or 407 response is returned.</p>
|
|
@@ -1813,14 +2067,17 @@ export interface Connection {
|
|
|
1813
2067
|
*/
|
|
1814
2068
|
AuthorizationType?: ConnectionAuthorizationType | string;
|
|
1815
2069
|
/**
|
|
2070
|
+
* @public
|
|
1816
2071
|
* <p>A time stamp for the time that the connection was created.</p>
|
|
1817
2072
|
*/
|
|
1818
2073
|
CreationTime?: Date;
|
|
1819
2074
|
/**
|
|
2075
|
+
* @public
|
|
1820
2076
|
* <p>A time stamp for the time that the connection was last modified.</p>
|
|
1821
2077
|
*/
|
|
1822
2078
|
LastModifiedTime?: Date;
|
|
1823
2079
|
/**
|
|
2080
|
+
* @public
|
|
1824
2081
|
* <p>A time stamp for the time that the connection was last authorized.</p>
|
|
1825
2082
|
*/
|
|
1826
2083
|
LastAuthorizedTime?: Date;
|
|
@@ -1830,10 +2087,12 @@ export interface Connection {
|
|
|
1830
2087
|
*/
|
|
1831
2088
|
export interface ListConnectionsResponse {
|
|
1832
2089
|
/**
|
|
2090
|
+
* @public
|
|
1833
2091
|
* <p>An array of connections objects that include details about the connections.</p>
|
|
1834
2092
|
*/
|
|
1835
2093
|
Connections?: Connection[];
|
|
1836
2094
|
/**
|
|
2095
|
+
* @public
|
|
1837
2096
|
* <p>A token you can use in a subsequent request to retrieve the next set of results.</p>
|
|
1838
2097
|
*/
|
|
1839
2098
|
NextToken?: string;
|
|
@@ -1843,20 +2102,24 @@ export interface ListConnectionsResponse {
|
|
|
1843
2102
|
*/
|
|
1844
2103
|
export interface ListEndpointsRequest {
|
|
1845
2104
|
/**
|
|
2105
|
+
* @public
|
|
1846
2106
|
* <p>A value that will return a subset of the endpoints associated with this account. For example, <code>"NamePrefix": "ABC"</code> will return all endpoints with "ABC" in the name.</p>
|
|
1847
2107
|
*/
|
|
1848
2108
|
NamePrefix?: string;
|
|
1849
2109
|
/**
|
|
2110
|
+
* @public
|
|
1850
2111
|
* <p>The primary Region of the endpoints associated with this account. For example <code>"HomeRegion": "us-east-1"</code>.</p>
|
|
1851
2112
|
*/
|
|
1852
2113
|
HomeRegion?: string;
|
|
1853
2114
|
/**
|
|
2115
|
+
* @public
|
|
1854
2116
|
* <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page.
|
|
1855
2117
|
* Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination
|
|
1856
2118
|
* token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.</p>
|
|
1857
2119
|
*/
|
|
1858
2120
|
NextToken?: string;
|
|
1859
2121
|
/**
|
|
2122
|
+
* @public
|
|
1860
2123
|
* <p>The maximum number of results returned by the call.</p>
|
|
1861
2124
|
*/
|
|
1862
2125
|
MaxResults?: number;
|
|
@@ -1867,55 +2130,68 @@ export interface ListEndpointsRequest {
|
|
|
1867
2130
|
*/
|
|
1868
2131
|
export interface Endpoint {
|
|
1869
2132
|
/**
|
|
2133
|
+
* @public
|
|
1870
2134
|
* <p>The name of the endpoint.</p>
|
|
1871
2135
|
*/
|
|
1872
2136
|
Name?: string;
|
|
1873
2137
|
/**
|
|
2138
|
+
* @public
|
|
1874
2139
|
* <p>A description for the endpoint.</p>
|
|
1875
2140
|
*/
|
|
1876
2141
|
Description?: string;
|
|
1877
2142
|
/**
|
|
2143
|
+
* @public
|
|
1878
2144
|
* <p>The ARN of the endpoint.</p>
|
|
1879
2145
|
*/
|
|
1880
2146
|
Arn?: string;
|
|
1881
2147
|
/**
|
|
2148
|
+
* @public
|
|
1882
2149
|
* <p>The routing configuration of the endpoint.</p>
|
|
1883
2150
|
*/
|
|
1884
2151
|
RoutingConfig?: RoutingConfig;
|
|
1885
2152
|
/**
|
|
2153
|
+
* @public
|
|
1886
2154
|
* <p>Whether event replication was enabled or disabled for this endpoint. The default state is <code>ENABLED</code> which means you must supply a <code>RoleArn</code>.
|
|
1887
2155
|
* If you don't have a <code>RoleArn</code> or you don't want event replication enabled, set the state to <code>DISABLED</code>.</p>
|
|
1888
2156
|
*/
|
|
1889
2157
|
ReplicationConfig?: ReplicationConfig;
|
|
1890
2158
|
/**
|
|
2159
|
+
* @public
|
|
1891
2160
|
* <p>The event buses being used by the endpoint.</p>
|
|
1892
2161
|
*/
|
|
1893
2162
|
EventBuses?: EndpointEventBus[];
|
|
1894
2163
|
/**
|
|
2164
|
+
* @public
|
|
1895
2165
|
* <p>The ARN of the role used by event replication for the endpoint.</p>
|
|
1896
2166
|
*/
|
|
1897
2167
|
RoleArn?: string;
|
|
1898
2168
|
/**
|
|
2169
|
+
* @public
|
|
1899
2170
|
* <p>The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is <code>abcde.veo</code>.</p>
|
|
1900
2171
|
*/
|
|
1901
2172
|
EndpointId?: string;
|
|
1902
2173
|
/**
|
|
2174
|
+
* @public
|
|
1903
2175
|
* <p>The URL of the endpoint.</p>
|
|
1904
2176
|
*/
|
|
1905
2177
|
EndpointUrl?: string;
|
|
1906
2178
|
/**
|
|
2179
|
+
* @public
|
|
1907
2180
|
* <p>The current state of the endpoint.</p>
|
|
1908
2181
|
*/
|
|
1909
2182
|
State?: EndpointState | string;
|
|
1910
2183
|
/**
|
|
2184
|
+
* @public
|
|
1911
2185
|
* <p>The reason the endpoint is in its current state.</p>
|
|
1912
2186
|
*/
|
|
1913
2187
|
StateReason?: string;
|
|
1914
2188
|
/**
|
|
2189
|
+
* @public
|
|
1915
2190
|
* <p>The time the endpoint was created.</p>
|
|
1916
2191
|
*/
|
|
1917
2192
|
CreationTime?: Date;
|
|
1918
2193
|
/**
|
|
2194
|
+
* @public
|
|
1919
2195
|
* <p>The last time the endpoint was modified.</p>
|
|
1920
2196
|
*/
|
|
1921
2197
|
LastModifiedTime?: Date;
|
|
@@ -1925,10 +2201,12 @@ export interface Endpoint {
|
|
|
1925
2201
|
*/
|
|
1926
2202
|
export interface ListEndpointsResponse {
|
|
1927
2203
|
/**
|
|
2204
|
+
* @public
|
|
1928
2205
|
* <p>The endpoints returned by the call.</p>
|
|
1929
2206
|
*/
|
|
1930
2207
|
Endpoints?: Endpoint[];
|
|
1931
2208
|
/**
|
|
2209
|
+
* @public
|
|
1932
2210
|
* <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page.
|
|
1933
2211
|
* Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination
|
|
1934
2212
|
* token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.</p>
|
|
@@ -1940,15 +2218,18 @@ export interface ListEndpointsResponse {
|
|
|
1940
2218
|
*/
|
|
1941
2219
|
export interface ListEventBusesRequest {
|
|
1942
2220
|
/**
|
|
2221
|
+
* @public
|
|
1943
2222
|
* <p>Specifying this limits the results to only those event buses with names that start with
|
|
1944
2223
|
* the specified prefix.</p>
|
|
1945
2224
|
*/
|
|
1946
2225
|
NamePrefix?: string;
|
|
1947
2226
|
/**
|
|
2227
|
+
* @public
|
|
1948
2228
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
1949
2229
|
*/
|
|
1950
2230
|
NextToken?: string;
|
|
1951
2231
|
/**
|
|
2232
|
+
* @public
|
|
1952
2233
|
* <p>Specifying this limits the number of results returned by this operation. The operation
|
|
1953
2234
|
* also returns a NextToken which you can use in a subsequent operation to retrieve the next set
|
|
1954
2235
|
* of results.</p>
|
|
@@ -1965,14 +2246,17 @@ export interface ListEventBusesRequest {
|
|
|
1965
2246
|
*/
|
|
1966
2247
|
export interface EventBus {
|
|
1967
2248
|
/**
|
|
2249
|
+
* @public
|
|
1968
2250
|
* <p>The name of the event bus.</p>
|
|
1969
2251
|
*/
|
|
1970
2252
|
Name?: string;
|
|
1971
2253
|
/**
|
|
2254
|
+
* @public
|
|
1972
2255
|
* <p>The ARN of the event bus.</p>
|
|
1973
2256
|
*/
|
|
1974
2257
|
Arn?: string;
|
|
1975
2258
|
/**
|
|
2259
|
+
* @public
|
|
1976
2260
|
* <p>The permissions policy of the event bus, describing which other Amazon Web Services accounts can write
|
|
1977
2261
|
* events to this event bus.</p>
|
|
1978
2262
|
*/
|
|
@@ -1983,10 +2267,12 @@ export interface EventBus {
|
|
|
1983
2267
|
*/
|
|
1984
2268
|
export interface ListEventBusesResponse {
|
|
1985
2269
|
/**
|
|
2270
|
+
* @public
|
|
1986
2271
|
* <p>This list of event buses.</p>
|
|
1987
2272
|
*/
|
|
1988
2273
|
EventBuses?: EventBus[];
|
|
1989
2274
|
/**
|
|
2275
|
+
* @public
|
|
1990
2276
|
* <p>A token you can use in a subsequent operation to retrieve the next set of results.</p>
|
|
1991
2277
|
*/
|
|
1992
2278
|
NextToken?: string;
|
|
@@ -1996,15 +2282,18 @@ export interface ListEventBusesResponse {
|
|
|
1996
2282
|
*/
|
|
1997
2283
|
export interface ListEventSourcesRequest {
|
|
1998
2284
|
/**
|
|
2285
|
+
* @public
|
|
1999
2286
|
* <p>Specifying this limits the results to only those partner event sources with names that
|
|
2000
2287
|
* start with the specified prefix.</p>
|
|
2001
2288
|
*/
|
|
2002
2289
|
NamePrefix?: string;
|
|
2003
2290
|
/**
|
|
2291
|
+
* @public
|
|
2004
2292
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
2005
2293
|
*/
|
|
2006
2294
|
NextToken?: string;
|
|
2007
2295
|
/**
|
|
2296
|
+
* @public
|
|
2008
2297
|
* <p>Specifying this limits the number of results returned by this operation. The operation
|
|
2009
2298
|
* also returns a NextToken which you can use in a subsequent operation to retrieve the next set
|
|
2010
2299
|
* of results.</p>
|
|
@@ -2019,27 +2308,33 @@ export interface ListEventSourcesRequest {
|
|
|
2019
2308
|
*/
|
|
2020
2309
|
export interface EventSource {
|
|
2021
2310
|
/**
|
|
2311
|
+
* @public
|
|
2022
2312
|
* <p>The ARN of the event source.</p>
|
|
2023
2313
|
*/
|
|
2024
2314
|
Arn?: string;
|
|
2025
2315
|
/**
|
|
2316
|
+
* @public
|
|
2026
2317
|
* <p>The name of the partner that created the event source.</p>
|
|
2027
2318
|
*/
|
|
2028
2319
|
CreatedBy?: string;
|
|
2029
2320
|
/**
|
|
2321
|
+
* @public
|
|
2030
2322
|
* <p>The date and time the event source was created.</p>
|
|
2031
2323
|
*/
|
|
2032
2324
|
CreationTime?: Date;
|
|
2033
2325
|
/**
|
|
2326
|
+
* @public
|
|
2034
2327
|
* <p>The date and time that the event source will expire, if the Amazon Web Services account doesn't create a
|
|
2035
2328
|
* matching event bus for it.</p>
|
|
2036
2329
|
*/
|
|
2037
2330
|
ExpirationTime?: Date;
|
|
2038
2331
|
/**
|
|
2332
|
+
* @public
|
|
2039
2333
|
* <p>The name of the event source.</p>
|
|
2040
2334
|
*/
|
|
2041
2335
|
Name?: string;
|
|
2042
2336
|
/**
|
|
2337
|
+
* @public
|
|
2043
2338
|
* <p>The state of the event source. If it is ACTIVE, you have already created a matching event
|
|
2044
2339
|
* bus for this event source, and that event bus is active. If it is PENDING, either you haven't
|
|
2045
2340
|
* yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have
|
|
@@ -2052,10 +2347,12 @@ export interface EventSource {
|
|
|
2052
2347
|
*/
|
|
2053
2348
|
export interface ListEventSourcesResponse {
|
|
2054
2349
|
/**
|
|
2350
|
+
* @public
|
|
2055
2351
|
* <p>The list of event sources.</p>
|
|
2056
2352
|
*/
|
|
2057
2353
|
EventSources?: EventSource[];
|
|
2058
2354
|
/**
|
|
2355
|
+
* @public
|
|
2059
2356
|
* <p>A token you can use in a subsequent operation to retrieve the next set of results.</p>
|
|
2060
2357
|
*/
|
|
2061
2358
|
NextToken?: string;
|
|
@@ -2065,15 +2362,18 @@ export interface ListEventSourcesResponse {
|
|
|
2065
2362
|
*/
|
|
2066
2363
|
export interface ListPartnerEventSourceAccountsRequest {
|
|
2067
2364
|
/**
|
|
2365
|
+
* @public
|
|
2068
2366
|
* <p>The name of the partner event source to display account information about.</p>
|
|
2069
2367
|
*/
|
|
2070
2368
|
EventSourceName: string | undefined;
|
|
2071
2369
|
/**
|
|
2370
|
+
* @public
|
|
2072
2371
|
* <p>The token returned by a previous call to this operation. Specifying this retrieves the
|
|
2073
2372
|
* next set of results.</p>
|
|
2074
2373
|
*/
|
|
2075
2374
|
NextToken?: string;
|
|
2076
2375
|
/**
|
|
2376
|
+
* @public
|
|
2077
2377
|
* <p>Specifying this limits the number of results returned by this operation. The operation
|
|
2078
2378
|
* also returns a NextToken which you can use in a subsequent operation to retrieve the next set
|
|
2079
2379
|
* of results.</p>
|
|
@@ -2086,19 +2386,23 @@ export interface ListPartnerEventSourceAccountsRequest {
|
|
|
2086
2386
|
*/
|
|
2087
2387
|
export interface PartnerEventSourceAccount {
|
|
2088
2388
|
/**
|
|
2389
|
+
* @public
|
|
2089
2390
|
* <p>The Amazon Web Services account ID that the partner event source was offered to.</p>
|
|
2090
2391
|
*/
|
|
2091
2392
|
Account?: string;
|
|
2092
2393
|
/**
|
|
2394
|
+
* @public
|
|
2093
2395
|
* <p>The date and time the event source was created.</p>
|
|
2094
2396
|
*/
|
|
2095
2397
|
CreationTime?: Date;
|
|
2096
2398
|
/**
|
|
2399
|
+
* @public
|
|
2097
2400
|
* <p>The date and time that the event source will expire, if the Amazon Web Services account doesn't create a
|
|
2098
2401
|
* matching event bus for it.</p>
|
|
2099
2402
|
*/
|
|
2100
2403
|
ExpirationTime?: Date;
|
|
2101
2404
|
/**
|
|
2405
|
+
* @public
|
|
2102
2406
|
* <p>The state of the event source. If it is ACTIVE, you have already created a matching event
|
|
2103
2407
|
* bus for this event source, and that event bus is active. If it is PENDING, either you haven't
|
|
2104
2408
|
* yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have
|
|
@@ -2111,10 +2415,12 @@ export interface PartnerEventSourceAccount {
|
|
|
2111
2415
|
*/
|
|
2112
2416
|
export interface ListPartnerEventSourceAccountsResponse {
|
|
2113
2417
|
/**
|
|
2418
|
+
* @public
|
|
2114
2419
|
* <p>The list of partner event sources returned by the operation.</p>
|
|
2115
2420
|
*/
|
|
2116
2421
|
PartnerEventSourceAccounts?: PartnerEventSourceAccount[];
|
|
2117
2422
|
/**
|
|
2423
|
+
* @public
|
|
2118
2424
|
* <p>A token you can use in a subsequent operation to retrieve the next set of results.</p>
|
|
2119
2425
|
*/
|
|
2120
2426
|
NextToken?: string;
|
|
@@ -2124,16 +2430,19 @@ export interface ListPartnerEventSourceAccountsResponse {
|
|
|
2124
2430
|
*/
|
|
2125
2431
|
export interface ListPartnerEventSourcesRequest {
|
|
2126
2432
|
/**
|
|
2433
|
+
* @public
|
|
2127
2434
|
* <p>If you specify this, the results are limited to only those partner event sources that
|
|
2128
2435
|
* start with the string you specify.</p>
|
|
2129
2436
|
*/
|
|
2130
2437
|
NamePrefix: string | undefined;
|
|
2131
2438
|
/**
|
|
2439
|
+
* @public
|
|
2132
2440
|
* <p>The token returned by a previous call to this operation. Specifying this retrieves the
|
|
2133
2441
|
* next set of results.</p>
|
|
2134
2442
|
*/
|
|
2135
2443
|
NextToken?: string;
|
|
2136
2444
|
/**
|
|
2445
|
+
* @public
|
|
2137
2446
|
* <p>pecifying this limits the number of results returned by this operation. The operation also
|
|
2138
2447
|
* returns a NextToken which you can use in a subsequent operation to retrieve the next set of
|
|
2139
2448
|
* results.</p>
|
|
@@ -2148,10 +2457,12 @@ export interface ListPartnerEventSourcesRequest {
|
|
|
2148
2457
|
*/
|
|
2149
2458
|
export interface PartnerEventSource {
|
|
2150
2459
|
/**
|
|
2460
|
+
* @public
|
|
2151
2461
|
* <p>The ARN of the partner event source.</p>
|
|
2152
2462
|
*/
|
|
2153
2463
|
Arn?: string;
|
|
2154
2464
|
/**
|
|
2465
|
+
* @public
|
|
2155
2466
|
* <p>The name of the partner event source.</p>
|
|
2156
2467
|
*/
|
|
2157
2468
|
Name?: string;
|
|
@@ -2161,10 +2472,12 @@ export interface PartnerEventSource {
|
|
|
2161
2472
|
*/
|
|
2162
2473
|
export interface ListPartnerEventSourcesResponse {
|
|
2163
2474
|
/**
|
|
2475
|
+
* @public
|
|
2164
2476
|
* <p>The list of partner event sources returned by the operation.</p>
|
|
2165
2477
|
*/
|
|
2166
2478
|
PartnerEventSources?: PartnerEventSource[];
|
|
2167
2479
|
/**
|
|
2480
|
+
* @public
|
|
2168
2481
|
* <p>A token you can use in a subsequent operation to retrieve the next set of results.</p>
|
|
2169
2482
|
*/
|
|
2170
2483
|
NextToken?: string;
|
|
@@ -2174,23 +2487,28 @@ export interface ListPartnerEventSourcesResponse {
|
|
|
2174
2487
|
*/
|
|
2175
2488
|
export interface ListReplaysRequest {
|
|
2176
2489
|
/**
|
|
2490
|
+
* @public
|
|
2177
2491
|
* <p>A name prefix to filter the replays returned. Only replays with name that match the prefix
|
|
2178
2492
|
* are returned.</p>
|
|
2179
2493
|
*/
|
|
2180
2494
|
NamePrefix?: string;
|
|
2181
2495
|
/**
|
|
2496
|
+
* @public
|
|
2182
2497
|
* <p>The state of the replay.</p>
|
|
2183
2498
|
*/
|
|
2184
2499
|
State?: ReplayState | string;
|
|
2185
2500
|
/**
|
|
2501
|
+
* @public
|
|
2186
2502
|
* <p>The ARN of the archive from which the events are replayed.</p>
|
|
2187
2503
|
*/
|
|
2188
2504
|
EventSourceArn?: string;
|
|
2189
2505
|
/**
|
|
2506
|
+
* @public
|
|
2190
2507
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
2191
2508
|
*/
|
|
2192
2509
|
NextToken?: string;
|
|
2193
2510
|
/**
|
|
2511
|
+
* @public
|
|
2194
2512
|
* <p>The maximum number of replays to retrieve.</p>
|
|
2195
2513
|
*/
|
|
2196
2514
|
Limit?: number;
|
|
@@ -2201,40 +2519,49 @@ export interface ListReplaysRequest {
|
|
|
2201
2519
|
*/
|
|
2202
2520
|
export interface Replay {
|
|
2203
2521
|
/**
|
|
2522
|
+
* @public
|
|
2204
2523
|
* <p>The name of the replay.</p>
|
|
2205
2524
|
*/
|
|
2206
2525
|
ReplayName?: string;
|
|
2207
2526
|
/**
|
|
2527
|
+
* @public
|
|
2208
2528
|
* <p>The ARN of the archive to replay event from.</p>
|
|
2209
2529
|
*/
|
|
2210
2530
|
EventSourceArn?: string;
|
|
2211
2531
|
/**
|
|
2532
|
+
* @public
|
|
2212
2533
|
* <p>The current state of the replay.</p>
|
|
2213
2534
|
*/
|
|
2214
2535
|
State?: ReplayState | string;
|
|
2215
2536
|
/**
|
|
2537
|
+
* @public
|
|
2216
2538
|
* <p>A description of why the replay is in the current state.</p>
|
|
2217
2539
|
*/
|
|
2218
2540
|
StateReason?: string;
|
|
2219
2541
|
/**
|
|
2542
|
+
* @public
|
|
2220
2543
|
* <p>A time stamp for the time to start replaying events. This is determined by the time in the
|
|
2221
2544
|
* event as described in <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEventsRequestEntry.html#eventbridge-Type-PutEventsRequestEntry-Time">Time</a>.</p>
|
|
2222
2545
|
*/
|
|
2223
2546
|
EventStartTime?: Date;
|
|
2224
2547
|
/**
|
|
2548
|
+
* @public
|
|
2225
2549
|
* <p>A time stamp for the time to start replaying events. Any event with a creation time prior
|
|
2226
2550
|
* to the <code>EventEndTime</code> specified is replayed.</p>
|
|
2227
2551
|
*/
|
|
2228
2552
|
EventEndTime?: Date;
|
|
2229
2553
|
/**
|
|
2554
|
+
* @public
|
|
2230
2555
|
* <p>A time stamp for the time that the last event was replayed.</p>
|
|
2231
2556
|
*/
|
|
2232
2557
|
EventLastReplayedTime?: Date;
|
|
2233
2558
|
/**
|
|
2559
|
+
* @public
|
|
2234
2560
|
* <p>A time stamp for the time that the replay started.</p>
|
|
2235
2561
|
*/
|
|
2236
2562
|
ReplayStartTime?: Date;
|
|
2237
2563
|
/**
|
|
2564
|
+
* @public
|
|
2238
2565
|
* <p>A time stamp for the time that the replay completed.</p>
|
|
2239
2566
|
*/
|
|
2240
2567
|
ReplayEndTime?: Date;
|
|
@@ -2244,10 +2571,12 @@ export interface Replay {
|
|
|
2244
2571
|
*/
|
|
2245
2572
|
export interface ListReplaysResponse {
|
|
2246
2573
|
/**
|
|
2574
|
+
* @public
|
|
2247
2575
|
* <p>An array of <code>Replay</code> objects that contain information about the replay.</p>
|
|
2248
2576
|
*/
|
|
2249
2577
|
Replays?: Replay[];
|
|
2250
2578
|
/**
|
|
2579
|
+
* @public
|
|
2251
2580
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
2252
2581
|
*/
|
|
2253
2582
|
NextToken?: string;
|
|
@@ -2257,19 +2586,23 @@ export interface ListReplaysResponse {
|
|
|
2257
2586
|
*/
|
|
2258
2587
|
export interface ListRuleNamesByTargetRequest {
|
|
2259
2588
|
/**
|
|
2589
|
+
* @public
|
|
2260
2590
|
* <p>The Amazon Resource Name (ARN) of the target resource.</p>
|
|
2261
2591
|
*/
|
|
2262
2592
|
TargetArn: string | undefined;
|
|
2263
2593
|
/**
|
|
2594
|
+
* @public
|
|
2264
2595
|
* <p>The name or ARN of the event bus to list rules for. If you omit this, the default event
|
|
2265
2596
|
* bus is used.</p>
|
|
2266
2597
|
*/
|
|
2267
2598
|
EventBusName?: string;
|
|
2268
2599
|
/**
|
|
2600
|
+
* @public
|
|
2269
2601
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
2270
2602
|
*/
|
|
2271
2603
|
NextToken?: string;
|
|
2272
2604
|
/**
|
|
2605
|
+
* @public
|
|
2273
2606
|
* <p>The maximum number of results to return.</p>
|
|
2274
2607
|
*/
|
|
2275
2608
|
Limit?: number;
|
|
@@ -2279,10 +2612,12 @@ export interface ListRuleNamesByTargetRequest {
|
|
|
2279
2612
|
*/
|
|
2280
2613
|
export interface ListRuleNamesByTargetResponse {
|
|
2281
2614
|
/**
|
|
2615
|
+
* @public
|
|
2282
2616
|
* <p>The names of the rules that can invoke the given target.</p>
|
|
2283
2617
|
*/
|
|
2284
2618
|
RuleNames?: string[];
|
|
2285
2619
|
/**
|
|
2620
|
+
* @public
|
|
2286
2621
|
* <p>Indicates whether there are additional results to retrieve. If there are no more results,
|
|
2287
2622
|
* the value is null.</p>
|
|
2288
2623
|
*/
|
|
@@ -2293,19 +2628,23 @@ export interface ListRuleNamesByTargetResponse {
|
|
|
2293
2628
|
*/
|
|
2294
2629
|
export interface ListRulesRequest {
|
|
2295
2630
|
/**
|
|
2631
|
+
* @public
|
|
2296
2632
|
* <p>The prefix matching the rule name.</p>
|
|
2297
2633
|
*/
|
|
2298
2634
|
NamePrefix?: string;
|
|
2299
2635
|
/**
|
|
2636
|
+
* @public
|
|
2300
2637
|
* <p>The name or ARN of the event bus to list the rules for. If you omit this, the default
|
|
2301
2638
|
* event bus is used.</p>
|
|
2302
2639
|
*/
|
|
2303
2640
|
EventBusName?: string;
|
|
2304
2641
|
/**
|
|
2642
|
+
* @public
|
|
2305
2643
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
2306
2644
|
*/
|
|
2307
2645
|
NextToken?: string;
|
|
2308
2646
|
/**
|
|
2647
|
+
* @public
|
|
2309
2648
|
* <p>The maximum number of results to return.</p>
|
|
2310
2649
|
*/
|
|
2311
2650
|
Limit?: number;
|
|
@@ -2316,31 +2655,38 @@ export interface ListRulesRequest {
|
|
|
2316
2655
|
*/
|
|
2317
2656
|
export interface Rule {
|
|
2318
2657
|
/**
|
|
2658
|
+
* @public
|
|
2319
2659
|
* <p>The name of the rule.</p>
|
|
2320
2660
|
*/
|
|
2321
2661
|
Name?: string;
|
|
2322
2662
|
/**
|
|
2663
|
+
* @public
|
|
2323
2664
|
* <p>The Amazon Resource Name (ARN) of the rule.</p>
|
|
2324
2665
|
*/
|
|
2325
2666
|
Arn?: string;
|
|
2326
2667
|
/**
|
|
2668
|
+
* @public
|
|
2327
2669
|
* <p>The event pattern of the rule. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html">Events and Event
|
|
2328
2670
|
* Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
2329
2671
|
*/
|
|
2330
2672
|
EventPattern?: string;
|
|
2331
2673
|
/**
|
|
2674
|
+
* @public
|
|
2332
2675
|
* <p>The state of the rule.</p>
|
|
2333
2676
|
*/
|
|
2334
2677
|
State?: RuleState | string;
|
|
2335
2678
|
/**
|
|
2679
|
+
* @public
|
|
2336
2680
|
* <p>The description of the rule.</p>
|
|
2337
2681
|
*/
|
|
2338
2682
|
Description?: string;
|
|
2339
2683
|
/**
|
|
2684
|
+
* @public
|
|
2340
2685
|
* <p>The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html">Creating an Amazon EventBridge rule that runs on a schedule</a>.</p>
|
|
2341
2686
|
*/
|
|
2342
2687
|
ScheduleExpression?: string;
|
|
2343
2688
|
/**
|
|
2689
|
+
* @public
|
|
2344
2690
|
* <p>The Amazon Resource Name (ARN) of the role that is used for target invocation.</p>
|
|
2345
2691
|
* <p>If you're setting an event bus in another account as the target and that account granted
|
|
2346
2692
|
* permission to your account through an organization instead of directly by the account ID, you
|
|
@@ -2349,11 +2695,13 @@ export interface Rule {
|
|
|
2349
2695
|
*/
|
|
2350
2696
|
RoleArn?: string;
|
|
2351
2697
|
/**
|
|
2698
|
+
* @public
|
|
2352
2699
|
* <p>If the rule was created on behalf of your account by an Amazon Web Services service, this field displays
|
|
2353
2700
|
* the principal name of the service that created the rule.</p>
|
|
2354
2701
|
*/
|
|
2355
2702
|
ManagedBy?: string;
|
|
2356
2703
|
/**
|
|
2704
|
+
* @public
|
|
2357
2705
|
* <p>The name or ARN of the event bus associated with the rule. If you omit this, the default
|
|
2358
2706
|
* event bus is used.</p>
|
|
2359
2707
|
*/
|
|
@@ -2364,10 +2712,12 @@ export interface Rule {
|
|
|
2364
2712
|
*/
|
|
2365
2713
|
export interface ListRulesResponse {
|
|
2366
2714
|
/**
|
|
2715
|
+
* @public
|
|
2367
2716
|
* <p>The rules that match the specified criteria.</p>
|
|
2368
2717
|
*/
|
|
2369
2718
|
Rules?: Rule[];
|
|
2370
2719
|
/**
|
|
2720
|
+
* @public
|
|
2371
2721
|
* <p>Indicates whether there are additional results to retrieve. If there are no more results,
|
|
2372
2722
|
* the value is null.</p>
|
|
2373
2723
|
*/
|
|
@@ -2378,6 +2728,7 @@ export interface ListRulesResponse {
|
|
|
2378
2728
|
*/
|
|
2379
2729
|
export interface ListTagsForResourceRequest {
|
|
2380
2730
|
/**
|
|
2731
|
+
* @public
|
|
2381
2732
|
* <p>The ARN of the EventBridge resource for which you want to view tags.</p>
|
|
2382
2733
|
*/
|
|
2383
2734
|
ResourceARN: string | undefined;
|
|
@@ -2387,6 +2738,7 @@ export interface ListTagsForResourceRequest {
|
|
|
2387
2738
|
*/
|
|
2388
2739
|
export interface ListTagsForResourceResponse {
|
|
2389
2740
|
/**
|
|
2741
|
+
* @public
|
|
2390
2742
|
* <p>The list of tag keys and values associated with the resource you specified</p>
|
|
2391
2743
|
*/
|
|
2392
2744
|
Tags?: Tag[];
|
|
@@ -2396,19 +2748,23 @@ export interface ListTagsForResourceResponse {
|
|
|
2396
2748
|
*/
|
|
2397
2749
|
export interface ListTargetsByRuleRequest {
|
|
2398
2750
|
/**
|
|
2751
|
+
* @public
|
|
2399
2752
|
* <p>The name of the rule.</p>
|
|
2400
2753
|
*/
|
|
2401
2754
|
Rule: string | undefined;
|
|
2402
2755
|
/**
|
|
2756
|
+
* @public
|
|
2403
2757
|
* <p>The name or ARN of the event bus associated with the rule. If you omit this, the default
|
|
2404
2758
|
* event bus is used.</p>
|
|
2405
2759
|
*/
|
|
2406
2760
|
EventBusName?: string;
|
|
2407
2761
|
/**
|
|
2762
|
+
* @public
|
|
2408
2763
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
2409
2764
|
*/
|
|
2410
2765
|
NextToken?: string;
|
|
2411
2766
|
/**
|
|
2767
|
+
* @public
|
|
2412
2768
|
* <p>The maximum number of results to return.</p>
|
|
2413
2769
|
*/
|
|
2414
2770
|
Limit?: number;
|
|
@@ -2421,6 +2777,7 @@ export interface ListTargetsByRuleRequest {
|
|
|
2421
2777
|
*/
|
|
2422
2778
|
export interface BatchArrayProperties {
|
|
2423
2779
|
/**
|
|
2780
|
+
* @public
|
|
2424
2781
|
* <p>The size of the array, if this is an array batch job. Valid values are integers between 2
|
|
2425
2782
|
* and 10,000.</p>
|
|
2426
2783
|
*/
|
|
@@ -2434,6 +2791,7 @@ export interface BatchArrayProperties {
|
|
|
2434
2791
|
*/
|
|
2435
2792
|
export interface BatchRetryStrategy {
|
|
2436
2793
|
/**
|
|
2794
|
+
* @public
|
|
2437
2795
|
* <p>The number of times to attempt to retry, if the job fails. Valid values are 1–10.</p>
|
|
2438
2796
|
*/
|
|
2439
2797
|
Attempts?: number;
|
|
@@ -2444,21 +2802,25 @@ export interface BatchRetryStrategy {
|
|
|
2444
2802
|
*/
|
|
2445
2803
|
export interface BatchParameters {
|
|
2446
2804
|
/**
|
|
2805
|
+
* @public
|
|
2447
2806
|
* <p>The ARN or name of the job definition to use if the event target is an Batch job. This
|
|
2448
2807
|
* job definition must already exist.</p>
|
|
2449
2808
|
*/
|
|
2450
2809
|
JobDefinition: string | undefined;
|
|
2451
2810
|
/**
|
|
2811
|
+
* @public
|
|
2452
2812
|
* <p>The name to use for this execution of the job, if the target is an Batch job.</p>
|
|
2453
2813
|
*/
|
|
2454
2814
|
JobName: string | undefined;
|
|
2455
2815
|
/**
|
|
2816
|
+
* @public
|
|
2456
2817
|
* <p>The array properties for the submitted job, such as the size of the array. The array size
|
|
2457
2818
|
* can be between 2 and 10,000. If you specify array properties for a job, it becomes an array
|
|
2458
2819
|
* job. This parameter is used only if the target is an Batch job.</p>
|
|
2459
2820
|
*/
|
|
2460
2821
|
ArrayProperties?: BatchArrayProperties;
|
|
2461
2822
|
/**
|
|
2823
|
+
* @public
|
|
2462
2824
|
* <p>The retry strategy to use for failed jobs, if the target is an Batch job. The retry
|
|
2463
2825
|
* strategy is the number of times to retry the failed job execution. Valid values are 1–10. When
|
|
2464
2826
|
* you specify a retry strategy here, it overrides the retry strategy defined in the job
|
|
@@ -2473,6 +2835,7 @@ export interface BatchParameters {
|
|
|
2473
2835
|
*/
|
|
2474
2836
|
export interface DeadLetterConfig {
|
|
2475
2837
|
/**
|
|
2838
|
+
* @public
|
|
2476
2839
|
* <p>The ARN of the SQS queue specified as the target for the dead-letter queue.</p>
|
|
2477
2840
|
*/
|
|
2478
2841
|
Arn?: string;
|
|
@@ -2483,16 +2846,19 @@ export interface DeadLetterConfig {
|
|
|
2483
2846
|
*/
|
|
2484
2847
|
export interface CapacityProviderStrategyItem {
|
|
2485
2848
|
/**
|
|
2849
|
+
* @public
|
|
2486
2850
|
* <p>The short name of the capacity provider.</p>
|
|
2487
2851
|
*/
|
|
2488
2852
|
capacityProvider: string | undefined;
|
|
2489
2853
|
/**
|
|
2854
|
+
* @public
|
|
2490
2855
|
* <p>The weight value designates the relative percentage of the total number of tasks launched
|
|
2491
2856
|
* that should use the specified capacity provider. The weight value is taken into consideration
|
|
2492
2857
|
* after the base value, if defined, is satisfied.</p>
|
|
2493
2858
|
*/
|
|
2494
2859
|
weight?: number;
|
|
2495
2860
|
/**
|
|
2861
|
+
* @public
|
|
2496
2862
|
* <p>The base value designates how many tasks, at a minimum, to run on the specified capacity
|
|
2497
2863
|
* provider. Only one capacity provider in a capacity provider strategy can have a base defined.
|
|
2498
2864
|
* If no value is specified, the default value of 0 is used. </p>
|
|
@@ -2520,17 +2886,20 @@ export type LaunchType = (typeof LaunchType)[keyof typeof LaunchType];
|
|
|
2520
2886
|
*/
|
|
2521
2887
|
export interface AwsVpcConfiguration {
|
|
2522
2888
|
/**
|
|
2889
|
+
* @public
|
|
2523
2890
|
* <p>Specifies the subnets associated with the task. These subnets must all be in the same VPC.
|
|
2524
2891
|
* You can specify as many as 16 subnets.</p>
|
|
2525
2892
|
*/
|
|
2526
2893
|
Subnets: string[] | undefined;
|
|
2527
2894
|
/**
|
|
2895
|
+
* @public
|
|
2528
2896
|
* <p>Specifies the security groups associated with the task. These security groups must all be
|
|
2529
2897
|
* in the same VPC. You can specify as many as five security groups. If you do not specify a
|
|
2530
2898
|
* security group, the default security group for the VPC is used.</p>
|
|
2531
2899
|
*/
|
|
2532
2900
|
SecurityGroups?: string[];
|
|
2533
2901
|
/**
|
|
2902
|
+
* @public
|
|
2534
2903
|
* <p>Specifies whether the task's elastic network interface receives a public IP address. You
|
|
2535
2904
|
* can specify <code>ENABLED</code> only when <code>LaunchType</code> in
|
|
2536
2905
|
* <code>EcsParameters</code> is set to <code>FARGATE</code>.</p>
|
|
@@ -2543,6 +2912,7 @@ export interface AwsVpcConfiguration {
|
|
|
2543
2912
|
*/
|
|
2544
2913
|
export interface NetworkConfiguration {
|
|
2545
2914
|
/**
|
|
2915
|
+
* @public
|
|
2546
2916
|
* <p>Use this structure to specify the VPC subnets and security groups for the task, and
|
|
2547
2917
|
* whether a public IP address is to be used. This structure is relevant only for ECS tasks that
|
|
2548
2918
|
* use the <code>awsvpc</code> network mode.</p>
|
|
@@ -2568,12 +2938,14 @@ export type PlacementConstraintType = (typeof PlacementConstraintType)[keyof typ
|
|
|
2568
2938
|
*/
|
|
2569
2939
|
export interface PlacementConstraint {
|
|
2570
2940
|
/**
|
|
2941
|
+
* @public
|
|
2571
2942
|
* <p>The type of constraint. Use distinctInstance to ensure that each task in a particular
|
|
2572
2943
|
* group is running on a different container instance. Use memberOf to restrict the selection to
|
|
2573
2944
|
* a group of valid candidates. </p>
|
|
2574
2945
|
*/
|
|
2575
2946
|
type?: PlacementConstraintType | string;
|
|
2576
2947
|
/**
|
|
2948
|
+
* @public
|
|
2577
2949
|
* <p>A cluster query language expression to apply to the constraint. You cannot specify an
|
|
2578
2950
|
* expression if the constraint type is <code>distinctInstance</code>. To learn more, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html">Cluster Query Language</a> in the Amazon Elastic Container Service Developer Guide.
|
|
2579
2951
|
* </p>
|
|
@@ -2600,6 +2972,7 @@ export type PlacementStrategyType = (typeof PlacementStrategyType)[keyof typeof
|
|
|
2600
2972
|
*/
|
|
2601
2973
|
export interface PlacementStrategy {
|
|
2602
2974
|
/**
|
|
2975
|
+
* @public
|
|
2603
2976
|
* <p>The type of placement strategy. The random placement strategy randomly places tasks on
|
|
2604
2977
|
* available candidates. The spread placement strategy spreads placement across available
|
|
2605
2978
|
* candidates evenly based on the field parameter. The binpack strategy places tasks on available
|
|
@@ -2609,6 +2982,7 @@ export interface PlacementStrategy {
|
|
|
2609
2982
|
*/
|
|
2610
2983
|
type?: PlacementStrategyType | string;
|
|
2611
2984
|
/**
|
|
2985
|
+
* @public
|
|
2612
2986
|
* <p>The field to apply the placement strategy against. For the spread placement strategy,
|
|
2613
2987
|
* valid values are instanceId (or host, which has the same effect), or any platform or custom
|
|
2614
2988
|
* attribute that is applied to a container instance, such as attribute:ecs.availability-zone.
|
|
@@ -2634,15 +3008,18 @@ export type PropagateTags = (typeof PropagateTags)[keyof typeof PropagateTags];
|
|
|
2634
3008
|
*/
|
|
2635
3009
|
export interface EcsParameters {
|
|
2636
3010
|
/**
|
|
3011
|
+
* @public
|
|
2637
3012
|
* <p>The ARN of the task definition to use if the event target is an Amazon ECS task. </p>
|
|
2638
3013
|
*/
|
|
2639
3014
|
TaskDefinitionArn: string | undefined;
|
|
2640
3015
|
/**
|
|
3016
|
+
* @public
|
|
2641
3017
|
* <p>The number of tasks to create based on <code>TaskDefinition</code>. The default is
|
|
2642
3018
|
* 1.</p>
|
|
2643
3019
|
*/
|
|
2644
3020
|
TaskCount?: number;
|
|
2645
3021
|
/**
|
|
3022
|
+
* @public
|
|
2646
3023
|
* <p>Specifies the launch type on which your task is running. The launch type that you specify
|
|
2647
3024
|
* here must match one of the launch type (compatibilities) of the target task. The
|
|
2648
3025
|
* <code>FARGATE</code> value is supported only in the Regions where Fargate with Amazon ECS
|
|
@@ -2651,6 +3028,7 @@ export interface EcsParameters {
|
|
|
2651
3028
|
*/
|
|
2652
3029
|
LaunchType?: LaunchType | string;
|
|
2653
3030
|
/**
|
|
3031
|
+
* @public
|
|
2654
3032
|
* <p>Use this structure if the Amazon ECS task uses the <code>awsvpc</code> network mode. This
|
|
2655
3033
|
* structure specifies the VPC subnets and security groups associated with the task, and whether
|
|
2656
3034
|
* a public IP address is to be used. This structure is required if <code>LaunchType</code> is
|
|
@@ -2661,6 +3039,7 @@ export interface EcsParameters {
|
|
|
2661
3039
|
*/
|
|
2662
3040
|
NetworkConfiguration?: NetworkConfiguration;
|
|
2663
3041
|
/**
|
|
3042
|
+
* @public
|
|
2664
3043
|
* <p>Specifies the platform version for the task. Specify only the numeric portion of the
|
|
2665
3044
|
* platform version, such as <code>1.1.0</code>.</p>
|
|
2666
3045
|
* <p>This structure is used only if <code>LaunchType</code> is <code>FARGATE</code>. For more
|
|
@@ -2670,10 +3049,12 @@ export interface EcsParameters {
|
|
|
2670
3049
|
*/
|
|
2671
3050
|
PlatformVersion?: string;
|
|
2672
3051
|
/**
|
|
3052
|
+
* @public
|
|
2673
3053
|
* <p>Specifies an ECS task group for the task. The maximum length is 255 characters.</p>
|
|
2674
3054
|
*/
|
|
2675
3055
|
Group?: string;
|
|
2676
3056
|
/**
|
|
3057
|
+
* @public
|
|
2677
3058
|
* <p>The capacity provider strategy to use for the task.</p>
|
|
2678
3059
|
* <p>If a <code>capacityProviderStrategy</code> is specified, the <code>launchType</code>
|
|
2679
3060
|
* parameter must be omitted. If no <code>capacityProviderStrategy</code> or launchType is
|
|
@@ -2681,39 +3062,46 @@ export interface EcsParameters {
|
|
|
2681
3062
|
*/
|
|
2682
3063
|
CapacityProviderStrategy?: CapacityProviderStrategyItem[];
|
|
2683
3064
|
/**
|
|
3065
|
+
* @public
|
|
2684
3066
|
* <p>Specifies whether to enable Amazon ECS managed tags for the task. For more information,
|
|
2685
3067
|
* see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html">Tagging Your Amazon ECS Resources</a> in the Amazon Elastic Container Service Developer
|
|
2686
3068
|
* Guide. </p>
|
|
2687
3069
|
*/
|
|
2688
3070
|
EnableECSManagedTags?: boolean;
|
|
2689
3071
|
/**
|
|
3072
|
+
* @public
|
|
2690
3073
|
* <p>Whether or not to enable the execute command functionality for the containers in this
|
|
2691
3074
|
* task. If true, this enables execute command functionality on all containers in the
|
|
2692
3075
|
* task.</p>
|
|
2693
3076
|
*/
|
|
2694
3077
|
EnableExecuteCommand?: boolean;
|
|
2695
3078
|
/**
|
|
3079
|
+
* @public
|
|
2696
3080
|
* <p>An array of placement constraint objects to use for the task. You can specify up to 10
|
|
2697
3081
|
* constraints per task (including constraints in the task definition and those specified at
|
|
2698
3082
|
* runtime).</p>
|
|
2699
3083
|
*/
|
|
2700
3084
|
PlacementConstraints?: PlacementConstraint[];
|
|
2701
3085
|
/**
|
|
3086
|
+
* @public
|
|
2702
3087
|
* <p>The placement strategy objects to use for the task. You can specify a maximum of five
|
|
2703
3088
|
* strategy rules per task. </p>
|
|
2704
3089
|
*/
|
|
2705
3090
|
PlacementStrategy?: PlacementStrategy[];
|
|
2706
3091
|
/**
|
|
3092
|
+
* @public
|
|
2707
3093
|
* <p>Specifies whether to propagate the tags from the task definition to the task. If no value
|
|
2708
3094
|
* is specified, the tags are not propagated. Tags can only be propagated to the task during task
|
|
2709
3095
|
* creation. To add tags to a task after task creation, use the TagResource API action. </p>
|
|
2710
3096
|
*/
|
|
2711
3097
|
PropagateTags?: PropagateTags | string;
|
|
2712
3098
|
/**
|
|
3099
|
+
* @public
|
|
2713
3100
|
* <p>The reference ID to use for the task.</p>
|
|
2714
3101
|
*/
|
|
2715
3102
|
ReferenceId?: string;
|
|
2716
3103
|
/**
|
|
3104
|
+
* @public
|
|
2717
3105
|
* <p>The metadata that you apply to the task to help you categorize and organize them. Each tag
|
|
2718
3106
|
* consists of a key and an optional value, both of which you define. To learn more, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-tags">RunTask</a> in the Amazon ECS API Reference.</p>
|
|
2719
3107
|
*/
|
|
@@ -2728,16 +3116,19 @@ export interface EcsParameters {
|
|
|
2728
3116
|
*/
|
|
2729
3117
|
export interface HttpParameters {
|
|
2730
3118
|
/**
|
|
3119
|
+
* @public
|
|
2731
3120
|
* <p>The path parameter values to be used to populate API Gateway API or EventBridge
|
|
2732
3121
|
* ApiDestination path wildcards ("*").</p>
|
|
2733
3122
|
*/
|
|
2734
3123
|
PathParameterValues?: string[];
|
|
2735
3124
|
/**
|
|
3125
|
+
* @public
|
|
2736
3126
|
* <p>The headers that need to be sent as part of request invoking the API Gateway API or
|
|
2737
3127
|
* EventBridge ApiDestination.</p>
|
|
2738
3128
|
*/
|
|
2739
3129
|
HeaderParameters?: Record<string, string>;
|
|
2740
3130
|
/**
|
|
3131
|
+
* @public
|
|
2741
3132
|
* <p>The query string keys/values that need to be sent as part of request invoking the API Gateway
|
|
2742
3133
|
* API or EventBridge ApiDestination.</p>
|
|
2743
3134
|
*/
|
|
@@ -2750,6 +3141,7 @@ export interface HttpParameters {
|
|
|
2750
3141
|
*/
|
|
2751
3142
|
export interface InputTransformer {
|
|
2752
3143
|
/**
|
|
3144
|
+
* @public
|
|
2753
3145
|
* <p>Map of JSON paths to be extracted from the event. You can then insert these in the
|
|
2754
3146
|
* template in <code>InputTemplate</code> to produce the output you want to be sent to the
|
|
2755
3147
|
* target.</p>
|
|
@@ -2761,6 +3153,7 @@ export interface InputTransformer {
|
|
|
2761
3153
|
*/
|
|
2762
3154
|
InputPathsMap?: Record<string, string>;
|
|
2763
3155
|
/**
|
|
3156
|
+
* @public
|
|
2764
3157
|
* <p>Input template where you specify placeholders that will be filled with the values of the
|
|
2765
3158
|
* keys from <code>InputPathsMap</code> to customize the data sent to the target. Enclose each
|
|
2766
3159
|
* <code>InputPathsMaps</code> value in brackets: <<i>value</i>>
|
|
@@ -2839,6 +3232,7 @@ export interface InputTransformer {
|
|
|
2839
3232
|
*/
|
|
2840
3233
|
export interface KinesisParameters {
|
|
2841
3234
|
/**
|
|
3235
|
+
* @public
|
|
2842
3236
|
* <p>The JSON path to be extracted from the event and used as the partition key. For more
|
|
2843
3237
|
* information, see <a href="https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html#partition-key">Amazon Kinesis Streams Key
|
|
2844
3238
|
* Concepts</a> in the <i>Amazon Kinesis Streams Developer Guide</i>.</p>
|
|
@@ -2852,34 +3246,41 @@ export interface KinesisParameters {
|
|
|
2852
3246
|
*/
|
|
2853
3247
|
export interface RedshiftDataParameters {
|
|
2854
3248
|
/**
|
|
3249
|
+
* @public
|
|
2855
3250
|
* <p>The name or ARN of the secret that enables access to the database. Required when
|
|
2856
3251
|
* authenticating using Amazon Web Services Secrets Manager.</p>
|
|
2857
3252
|
*/
|
|
2858
3253
|
SecretManagerArn?: string;
|
|
2859
3254
|
/**
|
|
3255
|
+
* @public
|
|
2860
3256
|
* <p>The name of the database. Required when authenticating using temporary credentials.</p>
|
|
2861
3257
|
*/
|
|
2862
3258
|
Database: string | undefined;
|
|
2863
3259
|
/**
|
|
3260
|
+
* @public
|
|
2864
3261
|
* <p>The database user name. Required when authenticating using temporary credentials.</p>
|
|
2865
3262
|
* <p>Do not provide this parameter when connecting to a Redshift Serverless workgroup.</p>
|
|
2866
3263
|
*/
|
|
2867
3264
|
DbUser?: string;
|
|
2868
3265
|
/**
|
|
3266
|
+
* @public
|
|
2869
3267
|
* <p>The SQL statement text to run.</p>
|
|
2870
3268
|
*/
|
|
2871
3269
|
Sql?: string;
|
|
2872
3270
|
/**
|
|
3271
|
+
* @public
|
|
2873
3272
|
* <p>The name of the SQL statement. You can name the SQL statement when you create it to
|
|
2874
3273
|
* identify the query.</p>
|
|
2875
3274
|
*/
|
|
2876
3275
|
StatementName?: string;
|
|
2877
3276
|
/**
|
|
3277
|
+
* @public
|
|
2878
3278
|
* <p>Indicates whether to send an event back to EventBridge after the SQL statement
|
|
2879
3279
|
* runs.</p>
|
|
2880
3280
|
*/
|
|
2881
3281
|
WithEvent?: boolean;
|
|
2882
3282
|
/**
|
|
3283
|
+
* @public
|
|
2883
3284
|
* A list of SQLs.
|
|
2884
3285
|
*/
|
|
2885
3286
|
Sqls?: string[];
|
|
@@ -2891,12 +3292,14 @@ export interface RedshiftDataParameters {
|
|
|
2891
3292
|
*/
|
|
2892
3293
|
export interface RetryPolicy {
|
|
2893
3294
|
/**
|
|
3295
|
+
* @public
|
|
2894
3296
|
* <p>The maximum number of retry attempts to make before the request fails. Retry attempts
|
|
2895
3297
|
* continue until either the maximum number of attempts is made or until the duration of the
|
|
2896
3298
|
* <code>MaximumEventAgeInSeconds</code> is met.</p>
|
|
2897
3299
|
*/
|
|
2898
3300
|
MaximumRetryAttempts?: number;
|
|
2899
3301
|
/**
|
|
3302
|
+
* @public
|
|
2900
3303
|
* <p>The maximum amount of time, in seconds, to continue to make retry attempts.</p>
|
|
2901
3304
|
*/
|
|
2902
3305
|
MaximumEventAgeInSeconds?: number;
|
|
@@ -2909,12 +3312,14 @@ export interface RetryPolicy {
|
|
|
2909
3312
|
*/
|
|
2910
3313
|
export interface RunCommandTarget {
|
|
2911
3314
|
/**
|
|
3315
|
+
* @public
|
|
2912
3316
|
* <p>Can be either <code>tag:</code>
|
|
2913
3317
|
* <i>tag-key</i> or
|
|
2914
3318
|
* <code>InstanceIds</code>.</p>
|
|
2915
3319
|
*/
|
|
2916
3320
|
Key: string | undefined;
|
|
2917
3321
|
/**
|
|
3322
|
+
* @public
|
|
2918
3323
|
* <p>If <code>Key</code> is <code>tag:</code>
|
|
2919
3324
|
* <i>tag-key</i>, <code>Values</code>
|
|
2920
3325
|
* is a list of tag values. If <code>Key</code> is <code>InstanceIds</code>, <code>Values</code>
|
|
@@ -2929,6 +3334,7 @@ export interface RunCommandTarget {
|
|
|
2929
3334
|
*/
|
|
2930
3335
|
export interface RunCommandParameters {
|
|
2931
3336
|
/**
|
|
3337
|
+
* @public
|
|
2932
3338
|
* <p>Currently, we support including only one RunCommandTarget block, which specifies either an
|
|
2933
3339
|
* array of InstanceIds or a tag.</p>
|
|
2934
3340
|
*/
|
|
@@ -2941,10 +3347,12 @@ export interface RunCommandParameters {
|
|
|
2941
3347
|
*/
|
|
2942
3348
|
export interface SageMakerPipelineParameter {
|
|
2943
3349
|
/**
|
|
3350
|
+
* @public
|
|
2944
3351
|
* <p>Name of parameter to start execution of a SageMaker Model Building Pipeline.</p>
|
|
2945
3352
|
*/
|
|
2946
3353
|
Name: string | undefined;
|
|
2947
3354
|
/**
|
|
3355
|
+
* @public
|
|
2948
3356
|
* <p>Value of parameter to start execution of a SageMaker Model Building Pipeline.</p>
|
|
2949
3357
|
*/
|
|
2950
3358
|
Value: string | undefined;
|
|
@@ -2956,6 +3364,7 @@ export interface SageMakerPipelineParameter {
|
|
|
2956
3364
|
*/
|
|
2957
3365
|
export interface SageMakerPipelineParameters {
|
|
2958
3366
|
/**
|
|
3367
|
+
* @public
|
|
2959
3368
|
* <p>List of Parameter names and values for SageMaker Model Building Pipeline execution.</p>
|
|
2960
3369
|
*/
|
|
2961
3370
|
PipelineParameterList?: SageMakerPipelineParameter[];
|
|
@@ -2967,6 +3376,7 @@ export interface SageMakerPipelineParameters {
|
|
|
2967
3376
|
*/
|
|
2968
3377
|
export interface SqsParameters {
|
|
2969
3378
|
/**
|
|
3379
|
+
* @public
|
|
2970
3380
|
* <p>The FIFO message group ID to use as the target.</p>
|
|
2971
3381
|
*/
|
|
2972
3382
|
MessageGroupId?: string;
|
|
@@ -2984,48 +3394,57 @@ export interface SqsParameters {
|
|
|
2984
3394
|
*/
|
|
2985
3395
|
export interface Target {
|
|
2986
3396
|
/**
|
|
3397
|
+
* @public
|
|
2987
3398
|
* <p>The ID of the target within the specified rule. Use this ID to reference the target when updating the rule. We recommend using a memorable and unique string.</p>
|
|
2988
3399
|
*/
|
|
2989
3400
|
Id: string | undefined;
|
|
2990
3401
|
/**
|
|
3402
|
+
* @public
|
|
2991
3403
|
* <p>The Amazon Resource Name (ARN) of the target.</p>
|
|
2992
3404
|
*/
|
|
2993
3405
|
Arn: string | undefined;
|
|
2994
3406
|
/**
|
|
3407
|
+
* @public
|
|
2995
3408
|
* <p>The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is
|
|
2996
3409
|
* triggered. If one rule triggers multiple targets, you can use a different IAM role for each
|
|
2997
3410
|
* target.</p>
|
|
2998
3411
|
*/
|
|
2999
3412
|
RoleArn?: string;
|
|
3000
3413
|
/**
|
|
3414
|
+
* @public
|
|
3001
3415
|
* <p>Valid JSON text passed to the target. In this case, nothing from the event itself is
|
|
3002
3416
|
* passed to the target. For more information, see <a href="http://www.rfc-editor.org/rfc/rfc7159.txt">The JavaScript Object Notation (JSON) Data
|
|
3003
3417
|
* Interchange Format</a>.</p>
|
|
3004
3418
|
*/
|
|
3005
3419
|
Input?: string;
|
|
3006
3420
|
/**
|
|
3421
|
+
* @public
|
|
3007
3422
|
* <p>The value of the JSONPath that is used for extracting part of the matched event when
|
|
3008
3423
|
* passing it to the target. You may use JSON dot notation or bracket notation. For more
|
|
3009
3424
|
* information about JSON paths, see <a href="http://goessner.net/articles/JsonPath/">JSONPath</a>.</p>
|
|
3010
3425
|
*/
|
|
3011
3426
|
InputPath?: string;
|
|
3012
3427
|
/**
|
|
3428
|
+
* @public
|
|
3013
3429
|
* <p>Settings to enable you to provide custom input to a target based on certain event data.
|
|
3014
3430
|
* You can extract one or more key-value pairs from the event and then use that data to send
|
|
3015
3431
|
* customized input to the target.</p>
|
|
3016
3432
|
*/
|
|
3017
3433
|
InputTransformer?: InputTransformer;
|
|
3018
3434
|
/**
|
|
3435
|
+
* @public
|
|
3019
3436
|
* <p>The custom parameter you can use to control the shard assignment, when the target is a
|
|
3020
3437
|
* Kinesis data stream. If you do not include this parameter, the default is to use the
|
|
3021
3438
|
* <code>eventId</code> as the partition key.</p>
|
|
3022
3439
|
*/
|
|
3023
3440
|
KinesisParameters?: KinesisParameters;
|
|
3024
3441
|
/**
|
|
3442
|
+
* @public
|
|
3025
3443
|
* <p>Parameters used when you are using the rule to invoke Amazon EC2 Run Command.</p>
|
|
3026
3444
|
*/
|
|
3027
3445
|
RunCommandParameters?: RunCommandParameters;
|
|
3028
3446
|
/**
|
|
3447
|
+
* @public
|
|
3029
3448
|
* <p>Contains the Amazon ECS task definition and task count to be used, if the event target is
|
|
3030
3449
|
* an Amazon ECS task. For more information about Amazon ECS tasks, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html">Task
|
|
3031
3450
|
* Definitions </a> in the <i>Amazon EC2 Container Service Developer
|
|
@@ -3033,18 +3452,21 @@ export interface Target {
|
|
|
3033
3452
|
*/
|
|
3034
3453
|
EcsParameters?: EcsParameters;
|
|
3035
3454
|
/**
|
|
3455
|
+
* @public
|
|
3036
3456
|
* <p>If the event target is an Batch job, this contains the job definition, job name, and
|
|
3037
3457
|
* other parameters. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/jobs.html">Jobs</a> in the <i>Batch User
|
|
3038
3458
|
* Guide</i>.</p>
|
|
3039
3459
|
*/
|
|
3040
3460
|
BatchParameters?: BatchParameters;
|
|
3041
3461
|
/**
|
|
3462
|
+
* @public
|
|
3042
3463
|
* <p>Contains the message group ID to use when the target is a FIFO queue.</p>
|
|
3043
3464
|
* <p>If you specify an SQS FIFO queue as a target, the queue must have content-based
|
|
3044
3465
|
* deduplication enabled.</p>
|
|
3045
3466
|
*/
|
|
3046
3467
|
SqsParameters?: SqsParameters;
|
|
3047
3468
|
/**
|
|
3469
|
+
* @public
|
|
3048
3470
|
* <p>Contains the HTTP parameters to use when the target is a API Gateway endpoint or
|
|
3049
3471
|
* EventBridge ApiDestination.</p>
|
|
3050
3472
|
* <p>If you specify an API Gateway API or EventBridge ApiDestination as a target, you can
|
|
@@ -3055,6 +3477,7 @@ export interface Target {
|
|
|
3055
3477
|
*/
|
|
3056
3478
|
HttpParameters?: HttpParameters;
|
|
3057
3479
|
/**
|
|
3480
|
+
* @public
|
|
3058
3481
|
* <p>Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift
|
|
3059
3482
|
* cluster.</p>
|
|
3060
3483
|
* <p>If you specify a Amazon Redshift Cluster as a Target, you can use this to specify parameters to
|
|
@@ -3062,6 +3485,7 @@ export interface Target {
|
|
|
3062
3485
|
*/
|
|
3063
3486
|
RedshiftDataParameters?: RedshiftDataParameters;
|
|
3064
3487
|
/**
|
|
3488
|
+
* @public
|
|
3065
3489
|
* <p>Contains the SageMaker Model Building Pipeline parameters to start execution of a
|
|
3066
3490
|
* SageMaker Model Building Pipeline.</p>
|
|
3067
3491
|
* <p>If you specify a SageMaker Model Building Pipeline as a target, you can use this to
|
|
@@ -3069,11 +3493,13 @@ export interface Target {
|
|
|
3069
3493
|
*/
|
|
3070
3494
|
SageMakerPipelineParameters?: SageMakerPipelineParameters;
|
|
3071
3495
|
/**
|
|
3496
|
+
* @public
|
|
3072
3497
|
* <p>The <code>DeadLetterConfig</code> that defines the target queue to send dead-letter queue
|
|
3073
3498
|
* events to.</p>
|
|
3074
3499
|
*/
|
|
3075
3500
|
DeadLetterConfig?: DeadLetterConfig;
|
|
3076
3501
|
/**
|
|
3502
|
+
* @public
|
|
3077
3503
|
* <p>The <code>RetryPolicy</code> object that contains the retry policy configuration to use
|
|
3078
3504
|
* for the dead-letter queue.</p>
|
|
3079
3505
|
*/
|
|
@@ -3084,10 +3510,12 @@ export interface Target {
|
|
|
3084
3510
|
*/
|
|
3085
3511
|
export interface ListTargetsByRuleResponse {
|
|
3086
3512
|
/**
|
|
3513
|
+
* @public
|
|
3087
3514
|
* <p>The targets assigned to the rule.</p>
|
|
3088
3515
|
*/
|
|
3089
3516
|
Targets?: Target[];
|
|
3090
3517
|
/**
|
|
3518
|
+
* @public
|
|
3091
3519
|
* <p>Indicates whether there are additional results to retrieve. If there are no more results,
|
|
3092
3520
|
* the value is null.</p>
|
|
3093
3521
|
*/
|
|
@@ -3099,28 +3527,34 @@ export interface ListTargetsByRuleResponse {
|
|
|
3099
3527
|
*/
|
|
3100
3528
|
export interface PutEventsRequestEntry {
|
|
3101
3529
|
/**
|
|
3530
|
+
* @public
|
|
3102
3531
|
* <p>The time stamp of the event, per <a href="https://www.rfc-editor.org/rfc/rfc3339.txt">RFC3339</a>. If no time stamp is provided, the time stamp of the <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html">PutEvents</a> call is used.</p>
|
|
3103
3532
|
*/
|
|
3104
3533
|
Time?: Date;
|
|
3105
3534
|
/**
|
|
3535
|
+
* @public
|
|
3106
3536
|
* <p>The source of the event.</p>
|
|
3107
3537
|
*/
|
|
3108
3538
|
Source?: string;
|
|
3109
3539
|
/**
|
|
3540
|
+
* @public
|
|
3110
3541
|
* <p>Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily
|
|
3111
3542
|
* concerns. Any number, including zero, may be present.</p>
|
|
3112
3543
|
*/
|
|
3113
3544
|
Resources?: string[];
|
|
3114
3545
|
/**
|
|
3546
|
+
* @public
|
|
3115
3547
|
* <p>Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.</p>
|
|
3116
3548
|
*/
|
|
3117
3549
|
DetailType?: string;
|
|
3118
3550
|
/**
|
|
3551
|
+
* @public
|
|
3119
3552
|
* <p>A valid JSON object. There is no other schema imposed. The JSON object may contain fields
|
|
3120
3553
|
* and nested subobjects.</p>
|
|
3121
3554
|
*/
|
|
3122
3555
|
Detail?: string;
|
|
3123
3556
|
/**
|
|
3557
|
+
* @public
|
|
3124
3558
|
* <p>The name or ARN of the event bus to receive the event. Only the rules that are associated
|
|
3125
3559
|
* with this event bus are used to match the event. If you omit this, the default event bus is
|
|
3126
3560
|
* used.</p>
|
|
@@ -3132,6 +3566,7 @@ export interface PutEventsRequestEntry {
|
|
|
3132
3566
|
*/
|
|
3133
3567
|
EventBusName?: string;
|
|
3134
3568
|
/**
|
|
3569
|
+
* @public
|
|
3135
3570
|
* <p>An X-Ray trace header, which is an http header (X-Amzn-Trace-Id) that contains the
|
|
3136
3571
|
* trace-id associated with the event.</p>
|
|
3137
3572
|
* <p>To learn more about X-Ray trace headers, see <a href="https://docs.aws.amazon.com/xray/latest/devguide/xray-concepts.html#xray-concepts-tracingheader">Tracing header</a> in the X-Ray Developer Guide.</p>
|
|
@@ -3143,12 +3578,14 @@ export interface PutEventsRequestEntry {
|
|
|
3143
3578
|
*/
|
|
3144
3579
|
export interface PutEventsRequest {
|
|
3145
3580
|
/**
|
|
3581
|
+
* @public
|
|
3146
3582
|
* <p>The entry that defines an event in your system. You can specify several parameters for the
|
|
3147
3583
|
* entry such as the source and type of the event, resources associated with the event, and so
|
|
3148
3584
|
* on.</p>
|
|
3149
3585
|
*/
|
|
3150
3586
|
Entries: PutEventsRequestEntry[] | undefined;
|
|
3151
3587
|
/**
|
|
3588
|
+
* @public
|
|
3152
3589
|
* <p>The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is <code>abcde.veo</code>.</p>
|
|
3153
3590
|
* <important>
|
|
3154
3591
|
* <p>When using Java, you must include <code>auth-crt</code> on the class path.</p>
|
|
@@ -3163,14 +3600,17 @@ export interface PutEventsRequest {
|
|
|
3163
3600
|
*/
|
|
3164
3601
|
export interface PutEventsResultEntry {
|
|
3165
3602
|
/**
|
|
3603
|
+
* @public
|
|
3166
3604
|
* <p>The ID of the event.</p>
|
|
3167
3605
|
*/
|
|
3168
3606
|
EventId?: string;
|
|
3169
3607
|
/**
|
|
3608
|
+
* @public
|
|
3170
3609
|
* <p>The error code that indicates why the event submission failed.</p>
|
|
3171
3610
|
*/
|
|
3172
3611
|
ErrorCode?: string;
|
|
3173
3612
|
/**
|
|
3613
|
+
* @public
|
|
3174
3614
|
* <p>The error message that explains why the event submission failed.</p>
|
|
3175
3615
|
*/
|
|
3176
3616
|
ErrorMessage?: string;
|
|
@@ -3180,10 +3620,12 @@ export interface PutEventsResultEntry {
|
|
|
3180
3620
|
*/
|
|
3181
3621
|
export interface PutEventsResponse {
|
|
3182
3622
|
/**
|
|
3623
|
+
* @public
|
|
3183
3624
|
* <p>The number of failed entries.</p>
|
|
3184
3625
|
*/
|
|
3185
3626
|
FailedEntryCount?: number;
|
|
3186
3627
|
/**
|
|
3628
|
+
* @public
|
|
3187
3629
|
* <p>The successfully and unsuccessfully ingested events results. If the ingestion was
|
|
3188
3630
|
* successful, the entry has the event ID in it. Otherwise, you can use the error code and error
|
|
3189
3631
|
* message to identify the problem with the entry.</p>
|
|
@@ -3197,23 +3639,28 @@ export interface PutEventsResponse {
|
|
|
3197
3639
|
*/
|
|
3198
3640
|
export interface PutPartnerEventsRequestEntry {
|
|
3199
3641
|
/**
|
|
3642
|
+
* @public
|
|
3200
3643
|
* <p>The date and time of the event.</p>
|
|
3201
3644
|
*/
|
|
3202
3645
|
Time?: Date;
|
|
3203
3646
|
/**
|
|
3647
|
+
* @public
|
|
3204
3648
|
* <p>The event source that is generating the entry.</p>
|
|
3205
3649
|
*/
|
|
3206
3650
|
Source?: string;
|
|
3207
3651
|
/**
|
|
3652
|
+
* @public
|
|
3208
3653
|
* <p>Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily
|
|
3209
3654
|
* concerns. Any number, including zero, may be present.</p>
|
|
3210
3655
|
*/
|
|
3211
3656
|
Resources?: string[];
|
|
3212
3657
|
/**
|
|
3658
|
+
* @public
|
|
3213
3659
|
* <p>A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.</p>
|
|
3214
3660
|
*/
|
|
3215
3661
|
DetailType?: string;
|
|
3216
3662
|
/**
|
|
3663
|
+
* @public
|
|
3217
3664
|
* <p>A valid JSON string. There is no other schema imposed. The JSON string may contain fields
|
|
3218
3665
|
* and nested subobjects.</p>
|
|
3219
3666
|
*/
|
|
@@ -3224,6 +3671,7 @@ export interface PutPartnerEventsRequestEntry {
|
|
|
3224
3671
|
*/
|
|
3225
3672
|
export interface PutPartnerEventsRequest {
|
|
3226
3673
|
/**
|
|
3674
|
+
* @public
|
|
3227
3675
|
* <p>The list of events to write to the event bus.</p>
|
|
3228
3676
|
*/
|
|
3229
3677
|
Entries: PutPartnerEventsRequestEntry[] | undefined;
|
|
@@ -3234,14 +3682,17 @@ export interface PutPartnerEventsRequest {
|
|
|
3234
3682
|
*/
|
|
3235
3683
|
export interface PutPartnerEventsResultEntry {
|
|
3236
3684
|
/**
|
|
3685
|
+
* @public
|
|
3237
3686
|
* <p>The ID of the event.</p>
|
|
3238
3687
|
*/
|
|
3239
3688
|
EventId?: string;
|
|
3240
3689
|
/**
|
|
3690
|
+
* @public
|
|
3241
3691
|
* <p>The error code that indicates why the event submission failed.</p>
|
|
3242
3692
|
*/
|
|
3243
3693
|
ErrorCode?: string;
|
|
3244
3694
|
/**
|
|
3695
|
+
* @public
|
|
3245
3696
|
* <p>The error message that explains why the event submission failed.</p>
|
|
3246
3697
|
*/
|
|
3247
3698
|
ErrorMessage?: string;
|
|
@@ -3251,11 +3702,13 @@ export interface PutPartnerEventsResultEntry {
|
|
|
3251
3702
|
*/
|
|
3252
3703
|
export interface PutPartnerEventsResponse {
|
|
3253
3704
|
/**
|
|
3705
|
+
* @public
|
|
3254
3706
|
* <p>The number of events from this operation that could not be written to the partner event
|
|
3255
3707
|
* bus.</p>
|
|
3256
3708
|
*/
|
|
3257
3709
|
FailedEntryCount?: number;
|
|
3258
3710
|
/**
|
|
3711
|
+
* @public
|
|
3259
3712
|
* <p>The list of events from this operation that were successfully written to the partner event
|
|
3260
3713
|
* bus.</p>
|
|
3261
3714
|
*/
|
|
@@ -3287,16 +3740,19 @@ export declare class PolicyLengthExceededException extends __BaseException {
|
|
|
3287
3740
|
*/
|
|
3288
3741
|
export interface Condition {
|
|
3289
3742
|
/**
|
|
3743
|
+
* @public
|
|
3290
3744
|
* <p>Specifies the type of condition. Currently the only supported value is
|
|
3291
3745
|
* <code>StringEquals</code>.</p>
|
|
3292
3746
|
*/
|
|
3293
3747
|
Type: string | undefined;
|
|
3294
3748
|
/**
|
|
3749
|
+
* @public
|
|
3295
3750
|
* <p>Specifies the key for the condition. Currently the only supported key is
|
|
3296
3751
|
* <code>aws:PrincipalOrgID</code>.</p>
|
|
3297
3752
|
*/
|
|
3298
3753
|
Key: string | undefined;
|
|
3299
3754
|
/**
|
|
3755
|
+
* @public
|
|
3300
3756
|
* <p>Specifies the value for the key. Currently, this must be the ID of the
|
|
3301
3757
|
* organization.</p>
|
|
3302
3758
|
*/
|
|
@@ -3307,15 +3763,18 @@ export interface Condition {
|
|
|
3307
3763
|
*/
|
|
3308
3764
|
export interface PutPermissionRequest {
|
|
3309
3765
|
/**
|
|
3766
|
+
* @public
|
|
3310
3767
|
* <p>The name of the event bus associated with the rule. If you omit this, the default event
|
|
3311
3768
|
* bus is used.</p>
|
|
3312
3769
|
*/
|
|
3313
3770
|
EventBusName?: string;
|
|
3314
3771
|
/**
|
|
3772
|
+
* @public
|
|
3315
3773
|
* <p>The action that you are enabling the other account to perform.</p>
|
|
3316
3774
|
*/
|
|
3317
3775
|
Action?: string;
|
|
3318
3776
|
/**
|
|
3777
|
+
* @public
|
|
3319
3778
|
* <p>The 12-digit Amazon Web Services account ID that you are permitting to put events to your default event
|
|
3320
3779
|
* bus. Specify "*" to permit any account to put events to your default event bus.</p>
|
|
3321
3780
|
* <p>If you specify "*" without specifying <code>Condition</code>, avoid creating rules that
|
|
@@ -3326,6 +3785,7 @@ export interface PutPermissionRequest {
|
|
|
3326
3785
|
*/
|
|
3327
3786
|
Principal?: string;
|
|
3328
3787
|
/**
|
|
3788
|
+
* @public
|
|
3329
3789
|
* <p>An identifier string for the external account that you are granting permissions to. If you
|
|
3330
3790
|
* later want to revoke the permission for this external account, specify this
|
|
3331
3791
|
* <code>StatementId</code> when you run <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemovePermission.html">RemovePermission</a>.</p>
|
|
@@ -3335,6 +3795,7 @@ export interface PutPermissionRequest {
|
|
|
3335
3795
|
*/
|
|
3336
3796
|
StatementId?: string;
|
|
3337
3797
|
/**
|
|
3798
|
+
* @public
|
|
3338
3799
|
* <p>This parameter enables you to limit the permission to accounts that fulfill a certain
|
|
3339
3800
|
* condition, such as being a member of a certain Amazon Web Services organization. For more information about
|
|
3340
3801
|
* Amazon Web Services Organizations, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html">What Is Amazon Web Services
|
|
@@ -3347,6 +3808,7 @@ export interface PutPermissionRequest {
|
|
|
3347
3808
|
*/
|
|
3348
3809
|
Condition?: Condition;
|
|
3349
3810
|
/**
|
|
3811
|
+
* @public
|
|
3350
3812
|
* <p>A JSON string that describes the permission policy statement. You can include a
|
|
3351
3813
|
* <code>Policy</code> parameter in the request instead of using the <code>StatementId</code>,
|
|
3352
3814
|
* <code>Action</code>, <code>Principal</code>, or <code>Condition</code> parameters.</p>
|
|
@@ -3358,27 +3820,33 @@ export interface PutPermissionRequest {
|
|
|
3358
3820
|
*/
|
|
3359
3821
|
export interface PutRuleRequest {
|
|
3360
3822
|
/**
|
|
3823
|
+
* @public
|
|
3361
3824
|
* <p>The name of the rule that you are creating or updating.</p>
|
|
3362
3825
|
*/
|
|
3363
3826
|
Name: string | undefined;
|
|
3364
3827
|
/**
|
|
3828
|
+
* @public
|
|
3365
3829
|
* <p>The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".</p>
|
|
3366
3830
|
*/
|
|
3367
3831
|
ScheduleExpression?: string;
|
|
3368
3832
|
/**
|
|
3833
|
+
* @public
|
|
3369
3834
|
* <p>The event pattern. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html">Amazon EventBridge event
|
|
3370
3835
|
* patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
3371
3836
|
*/
|
|
3372
3837
|
EventPattern?: string;
|
|
3373
3838
|
/**
|
|
3839
|
+
* @public
|
|
3374
3840
|
* <p>Indicates whether the rule is enabled or disabled.</p>
|
|
3375
3841
|
*/
|
|
3376
3842
|
State?: RuleState | string;
|
|
3377
3843
|
/**
|
|
3844
|
+
* @public
|
|
3378
3845
|
* <p>A description of the rule.</p>
|
|
3379
3846
|
*/
|
|
3380
3847
|
Description?: string;
|
|
3381
3848
|
/**
|
|
3849
|
+
* @public
|
|
3382
3850
|
* <p>The Amazon Resource Name (ARN) of the IAM role associated with the rule.</p>
|
|
3383
3851
|
* <p>If you're setting an event bus in another account as the target and that account granted
|
|
3384
3852
|
* permission to your account through an organization instead of directly by the account ID, you
|
|
@@ -3387,10 +3855,12 @@ export interface PutRuleRequest {
|
|
|
3387
3855
|
*/
|
|
3388
3856
|
RoleArn?: string;
|
|
3389
3857
|
/**
|
|
3858
|
+
* @public
|
|
3390
3859
|
* <p>The list of key-value pairs to associate with the rule.</p>
|
|
3391
3860
|
*/
|
|
3392
3861
|
Tags?: Tag[];
|
|
3393
3862
|
/**
|
|
3863
|
+
* @public
|
|
3394
3864
|
* <p>The name or ARN of the event bus to associate with this rule. If you omit this, the
|
|
3395
3865
|
* default event bus is used.</p>
|
|
3396
3866
|
*/
|
|
@@ -3401,6 +3871,7 @@ export interface PutRuleRequest {
|
|
|
3401
3871
|
*/
|
|
3402
3872
|
export interface PutRuleResponse {
|
|
3403
3873
|
/**
|
|
3874
|
+
* @public
|
|
3404
3875
|
* <p>The Amazon Resource Name (ARN) of the rule.</p>
|
|
3405
3876
|
*/
|
|
3406
3877
|
RuleArn?: string;
|
|
@@ -3410,15 +3881,18 @@ export interface PutRuleResponse {
|
|
|
3410
3881
|
*/
|
|
3411
3882
|
export interface PutTargetsRequest {
|
|
3412
3883
|
/**
|
|
3884
|
+
* @public
|
|
3413
3885
|
* <p>The name of the rule.</p>
|
|
3414
3886
|
*/
|
|
3415
3887
|
Rule: string | undefined;
|
|
3416
3888
|
/**
|
|
3889
|
+
* @public
|
|
3417
3890
|
* <p>The name or ARN of the event bus associated with the rule. If you omit this, the default
|
|
3418
3891
|
* event bus is used.</p>
|
|
3419
3892
|
*/
|
|
3420
3893
|
EventBusName?: string;
|
|
3421
3894
|
/**
|
|
3895
|
+
* @public
|
|
3422
3896
|
* <p>The targets to update or add to the rule.</p>
|
|
3423
3897
|
*/
|
|
3424
3898
|
Targets: Target[] | undefined;
|
|
@@ -3429,16 +3903,19 @@ export interface PutTargetsRequest {
|
|
|
3429
3903
|
*/
|
|
3430
3904
|
export interface PutTargetsResultEntry {
|
|
3431
3905
|
/**
|
|
3906
|
+
* @public
|
|
3432
3907
|
* <p>The ID of the target.</p>
|
|
3433
3908
|
*/
|
|
3434
3909
|
TargetId?: string;
|
|
3435
3910
|
/**
|
|
3911
|
+
* @public
|
|
3436
3912
|
* <p>The error code that indicates why the target addition failed. If the value is
|
|
3437
3913
|
* <code>ConcurrentModificationException</code>, too many requests were made at the same
|
|
3438
3914
|
* time.</p>
|
|
3439
3915
|
*/
|
|
3440
3916
|
ErrorCode?: string;
|
|
3441
3917
|
/**
|
|
3918
|
+
* @public
|
|
3442
3919
|
* <p>The error message that explains why the target addition failed.</p>
|
|
3443
3920
|
*/
|
|
3444
3921
|
ErrorMessage?: string;
|
|
@@ -3448,10 +3925,12 @@ export interface PutTargetsResultEntry {
|
|
|
3448
3925
|
*/
|
|
3449
3926
|
export interface PutTargetsResponse {
|
|
3450
3927
|
/**
|
|
3928
|
+
* @public
|
|
3451
3929
|
* <p>The number of failed entries.</p>
|
|
3452
3930
|
*/
|
|
3453
3931
|
FailedEntryCount?: number;
|
|
3454
3932
|
/**
|
|
3933
|
+
* @public
|
|
3455
3934
|
* <p>The failed target entries.</p>
|
|
3456
3935
|
*/
|
|
3457
3936
|
FailedEntries?: PutTargetsResultEntry[];
|
|
@@ -3461,15 +3940,18 @@ export interface PutTargetsResponse {
|
|
|
3461
3940
|
*/
|
|
3462
3941
|
export interface RemovePermissionRequest {
|
|
3463
3942
|
/**
|
|
3943
|
+
* @public
|
|
3464
3944
|
* <p>The statement ID corresponding to the account that is no longer allowed to put events to
|
|
3465
3945
|
* the default event bus.</p>
|
|
3466
3946
|
*/
|
|
3467
3947
|
StatementId?: string;
|
|
3468
3948
|
/**
|
|
3949
|
+
* @public
|
|
3469
3950
|
* <p>Specifies whether to remove all permissions.</p>
|
|
3470
3951
|
*/
|
|
3471
3952
|
RemoveAllPermissions?: boolean;
|
|
3472
3953
|
/**
|
|
3954
|
+
* @public
|
|
3473
3955
|
* <p>The name of the event bus to revoke permissions for. If you omit this, the default event
|
|
3474
3956
|
* bus is used.</p>
|
|
3475
3957
|
*/
|
|
@@ -3480,19 +3962,23 @@ export interface RemovePermissionRequest {
|
|
|
3480
3962
|
*/
|
|
3481
3963
|
export interface RemoveTargetsRequest {
|
|
3482
3964
|
/**
|
|
3965
|
+
* @public
|
|
3483
3966
|
* <p>The name of the rule.</p>
|
|
3484
3967
|
*/
|
|
3485
3968
|
Rule: string | undefined;
|
|
3486
3969
|
/**
|
|
3970
|
+
* @public
|
|
3487
3971
|
* <p>The name or ARN of the event bus associated with the rule. If you omit this, the default
|
|
3488
3972
|
* event bus is used.</p>
|
|
3489
3973
|
*/
|
|
3490
3974
|
EventBusName?: string;
|
|
3491
3975
|
/**
|
|
3976
|
+
* @public
|
|
3492
3977
|
* <p>The IDs of the targets to remove from the rule.</p>
|
|
3493
3978
|
*/
|
|
3494
3979
|
Ids: string[] | undefined;
|
|
3495
3980
|
/**
|
|
3981
|
+
* @public
|
|
3496
3982
|
* <p>If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify
|
|
3497
3983
|
* <code>Force</code> as <code>True</code> to remove targets. This parameter is ignored for
|
|
3498
3984
|
* rules that are not managed rules. You can check whether a rule is a managed rule by using
|
|
@@ -3507,16 +3993,19 @@ export interface RemoveTargetsRequest {
|
|
|
3507
3993
|
*/
|
|
3508
3994
|
export interface RemoveTargetsResultEntry {
|
|
3509
3995
|
/**
|
|
3996
|
+
* @public
|
|
3510
3997
|
* <p>The ID of the target.</p>
|
|
3511
3998
|
*/
|
|
3512
3999
|
TargetId?: string;
|
|
3513
4000
|
/**
|
|
4001
|
+
* @public
|
|
3514
4002
|
* <p>The error code that indicates why the target removal failed. If the value is
|
|
3515
4003
|
* <code>ConcurrentModificationException</code>, too many requests were made at the same
|
|
3516
4004
|
* time.</p>
|
|
3517
4005
|
*/
|
|
3518
4006
|
ErrorCode?: string;
|
|
3519
4007
|
/**
|
|
4008
|
+
* @public
|
|
3520
4009
|
* <p>The error message that explains why the target removal failed.</p>
|
|
3521
4010
|
*/
|
|
3522
4011
|
ErrorMessage?: string;
|
|
@@ -3526,10 +4015,12 @@ export interface RemoveTargetsResultEntry {
|
|
|
3526
4015
|
*/
|
|
3527
4016
|
export interface RemoveTargetsResponse {
|
|
3528
4017
|
/**
|
|
4018
|
+
* @public
|
|
3529
4019
|
* <p>The number of failed entries.</p>
|
|
3530
4020
|
*/
|
|
3531
4021
|
FailedEntryCount?: number;
|
|
3532
4022
|
/**
|
|
4023
|
+
* @public
|
|
3533
4024
|
* <p>The failed target entries.</p>
|
|
3534
4025
|
*/
|
|
3535
4026
|
FailedEntries?: RemoveTargetsResultEntry[];
|
|
@@ -3539,28 +4030,34 @@ export interface RemoveTargetsResponse {
|
|
|
3539
4030
|
*/
|
|
3540
4031
|
export interface StartReplayRequest {
|
|
3541
4032
|
/**
|
|
4033
|
+
* @public
|
|
3542
4034
|
* <p>The name of the replay to start.</p>
|
|
3543
4035
|
*/
|
|
3544
4036
|
ReplayName: string | undefined;
|
|
3545
4037
|
/**
|
|
4038
|
+
* @public
|
|
3546
4039
|
* <p>A description for the replay to start.</p>
|
|
3547
4040
|
*/
|
|
3548
4041
|
Description?: string;
|
|
3549
4042
|
/**
|
|
4043
|
+
* @public
|
|
3550
4044
|
* <p>The ARN of the archive to replay events from.</p>
|
|
3551
4045
|
*/
|
|
3552
4046
|
EventSourceArn: string | undefined;
|
|
3553
4047
|
/**
|
|
4048
|
+
* @public
|
|
3554
4049
|
* <p>A time stamp for the time to start replaying events. Only events that occurred between the
|
|
3555
4050
|
* <code>EventStartTime</code> and <code>EventEndTime</code> are replayed.</p>
|
|
3556
4051
|
*/
|
|
3557
4052
|
EventStartTime: Date | undefined;
|
|
3558
4053
|
/**
|
|
4054
|
+
* @public
|
|
3559
4055
|
* <p>A time stamp for the time to stop replaying events. Only events that occurred between the
|
|
3560
4056
|
* <code>EventStartTime</code> and <code>EventEndTime</code> are replayed.</p>
|
|
3561
4057
|
*/
|
|
3562
4058
|
EventEndTime: Date | undefined;
|
|
3563
4059
|
/**
|
|
4060
|
+
* @public
|
|
3564
4061
|
* <p>A <code>ReplayDestination</code> object that includes details about the destination for
|
|
3565
4062
|
* the replay.</p>
|
|
3566
4063
|
*/
|
|
@@ -3571,18 +4068,22 @@ export interface StartReplayRequest {
|
|
|
3571
4068
|
*/
|
|
3572
4069
|
export interface StartReplayResponse {
|
|
3573
4070
|
/**
|
|
4071
|
+
* @public
|
|
3574
4072
|
* <p>The ARN of the replay.</p>
|
|
3575
4073
|
*/
|
|
3576
4074
|
ReplayArn?: string;
|
|
3577
4075
|
/**
|
|
4076
|
+
* @public
|
|
3578
4077
|
* <p>The state of the replay.</p>
|
|
3579
4078
|
*/
|
|
3580
4079
|
State?: ReplayState | string;
|
|
3581
4080
|
/**
|
|
4081
|
+
* @public
|
|
3582
4082
|
* <p>The reason that the replay is in the state.</p>
|
|
3583
4083
|
*/
|
|
3584
4084
|
StateReason?: string;
|
|
3585
4085
|
/**
|
|
4086
|
+
* @public
|
|
3586
4087
|
* <p>The time at which the replay started.</p>
|
|
3587
4088
|
*/
|
|
3588
4089
|
ReplayStartTime?: Date;
|
|
@@ -3592,10 +4093,12 @@ export interface StartReplayResponse {
|
|
|
3592
4093
|
*/
|
|
3593
4094
|
export interface TagResourceRequest {
|
|
3594
4095
|
/**
|
|
4096
|
+
* @public
|
|
3595
4097
|
* <p>The ARN of the EventBridge resource that you're adding tags to.</p>
|
|
3596
4098
|
*/
|
|
3597
4099
|
ResourceARN: string | undefined;
|
|
3598
4100
|
/**
|
|
4101
|
+
* @public
|
|
3599
4102
|
* <p>The list of key-value pairs to associate with the resource.</p>
|
|
3600
4103
|
*/
|
|
3601
4104
|
Tags: Tag[] | undefined;
|
|
@@ -3610,11 +4113,13 @@ export interface TagResourceResponse {
|
|
|
3610
4113
|
*/
|
|
3611
4114
|
export interface TestEventPatternRequest {
|
|
3612
4115
|
/**
|
|
4116
|
+
* @public
|
|
3613
4117
|
* <p>The event pattern. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html">Events and Event
|
|
3614
4118
|
* Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
3615
4119
|
*/
|
|
3616
4120
|
EventPattern: string | undefined;
|
|
3617
4121
|
/**
|
|
4122
|
+
* @public
|
|
3618
4123
|
* <p>The event, in JSON format, to test against the event pattern. The JSON must follow the
|
|
3619
4124
|
* format specified in <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/aws-events.html">Amazon Web Services Events</a>, and the following
|
|
3620
4125
|
* fields are mandatory:</p>
|
|
@@ -3663,6 +4168,7 @@ export interface TestEventPatternRequest {
|
|
|
3663
4168
|
*/
|
|
3664
4169
|
export interface TestEventPatternResponse {
|
|
3665
4170
|
/**
|
|
4171
|
+
* @public
|
|
3666
4172
|
* <p>Indicates whether the event matches the event pattern.</p>
|
|
3667
4173
|
*/
|
|
3668
4174
|
Result?: boolean;
|
|
@@ -3672,10 +4178,12 @@ export interface TestEventPatternResponse {
|
|
|
3672
4178
|
*/
|
|
3673
4179
|
export interface UntagResourceRequest {
|
|
3674
4180
|
/**
|
|
4181
|
+
* @public
|
|
3675
4182
|
* <p>The ARN of the EventBridge resource from which you are removing tags.</p>
|
|
3676
4183
|
*/
|
|
3677
4184
|
ResourceARN: string | undefined;
|
|
3678
4185
|
/**
|
|
4186
|
+
* @public
|
|
3679
4187
|
* <p>The list of tag keys to remove from the resource.</p>
|
|
3680
4188
|
*/
|
|
3681
4189
|
TagKeys: string[] | undefined;
|
|
@@ -3690,26 +4198,32 @@ export interface UntagResourceResponse {
|
|
|
3690
4198
|
*/
|
|
3691
4199
|
export interface UpdateApiDestinationRequest {
|
|
3692
4200
|
/**
|
|
4201
|
+
* @public
|
|
3693
4202
|
* <p>The name of the API destination to update.</p>
|
|
3694
4203
|
*/
|
|
3695
4204
|
Name: string | undefined;
|
|
3696
4205
|
/**
|
|
4206
|
+
* @public
|
|
3697
4207
|
* <p>The name of the API destination to update.</p>
|
|
3698
4208
|
*/
|
|
3699
4209
|
Description?: string;
|
|
3700
4210
|
/**
|
|
4211
|
+
* @public
|
|
3701
4212
|
* <p>The ARN of the connection to use for the API destination.</p>
|
|
3702
4213
|
*/
|
|
3703
4214
|
ConnectionArn?: string;
|
|
3704
4215
|
/**
|
|
4216
|
+
* @public
|
|
3705
4217
|
* <p>The URL to the endpoint to use for the API destination.</p>
|
|
3706
4218
|
*/
|
|
3707
4219
|
InvocationEndpoint?: string;
|
|
3708
4220
|
/**
|
|
4221
|
+
* @public
|
|
3709
4222
|
* <p>The method to use for the API destination.</p>
|
|
3710
4223
|
*/
|
|
3711
4224
|
HttpMethod?: ApiDestinationHttpMethod | string;
|
|
3712
4225
|
/**
|
|
4226
|
+
* @public
|
|
3713
4227
|
* <p>The maximum number of invocations per second to send to the API destination.</p>
|
|
3714
4228
|
*/
|
|
3715
4229
|
InvocationRateLimitPerSecond?: number;
|
|
@@ -3719,18 +4233,22 @@ export interface UpdateApiDestinationRequest {
|
|
|
3719
4233
|
*/
|
|
3720
4234
|
export interface UpdateApiDestinationResponse {
|
|
3721
4235
|
/**
|
|
4236
|
+
* @public
|
|
3722
4237
|
* <p>The ARN of the API destination that was updated.</p>
|
|
3723
4238
|
*/
|
|
3724
4239
|
ApiDestinationArn?: string;
|
|
3725
4240
|
/**
|
|
4241
|
+
* @public
|
|
3726
4242
|
* <p>The state of the API destination that was updated.</p>
|
|
3727
4243
|
*/
|
|
3728
4244
|
ApiDestinationState?: ApiDestinationState | string;
|
|
3729
4245
|
/**
|
|
4246
|
+
* @public
|
|
3730
4247
|
* <p>A time stamp for the time that the API destination was created.</p>
|
|
3731
4248
|
*/
|
|
3732
4249
|
CreationTime?: Date;
|
|
3733
4250
|
/**
|
|
4251
|
+
* @public
|
|
3734
4252
|
* <p>A time stamp for the time that the API destination was last modified.</p>
|
|
3735
4253
|
*/
|
|
3736
4254
|
LastModifiedTime?: Date;
|
|
@@ -3740,18 +4258,22 @@ export interface UpdateApiDestinationResponse {
|
|
|
3740
4258
|
*/
|
|
3741
4259
|
export interface UpdateArchiveRequest {
|
|
3742
4260
|
/**
|
|
4261
|
+
* @public
|
|
3743
4262
|
* <p>The name of the archive to update.</p>
|
|
3744
4263
|
*/
|
|
3745
4264
|
ArchiveName: string | undefined;
|
|
3746
4265
|
/**
|
|
4266
|
+
* @public
|
|
3747
4267
|
* <p>The description for the archive.</p>
|
|
3748
4268
|
*/
|
|
3749
4269
|
Description?: string;
|
|
3750
4270
|
/**
|
|
4271
|
+
* @public
|
|
3751
4272
|
* <p>The event pattern to use to filter events sent to the archive.</p>
|
|
3752
4273
|
*/
|
|
3753
4274
|
EventPattern?: string;
|
|
3754
4275
|
/**
|
|
4276
|
+
* @public
|
|
3755
4277
|
* <p>The number of days to retain events in the archive.</p>
|
|
3756
4278
|
*/
|
|
3757
4279
|
RetentionDays?: number;
|
|
@@ -3761,18 +4283,22 @@ export interface UpdateArchiveRequest {
|
|
|
3761
4283
|
*/
|
|
3762
4284
|
export interface UpdateArchiveResponse {
|
|
3763
4285
|
/**
|
|
4286
|
+
* @public
|
|
3764
4287
|
* <p>The ARN of the archive.</p>
|
|
3765
4288
|
*/
|
|
3766
4289
|
ArchiveArn?: string;
|
|
3767
4290
|
/**
|
|
4291
|
+
* @public
|
|
3768
4292
|
* <p>The state of the archive.</p>
|
|
3769
4293
|
*/
|
|
3770
4294
|
State?: ArchiveState | string;
|
|
3771
4295
|
/**
|
|
4296
|
+
* @public
|
|
3772
4297
|
* <p>The reason that the archive is in the current state.</p>
|
|
3773
4298
|
*/
|
|
3774
4299
|
StateReason?: string;
|
|
3775
4300
|
/**
|
|
4301
|
+
* @public
|
|
3776
4302
|
* <p>The time at which the archive was updated.</p>
|
|
3777
4303
|
*/
|
|
3778
4304
|
CreationTime?: Date;
|
|
@@ -3783,10 +4309,12 @@ export interface UpdateArchiveResponse {
|
|
|
3783
4309
|
*/
|
|
3784
4310
|
export interface UpdateConnectionApiKeyAuthRequestParameters {
|
|
3785
4311
|
/**
|
|
4312
|
+
* @public
|
|
3786
4313
|
* <p>The name of the API key to use for authorization.</p>
|
|
3787
4314
|
*/
|
|
3788
4315
|
ApiKeyName?: string;
|
|
3789
4316
|
/**
|
|
4317
|
+
* @public
|
|
3790
4318
|
* <p>The value associated with teh API key to use for authorization.</p>
|
|
3791
4319
|
*/
|
|
3792
4320
|
ApiKeyValue?: string;
|
|
@@ -3797,10 +4325,12 @@ export interface UpdateConnectionApiKeyAuthRequestParameters {
|
|
|
3797
4325
|
*/
|
|
3798
4326
|
export interface UpdateConnectionBasicAuthRequestParameters {
|
|
3799
4327
|
/**
|
|
4328
|
+
* @public
|
|
3800
4329
|
* <p>The user name to use for Basic authorization.</p>
|
|
3801
4330
|
*/
|
|
3802
4331
|
Username?: string;
|
|
3803
4332
|
/**
|
|
4333
|
+
* @public
|
|
3804
4334
|
* <p>The password associated with the user name to use for Basic authorization.</p>
|
|
3805
4335
|
*/
|
|
3806
4336
|
Password?: string;
|
|
@@ -3811,10 +4341,12 @@ export interface UpdateConnectionBasicAuthRequestParameters {
|
|
|
3811
4341
|
*/
|
|
3812
4342
|
export interface UpdateConnectionOAuthClientRequestParameters {
|
|
3813
4343
|
/**
|
|
4344
|
+
* @public
|
|
3814
4345
|
* <p>The client ID to use for OAuth authorization.</p>
|
|
3815
4346
|
*/
|
|
3816
4347
|
ClientID?: string;
|
|
3817
4348
|
/**
|
|
4349
|
+
* @public
|
|
3818
4350
|
* <p>The client secret assciated with the client ID to use for OAuth authorization.</p>
|
|
3819
4351
|
*/
|
|
3820
4352
|
ClientSecret?: string;
|
|
@@ -3825,21 +4357,25 @@ export interface UpdateConnectionOAuthClientRequestParameters {
|
|
|
3825
4357
|
*/
|
|
3826
4358
|
export interface UpdateConnectionOAuthRequestParameters {
|
|
3827
4359
|
/**
|
|
4360
|
+
* @public
|
|
3828
4361
|
* <p>A <code>UpdateConnectionOAuthClientRequestParameters</code> object that contains the
|
|
3829
4362
|
* client parameters to use for the connection when OAuth is specified as the authorization
|
|
3830
4363
|
* type.</p>
|
|
3831
4364
|
*/
|
|
3832
4365
|
ClientParameters?: UpdateConnectionOAuthClientRequestParameters;
|
|
3833
4366
|
/**
|
|
4367
|
+
* @public
|
|
3834
4368
|
* <p>The URL to the authorization endpoint when OAuth is specified as the authorization
|
|
3835
4369
|
* type.</p>
|
|
3836
4370
|
*/
|
|
3837
4371
|
AuthorizationEndpoint?: string;
|
|
3838
4372
|
/**
|
|
4373
|
+
* @public
|
|
3839
4374
|
* <p>The method used to connect to the HTTP endpoint.</p>
|
|
3840
4375
|
*/
|
|
3841
4376
|
HttpMethod?: ConnectionOAuthHttpMethod | string;
|
|
3842
4377
|
/**
|
|
4378
|
+
* @public
|
|
3843
4379
|
* <p>The additional HTTP parameters used for the OAuth authorization request.</p>
|
|
3844
4380
|
*/
|
|
3845
4381
|
OAuthHttpParameters?: ConnectionHttpParameters;
|
|
@@ -3850,21 +4386,25 @@ export interface UpdateConnectionOAuthRequestParameters {
|
|
|
3850
4386
|
*/
|
|
3851
4387
|
export interface UpdateConnectionAuthRequestParameters {
|
|
3852
4388
|
/**
|
|
4389
|
+
* @public
|
|
3853
4390
|
* <p>A <code>UpdateConnectionBasicAuthRequestParameters</code> object that contains the
|
|
3854
4391
|
* authorization parameters for Basic authorization.</p>
|
|
3855
4392
|
*/
|
|
3856
4393
|
BasicAuthParameters?: UpdateConnectionBasicAuthRequestParameters;
|
|
3857
4394
|
/**
|
|
4395
|
+
* @public
|
|
3858
4396
|
* <p>A <code>UpdateConnectionOAuthRequestParameters</code> object that contains the
|
|
3859
4397
|
* authorization parameters for OAuth authorization.</p>
|
|
3860
4398
|
*/
|
|
3861
4399
|
OAuthParameters?: UpdateConnectionOAuthRequestParameters;
|
|
3862
4400
|
/**
|
|
4401
|
+
* @public
|
|
3863
4402
|
* <p>A <code>UpdateConnectionApiKeyAuthRequestParameters</code> object that contains the
|
|
3864
4403
|
* authorization parameters for API key authorization.</p>
|
|
3865
4404
|
*/
|
|
3866
4405
|
ApiKeyAuthParameters?: UpdateConnectionApiKeyAuthRequestParameters;
|
|
3867
4406
|
/**
|
|
4407
|
+
* @public
|
|
3868
4408
|
* <p>A <code>ConnectionHttpParameters</code> object that contains the additional parameters to
|
|
3869
4409
|
* use for the connection.</p>
|
|
3870
4410
|
*/
|
|
@@ -3875,18 +4415,22 @@ export interface UpdateConnectionAuthRequestParameters {
|
|
|
3875
4415
|
*/
|
|
3876
4416
|
export interface UpdateConnectionRequest {
|
|
3877
4417
|
/**
|
|
4418
|
+
* @public
|
|
3878
4419
|
* <p>The name of the connection to update.</p>
|
|
3879
4420
|
*/
|
|
3880
4421
|
Name: string | undefined;
|
|
3881
4422
|
/**
|
|
4423
|
+
* @public
|
|
3882
4424
|
* <p>A description for the connection.</p>
|
|
3883
4425
|
*/
|
|
3884
4426
|
Description?: string;
|
|
3885
4427
|
/**
|
|
4428
|
+
* @public
|
|
3886
4429
|
* <p>The type of authorization to use for the connection.</p>
|
|
3887
4430
|
*/
|
|
3888
4431
|
AuthorizationType?: ConnectionAuthorizationType | string;
|
|
3889
4432
|
/**
|
|
4433
|
+
* @public
|
|
3890
4434
|
* <p>The authorization parameters to use for the connection.</p>
|
|
3891
4435
|
*/
|
|
3892
4436
|
AuthParameters?: UpdateConnectionAuthRequestParameters;
|
|
@@ -3896,22 +4440,27 @@ export interface UpdateConnectionRequest {
|
|
|
3896
4440
|
*/
|
|
3897
4441
|
export interface UpdateConnectionResponse {
|
|
3898
4442
|
/**
|
|
4443
|
+
* @public
|
|
3899
4444
|
* <p>The ARN of the connection that was updated.</p>
|
|
3900
4445
|
*/
|
|
3901
4446
|
ConnectionArn?: string;
|
|
3902
4447
|
/**
|
|
4448
|
+
* @public
|
|
3903
4449
|
* <p>The state of the connection that was updated.</p>
|
|
3904
4450
|
*/
|
|
3905
4451
|
ConnectionState?: ConnectionState | string;
|
|
3906
4452
|
/**
|
|
4453
|
+
* @public
|
|
3907
4454
|
* <p>A time stamp for the time that the connection was created.</p>
|
|
3908
4455
|
*/
|
|
3909
4456
|
CreationTime?: Date;
|
|
3910
4457
|
/**
|
|
4458
|
+
* @public
|
|
3911
4459
|
* <p>A time stamp for the time that the connection was last modified.</p>
|
|
3912
4460
|
*/
|
|
3913
4461
|
LastModifiedTime?: Date;
|
|
3914
4462
|
/**
|
|
4463
|
+
* @public
|
|
3915
4464
|
* <p>A time stamp for the time that the connection was last authorized.</p>
|
|
3916
4465
|
*/
|
|
3917
4466
|
LastAuthorizedTime?: Date;
|
|
@@ -3921,26 +4470,32 @@ export interface UpdateConnectionResponse {
|
|
|
3921
4470
|
*/
|
|
3922
4471
|
export interface UpdateEndpointRequest {
|
|
3923
4472
|
/**
|
|
4473
|
+
* @public
|
|
3924
4474
|
* <p>The name of the endpoint you want to update.</p>
|
|
3925
4475
|
*/
|
|
3926
4476
|
Name: string | undefined;
|
|
3927
4477
|
/**
|
|
4478
|
+
* @public
|
|
3928
4479
|
* <p>A description for the endpoint.</p>
|
|
3929
4480
|
*/
|
|
3930
4481
|
Description?: string;
|
|
3931
4482
|
/**
|
|
4483
|
+
* @public
|
|
3932
4484
|
* <p>Configure the routing policy, including the health check and secondary Region.</p>
|
|
3933
4485
|
*/
|
|
3934
4486
|
RoutingConfig?: RoutingConfig;
|
|
3935
4487
|
/**
|
|
4488
|
+
* @public
|
|
3936
4489
|
* <p>Whether event replication was enabled or disabled by this request.</p>
|
|
3937
4490
|
*/
|
|
3938
4491
|
ReplicationConfig?: ReplicationConfig;
|
|
3939
4492
|
/**
|
|
4493
|
+
* @public
|
|
3940
4494
|
* <p>Define event buses used for replication.</p>
|
|
3941
4495
|
*/
|
|
3942
4496
|
EventBuses?: EndpointEventBus[];
|
|
3943
4497
|
/**
|
|
4498
|
+
* @public
|
|
3944
4499
|
* <p>The ARN of the role used by event replication for this request.</p>
|
|
3945
4500
|
*/
|
|
3946
4501
|
RoleArn?: string;
|
|
@@ -3950,38 +4505,47 @@ export interface UpdateEndpointRequest {
|
|
|
3950
4505
|
*/
|
|
3951
4506
|
export interface UpdateEndpointResponse {
|
|
3952
4507
|
/**
|
|
4508
|
+
* @public
|
|
3953
4509
|
* <p>The name of the endpoint you updated in this request.</p>
|
|
3954
4510
|
*/
|
|
3955
4511
|
Name?: string;
|
|
3956
4512
|
/**
|
|
4513
|
+
* @public
|
|
3957
4514
|
* <p>The ARN of the endpoint you updated in this request.</p>
|
|
3958
4515
|
*/
|
|
3959
4516
|
Arn?: string;
|
|
3960
4517
|
/**
|
|
4518
|
+
* @public
|
|
3961
4519
|
* <p>The routing configuration you updated in this request.</p>
|
|
3962
4520
|
*/
|
|
3963
4521
|
RoutingConfig?: RoutingConfig;
|
|
3964
4522
|
/**
|
|
4523
|
+
* @public
|
|
3965
4524
|
* <p>Whether event replication was enabled or disabled for the endpoint you updated in this request.</p>
|
|
3966
4525
|
*/
|
|
3967
4526
|
ReplicationConfig?: ReplicationConfig;
|
|
3968
4527
|
/**
|
|
4528
|
+
* @public
|
|
3969
4529
|
* <p>The event buses used for replication for the endpoint you updated in this request.</p>
|
|
3970
4530
|
*/
|
|
3971
4531
|
EventBuses?: EndpointEventBus[];
|
|
3972
4532
|
/**
|
|
4533
|
+
* @public
|
|
3973
4534
|
* <p>The ARN of the role used by event replication for the endpoint you updated in this request.</p>
|
|
3974
4535
|
*/
|
|
3975
4536
|
RoleArn?: string;
|
|
3976
4537
|
/**
|
|
4538
|
+
* @public
|
|
3977
4539
|
* <p>The ID of the endpoint you updated in this request.</p>
|
|
3978
4540
|
*/
|
|
3979
4541
|
EndpointId?: string;
|
|
3980
4542
|
/**
|
|
4543
|
+
* @public
|
|
3981
4544
|
* <p>The URL of the endpoint you updated in this request.</p>
|
|
3982
4545
|
*/
|
|
3983
4546
|
EndpointUrl?: string;
|
|
3984
4547
|
/**
|
|
4548
|
+
* @public
|
|
3985
4549
|
* <p>The state of the endpoint you updated in this request.</p>
|
|
3986
4550
|
*/
|
|
3987
4551
|
State?: EndpointState | string;
|