@aws-sdk/client-cloudwatch-events 3.295.0 → 3.297.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.
Files changed (56) hide show
  1. package/dist-types/CloudWatchEvents.d.ts +52 -0
  2. package/dist-types/CloudWatchEventsClient.d.ts +24 -4
  3. package/dist-types/commands/ActivateEventSourceCommand.d.ts +16 -0
  4. package/dist-types/commands/CancelReplayCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateApiDestinationCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateArchiveCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateConnectionCommand.d.ts +16 -0
  8. package/dist-types/commands/CreateEventBusCommand.d.ts +16 -0
  9. package/dist-types/commands/CreatePartnerEventSourceCommand.d.ts +16 -0
  10. package/dist-types/commands/DeactivateEventSourceCommand.d.ts +16 -0
  11. package/dist-types/commands/DeauthorizeConnectionCommand.d.ts +16 -0
  12. package/dist-types/commands/DeleteApiDestinationCommand.d.ts +16 -0
  13. package/dist-types/commands/DeleteArchiveCommand.d.ts +16 -0
  14. package/dist-types/commands/DeleteConnectionCommand.d.ts +16 -0
  15. package/dist-types/commands/DeleteEventBusCommand.d.ts +16 -0
  16. package/dist-types/commands/DeletePartnerEventSourceCommand.d.ts +16 -0
  17. package/dist-types/commands/DeleteRuleCommand.d.ts +16 -0
  18. package/dist-types/commands/DescribeApiDestinationCommand.d.ts +16 -0
  19. package/dist-types/commands/DescribeArchiveCommand.d.ts +16 -0
  20. package/dist-types/commands/DescribeConnectionCommand.d.ts +16 -0
  21. package/dist-types/commands/DescribeEventBusCommand.d.ts +16 -0
  22. package/dist-types/commands/DescribeEventSourceCommand.d.ts +16 -0
  23. package/dist-types/commands/DescribePartnerEventSourceCommand.d.ts +16 -0
  24. package/dist-types/commands/DescribeReplayCommand.d.ts +16 -0
  25. package/dist-types/commands/DescribeRuleCommand.d.ts +16 -0
  26. package/dist-types/commands/DisableRuleCommand.d.ts +16 -0
  27. package/dist-types/commands/EnableRuleCommand.d.ts +16 -0
  28. package/dist-types/commands/ListApiDestinationsCommand.d.ts +16 -0
  29. package/dist-types/commands/ListArchivesCommand.d.ts +16 -0
  30. package/dist-types/commands/ListConnectionsCommand.d.ts +16 -0
  31. package/dist-types/commands/ListEventBusesCommand.d.ts +16 -0
  32. package/dist-types/commands/ListEventSourcesCommand.d.ts +16 -0
  33. package/dist-types/commands/ListPartnerEventSourceAccountsCommand.d.ts +16 -0
  34. package/dist-types/commands/ListPartnerEventSourcesCommand.d.ts +16 -0
  35. package/dist-types/commands/ListReplaysCommand.d.ts +16 -0
  36. package/dist-types/commands/ListRuleNamesByTargetCommand.d.ts +16 -0
  37. package/dist-types/commands/ListRulesCommand.d.ts +16 -0
  38. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  39. package/dist-types/commands/ListTargetsByRuleCommand.d.ts +16 -0
  40. package/dist-types/commands/PutEventsCommand.d.ts +16 -0
  41. package/dist-types/commands/PutPartnerEventsCommand.d.ts +16 -0
  42. package/dist-types/commands/PutPermissionCommand.d.ts +16 -0
  43. package/dist-types/commands/PutRuleCommand.d.ts +16 -0
  44. package/dist-types/commands/PutTargetsCommand.d.ts +16 -0
  45. package/dist-types/commands/RemovePermissionCommand.d.ts +16 -0
  46. package/dist-types/commands/RemoveTargetsCommand.d.ts +16 -0
  47. package/dist-types/commands/StartReplayCommand.d.ts +16 -0
  48. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  49. package/dist-types/commands/TestEventPatternCommand.d.ts +16 -0
  50. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  51. package/dist-types/commands/UpdateApiDestinationCommand.d.ts +16 -0
  52. package/dist-types/commands/UpdateArchiveCommand.d.ts +16 -0
  53. package/dist-types/commands/UpdateConnectionCommand.d.ts +16 -0
  54. package/dist-types/models/CloudWatchEventsServiceException.d.ts +2 -0
  55. package/dist-types/models/models_0.d.ts +406 -16
  56. package/package.json +29 -29
@@ -1,5 +1,8 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { CloudWatchEventsServiceException as __BaseException } from "./CloudWatchEventsServiceException";
3
+ /**
4
+ * @public
5
+ */
3
6
  export interface ActivateEventSourceRequest {
4
7
  /**
5
8
  * <p>The name of the partner event source to activate.</p>
@@ -7,6 +10,7 @@ export interface ActivateEventSourceRequest {
7
10
  Name: string | undefined;
8
11
  }
9
12
  /**
13
+ * @public
10
14
  * <p>There is concurrent modification on a rule, target, archive, or replay.</p>
11
15
  */
12
16
  export declare class ConcurrentModificationException extends __BaseException {
@@ -18,6 +22,7 @@ export declare class ConcurrentModificationException extends __BaseException {
18
22
  constructor(opts: __ExceptionOptionType<ConcurrentModificationException, __BaseException>);
19
23
  }
20
24
  /**
25
+ * @public
21
26
  * <p>This exception occurs due to unexpected causes.</p>
22
27
  */
23
28
  export declare class InternalException extends __BaseException {
@@ -29,6 +34,7 @@ export declare class InternalException extends __BaseException {
29
34
  constructor(opts: __ExceptionOptionType<InternalException, __BaseException>);
30
35
  }
31
36
  /**
37
+ * @public
32
38
  * <p>The specified state is not a valid state for an event source.</p>
33
39
  */
34
40
  export declare class InvalidStateException extends __BaseException {
@@ -40,6 +46,7 @@ export declare class InvalidStateException extends __BaseException {
40
46
  constructor(opts: __ExceptionOptionType<InvalidStateException, __BaseException>);
41
47
  }
42
48
  /**
49
+ * @public
43
50
  * <p>The operation you are attempting is not available in this region.</p>
44
51
  */
45
52
  export declare class OperationDisabledException extends __BaseException {
@@ -51,6 +58,7 @@ export declare class OperationDisabledException extends __BaseException {
51
58
  constructor(opts: __ExceptionOptionType<OperationDisabledException, __BaseException>);
52
59
  }
53
60
  /**
61
+ * @public
54
62
  * <p>An entity that you specified does not exist.</p>
55
63
  */
56
64
  export declare class ResourceNotFoundException extends __BaseException {
@@ -61,10 +69,16 @@ export declare class ResourceNotFoundException extends __BaseException {
61
69
  */
62
70
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
63
71
  }
72
+ /**
73
+ * @public
74
+ */
64
75
  export declare enum ApiDestinationState {
65
76
  ACTIVE = "ACTIVE",
66
77
  INACTIVE = "INACTIVE"
67
78
  }
79
+ /**
80
+ * @public
81
+ */
68
82
  export declare enum ApiDestinationHttpMethod {
69
83
  DELETE = "DELETE",
70
84
  GET = "GET",
@@ -75,6 +89,7 @@ export declare enum ApiDestinationHttpMethod {
75
89
  PUT = "PUT"
76
90
  }
77
91
  /**
92
+ * @public
78
93
  * <p>Contains details about an API destination.</p>
79
94
  */
80
95
  export interface ApiDestination {
@@ -115,6 +130,9 @@ export interface ApiDestination {
115
130
  */
116
131
  LastModifiedTime?: Date;
117
132
  }
133
+ /**
134
+ * @public
135
+ */
118
136
  export declare enum ArchiveState {
119
137
  CREATE_FAILED = "CREATE_FAILED",
120
138
  CREATING = "CREATING",
@@ -124,6 +142,7 @@ export declare enum ArchiveState {
124
142
  UPDATING = "UPDATING"
125
143
  }
126
144
  /**
145
+ * @public
127
146
  * <p>An <code>Archive</code> object that contains details about an archive.</p>
128
147
  */
129
148
  export interface Archive {
@@ -161,16 +180,25 @@ export interface Archive {
161
180
  */
162
181
  CreationTime?: Date;
163
182
  }
183
+ /**
184
+ * @public
185
+ */
164
186
  export declare enum AssignPublicIp {
165
187
  DISABLED = "DISABLED",
166
188
  ENABLED = "ENABLED"
167
189
  }
190
+ /**
191
+ * @public
192
+ */
168
193
  export interface CancelReplayRequest {
169
194
  /**
170
195
  * <p>The name of the replay to cancel.</p>
171
196
  */
172
197
  ReplayName: string | undefined;
173
198
  }
199
+ /**
200
+ * @public
201
+ */
174
202
  export declare enum ReplayState {
175
203
  CANCELLED = "CANCELLED",
176
204
  CANCELLING = "CANCELLING",
@@ -179,6 +207,9 @@ export declare enum ReplayState {
179
207
  RUNNING = "RUNNING",
180
208
  STARTING = "STARTING"
181
209
  }
210
+ /**
211
+ * @public
212
+ */
182
213
  export interface CancelReplayResponse {
183
214
  /**
184
215
  * <p>The ARN of the replay to cancel.</p>
@@ -194,6 +225,7 @@ export interface CancelReplayResponse {
194
225
  StateReason?: string;
195
226
  }
196
227
  /**
228
+ * @public
197
229
  * <p>An error occurred because a replay can be canceled only when the state is Running or
198
230
  * Starting.</p>
199
231
  */
@@ -205,6 +237,9 @@ export declare class IllegalStatusException extends __BaseException {
205
237
  */
206
238
  constructor(opts: __ExceptionOptionType<IllegalStatusException, __BaseException>);
207
239
  }
240
+ /**
241
+ * @public
242
+ */
208
243
  export interface CreateApiDestinationRequest {
209
244
  /**
210
245
  * <p>The name for the API destination to create.</p>
@@ -232,6 +267,9 @@ export interface CreateApiDestinationRequest {
232
267
  */
233
268
  InvocationRateLimitPerSecond?: number;
234
269
  }
270
+ /**
271
+ * @public
272
+ */
235
273
  export interface CreateApiDestinationResponse {
236
274
  /**
237
275
  * <p>The ARN of the API destination that was created by the request.</p>
@@ -251,6 +289,7 @@ export interface CreateApiDestinationResponse {
251
289
  LastModifiedTime?: Date;
252
290
  }
253
291
  /**
292
+ * @public
254
293
  * <p>The request failed because it attempted to create resource beyond the allowed service
255
294
  * quota.</p>
256
295
  */
@@ -263,6 +302,7 @@ export declare class LimitExceededException extends __BaseException {
263
302
  constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
264
303
  }
265
304
  /**
305
+ * @public
266
306
  * <p>The resource you are trying to create already exists.</p>
267
307
  */
268
308
  export declare class ResourceAlreadyExistsException extends __BaseException {
@@ -273,6 +313,9 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
273
313
  */
274
314
  constructor(opts: __ExceptionOptionType<ResourceAlreadyExistsException, __BaseException>);
275
315
  }
316
+ /**
317
+ * @public
318
+ */
276
319
  export interface CreateArchiveRequest {
277
320
  /**
278
321
  * <p>The name for the archive to create.</p>
@@ -296,6 +339,9 @@ export interface CreateArchiveRequest {
296
339
  */
297
340
  RetentionDays?: number;
298
341
  }
342
+ /**
343
+ * @public
344
+ */
299
345
  export interface CreateArchiveResponse {
300
346
  /**
301
347
  * <p>The ARN of the archive that was created.</p>
@@ -315,6 +361,7 @@ export interface CreateArchiveResponse {
315
361
  CreationTime?: Date;
316
362
  }
317
363
  /**
364
+ * @public
318
365
  * <p>The event pattern is not valid.</p>
319
366
  */
320
367
  export declare class InvalidEventPatternException extends __BaseException {
@@ -325,12 +372,16 @@ export declare class InvalidEventPatternException extends __BaseException {
325
372
  */
326
373
  constructor(opts: __ExceptionOptionType<InvalidEventPatternException, __BaseException>);
327
374
  }
375
+ /**
376
+ * @public
377
+ */
328
378
  export declare enum ConnectionAuthorizationType {
329
379
  API_KEY = "API_KEY",
330
380
  BASIC = "BASIC",
331
381
  OAUTH_CLIENT_CREDENTIALS = "OAUTH_CLIENT_CREDENTIALS"
332
382
  }
333
383
  /**
384
+ * @public
334
385
  * <p>Contains the API key authorization parameters for the connection.</p>
335
386
  */
336
387
  export interface CreateConnectionApiKeyAuthRequestParameters {
@@ -344,6 +395,7 @@ export interface CreateConnectionApiKeyAuthRequestParameters {
344
395
  ApiKeyValue: string | undefined;
345
396
  }
346
397
  /**
398
+ * @public
347
399
  * <p>Contains the Basic authorization parameters to use for the connection.</p>
348
400
  */
349
401
  export interface CreateConnectionBasicAuthRequestParameters {
@@ -357,6 +409,7 @@ export interface CreateConnectionBasicAuthRequestParameters {
357
409
  Password: string | undefined;
358
410
  }
359
411
  /**
412
+ * @public
360
413
  * <p>Additional parameter included in the body. You can include up to 100 additional body
361
414
  * parameters per request. An event payload cannot exceed 64 KB.</p>
362
415
  */
@@ -375,6 +428,7 @@ export interface ConnectionBodyParameter {
375
428
  IsValueSecret?: boolean;
376
429
  }
377
430
  /**
431
+ * @public
378
432
  * <p>Additional parameter included in the header. You can include up to 100 additional header
379
433
  * parameters per request. An event payload cannot exceed 64 KB.</p>
380
434
  */
@@ -393,6 +447,7 @@ export interface ConnectionHeaderParameter {
393
447
  IsValueSecret?: boolean;
394
448
  }
395
449
  /**
450
+ * @public
396
451
  * <p>Additional query string parameter for the connection. You can include up to 100 additional
397
452
  * query string parameters per request. Each additional parameter counts towards the event
398
453
  * payload size, which cannot exceed 64 KB.</p>
@@ -412,6 +467,7 @@ export interface ConnectionQueryStringParameter {
412
467
  IsValueSecret?: boolean;
413
468
  }
414
469
  /**
470
+ * @public
415
471
  * <p>Contains additional parameters for the connection.</p>
416
472
  */
417
473
  export interface ConnectionHttpParameters {
@@ -429,6 +485,7 @@ export interface ConnectionHttpParameters {
429
485
  BodyParameters?: ConnectionBodyParameter[];
430
486
  }
431
487
  /**
488
+ * @public
432
489
  * <p>Contains the Basic authorization parameters to use for the connection.</p>
433
490
  */
434
491
  export interface CreateConnectionOAuthClientRequestParameters {
@@ -442,12 +499,16 @@ export interface CreateConnectionOAuthClientRequestParameters {
442
499
  */
443
500
  ClientSecret: string | undefined;
444
501
  }
502
+ /**
503
+ * @public
504
+ */
445
505
  export declare enum ConnectionOAuthHttpMethod {
446
506
  GET = "GET",
447
507
  POST = "POST",
448
508
  PUT = "PUT"
449
509
  }
450
510
  /**
511
+ * @public
451
512
  * <p>Contains the OAuth authorization parameters to use for the connection.</p>
452
513
  */
453
514
  export interface CreateConnectionOAuthRequestParameters {
@@ -472,6 +533,7 @@ export interface CreateConnectionOAuthRequestParameters {
472
533
  OAuthHttpParameters?: ConnectionHttpParameters;
473
534
  }
474
535
  /**
536
+ * @public
475
537
  * <p>Contains the authorization parameters for the connection.</p>
476
538
  */
477
539
  export interface CreateConnectionAuthRequestParameters {
@@ -498,6 +560,9 @@ export interface CreateConnectionAuthRequestParameters {
498
560
  */
499
561
  InvocationHttpParameters?: ConnectionHttpParameters;
500
562
  }
563
+ /**
564
+ * @public
565
+ */
501
566
  export interface CreateConnectionRequest {
502
567
  /**
503
568
  * <p>The name for the connection to create.</p>
@@ -517,6 +582,9 @@ export interface CreateConnectionRequest {
517
582
  */
518
583
  AuthParameters: CreateConnectionAuthRequestParameters | undefined;
519
584
  }
585
+ /**
586
+ * @public
587
+ */
520
588
  export declare enum ConnectionState {
521
589
  AUTHORIZED = "AUTHORIZED",
522
590
  AUTHORIZING = "AUTHORIZING",
@@ -526,6 +594,9 @@ export declare enum ConnectionState {
526
594
  DELETING = "DELETING",
527
595
  UPDATING = "UPDATING"
528
596
  }
597
+ /**
598
+ * @public
599
+ */
529
600
  export interface CreateConnectionResponse {
530
601
  /**
531
602
  * <p>The ARN of the connection that was created by the request.</p>
@@ -545,6 +616,7 @@ export interface CreateConnectionResponse {
545
616
  LastModifiedTime?: Date;
546
617
  }
547
618
  /**
619
+ * @public
548
620
  * <p>A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses
549
621
  * support tagging.</p>
550
622
  */
@@ -559,6 +631,9 @@ export interface Tag {
559
631
  */
560
632
  Value: string | undefined;
561
633
  }
634
+ /**
635
+ * @public
636
+ */
562
637
  export interface CreateEventBusRequest {
563
638
  /**
564
639
  * <p>The name of the new event bus. </p>
@@ -579,12 +654,18 @@ export interface CreateEventBusRequest {
579
654
  */
580
655
  Tags?: Tag[];
581
656
  }
657
+ /**
658
+ * @public
659
+ */
582
660
  export interface CreateEventBusResponse {
583
661
  /**
584
662
  * <p>The ARN of the new event bus.</p>
585
663
  */
586
664
  EventBusArn?: string;
587
665
  }
666
+ /**
667
+ * @public
668
+ */
588
669
  export interface CreatePartnerEventSourceRequest {
589
670
  /**
590
671
  * <p>The name of the partner event source. This name must be unique and must be in the format
@@ -601,24 +682,36 @@ export interface CreatePartnerEventSourceRequest {
601
682
  */
602
683
  Account: string | undefined;
603
684
  }
685
+ /**
686
+ * @public
687
+ */
604
688
  export interface CreatePartnerEventSourceResponse {
605
689
  /**
606
690
  * <p>The ARN of the partner event source.</p>
607
691
  */
608
692
  EventSourceArn?: string;
609
693
  }
694
+ /**
695
+ * @public
696
+ */
610
697
  export interface DeactivateEventSourceRequest {
611
698
  /**
612
699
  * <p>The name of the partner event source to deactivate.</p>
613
700
  */
614
701
  Name: string | undefined;
615
702
  }
703
+ /**
704
+ * @public
705
+ */
616
706
  export interface DeauthorizeConnectionRequest {
617
707
  /**
618
708
  * <p>The name of the connection to remove authorization from.</p>
619
709
  */
620
710
  Name: string | undefined;
621
711
  }
712
+ /**
713
+ * @public
714
+ */
622
715
  export interface DeauthorizeConnectionResponse {
623
716
  /**
624
717
  * <p>The ARN of the connection that authorization was removed from.</p>
@@ -641,28 +734,46 @@ export interface DeauthorizeConnectionResponse {
641
734
  */
642
735
  LastAuthorizedTime?: Date;
643
736
  }
737
+ /**
738
+ * @public
739
+ */
644
740
  export interface DeleteApiDestinationRequest {
645
741
  /**
646
742
  * <p>The name of the destination to delete.</p>
647
743
  */
648
744
  Name: string | undefined;
649
745
  }
746
+ /**
747
+ * @public
748
+ */
650
749
  export interface DeleteApiDestinationResponse {
651
750
  }
751
+ /**
752
+ * @public
753
+ */
652
754
  export interface DeleteArchiveRequest {
653
755
  /**
654
756
  * <p>The name of the archive to delete.</p>
655
757
  */
656
758
  ArchiveName: string | undefined;
657
759
  }
760
+ /**
761
+ * @public
762
+ */
658
763
  export interface DeleteArchiveResponse {
659
764
  }
765
+ /**
766
+ * @public
767
+ */
660
768
  export interface DeleteConnectionRequest {
661
769
  /**
662
770
  * <p>The name of the connection to delete.</p>
663
771
  */
664
772
  Name: string | undefined;
665
773
  }
774
+ /**
775
+ * @public
776
+ */
666
777
  export interface DeleteConnectionResponse {
667
778
  /**
668
779
  * <p>The ARN of the connection that was deleted.</p>
@@ -687,12 +798,18 @@ export interface DeleteConnectionResponse {
687
798
  */
688
799
  LastAuthorizedTime?: Date;
689
800
  }
801
+ /**
802
+ * @public
803
+ */
690
804
  export interface DeleteEventBusRequest {
691
805
  /**
692
806
  * <p>The name of the event bus to delete.</p>
693
807
  */
694
808
  Name: string | undefined;
695
809
  }
810
+ /**
811
+ * @public
812
+ */
696
813
  export interface DeletePartnerEventSourceRequest {
697
814
  /**
698
815
  * <p>The name of the event source to delete.</p>
@@ -703,6 +820,9 @@ export interface DeletePartnerEventSourceRequest {
703
820
  */
704
821
  Account: string | undefined;
705
822
  }
823
+ /**
824
+ * @public
825
+ */
706
826
  export interface DeleteRuleRequest {
707
827
  /**
708
828
  * <p>The name of the rule.</p>
@@ -723,6 +843,7 @@ export interface DeleteRuleRequest {
723
843
  Force?: boolean;
724
844
  }
725
845
  /**
846
+ * @public
726
847
  * <p>This rule was created by an Amazon Web Services service on behalf of your account. It is managed by that
727
848
  * service. If you see this error in response to <code>DeleteRule</code> or
728
849
  * <code>RemoveTargets</code>, you can use the <code>Force</code> parameter in those calls to
@@ -738,12 +859,18 @@ export declare class ManagedRuleException extends __BaseException {
738
859
  */
739
860
  constructor(opts: __ExceptionOptionType<ManagedRuleException, __BaseException>);
740
861
  }
862
+ /**
863
+ * @public
864
+ */
741
865
  export interface DescribeApiDestinationRequest {
742
866
  /**
743
867
  * <p>The name of the API destination to retrieve.</p>
744
868
  */
745
869
  Name: string | undefined;
746
870
  }
871
+ /**
872
+ * @public
873
+ */
747
874
  export interface DescribeApiDestinationResponse {
748
875
  /**
749
876
  * <p>The ARN of the API destination retrieved.</p>
@@ -791,12 +918,18 @@ export interface DescribeApiDestinationResponse {
791
918
  */
792
919
  LastModifiedTime?: Date;
793
920
  }
921
+ /**
922
+ * @public
923
+ */
794
924
  export interface DescribeArchiveRequest {
795
925
  /**
796
926
  * <p>The name of the archive to retrieve.</p>
797
927
  */
798
928
  ArchiveName: string | undefined;
799
929
  }
930
+ /**
931
+ * @public
932
+ */
800
933
  export interface DescribeArchiveResponse {
801
934
  /**
802
935
  * <p>The ARN of the archive.</p>
@@ -843,6 +976,9 @@ export interface DescribeArchiveResponse {
843
976
  */
844
977
  CreationTime?: Date;
845
978
  }
979
+ /**
980
+ * @public
981
+ */
846
982
  export interface DescribeConnectionRequest {
847
983
  /**
848
984
  * <p>The name of the connection to retrieve.</p>
@@ -850,6 +986,7 @@ export interface DescribeConnectionRequest {
850
986
  Name: string | undefined;
851
987
  }
852
988
  /**
989
+ * @public
853
990
  * <p>Contains the authorization parameters for the connection if API Key is specified as the
854
991
  * authorization type.</p>
855
992
  */
@@ -861,6 +998,7 @@ export interface ConnectionApiKeyAuthResponseParameters {
861
998
  ApiKeyName?: string;
862
999
  }
863
1000
  /**
1001
+ * @public
864
1002
  * <p>Contains the authorization parameters for the connection if Basic is specified as the
865
1003
  * authorization type.</p>
866
1004
  */
@@ -871,6 +1009,7 @@ export interface ConnectionBasicAuthResponseParameters {
871
1009
  Username?: string;
872
1010
  }
873
1011
  /**
1012
+ * @public
874
1013
  * <p>Contains the client response parameters for the connection when OAuth is specified as the
875
1014
  * authorization type.</p>
876
1015
  */
@@ -881,6 +1020,7 @@ export interface ConnectionOAuthClientResponseParameters {
881
1020
  ClientID?: string;
882
1021
  }
883
1022
  /**
1023
+ * @public
884
1024
  * <p>Contains the response parameters when OAuth is specified as the authorization type.</p>
885
1025
  */
886
1026
  export interface ConnectionOAuthResponseParameters {
@@ -903,6 +1043,7 @@ export interface ConnectionOAuthResponseParameters {
903
1043
  OAuthHttpParameters?: ConnectionHttpParameters;
904
1044
  }
905
1045
  /**
1046
+ * @public
906
1047
  * <p>Contains the authorization parameters to use for the connection.</p>
907
1048
  */
908
1049
  export interface ConnectionAuthResponseParameters {
@@ -924,6 +1065,9 @@ export interface ConnectionAuthResponseParameters {
924
1065
  */
925
1066
  InvocationHttpParameters?: ConnectionHttpParameters;
926
1067
  }
1068
+ /**
1069
+ * @public
1070
+ */
927
1071
  export interface DescribeConnectionResponse {
928
1072
  /**
929
1073
  * <p>The ARN of the connection retrieved.</p>
@@ -971,6 +1115,9 @@ export interface DescribeConnectionResponse {
971
1115
  */
972
1116
  LastAuthorizedTime?: Date;
973
1117
  }
1118
+ /**
1119
+ * @public
1120
+ */
974
1121
  export interface DescribeEventBusRequest {
975
1122
  /**
976
1123
  * <p>The name or ARN of the event bus to show details for. If you omit this, the default event
@@ -978,6 +1125,9 @@ export interface DescribeEventBusRequest {
978
1125
  */
979
1126
  Name?: string;
980
1127
  }
1128
+ /**
1129
+ * @public
1130
+ */
981
1131
  export interface DescribeEventBusResponse {
982
1132
  /**
983
1133
  * <p>The name of the event bus. Currently, this is always <code>default</code>.</p>
@@ -993,17 +1143,26 @@ export interface DescribeEventBusResponse {
993
1143
  */
994
1144
  Policy?: string;
995
1145
  }
1146
+ /**
1147
+ * @public
1148
+ */
996
1149
  export interface DescribeEventSourceRequest {
997
1150
  /**
998
1151
  * <p>The name of the partner event source to display the details of.</p>
999
1152
  */
1000
1153
  Name: string | undefined;
1001
1154
  }
1155
+ /**
1156
+ * @public
1157
+ */
1002
1158
  export declare enum EventSourceState {
1003
1159
  ACTIVE = "ACTIVE",
1004
1160
  DELETED = "DELETED",
1005
1161
  PENDING = "PENDING"
1006
1162
  }
1163
+ /**
1164
+ * @public
1165
+ */
1007
1166
  export interface DescribeEventSourceResponse {
1008
1167
  /**
1009
1168
  * <p>The ARN of the partner event source.</p>
@@ -1034,12 +1193,18 @@ export interface DescribeEventSourceResponse {
1034
1193
  */
1035
1194
  State?: EventSourceState | string;
1036
1195
  }
1196
+ /**
1197
+ * @public
1198
+ */
1037
1199
  export interface DescribePartnerEventSourceRequest {
1038
1200
  /**
1039
1201
  * <p>The name of the event source to display.</p>
1040
1202
  */
1041
1203
  Name: string | undefined;
1042
1204
  }
1205
+ /**
1206
+ * @public
1207
+ */
1043
1208
  export interface DescribePartnerEventSourceResponse {
1044
1209
  /**
1045
1210
  * <p>The ARN of the event source.</p>
@@ -1050,6 +1215,9 @@ export interface DescribePartnerEventSourceResponse {
1050
1215
  */
1051
1216
  Name?: string;
1052
1217
  }
1218
+ /**
1219
+ * @public
1220
+ */
1053
1221
  export interface DescribeReplayRequest {
1054
1222
  /**
1055
1223
  * <p>The name of the replay to retrieve.</p>
@@ -1057,6 +1225,7 @@ export interface DescribeReplayRequest {
1057
1225
  ReplayName: string | undefined;
1058
1226
  }
1059
1227
  /**
1228
+ * @public
1060
1229
  * <p>A <code>ReplayDestination</code> object that contains details about a replay.</p>
1061
1230
  */
1062
1231
  export interface ReplayDestination {
@@ -1070,6 +1239,9 @@ export interface ReplayDestination {
1070
1239
  */
1071
1240
  FilterArns?: string[];
1072
1241
  }
1242
+ /**
1243
+ * @public
1244
+ */
1073
1245
  export interface DescribeReplayResponse {
1074
1246
  /**
1075
1247
  * <p>The name of the replay.</p>
@@ -1120,6 +1292,9 @@ export interface DescribeReplayResponse {
1120
1292
  */
1121
1293
  ReplayEndTime?: Date;
1122
1294
  }
1295
+ /**
1296
+ * @public
1297
+ */
1123
1298
  export interface DescribeRuleRequest {
1124
1299
  /**
1125
1300
  * <p>The name of the rule.</p>
@@ -1131,10 +1306,16 @@ export interface DescribeRuleRequest {
1131
1306
  */
1132
1307
  EventBusName?: string;
1133
1308
  }
1309
+ /**
1310
+ * @public
1311
+ */
1134
1312
  export declare enum RuleState {
1135
1313
  DISABLED = "DISABLED",
1136
1314
  ENABLED = "ENABLED"
1137
1315
  }
1316
+ /**
1317
+ * @public
1318
+ */
1138
1319
  export interface DescribeRuleResponse {
1139
1320
  /**
1140
1321
  * <p>The name of the rule.</p>
@@ -1183,6 +1364,9 @@ export interface DescribeRuleResponse {
1183
1364
  */
1184
1365
  CreatedBy?: string;
1185
1366
  }
1367
+ /**
1368
+ * @public
1369
+ */
1186
1370
  export interface DisableRuleRequest {
1187
1371
  /**
1188
1372
  * <p>The name of the rule.</p>
@@ -1194,6 +1378,9 @@ export interface DisableRuleRequest {
1194
1378
  */
1195
1379
  EventBusName?: string;
1196
1380
  }
1381
+ /**
1382
+ * @public
1383
+ */
1197
1384
  export interface EnableRuleRequest {
1198
1385
  /**
1199
1386
  * <p>The name of the rule.</p>
@@ -1205,6 +1392,9 @@ export interface EnableRuleRequest {
1205
1392
  */
1206
1393
  EventBusName?: string;
1207
1394
  }
1395
+ /**
1396
+ * @public
1397
+ */
1208
1398
  export interface ListApiDestinationsRequest {
1209
1399
  /**
1210
1400
  * <p>A name prefix to filter results returned. Only API destinations with a name that starts
@@ -1224,6 +1414,9 @@ export interface ListApiDestinationsRequest {
1224
1414
  */
1225
1415
  Limit?: number;
1226
1416
  }
1417
+ /**
1418
+ * @public
1419
+ */
1227
1420
  export interface ListApiDestinationsResponse {
1228
1421
  /**
1229
1422
  * <p>An array of <code>ApiDestination</code> objects that include information about an API
@@ -1235,6 +1428,9 @@ export interface ListApiDestinationsResponse {
1235
1428
  */
1236
1429
  NextToken?: string;
1237
1430
  }
1431
+ /**
1432
+ * @public
1433
+ */
1238
1434
  export interface ListArchivesRequest {
1239
1435
  /**
1240
1436
  * <p>A name prefix to filter the archives returned. Only archives with name that match the
@@ -1258,6 +1454,9 @@ export interface ListArchivesRequest {
1258
1454
  */
1259
1455
  Limit?: number;
1260
1456
  }
1457
+ /**
1458
+ * @public
1459
+ */
1261
1460
  export interface ListArchivesResponse {
1262
1461
  /**
1263
1462
  * <p>An array of <code>Archive</code> objects that include details about an archive.</p>
@@ -1268,6 +1467,9 @@ export interface ListArchivesResponse {
1268
1467
  */
1269
1468
  NextToken?: string;
1270
1469
  }
1470
+ /**
1471
+ * @public
1472
+ */
1271
1473
  export interface ListConnectionsRequest {
1272
1474
  /**
1273
1475
  * <p>A name prefix to filter results returned. Only connections with a name that starts with
@@ -1288,6 +1490,7 @@ export interface ListConnectionsRequest {
1288
1490
  Limit?: number;
1289
1491
  }
1290
1492
  /**
1493
+ * @public
1291
1494
  * <p>Contains information about a connection.</p>
1292
1495
  */
1293
1496
  export interface Connection {
@@ -1324,6 +1527,9 @@ export interface Connection {
1324
1527
  */
1325
1528
  LastAuthorizedTime?: Date;
1326
1529
  }
1530
+ /**
1531
+ * @public
1532
+ */
1327
1533
  export interface ListConnectionsResponse {
1328
1534
  /**
1329
1535
  * <p>An array of connections objects that include details about the connections.</p>
@@ -1334,6 +1540,9 @@ export interface ListConnectionsResponse {
1334
1540
  */
1335
1541
  NextToken?: string;
1336
1542
  }
1543
+ /**
1544
+ * @public
1545
+ */
1337
1546
  export interface ListEventBusesRequest {
1338
1547
  /**
1339
1548
  * <p>Specifying this limits the results to only those event buses with names that start with
@@ -1352,6 +1561,7 @@ export interface ListEventBusesRequest {
1352
1561
  Limit?: number;
1353
1562
  }
1354
1563
  /**
1564
+ * @public
1355
1565
  * <p>An event bus receives events from a source and routes them to rules associated with that
1356
1566
  * event bus. Your account's default event bus receives events from Amazon Web Services services. A custom event
1357
1567
  * bus can receive events from your custom applications and services. A partner event bus
@@ -1373,6 +1583,9 @@ export interface EventBus {
1373
1583
  */
1374
1584
  Policy?: string;
1375
1585
  }
1586
+ /**
1587
+ * @public
1588
+ */
1376
1589
  export interface ListEventBusesResponse {
1377
1590
  /**
1378
1591
  * <p>This list of event buses.</p>
@@ -1383,6 +1596,9 @@ export interface ListEventBusesResponse {
1383
1596
  */
1384
1597
  NextToken?: string;
1385
1598
  }
1599
+ /**
1600
+ * @public
1601
+ */
1386
1602
  export interface ListEventSourcesRequest {
1387
1603
  /**
1388
1604
  * <p>Specifying this limits the results to only those partner event sources with names that
@@ -1401,6 +1617,7 @@ export interface ListEventSourcesRequest {
1401
1617
  Limit?: number;
1402
1618
  }
1403
1619
  /**
1620
+ * @public
1404
1621
  * <p>A partner event source is created by an SaaS partner. If a customer creates a partner
1405
1622
  * event bus that matches this event source, that Amazon Web Services account can receive events from the
1406
1623
  * partner's applications or services.</p>
@@ -1435,6 +1652,9 @@ export interface EventSource {
1435
1652
  */
1436
1653
  State?: EventSourceState | string;
1437
1654
  }
1655
+ /**
1656
+ * @public
1657
+ */
1438
1658
  export interface ListEventSourcesResponse {
1439
1659
  /**
1440
1660
  * <p>The list of event sources.</p>
@@ -1445,6 +1665,9 @@ export interface ListEventSourcesResponse {
1445
1665
  */
1446
1666
  NextToken?: string;
1447
1667
  }
1668
+ /**
1669
+ * @public
1670
+ */
1448
1671
  export interface ListPartnerEventSourceAccountsRequest {
1449
1672
  /**
1450
1673
  * <p>The name of the partner event source to display account information about.</p>
@@ -1463,6 +1686,7 @@ export interface ListPartnerEventSourceAccountsRequest {
1463
1686
  Limit?: number;
1464
1687
  }
1465
1688
  /**
1689
+ * @public
1466
1690
  * <p>The Amazon Web Services account that a partner event source has been offered to.</p>
1467
1691
  */
1468
1692
  export interface PartnerEventSourceAccount {
@@ -1487,6 +1711,9 @@ export interface PartnerEventSourceAccount {
1487
1711
  */
1488
1712
  State?: EventSourceState | string;
1489
1713
  }
1714
+ /**
1715
+ * @public
1716
+ */
1490
1717
  export interface ListPartnerEventSourceAccountsResponse {
1491
1718
  /**
1492
1719
  * <p>The list of partner event sources returned by the operation.</p>
@@ -1497,6 +1724,9 @@ export interface ListPartnerEventSourceAccountsResponse {
1497
1724
  */
1498
1725
  NextToken?: string;
1499
1726
  }
1727
+ /**
1728
+ * @public
1729
+ */
1500
1730
  export interface ListPartnerEventSourcesRequest {
1501
1731
  /**
1502
1732
  * <p>If you specify this, the results are limited to only those partner event sources that
@@ -1516,6 +1746,7 @@ export interface ListPartnerEventSourcesRequest {
1516
1746
  Limit?: number;
1517
1747
  }
1518
1748
  /**
1749
+ * @public
1519
1750
  * <p>A partner event source is created by an SaaS partner. If a customer creates a partner
1520
1751
  * event bus that matches this event source, that Amazon Web Services account can receive events from the
1521
1752
  * partner's applications or services.</p>
@@ -1530,6 +1761,9 @@ export interface PartnerEventSource {
1530
1761
  */
1531
1762
  Name?: string;
1532
1763
  }
1764
+ /**
1765
+ * @public
1766
+ */
1533
1767
  export interface ListPartnerEventSourcesResponse {
1534
1768
  /**
1535
1769
  * <p>The list of partner event sources returned by the operation.</p>
@@ -1540,6 +1774,9 @@ export interface ListPartnerEventSourcesResponse {
1540
1774
  */
1541
1775
  NextToken?: string;
1542
1776
  }
1777
+ /**
1778
+ * @public
1779
+ */
1543
1780
  export interface ListReplaysRequest {
1544
1781
  /**
1545
1782
  * <p>A name prefix to filter the replays returned. Only replays with name that match the prefix
@@ -1564,6 +1801,7 @@ export interface ListReplaysRequest {
1564
1801
  Limit?: number;
1565
1802
  }
1566
1803
  /**
1804
+ * @public
1567
1805
  * <p>A <code>Replay</code> object that contains details about a replay.</p>
1568
1806
  */
1569
1807
  export interface Replay {
@@ -1606,6 +1844,9 @@ export interface Replay {
1606
1844
  */
1607
1845
  ReplayEndTime?: Date;
1608
1846
  }
1847
+ /**
1848
+ * @public
1849
+ */
1609
1850
  export interface ListReplaysResponse {
1610
1851
  /**
1611
1852
  * <p>An array of <code>Replay</code> objects that contain information about the replay.</p>
@@ -1616,6 +1857,9 @@ export interface ListReplaysResponse {
1616
1857
  */
1617
1858
  NextToken?: string;
1618
1859
  }
1860
+ /**
1861
+ * @public
1862
+ */
1619
1863
  export interface ListRuleNamesByTargetRequest {
1620
1864
  /**
1621
1865
  * <p>The Amazon Resource Name (ARN) of the target resource.</p>
@@ -1635,6 +1879,9 @@ export interface ListRuleNamesByTargetRequest {
1635
1879
  */
1636
1880
  Limit?: number;
1637
1881
  }
1882
+ /**
1883
+ * @public
1884
+ */
1638
1885
  export interface ListRuleNamesByTargetResponse {
1639
1886
  /**
1640
1887
  * <p>The names of the rules that can invoke the given target.</p>
@@ -1646,6 +1893,9 @@ export interface ListRuleNamesByTargetResponse {
1646
1893
  */
1647
1894
  NextToken?: string;
1648
1895
  }
1896
+ /**
1897
+ * @public
1898
+ */
1649
1899
  export interface ListRulesRequest {
1650
1900
  /**
1651
1901
  * <p>The prefix matching the rule name.</p>
@@ -1666,6 +1916,7 @@ export interface ListRulesRequest {
1666
1916
  Limit?: number;
1667
1917
  }
1668
1918
  /**
1919
+ * @public
1669
1920
  * <p>Contains information about a rule in Amazon EventBridge.</p>
1670
1921
  */
1671
1922
  export interface Rule {
@@ -1713,6 +1964,9 @@ export interface Rule {
1713
1964
  */
1714
1965
  EventBusName?: string;
1715
1966
  }
1967
+ /**
1968
+ * @public
1969
+ */
1716
1970
  export interface ListRulesResponse {
1717
1971
  /**
1718
1972
  * <p>The rules that match the specified criteria.</p>
@@ -1724,18 +1978,27 @@ export interface ListRulesResponse {
1724
1978
  */
1725
1979
  NextToken?: string;
1726
1980
  }
1981
+ /**
1982
+ * @public
1983
+ */
1727
1984
  export interface ListTagsForResourceRequest {
1728
1985
  /**
1729
1986
  * <p>The ARN of the EventBridge resource for which you want to view tags.</p>
1730
1987
  */
1731
1988
  ResourceARN: string | undefined;
1732
1989
  }
1990
+ /**
1991
+ * @public
1992
+ */
1733
1993
  export interface ListTagsForResourceResponse {
1734
1994
  /**
1735
1995
  * <p>The list of tag keys and values associated with the resource you specified</p>
1736
1996
  */
1737
1997
  Tags?: Tag[];
1738
1998
  }
1999
+ /**
2000
+ * @public
2001
+ */
1739
2002
  export interface ListTargetsByRuleRequest {
1740
2003
  /**
1741
2004
  * <p>The name of the rule.</p>
@@ -1756,6 +2019,7 @@ export interface ListTargetsByRuleRequest {
1756
2019
  Limit?: number;
1757
2020
  }
1758
2021
  /**
2022
+ * @public
1759
2023
  * <p>The array properties for the submitted job, such as the size of the array. The array size
1760
2024
  * can be between 2 and 10,000. If you specify array properties for a job, it becomes an array
1761
2025
  * job. This parameter is used only if the target is an Batch job.</p>
@@ -1768,6 +2032,7 @@ export interface BatchArrayProperties {
1768
2032
  Size?: number;
1769
2033
  }
1770
2034
  /**
2035
+ * @public
1771
2036
  * <p>The retry strategy to use for failed jobs, if the target is an Batch job. If you
1772
2037
  * specify a retry strategy here, it overrides the retry strategy defined in the job
1773
2038
  * definition.</p>
@@ -1779,6 +2044,7 @@ export interface BatchRetryStrategy {
1779
2044
  Attempts?: number;
1780
2045
  }
1781
2046
  /**
2047
+ * @public
1782
2048
  * <p>The custom parameters to be used when the target is an Batch job.</p>
1783
2049
  */
1784
2050
  export interface BatchParameters {
@@ -1806,6 +2072,7 @@ export interface BatchParameters {
1806
2072
  RetryStrategy?: BatchRetryStrategy;
1807
2073
  }
1808
2074
  /**
2075
+ * @public
1809
2076
  * <p>A <code>DeadLetterConfig</code> object that contains information about a dead-letter queue
1810
2077
  * configuration.</p>
1811
2078
  */
@@ -1816,6 +2083,7 @@ export interface DeadLetterConfig {
1816
2083
  Arn?: string;
1817
2084
  }
1818
2085
  /**
2086
+ * @public
1819
2087
  * <p>The details of a capacity provider strategy. To learn more, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html">CapacityProviderStrategyItem</a> in the Amazon ECS API Reference.</p>
1820
2088
  */
1821
2089
  export interface CapacityProviderStrategyItem {
@@ -1836,12 +2104,16 @@ export interface CapacityProviderStrategyItem {
1836
2104
  */
1837
2105
  base?: number;
1838
2106
  }
2107
+ /**
2108
+ * @public
2109
+ */
1839
2110
  export declare enum LaunchType {
1840
2111
  EC2 = "EC2",
1841
2112
  EXTERNAL = "EXTERNAL",
1842
2113
  FARGATE = "FARGATE"
1843
2114
  }
1844
2115
  /**
2116
+ * @public
1845
2117
  * <p>This structure specifies the VPC subnets and security groups for the task, and whether a
1846
2118
  * public IP address is to be used. This structure is relevant only for ECS tasks that use the
1847
2119
  * <code>awsvpc</code> network mode.</p>
@@ -1866,6 +2138,7 @@ export interface AwsVpcConfiguration {
1866
2138
  AssignPublicIp?: AssignPublicIp | string;
1867
2139
  }
1868
2140
  /**
2141
+ * @public
1869
2142
  * <p>This structure specifies the network configuration for an ECS task.</p>
1870
2143
  */
1871
2144
  export interface NetworkConfiguration {
@@ -1876,11 +2149,15 @@ export interface NetworkConfiguration {
1876
2149
  */
1877
2150
  awsvpcConfiguration?: AwsVpcConfiguration;
1878
2151
  }
2152
+ /**
2153
+ * @public
2154
+ */
1879
2155
  export declare enum PlacementConstraintType {
1880
2156
  DISTINCT_INSTANCE = "distinctInstance",
1881
2157
  MEMBER_OF = "memberOf"
1882
2158
  }
1883
2159
  /**
2160
+ * @public
1884
2161
  * <p>An object representing a constraint on task placement. To learn more, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html">Task Placement Constraints</a> in the Amazon Elastic Container Service Developer
1885
2162
  * Guide.</p>
1886
2163
  */
@@ -1898,12 +2175,16 @@ export interface PlacementConstraint {
1898
2175
  */
1899
2176
  expression?: string;
1900
2177
  }
2178
+ /**
2179
+ * @public
2180
+ */
1901
2181
  export declare enum PlacementStrategyType {
1902
2182
  BINPACK = "binpack",
1903
2183
  RANDOM = "random",
1904
2184
  SPREAD = "spread"
1905
2185
  }
1906
2186
  /**
2187
+ * @public
1907
2188
  * <p>The task placement strategy for a task or service. To learn more, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html">Task Placement Strategies</a> in the Amazon Elastic Container Service Service Developer
1908
2189
  * Guide.</p>
1909
2190
  */
@@ -1926,10 +2207,14 @@ export interface PlacementStrategy {
1926
2207
  */
1927
2208
  field?: string;
1928
2209
  }
2210
+ /**
2211
+ * @public
2212
+ */
1929
2213
  export declare enum PropagateTags {
1930
2214
  TASK_DEFINITION = "TASK_DEFINITION"
1931
2215
  }
1932
2216
  /**
2217
+ * @public
1933
2218
  * <p>The custom parameters to be used when the target is an Amazon ECS task.</p>
1934
2219
  */
1935
2220
  export interface EcsParameters {
@@ -2020,6 +2305,7 @@ export interface EcsParameters {
2020
2305
  Tags?: Tag[];
2021
2306
  }
2022
2307
  /**
2308
+ * @public
2023
2309
  * <p>These are custom parameter to be used when the target is an API Gateway REST APIs or
2024
2310
  * EventBridge ApiDestinations. In the latter case, these are merged with any
2025
2311
  * InvocationParameters specified on the Connection, with any values from the Connection taking
@@ -2043,6 +2329,7 @@ export interface HttpParameters {
2043
2329
  QueryStringParameters?: Record<string, string>;
2044
2330
  }
2045
2331
  /**
2332
+ * @public
2046
2333
  * <p>Contains the parameters needed for you to provide custom input to a target based on one or
2047
2334
  * more pieces of data extracted from the event.</p>
2048
2335
  */
@@ -2077,17 +2364,17 @@ export interface InputTransformer {
2077
2364
  * <code> "InputTransformer":</code>
2078
2365
  * </p>
2079
2366
  * <p>
2080
- * <code>{</code>
2367
+ * <code>\{</code>
2081
2368
  * </p>
2082
2369
  * <p>
2083
- * <code>"InputPathsMap": {"instance": "$.detail.instance","status":
2084
- * "$.detail.status"},</code>
2370
+ * <code>"InputPathsMap": \{"instance": "$.detail.instance","status":
2371
+ * "$.detail.status"\},</code>
2085
2372
  * </p>
2086
2373
  * <p>
2087
2374
  * <code>"InputTemplate": "<instance> is in state <status>"</code>
2088
2375
  * </p>
2089
2376
  * <p>
2090
- * <code>}</code>
2377
+ * <code>\}</code>
2091
2378
  * </p>
2092
2379
  * <p>To have the <code>InputTemplate</code> include quote marks within a JSON string, escape
2093
2380
  * each quote marks with a slash, as in the following example:</p>
@@ -2095,17 +2382,17 @@ export interface InputTransformer {
2095
2382
  * <code> "InputTransformer":</code>
2096
2383
  * </p>
2097
2384
  * <p>
2098
- * <code>{</code>
2385
+ * <code>\{</code>
2099
2386
  * </p>
2100
2387
  * <p>
2101
- * <code>"InputPathsMap": {"instance": "$.detail.instance","status":
2102
- * "$.detail.status"},</code>
2388
+ * <code>"InputPathsMap": \{"instance": "$.detail.instance","status":
2389
+ * "$.detail.status"\},</code>
2103
2390
  * </p>
2104
2391
  * <p>
2105
2392
  * <code>"InputTemplate": "<instance> is in state \"<status>\""</code>
2106
2393
  * </p>
2107
2394
  * <p>
2108
- * <code>}</code>
2395
+ * <code>\}</code>
2109
2396
  * </p>
2110
2397
  * <p>The <code>InputTemplate</code> can also be valid JSON with varibles in quotes or out, as
2111
2398
  * in the following example:</p>
@@ -2113,23 +2400,24 @@ export interface InputTransformer {
2113
2400
  * <code> "InputTransformer":</code>
2114
2401
  * </p>
2115
2402
  * <p>
2116
- * <code>{</code>
2403
+ * <code>\{</code>
2117
2404
  * </p>
2118
2405
  * <p>
2119
- * <code>"InputPathsMap": {"instance": "$.detail.instance","status":
2120
- * "$.detail.status"},</code>
2406
+ * <code>"InputPathsMap": \{"instance": "$.detail.instance","status":
2407
+ * "$.detail.status"\},</code>
2121
2408
  * </p>
2122
2409
  * <p>
2123
- * <code>"InputTemplate": '{"myInstance": <instance>,"myStatus": "<instance> is
2124
- * in state \"<status>\""}'</code>
2410
+ * <code>"InputTemplate": '\{"myInstance": <instance>,"myStatus": "<instance> is
2411
+ * in state \"<status>\""\}'</code>
2125
2412
  * </p>
2126
2413
  * <p>
2127
- * <code>}</code>
2414
+ * <code>\}</code>
2128
2415
  * </p>
2129
2416
  */
2130
2417
  InputTemplate: string | undefined;
2131
2418
  }
2132
2419
  /**
2420
+ * @public
2133
2421
  * <p>This object enables you to specify a JSON path to extract from the event and use as the
2134
2422
  * partition key for the Amazon Kinesis data stream, so that you can control the shard to which
2135
2423
  * the event goes. If you do not include this parameter, the default is to use the
@@ -2144,6 +2432,7 @@ export interface KinesisParameters {
2144
2432
  PartitionKeyPath: string | undefined;
2145
2433
  }
2146
2434
  /**
2435
+ * @public
2147
2436
  * <p>These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the
2148
2437
  * Amazon Redshift Data API ExecuteStatement based on EventBridge events.</p>
2149
2438
  */
@@ -2177,6 +2466,7 @@ export interface RedshiftDataParameters {
2177
2466
  WithEvent?: boolean;
2178
2467
  }
2179
2468
  /**
2469
+ * @public
2180
2470
  * <p>A <code>RetryPolicy</code> object that includes information about the retry policy
2181
2471
  * settings.</p>
2182
2472
  */
@@ -2193,6 +2483,7 @@ export interface RetryPolicy {
2193
2483
  MaximumEventAgeInSeconds?: number;
2194
2484
  }
2195
2485
  /**
2486
+ * @public
2196
2487
  * <p>Information about the EC2 instances that are to be sent the command, specified as
2197
2488
  * key-value pairs. Each <code>RunCommandTarget</code> block can include only one key, but this
2198
2489
  * key may specify multiple values.</p>
@@ -2213,6 +2504,7 @@ export interface RunCommandTarget {
2213
2504
  Values: string[] | undefined;
2214
2505
  }
2215
2506
  /**
2507
+ * @public
2216
2508
  * <p>This parameter contains the criteria (either InstanceIds or a tag) used to specify which
2217
2509
  * EC2 instances are to be sent the command. </p>
2218
2510
  */
@@ -2224,6 +2516,7 @@ export interface RunCommandParameters {
2224
2516
  RunCommandTargets: RunCommandTarget[] | undefined;
2225
2517
  }
2226
2518
  /**
2519
+ * @public
2227
2520
  * <p>Name/Value pair of a parameter to start execution of a SageMaker Model Building
2228
2521
  * Pipeline.</p>
2229
2522
  */
@@ -2238,6 +2531,7 @@ export interface SageMakerPipelineParameter {
2238
2531
  Value: string | undefined;
2239
2532
  }
2240
2533
  /**
2534
+ * @public
2241
2535
  * <p>These are custom parameters to use when the target is a SageMaker Model Building Pipeline
2242
2536
  * that starts based on EventBridge events.</p>
2243
2537
  */
@@ -2248,6 +2542,7 @@ export interface SageMakerPipelineParameters {
2248
2542
  PipelineParameterList?: SageMakerPipelineParameter[];
2249
2543
  }
2250
2544
  /**
2545
+ * @public
2251
2546
  * <p>This structure includes the custom parameter to be used when the target is an SQS FIFO
2252
2547
  * queue.</p>
2253
2548
  */
@@ -2258,6 +2553,7 @@ export interface SqsParameters {
2258
2553
  MessageGroupId?: string;
2259
2554
  }
2260
2555
  /**
2556
+ * @public
2261
2557
  * <p>Targets are the resources to be invoked when a rule is triggered. For a complete list of
2262
2558
  * services and resources that can be set as a target, see <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutTargets.html">PutTargets</a>.</p>
2263
2559
  *
@@ -2365,6 +2661,9 @@ export interface Target {
2365
2661
  */
2366
2662
  RetryPolicy?: RetryPolicy;
2367
2663
  }
2664
+ /**
2665
+ * @public
2666
+ */
2368
2667
  export interface ListTargetsByRuleResponse {
2369
2668
  /**
2370
2669
  * <p>The targets assigned to the rule.</p>
@@ -2377,6 +2676,7 @@ export interface ListTargetsByRuleResponse {
2377
2676
  NextToken?: string;
2378
2677
  }
2379
2678
  /**
2679
+ * @public
2380
2680
  * <p>Represents an event to be submitted.</p>
2381
2681
  */
2382
2682
  export interface PutEventsRequestEntry {
@@ -2415,6 +2715,9 @@ export interface PutEventsRequestEntry {
2415
2715
  */
2416
2716
  TraceHeader?: string;
2417
2717
  }
2718
+ /**
2719
+ * @public
2720
+ */
2418
2721
  export interface PutEventsRequest {
2419
2722
  /**
2420
2723
  * <p>The entry that defines an event in your system. You can specify several parameters for the
@@ -2424,6 +2727,7 @@ export interface PutEventsRequest {
2424
2727
  Entries: PutEventsRequestEntry[] | undefined;
2425
2728
  }
2426
2729
  /**
2730
+ * @public
2427
2731
  * <p>Represents an event that failed to be submitted.</p>
2428
2732
  */
2429
2733
  export interface PutEventsResultEntry {
@@ -2440,6 +2744,9 @@ export interface PutEventsResultEntry {
2440
2744
  */
2441
2745
  ErrorMessage?: string;
2442
2746
  }
2747
+ /**
2748
+ * @public
2749
+ */
2443
2750
  export interface PutEventsResponse {
2444
2751
  /**
2445
2752
  * <p>The number of failed entries.</p>
@@ -2453,6 +2760,7 @@ export interface PutEventsResponse {
2453
2760
  Entries?: PutEventsResultEntry[];
2454
2761
  }
2455
2762
  /**
2763
+ * @public
2456
2764
  * <p>The details about an event generated by an SaaS partner.</p>
2457
2765
  */
2458
2766
  export interface PutPartnerEventsRequestEntry {
@@ -2479,6 +2787,9 @@ export interface PutPartnerEventsRequestEntry {
2479
2787
  */
2480
2788
  Detail?: string;
2481
2789
  }
2790
+ /**
2791
+ * @public
2792
+ */
2482
2793
  export interface PutPartnerEventsRequest {
2483
2794
  /**
2484
2795
  * <p>The list of events to write to the event bus.</p>
@@ -2486,6 +2797,7 @@ export interface PutPartnerEventsRequest {
2486
2797
  Entries: PutPartnerEventsRequestEntry[] | undefined;
2487
2798
  }
2488
2799
  /**
2800
+ * @public
2489
2801
  * <p>Represents an event that a partner tried to generate, but failed.</p>
2490
2802
  */
2491
2803
  export interface PutPartnerEventsResultEntry {
@@ -2502,6 +2814,9 @@ export interface PutPartnerEventsResultEntry {
2502
2814
  */
2503
2815
  ErrorMessage?: string;
2504
2816
  }
2817
+ /**
2818
+ * @public
2819
+ */
2505
2820
  export interface PutPartnerEventsResponse {
2506
2821
  /**
2507
2822
  * <p>The number of events from this operation that could not be written to the partner event
@@ -2515,6 +2830,7 @@ export interface PutPartnerEventsResponse {
2515
2830
  Entries?: PutPartnerEventsResultEntry[];
2516
2831
  }
2517
2832
  /**
2833
+ * @public
2518
2834
  * <p>The event bus policy is too long. For more information, see the limits.</p>
2519
2835
  */
2520
2836
  export declare class PolicyLengthExceededException extends __BaseException {
@@ -2526,14 +2842,15 @@ export declare class PolicyLengthExceededException extends __BaseException {
2526
2842
  constructor(opts: __ExceptionOptionType<PolicyLengthExceededException, __BaseException>);
2527
2843
  }
2528
2844
  /**
2845
+ * @public
2529
2846
  * <p>A JSON string which you can use to limit the event bus permissions you are granting to
2530
2847
  * only accounts that fulfill the condition. Currently, the only supported condition is
2531
2848
  * membership in a certain Amazon Web Services organization. The string must contain <code>Type</code>,
2532
2849
  * <code>Key</code>, and <code>Value</code> fields. The <code>Value</code> field specifies the
2533
2850
  * ID of the Amazon Web Services organization. Following is an example value for <code>Condition</code>:</p>
2534
2851
  * <p>
2535
- * <code>'{"Type" : "StringEquals", "Key": "aws:PrincipalOrgID", "Value":
2536
- * "o-1234567890"}'</code>
2852
+ * <code>'\{"Type" : "StringEquals", "Key": "aws:PrincipalOrgID", "Value":
2853
+ * "o-1234567890"\}'</code>
2537
2854
  * </p>
2538
2855
  */
2539
2856
  export interface Condition {
@@ -2553,6 +2870,9 @@ export interface Condition {
2553
2870
  */
2554
2871
  Value: string | undefined;
2555
2872
  }
2873
+ /**
2874
+ * @public
2875
+ */
2556
2876
  export interface PutPermissionRequest {
2557
2877
  /**
2558
2878
  * <p>The name of the event bus associated with the rule. If you omit this, the default event
@@ -2600,6 +2920,9 @@ export interface PutPermissionRequest {
2600
2920
  */
2601
2921
  Policy?: string;
2602
2922
  }
2923
+ /**
2924
+ * @public
2925
+ */
2603
2926
  export interface PutRuleRequest {
2604
2927
  /**
2605
2928
  * <p>The name of the rule that you are creating or updating.</p>
@@ -2640,12 +2963,18 @@ export interface PutRuleRequest {
2640
2963
  */
2641
2964
  EventBusName?: string;
2642
2965
  }
2966
+ /**
2967
+ * @public
2968
+ */
2643
2969
  export interface PutRuleResponse {
2644
2970
  /**
2645
2971
  * <p>The Amazon Resource Name (ARN) of the rule.</p>
2646
2972
  */
2647
2973
  RuleArn?: string;
2648
2974
  }
2975
+ /**
2976
+ * @public
2977
+ */
2649
2978
  export interface PutTargetsRequest {
2650
2979
  /**
2651
2980
  * <p>The name of the rule.</p>
@@ -2662,6 +2991,7 @@ export interface PutTargetsRequest {
2662
2991
  Targets: Target[] | undefined;
2663
2992
  }
2664
2993
  /**
2994
+ * @public
2665
2995
  * <p>Represents a target that failed to be added to a rule.</p>
2666
2996
  */
2667
2997
  export interface PutTargetsResultEntry {
@@ -2680,6 +3010,9 @@ export interface PutTargetsResultEntry {
2680
3010
  */
2681
3011
  ErrorMessage?: string;
2682
3012
  }
3013
+ /**
3014
+ * @public
3015
+ */
2683
3016
  export interface PutTargetsResponse {
2684
3017
  /**
2685
3018
  * <p>The number of failed entries.</p>
@@ -2690,6 +3023,9 @@ export interface PutTargetsResponse {
2690
3023
  */
2691
3024
  FailedEntries?: PutTargetsResultEntry[];
2692
3025
  }
3026
+ /**
3027
+ * @public
3028
+ */
2693
3029
  export interface RemovePermissionRequest {
2694
3030
  /**
2695
3031
  * <p>The statement ID corresponding to the account that is no longer allowed to put events to
@@ -2706,6 +3042,9 @@ export interface RemovePermissionRequest {
2706
3042
  */
2707
3043
  EventBusName?: string;
2708
3044
  }
3045
+ /**
3046
+ * @public
3047
+ */
2709
3048
  export interface RemoveTargetsRequest {
2710
3049
  /**
2711
3050
  * <p>The name of the rule.</p>
@@ -2730,6 +3069,7 @@ export interface RemoveTargetsRequest {
2730
3069
  Force?: boolean;
2731
3070
  }
2732
3071
  /**
3072
+ * @public
2733
3073
  * <p>Represents a target that failed to be removed from a rule.</p>
2734
3074
  */
2735
3075
  export interface RemoveTargetsResultEntry {
@@ -2748,6 +3088,9 @@ export interface RemoveTargetsResultEntry {
2748
3088
  */
2749
3089
  ErrorMessage?: string;
2750
3090
  }
3091
+ /**
3092
+ * @public
3093
+ */
2751
3094
  export interface RemoveTargetsResponse {
2752
3095
  /**
2753
3096
  * <p>The number of failed entries.</p>
@@ -2758,6 +3101,9 @@ export interface RemoveTargetsResponse {
2758
3101
  */
2759
3102
  FailedEntries?: RemoveTargetsResultEntry[];
2760
3103
  }
3104
+ /**
3105
+ * @public
3106
+ */
2761
3107
  export interface StartReplayRequest {
2762
3108
  /**
2763
3109
  * <p>The name of the replay to start.</p>
@@ -2787,6 +3133,9 @@ export interface StartReplayRequest {
2787
3133
  */
2788
3134
  Destination: ReplayDestination | undefined;
2789
3135
  }
3136
+ /**
3137
+ * @public
3138
+ */
2790
3139
  export interface StartReplayResponse {
2791
3140
  /**
2792
3141
  * <p>The ARN of the replay.</p>
@@ -2805,6 +3154,9 @@ export interface StartReplayResponse {
2805
3154
  */
2806
3155
  ReplayStartTime?: Date;
2807
3156
  }
3157
+ /**
3158
+ * @public
3159
+ */
2808
3160
  export interface TagResourceRequest {
2809
3161
  /**
2810
3162
  * <p>The ARN of the EventBridge resource that you're adding tags to.</p>
@@ -2815,8 +3167,14 @@ export interface TagResourceRequest {
2815
3167
  */
2816
3168
  Tags: Tag[] | undefined;
2817
3169
  }
3170
+ /**
3171
+ * @public
3172
+ */
2818
3173
  export interface TagResourceResponse {
2819
3174
  }
3175
+ /**
3176
+ * @public
3177
+ */
2820
3178
  export interface TestEventPatternRequest {
2821
3179
  /**
2822
3180
  * <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
@@ -2867,12 +3225,18 @@ export interface TestEventPatternRequest {
2867
3225
  */
2868
3226
  Event: string | undefined;
2869
3227
  }
3228
+ /**
3229
+ * @public
3230
+ */
2870
3231
  export interface TestEventPatternResponse {
2871
3232
  /**
2872
3233
  * <p>Indicates whether the event matches the event pattern.</p>
2873
3234
  */
2874
3235
  Result?: boolean;
2875
3236
  }
3237
+ /**
3238
+ * @public
3239
+ */
2876
3240
  export interface UntagResourceRequest {
2877
3241
  /**
2878
3242
  * <p>The ARN of the EventBridge resource from which you are removing tags.</p>
@@ -2883,8 +3247,14 @@ export interface UntagResourceRequest {
2883
3247
  */
2884
3248
  TagKeys: string[] | undefined;
2885
3249
  }
3250
+ /**
3251
+ * @public
3252
+ */
2886
3253
  export interface UntagResourceResponse {
2887
3254
  }
3255
+ /**
3256
+ * @public
3257
+ */
2888
3258
  export interface UpdateApiDestinationRequest {
2889
3259
  /**
2890
3260
  * <p>The name of the API destination to update.</p>
@@ -2911,6 +3281,9 @@ export interface UpdateApiDestinationRequest {
2911
3281
  */
2912
3282
  InvocationRateLimitPerSecond?: number;
2913
3283
  }
3284
+ /**
3285
+ * @public
3286
+ */
2914
3287
  export interface UpdateApiDestinationResponse {
2915
3288
  /**
2916
3289
  * <p>The ARN of the API destination that was updated.</p>
@@ -2929,6 +3302,9 @@ export interface UpdateApiDestinationResponse {
2929
3302
  */
2930
3303
  LastModifiedTime?: Date;
2931
3304
  }
3305
+ /**
3306
+ * @public
3307
+ */
2932
3308
  export interface UpdateArchiveRequest {
2933
3309
  /**
2934
3310
  * <p>The name of the archive to update.</p>
@@ -2947,6 +3323,9 @@ export interface UpdateArchiveRequest {
2947
3323
  */
2948
3324
  RetentionDays?: number;
2949
3325
  }
3326
+ /**
3327
+ * @public
3328
+ */
2950
3329
  export interface UpdateArchiveResponse {
2951
3330
  /**
2952
3331
  * <p>The ARN of the archive.</p>
@@ -2966,6 +3345,7 @@ export interface UpdateArchiveResponse {
2966
3345
  CreationTime?: Date;
2967
3346
  }
2968
3347
  /**
3348
+ * @public
2969
3349
  * <p>Contains the API key authorization parameters to use to update the connection.</p>
2970
3350
  */
2971
3351
  export interface UpdateConnectionApiKeyAuthRequestParameters {
@@ -2979,6 +3359,7 @@ export interface UpdateConnectionApiKeyAuthRequestParameters {
2979
3359
  ApiKeyValue?: string;
2980
3360
  }
2981
3361
  /**
3362
+ * @public
2982
3363
  * <p>Contains the Basic authorization parameters for the connection.</p>
2983
3364
  */
2984
3365
  export interface UpdateConnectionBasicAuthRequestParameters {
@@ -2992,6 +3373,7 @@ export interface UpdateConnectionBasicAuthRequestParameters {
2992
3373
  Password?: string;
2993
3374
  }
2994
3375
  /**
3376
+ * @public
2995
3377
  * <p>Contains the OAuth authorization parameters to use for the connection.</p>
2996
3378
  */
2997
3379
  export interface UpdateConnectionOAuthClientRequestParameters {
@@ -3005,6 +3387,7 @@ export interface UpdateConnectionOAuthClientRequestParameters {
3005
3387
  ClientSecret?: string;
3006
3388
  }
3007
3389
  /**
3390
+ * @public
3008
3391
  * <p>Contains the OAuth request parameters to use for the connection.</p>
3009
3392
  */
3010
3393
  export interface UpdateConnectionOAuthRequestParameters {
@@ -3029,6 +3412,7 @@ export interface UpdateConnectionOAuthRequestParameters {
3029
3412
  OAuthHttpParameters?: ConnectionHttpParameters;
3030
3413
  }
3031
3414
  /**
3415
+ * @public
3032
3416
  * <p>Contains the additional parameters to use for the connection.</p>
3033
3417
  */
3034
3418
  export interface UpdateConnectionAuthRequestParameters {
@@ -3053,6 +3437,9 @@ export interface UpdateConnectionAuthRequestParameters {
3053
3437
  */
3054
3438
  InvocationHttpParameters?: ConnectionHttpParameters;
3055
3439
  }
3440
+ /**
3441
+ * @public
3442
+ */
3056
3443
  export interface UpdateConnectionRequest {
3057
3444
  /**
3058
3445
  * <p>The name of the connection to update.</p>
@@ -3071,6 +3458,9 @@ export interface UpdateConnectionRequest {
3071
3458
  */
3072
3459
  AuthParameters?: UpdateConnectionAuthRequestParameters;
3073
3460
  }
3461
+ /**
3462
+ * @public
3463
+ */
3074
3464
  export interface UpdateConnectionResponse {
3075
3465
  /**
3076
3466
  * <p>The ARN of the connection that was updated.</p>