@aws-sdk/client-cloudwatch-events 3.379.1 → 3.385.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.
@@ -5,6 +5,7 @@ import { CloudWatchEventsServiceException as __BaseException } from "./CloudWatc
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,18 +667,22 @@ 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
  */
613
683
  AuthorizationType: ConnectionAuthorizationType | string | undefined;
614
684
  /**
685
+ * @public
615
686
  * <p>A <code>CreateConnectionAuthRequestParameters</code> object that contains the
616
687
  * authorization parameters to use to authorize with the endpoint. </p>
617
688
  */
@@ -639,18 +710,22 @@ export type ConnectionState = (typeof ConnectionState)[keyof typeof ConnectionSt
639
710
  */
640
711
  export interface CreateConnectionResponse {
641
712
  /**
713
+ * @public
642
714
  * <p>The ARN of the connection that was created by the request.</p>
643
715
  */
644
716
  ConnectionArn?: string;
645
717
  /**
718
+ * @public
646
719
  * <p>The state of the connection that was created by the request.</p>
647
720
  */
648
721
  ConnectionState?: ConnectionState | string;
649
722
  /**
723
+ * @public
650
724
  * <p>A time stamp for the time that the connection was created.</p>
651
725
  */
652
726
  CreationTime?: Date;
653
727
  /**
728
+ * @public
654
729
  * <p>A time stamp for the time that the connection was last updated.</p>
655
730
  */
656
731
  LastModifiedTime?: Date;
@@ -662,11 +737,13 @@ export interface CreateConnectionResponse {
662
737
  */
663
738
  export interface Tag {
664
739
  /**
740
+ * @public
665
741
  * <p>A string you can use to assign a value. The combination of tag keys and values can help
666
742
  * you organize and categorize your resources.</p>
667
743
  */
668
744
  Key: string | undefined;
669
745
  /**
746
+ * @public
670
747
  * <p>The value for the specified tag key.</p>
671
748
  */
672
749
  Value: string | undefined;
@@ -676,6 +753,7 @@ export interface Tag {
676
753
  */
677
754
  export interface CreateEventBusRequest {
678
755
  /**
756
+ * @public
679
757
  * <p>The name of the new event bus. </p>
680
758
  * <p>Event bus names cannot contain the / character. You can't use the name
681
759
  * <code>default</code> for a custom event bus, as this name is already used for your account's
@@ -685,11 +763,13 @@ export interface CreateEventBusRequest {
685
763
  */
686
764
  Name: string | undefined;
687
765
  /**
766
+ * @public
688
767
  * <p>If you are creating a partner event bus, this specifies the partner event source that the
689
768
  * new event bus will be matched with.</p>
690
769
  */
691
770
  EventSourceName?: string;
692
771
  /**
772
+ * @public
693
773
  * <p>Tags to associate with the event bus.</p>
694
774
  */
695
775
  Tags?: Tag[];
@@ -699,6 +779,7 @@ export interface CreateEventBusRequest {
699
779
  */
700
780
  export interface CreateEventBusResponse {
701
781
  /**
782
+ * @public
702
783
  * <p>The ARN of the new event bus.</p>
703
784
  */
704
785
  EventBusArn?: string;
@@ -708,6 +789,7 @@ export interface CreateEventBusResponse {
708
789
  */
709
790
  export interface CreatePartnerEventSourceRequest {
710
791
  /**
792
+ * @public
711
793
  * <p>The name of the partner event source. This name must be unique and must be in the format
712
794
  * <code>
713
795
  * <i>partner_name</i>/<i>event_namespace</i>/<i>event_name</i>
@@ -717,6 +799,7 @@ export interface CreatePartnerEventSourceRequest {
717
799
  */
718
800
  Name: string | undefined;
719
801
  /**
802
+ * @public
720
803
  * <p>The Amazon Web Services account ID that is permitted to create a matching partner event bus for this
721
804
  * partner event source.</p>
722
805
  */
@@ -727,6 +810,7 @@ export interface CreatePartnerEventSourceRequest {
727
810
  */
728
811
  export interface CreatePartnerEventSourceResponse {
729
812
  /**
813
+ * @public
730
814
  * <p>The ARN of the partner event source.</p>
731
815
  */
732
816
  EventSourceArn?: string;
@@ -736,6 +820,7 @@ export interface CreatePartnerEventSourceResponse {
736
820
  */
737
821
  export interface DeactivateEventSourceRequest {
738
822
  /**
823
+ * @public
739
824
  * <p>The name of the partner event source to deactivate.</p>
740
825
  */
741
826
  Name: string | undefined;
@@ -745,6 +830,7 @@ export interface DeactivateEventSourceRequest {
745
830
  */
746
831
  export interface DeauthorizeConnectionRequest {
747
832
  /**
833
+ * @public
748
834
  * <p>The name of the connection to remove authorization from.</p>
749
835
  */
750
836
  Name: string | undefined;
@@ -754,22 +840,27 @@ export interface DeauthorizeConnectionRequest {
754
840
  */
755
841
  export interface DeauthorizeConnectionResponse {
756
842
  /**
843
+ * @public
757
844
  * <p>The ARN of the connection that authorization was removed from.</p>
758
845
  */
759
846
  ConnectionArn?: string;
760
847
  /**
848
+ * @public
761
849
  * <p>The state of the connection.</p>
762
850
  */
763
851
  ConnectionState?: ConnectionState | string;
764
852
  /**
853
+ * @public
765
854
  * <p>A time stamp for the time that the connection was created.</p>
766
855
  */
767
856
  CreationTime?: Date;
768
857
  /**
858
+ * @public
769
859
  * <p>A time stamp for the time that the connection was last updated.</p>
770
860
  */
771
861
  LastModifiedTime?: Date;
772
862
  /**
863
+ * @public
773
864
  * <p>A time stamp for the time that the connection was last authorized.</p>
774
865
  */
775
866
  LastAuthorizedTime?: Date;
@@ -779,6 +870,7 @@ export interface DeauthorizeConnectionResponse {
779
870
  */
780
871
  export interface DeleteApiDestinationRequest {
781
872
  /**
873
+ * @public
782
874
  * <p>The name of the destination to delete.</p>
783
875
  */
784
876
  Name: string | undefined;
@@ -793,6 +885,7 @@ export interface DeleteApiDestinationResponse {
793
885
  */
794
886
  export interface DeleteArchiveRequest {
795
887
  /**
888
+ * @public
796
889
  * <p>The name of the archive to delete.</p>
797
890
  */
798
891
  ArchiveName: string | undefined;
@@ -807,6 +900,7 @@ export interface DeleteArchiveResponse {
807
900
  */
808
901
  export interface DeleteConnectionRequest {
809
902
  /**
903
+ * @public
810
904
  * <p>The name of the connection to delete.</p>
811
905
  */
812
906
  Name: string | undefined;
@@ -816,23 +910,28 @@ export interface DeleteConnectionRequest {
816
910
  */
817
911
  export interface DeleteConnectionResponse {
818
912
  /**
913
+ * @public
819
914
  * <p>The ARN of the connection that was deleted.</p>
820
915
  */
821
916
  ConnectionArn?: string;
822
917
  /**
918
+ * @public
823
919
  * <p>The state of the connection before it was deleted.</p>
824
920
  */
825
921
  ConnectionState?: ConnectionState | string;
826
922
  /**
923
+ * @public
827
924
  * <p>A time stamp for the time that the connection was created.</p>
828
925
  */
829
926
  CreationTime?: Date;
830
927
  /**
928
+ * @public
831
929
  * <p>A time stamp for the time that the connection was last modified before it was
832
930
  * deleted.</p>
833
931
  */
834
932
  LastModifiedTime?: Date;
835
933
  /**
934
+ * @public
836
935
  * <p>A time stamp for the time that the connection was last authorized before it wa
837
936
  * deleted.</p>
838
937
  */
@@ -843,6 +942,7 @@ export interface DeleteConnectionResponse {
843
942
  */
844
943
  export interface DeleteEventBusRequest {
845
944
  /**
945
+ * @public
846
946
  * <p>The name of the event bus to delete.</p>
847
947
  */
848
948
  Name: string | undefined;
@@ -852,10 +952,12 @@ export interface DeleteEventBusRequest {
852
952
  */
853
953
  export interface DeletePartnerEventSourceRequest {
854
954
  /**
955
+ * @public
855
956
  * <p>The name of the event source to delete.</p>
856
957
  */
857
958
  Name: string | undefined;
858
959
  /**
960
+ * @public
859
961
  * <p>The Amazon Web Services account ID of the Amazon Web Services customer that the event source was created for.</p>
860
962
  */
861
963
  Account: string | undefined;
@@ -865,15 +967,18 @@ export interface DeletePartnerEventSourceRequest {
865
967
  */
866
968
  export interface DeleteRuleRequest {
867
969
  /**
970
+ * @public
868
971
  * <p>The name of the rule.</p>
869
972
  */
870
973
  Name: string | undefined;
871
974
  /**
975
+ * @public
872
976
  * <p>The name or ARN of the event bus associated with the rule. If you omit this, the default
873
977
  * event bus is used.</p>
874
978
  */
875
979
  EventBusName?: string;
876
980
  /**
981
+ * @public
877
982
  * <p>If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify
878
983
  * <code>Force</code> as <code>True</code> to delete the rule. This parameter is ignored for
879
984
  * rules that are not managed rules. You can check whether a rule is a managed rule by using
@@ -904,6 +1009,7 @@ export declare class ManagedRuleException extends __BaseException {
904
1009
  */
905
1010
  export interface DescribeApiDestinationRequest {
906
1011
  /**
1012
+ * @public
907
1013
  * <p>The name of the API destination to retrieve.</p>
908
1014
  */
909
1015
  Name: string | undefined;
@@ -913,34 +1019,42 @@ export interface DescribeApiDestinationRequest {
913
1019
  */
914
1020
  export interface DescribeApiDestinationResponse {
915
1021
  /**
1022
+ * @public
916
1023
  * <p>The ARN of the API destination retrieved.</p>
917
1024
  */
918
1025
  ApiDestinationArn?: string;
919
1026
  /**
1027
+ * @public
920
1028
  * <p>The name of the API destination retrieved.</p>
921
1029
  */
922
1030
  Name?: string;
923
1031
  /**
1032
+ * @public
924
1033
  * <p>The description for the API destination retrieved.</p>
925
1034
  */
926
1035
  Description?: string;
927
1036
  /**
1037
+ * @public
928
1038
  * <p>The state of the API destination retrieved.</p>
929
1039
  */
930
1040
  ApiDestinationState?: ApiDestinationState | string;
931
1041
  /**
1042
+ * @public
932
1043
  * <p>The ARN of the connection specified for the API destination retrieved.</p>
933
1044
  */
934
1045
  ConnectionArn?: string;
935
1046
  /**
1047
+ * @public
936
1048
  * <p>The URL to use to connect to the HTTP endpoint.</p>
937
1049
  */
938
1050
  InvocationEndpoint?: string;
939
1051
  /**
1052
+ * @public
940
1053
  * <p>The method to use to connect to the HTTP endpoint.</p>
941
1054
  */
942
1055
  HttpMethod?: ApiDestinationHttpMethod | string;
943
1056
  /**
1057
+ * @public
944
1058
  * <p>The maximum number of invocations per second to specified for the API destination. Note
945
1059
  * that if you set the invocation rate maximum to a value lower the rate necessary to send all
946
1060
  * events received on to the destination HTTP endpoint, some events may not be delivered within
@@ -950,10 +1064,12 @@ export interface DescribeApiDestinationResponse {
950
1064
  */
951
1065
  InvocationRateLimitPerSecond?: number;
952
1066
  /**
1067
+ * @public
953
1068
  * <p>A time stamp for the time that the API destination was created.</p>
954
1069
  */
955
1070
  CreationTime?: Date;
956
1071
  /**
1072
+ * @public
957
1073
  * <p>A time stamp for the time that the API destination was last modified.</p>
958
1074
  */
959
1075
  LastModifiedTime?: Date;
@@ -963,6 +1079,7 @@ export interface DescribeApiDestinationResponse {
963
1079
  */
964
1080
  export interface DescribeArchiveRequest {
965
1081
  /**
1082
+ * @public
966
1083
  * <p>The name of the archive to retrieve.</p>
967
1084
  */
968
1085
  ArchiveName: string | undefined;
@@ -972,46 +1089,57 @@ export interface DescribeArchiveRequest {
972
1089
  */
973
1090
  export interface DescribeArchiveResponse {
974
1091
  /**
1092
+ * @public
975
1093
  * <p>The ARN of the archive.</p>
976
1094
  */
977
1095
  ArchiveArn?: string;
978
1096
  /**
1097
+ * @public
979
1098
  * <p>The name of the archive.</p>
980
1099
  */
981
1100
  ArchiveName?: string;
982
1101
  /**
1102
+ * @public
983
1103
  * <p>The ARN of the event source associated with the archive.</p>
984
1104
  */
985
1105
  EventSourceArn?: string;
986
1106
  /**
1107
+ * @public
987
1108
  * <p>The description of the archive.</p>
988
1109
  */
989
1110
  Description?: string;
990
1111
  /**
1112
+ * @public
991
1113
  * <p>The event pattern used to filter events sent to the archive.</p>
992
1114
  */
993
1115
  EventPattern?: string;
994
1116
  /**
1117
+ * @public
995
1118
  * <p>The state of the archive.</p>
996
1119
  */
997
1120
  State?: ArchiveState | string;
998
1121
  /**
1122
+ * @public
999
1123
  * <p>The reason that the archive is in the state.</p>
1000
1124
  */
1001
1125
  StateReason?: string;
1002
1126
  /**
1127
+ * @public
1003
1128
  * <p>The number of days to retain events for in the archive.</p>
1004
1129
  */
1005
1130
  RetentionDays?: number;
1006
1131
  /**
1132
+ * @public
1007
1133
  * <p>The size of the archive in bytes.</p>
1008
1134
  */
1009
1135
  SizeBytes?: number;
1010
1136
  /**
1137
+ * @public
1011
1138
  * <p>The number of events in the archive.</p>
1012
1139
  */
1013
1140
  EventCount?: number;
1014
1141
  /**
1142
+ * @public
1015
1143
  * <p>The time at which the archive was created.</p>
1016
1144
  */
1017
1145
  CreationTime?: Date;
@@ -1021,6 +1149,7 @@ export interface DescribeArchiveResponse {
1021
1149
  */
1022
1150
  export interface DescribeConnectionRequest {
1023
1151
  /**
1152
+ * @public
1024
1153
  * <p>The name of the connection to retrieve.</p>
1025
1154
  */
1026
1155
  Name: string | undefined;
@@ -1032,6 +1161,7 @@ export interface DescribeConnectionRequest {
1032
1161
  */
1033
1162
  export interface ConnectionApiKeyAuthResponseParameters {
1034
1163
  /**
1164
+ * @public
1035
1165
  * <p>The name of the header to use for the <code>APIKeyValue</code> used for
1036
1166
  * authorization.</p>
1037
1167
  */
@@ -1044,6 +1174,7 @@ export interface ConnectionApiKeyAuthResponseParameters {
1044
1174
  */
1045
1175
  export interface ConnectionBasicAuthResponseParameters {
1046
1176
  /**
1177
+ * @public
1047
1178
  * <p>The user name to use for Basic authorization.</p>
1048
1179
  */
1049
1180
  Username?: string;
@@ -1055,6 +1186,7 @@ export interface ConnectionBasicAuthResponseParameters {
1055
1186
  */
1056
1187
  export interface ConnectionOAuthClientResponseParameters {
1057
1188
  /**
1189
+ * @public
1058
1190
  * <p>The client ID associated with the response to the connection request.</p>
1059
1191
  */
1060
1192
  ClientID?: string;
@@ -1065,19 +1197,23 @@ export interface ConnectionOAuthClientResponseParameters {
1065
1197
  */
1066
1198
  export interface ConnectionOAuthResponseParameters {
1067
1199
  /**
1200
+ * @public
1068
1201
  * <p>A <code>ConnectionOAuthClientResponseParameters</code> object that contains details about
1069
1202
  * the client parameters returned when OAuth is specified as the authorization type.</p>
1070
1203
  */
1071
1204
  ClientParameters?: ConnectionOAuthClientResponseParameters;
1072
1205
  /**
1206
+ * @public
1073
1207
  * <p>The URL to the HTTP endpoint that authorized the request.</p>
1074
1208
  */
1075
1209
  AuthorizationEndpoint?: string;
1076
1210
  /**
1211
+ * @public
1077
1212
  * <p>The method used to connect to the HTTP endpoint.</p>
1078
1213
  */
1079
1214
  HttpMethod?: ConnectionOAuthHttpMethod | string;
1080
1215
  /**
1216
+ * @public
1081
1217
  * <p>The additional HTTP parameters used for the OAuth authorization request.</p>
1082
1218
  */
1083
1219
  OAuthHttpParameters?: ConnectionHttpParameters;
@@ -1088,18 +1224,22 @@ export interface ConnectionOAuthResponseParameters {
1088
1224
  */
1089
1225
  export interface ConnectionAuthResponseParameters {
1090
1226
  /**
1227
+ * @public
1091
1228
  * <p>The authorization parameters for Basic authorization.</p>
1092
1229
  */
1093
1230
  BasicAuthParameters?: ConnectionBasicAuthResponseParameters;
1094
1231
  /**
1232
+ * @public
1095
1233
  * <p>The OAuth parameters to use for authorization.</p>
1096
1234
  */
1097
1235
  OAuthParameters?: ConnectionOAuthResponseParameters;
1098
1236
  /**
1237
+ * @public
1099
1238
  * <p>The API Key parameters to use for authorization.</p>
1100
1239
  */
1101
1240
  ApiKeyAuthParameters?: ConnectionApiKeyAuthResponseParameters;
1102
1241
  /**
1242
+ * @public
1103
1243
  * <p>Additional parameters for the connection that are passed through with every invocation to
1104
1244
  * the HTTP endpoint.</p>
1105
1245
  */
@@ -1110,47 +1250,58 @@ export interface ConnectionAuthResponseParameters {
1110
1250
  */
1111
1251
  export interface DescribeConnectionResponse {
1112
1252
  /**
1253
+ * @public
1113
1254
  * <p>The ARN of the connection retrieved.</p>
1114
1255
  */
1115
1256
  ConnectionArn?: string;
1116
1257
  /**
1258
+ * @public
1117
1259
  * <p>The name of the connection retrieved.</p>
1118
1260
  */
1119
1261
  Name?: string;
1120
1262
  /**
1263
+ * @public
1121
1264
  * <p>The description for the connection retrieved.</p>
1122
1265
  */
1123
1266
  Description?: string;
1124
1267
  /**
1268
+ * @public
1125
1269
  * <p>The state of the connection retrieved.</p>
1126
1270
  */
1127
1271
  ConnectionState?: ConnectionState | string;
1128
1272
  /**
1273
+ * @public
1129
1274
  * <p>The reason that the connection is in the current connection state.</p>
1130
1275
  */
1131
1276
  StateReason?: string;
1132
1277
  /**
1278
+ * @public
1133
1279
  * <p>The type of authorization specified for the connection.</p>
1134
1280
  */
1135
1281
  AuthorizationType?: ConnectionAuthorizationType | string;
1136
1282
  /**
1283
+ * @public
1137
1284
  * <p>The ARN of the secret created from the authorization parameters specified for the
1138
1285
  * connection.</p>
1139
1286
  */
1140
1287
  SecretArn?: string;
1141
1288
  /**
1289
+ * @public
1142
1290
  * <p>The parameters to use for authorization for the connection.</p>
1143
1291
  */
1144
1292
  AuthParameters?: ConnectionAuthResponseParameters;
1145
1293
  /**
1294
+ * @public
1146
1295
  * <p>A time stamp for the time that the connection was created.</p>
1147
1296
  */
1148
1297
  CreationTime?: Date;
1149
1298
  /**
1299
+ * @public
1150
1300
  * <p>A time stamp for the time that the connection was last modified.</p>
1151
1301
  */
1152
1302
  LastModifiedTime?: Date;
1153
1303
  /**
1304
+ * @public
1154
1305
  * <p>A time stamp for the time that the connection was last authorized.</p>
1155
1306
  */
1156
1307
  LastAuthorizedTime?: Date;
@@ -1160,6 +1311,7 @@ export interface DescribeConnectionResponse {
1160
1311
  */
1161
1312
  export interface DescribeEventBusRequest {
1162
1313
  /**
1314
+ * @public
1163
1315
  * <p>The name or ARN of the event bus to show details for. If you omit this, the default event
1164
1316
  * bus is displayed.</p>
1165
1317
  */
@@ -1170,15 +1322,18 @@ export interface DescribeEventBusRequest {
1170
1322
  */
1171
1323
  export interface DescribeEventBusResponse {
1172
1324
  /**
1325
+ * @public
1173
1326
  * <p>The name of the event bus. Currently, this is always <code>default</code>.</p>
1174
1327
  */
1175
1328
  Name?: string;
1176
1329
  /**
1330
+ * @public
1177
1331
  * <p>The Amazon Resource Name (ARN) of the account permitted to write events to the current
1178
1332
  * account.</p>
1179
1333
  */
1180
1334
  Arn?: string;
1181
1335
  /**
1336
+ * @public
1182
1337
  * <p>The policy that enables the external account to send events to your account.</p>
1183
1338
  */
1184
1339
  Policy?: string;
@@ -1188,6 +1343,7 @@ export interface DescribeEventBusResponse {
1188
1343
  */
1189
1344
  export interface DescribeEventSourceRequest {
1190
1345
  /**
1346
+ * @public
1191
1347
  * <p>The name of the partner event source to display the details of.</p>
1192
1348
  */
1193
1349
  Name: string | undefined;
@@ -1210,27 +1366,33 @@ export type EventSourceState = (typeof EventSourceState)[keyof typeof EventSourc
1210
1366
  */
1211
1367
  export interface DescribeEventSourceResponse {
1212
1368
  /**
1369
+ * @public
1213
1370
  * <p>The ARN of the partner event source.</p>
1214
1371
  */
1215
1372
  Arn?: string;
1216
1373
  /**
1374
+ * @public
1217
1375
  * <p>The name of the SaaS partner that created the event source.</p>
1218
1376
  */
1219
1377
  CreatedBy?: string;
1220
1378
  /**
1379
+ * @public
1221
1380
  * <p>The date and time that the event source was created.</p>
1222
1381
  */
1223
1382
  CreationTime?: Date;
1224
1383
  /**
1384
+ * @public
1225
1385
  * <p>The date and time that the event source will expire if you do not create a matching event
1226
1386
  * bus.</p>
1227
1387
  */
1228
1388
  ExpirationTime?: Date;
1229
1389
  /**
1390
+ * @public
1230
1391
  * <p>The name of the partner event source.</p>
1231
1392
  */
1232
1393
  Name?: string;
1233
1394
  /**
1395
+ * @public
1234
1396
  * <p>The state of the event source. If it is ACTIVE, you have already created a matching event
1235
1397
  * bus for this event source, and that event bus is active. If it is PENDING, either you haven't
1236
1398
  * yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have
@@ -1243,6 +1405,7 @@ export interface DescribeEventSourceResponse {
1243
1405
  */
1244
1406
  export interface DescribePartnerEventSourceRequest {
1245
1407
  /**
1408
+ * @public
1246
1409
  * <p>The name of the event source to display.</p>
1247
1410
  */
1248
1411
  Name: string | undefined;
@@ -1252,10 +1415,12 @@ export interface DescribePartnerEventSourceRequest {
1252
1415
  */
1253
1416
  export interface DescribePartnerEventSourceResponse {
1254
1417
  /**
1418
+ * @public
1255
1419
  * <p>The ARN of the event source.</p>
1256
1420
  */
1257
1421
  Arn?: string;
1258
1422
  /**
1423
+ * @public
1259
1424
  * <p>The name of the event source.</p>
1260
1425
  */
1261
1426
  Name?: string;
@@ -1265,6 +1430,7 @@ export interface DescribePartnerEventSourceResponse {
1265
1430
  */
1266
1431
  export interface DescribeReplayRequest {
1267
1432
  /**
1433
+ * @public
1268
1434
  * <p>The name of the replay to retrieve.</p>
1269
1435
  */
1270
1436
  ReplayName: string | undefined;
@@ -1275,11 +1441,13 @@ export interface DescribeReplayRequest {
1275
1441
  */
1276
1442
  export interface ReplayDestination {
1277
1443
  /**
1444
+ * @public
1278
1445
  * <p>The ARN of the event bus to replay event to. You can replay events only to the event bus
1279
1446
  * specified to create the archive.</p>
1280
1447
  */
1281
1448
  Arn: string | undefined;
1282
1449
  /**
1450
+ * @public
1283
1451
  * <p>A list of ARNs for rules to replay events to.</p>
1284
1452
  */
1285
1453
  FilterArns?: string[];
@@ -1289,50 +1457,62 @@ export interface ReplayDestination {
1289
1457
  */
1290
1458
  export interface DescribeReplayResponse {
1291
1459
  /**
1460
+ * @public
1292
1461
  * <p>The name of the replay.</p>
1293
1462
  */
1294
1463
  ReplayName?: string;
1295
1464
  /**
1465
+ * @public
1296
1466
  * <p>The ARN of the replay.</p>
1297
1467
  */
1298
1468
  ReplayArn?: string;
1299
1469
  /**
1470
+ * @public
1300
1471
  * <p>The description of the replay.</p>
1301
1472
  */
1302
1473
  Description?: string;
1303
1474
  /**
1475
+ * @public
1304
1476
  * <p>The current state of the replay.</p>
1305
1477
  */
1306
1478
  State?: ReplayState | string;
1307
1479
  /**
1480
+ * @public
1308
1481
  * <p>The reason that the replay is in the current state.</p>
1309
1482
  */
1310
1483
  StateReason?: string;
1311
1484
  /**
1485
+ * @public
1312
1486
  * <p>The ARN of the archive events were replayed from.</p>
1313
1487
  */
1314
1488
  EventSourceArn?: string;
1315
1489
  /**
1490
+ * @public
1316
1491
  * <p>A <code>ReplayDestination</code> object that contains details about the replay.</p>
1317
1492
  */
1318
1493
  Destination?: ReplayDestination;
1319
1494
  /**
1495
+ * @public
1320
1496
  * <p>The time stamp of the first event that was last replayed from the archive.</p>
1321
1497
  */
1322
1498
  EventStartTime?: Date;
1323
1499
  /**
1500
+ * @public
1324
1501
  * <p>The time stamp for the last event that was replayed from the archive.</p>
1325
1502
  */
1326
1503
  EventEndTime?: Date;
1327
1504
  /**
1505
+ * @public
1328
1506
  * <p>The time that the event was last replayed.</p>
1329
1507
  */
1330
1508
  EventLastReplayedTime?: Date;
1331
1509
  /**
1510
+ * @public
1332
1511
  * <p>A time stamp for the time that the replay started.</p>
1333
1512
  */
1334
1513
  ReplayStartTime?: Date;
1335
1514
  /**
1515
+ * @public
1336
1516
  * <p>A time stamp for the time that the replay stopped.</p>
1337
1517
  */
1338
1518
  ReplayEndTime?: Date;
@@ -1342,10 +1522,12 @@ export interface DescribeReplayResponse {
1342
1522
  */
1343
1523
  export interface DescribeRuleRequest {
1344
1524
  /**
1525
+ * @public
1345
1526
  * <p>The name of the rule.</p>
1346
1527
  */
1347
1528
  Name: string | undefined;
1348
1529
  /**
1530
+ * @public
1349
1531
  * <p>The name or ARN of the event bus associated with the rule. If you omit this, the default
1350
1532
  * event bus is used.</p>
1351
1533
  */
@@ -1368,44 +1550,54 @@ export type RuleState = (typeof RuleState)[keyof typeof RuleState];
1368
1550
  */
1369
1551
  export interface DescribeRuleResponse {
1370
1552
  /**
1553
+ * @public
1371
1554
  * <p>The name of the rule.</p>
1372
1555
  */
1373
1556
  Name?: string;
1374
1557
  /**
1558
+ * @public
1375
1559
  * <p>The Amazon Resource Name (ARN) of the rule.</p>
1376
1560
  */
1377
1561
  Arn?: string;
1378
1562
  /**
1563
+ * @public
1379
1564
  * <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
1380
1565
  * Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
1381
1566
  */
1382
1567
  EventPattern?: string;
1383
1568
  /**
1569
+ * @public
1384
1570
  * <p>The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".</p>
1385
1571
  */
1386
1572
  ScheduleExpression?: string;
1387
1573
  /**
1574
+ * @public
1388
1575
  * <p>Specifies whether the rule is enabled or disabled.</p>
1389
1576
  */
1390
1577
  State?: RuleState | string;
1391
1578
  /**
1579
+ * @public
1392
1580
  * <p>The description of the rule.</p>
1393
1581
  */
1394
1582
  Description?: string;
1395
1583
  /**
1584
+ * @public
1396
1585
  * <p>The Amazon Resource Name (ARN) of the IAM role associated with the rule.</p>
1397
1586
  */
1398
1587
  RoleArn?: string;
1399
1588
  /**
1589
+ * @public
1400
1590
  * <p>If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays
1401
1591
  * the principal name of the Amazon Web Services service that created the rule.</p>
1402
1592
  */
1403
1593
  ManagedBy?: string;
1404
1594
  /**
1595
+ * @public
1405
1596
  * <p>The name of the event bus associated with the rule.</p>
1406
1597
  */
1407
1598
  EventBusName?: string;
1408
1599
  /**
1600
+ * @public
1409
1601
  * <p>The account ID of the user that created the rule. If you use <code>PutRule</code> to put a
1410
1602
  * rule on an event bus in another account, the other account is the owner of the rule, and the
1411
1603
  * rule ARN includes the account ID for that account. However, the value for
@@ -1419,10 +1611,12 @@ export interface DescribeRuleResponse {
1419
1611
  */
1420
1612
  export interface DisableRuleRequest {
1421
1613
  /**
1614
+ * @public
1422
1615
  * <p>The name of the rule.</p>
1423
1616
  */
1424
1617
  Name: string | undefined;
1425
1618
  /**
1619
+ * @public
1426
1620
  * <p>The name or ARN of the event bus associated with the rule. If you omit this, the default
1427
1621
  * event bus is used.</p>
1428
1622
  */
@@ -1433,10 +1627,12 @@ export interface DisableRuleRequest {
1433
1627
  */
1434
1628
  export interface EnableRuleRequest {
1435
1629
  /**
1630
+ * @public
1436
1631
  * <p>The name of the rule.</p>
1437
1632
  */
1438
1633
  Name: string | undefined;
1439
1634
  /**
1635
+ * @public
1440
1636
  * <p>The name or ARN of the event bus associated with the rule. If you omit this, the default
1441
1637
  * event bus is used.</p>
1442
1638
  */
@@ -1447,19 +1643,23 @@ export interface EnableRuleRequest {
1447
1643
  */
1448
1644
  export interface ListApiDestinationsRequest {
1449
1645
  /**
1646
+ * @public
1450
1647
  * <p>A name prefix to filter results returned. Only API destinations with a name that starts
1451
1648
  * with the prefix are returned.</p>
1452
1649
  */
1453
1650
  NamePrefix?: string;
1454
1651
  /**
1652
+ * @public
1455
1653
  * <p>The ARN of the connection specified for the API destination.</p>
1456
1654
  */
1457
1655
  ConnectionArn?: string;
1458
1656
  /**
1657
+ * @public
1459
1658
  * <p>The token returned by a previous call to retrieve the next set of results.</p>
1460
1659
  */
1461
1660
  NextToken?: string;
1462
1661
  /**
1662
+ * @public
1463
1663
  * <p>The maximum number of API destinations to include in the response.</p>
1464
1664
  */
1465
1665
  Limit?: number;
@@ -1469,11 +1669,13 @@ export interface ListApiDestinationsRequest {
1469
1669
  */
1470
1670
  export interface ListApiDestinationsResponse {
1471
1671
  /**
1672
+ * @public
1472
1673
  * <p>An array of <code>ApiDestination</code> objects that include information about an API
1473
1674
  * destination.</p>
1474
1675
  */
1475
1676
  ApiDestinations?: ApiDestination[];
1476
1677
  /**
1678
+ * @public
1477
1679
  * <p>A token you can use in a subsequent request to retrieve the next set of results.</p>
1478
1680
  */
1479
1681
  NextToken?: string;
@@ -1483,23 +1685,28 @@ export interface ListApiDestinationsResponse {
1483
1685
  */
1484
1686
  export interface ListArchivesRequest {
1485
1687
  /**
1688
+ * @public
1486
1689
  * <p>A name prefix to filter the archives returned. Only archives with name that match the
1487
1690
  * prefix are returned.</p>
1488
1691
  */
1489
1692
  NamePrefix?: string;
1490
1693
  /**
1694
+ * @public
1491
1695
  * <p>The ARN of the event source associated with the archive.</p>
1492
1696
  */
1493
1697
  EventSourceArn?: string;
1494
1698
  /**
1699
+ * @public
1495
1700
  * <p>The state of the archive.</p>
1496
1701
  */
1497
1702
  State?: ArchiveState | string;
1498
1703
  /**
1704
+ * @public
1499
1705
  * <p>The token returned by a previous call to retrieve the next set of results.</p>
1500
1706
  */
1501
1707
  NextToken?: string;
1502
1708
  /**
1709
+ * @public
1503
1710
  * <p>The maximum number of results to return.</p>
1504
1711
  */
1505
1712
  Limit?: number;
@@ -1509,10 +1716,12 @@ export interface ListArchivesRequest {
1509
1716
  */
1510
1717
  export interface ListArchivesResponse {
1511
1718
  /**
1719
+ * @public
1512
1720
  * <p>An array of <code>Archive</code> objects that include details about an archive.</p>
1513
1721
  */
1514
1722
  Archives?: Archive[];
1515
1723
  /**
1724
+ * @public
1516
1725
  * <p>The token returned by a previous call to retrieve the next set of results.</p>
1517
1726
  */
1518
1727
  NextToken?: string;
@@ -1522,19 +1731,23 @@ export interface ListArchivesResponse {
1522
1731
  */
1523
1732
  export interface ListConnectionsRequest {
1524
1733
  /**
1734
+ * @public
1525
1735
  * <p>A name prefix to filter results returned. Only connections with a name that starts with
1526
1736
  * the prefix are returned.</p>
1527
1737
  */
1528
1738
  NamePrefix?: string;
1529
1739
  /**
1740
+ * @public
1530
1741
  * <p>The state of the connection.</p>
1531
1742
  */
1532
1743
  ConnectionState?: ConnectionState | string;
1533
1744
  /**
1745
+ * @public
1534
1746
  * <p>The token returned by a previous call to retrieve the next set of results.</p>
1535
1747
  */
1536
1748
  NextToken?: string;
1537
1749
  /**
1750
+ * @public
1538
1751
  * <p>The maximum number of connections to return.</p>
1539
1752
  */
1540
1753
  Limit?: number;
@@ -1545,34 +1758,42 @@ export interface ListConnectionsRequest {
1545
1758
  */
1546
1759
  export interface Connection {
1547
1760
  /**
1761
+ * @public
1548
1762
  * <p>The ARN of the connection.</p>
1549
1763
  */
1550
1764
  ConnectionArn?: string;
1551
1765
  /**
1766
+ * @public
1552
1767
  * <p>The name of the connection.</p>
1553
1768
  */
1554
1769
  Name?: string;
1555
1770
  /**
1771
+ * @public
1556
1772
  * <p>The state of the connection.</p>
1557
1773
  */
1558
1774
  ConnectionState?: ConnectionState | string;
1559
1775
  /**
1776
+ * @public
1560
1777
  * <p>The reason that the connection is in the connection state.</p>
1561
1778
  */
1562
1779
  StateReason?: string;
1563
1780
  /**
1781
+ * @public
1564
1782
  * <p>The authorization type specified for the connection.</p>
1565
1783
  */
1566
1784
  AuthorizationType?: ConnectionAuthorizationType | string;
1567
1785
  /**
1786
+ * @public
1568
1787
  * <p>A time stamp for the time that the connection was created.</p>
1569
1788
  */
1570
1789
  CreationTime?: Date;
1571
1790
  /**
1791
+ * @public
1572
1792
  * <p>A time stamp for the time that the connection was last modified.</p>
1573
1793
  */
1574
1794
  LastModifiedTime?: Date;
1575
1795
  /**
1796
+ * @public
1576
1797
  * <p>A time stamp for the time that the connection was last authorized.</p>
1577
1798
  */
1578
1799
  LastAuthorizedTime?: Date;
@@ -1582,10 +1803,12 @@ export interface Connection {
1582
1803
  */
1583
1804
  export interface ListConnectionsResponse {
1584
1805
  /**
1806
+ * @public
1585
1807
  * <p>An array of connections objects that include details about the connections.</p>
1586
1808
  */
1587
1809
  Connections?: Connection[];
1588
1810
  /**
1811
+ * @public
1589
1812
  * <p>A token you can use in a subsequent request to retrieve the next set of results.</p>
1590
1813
  */
1591
1814
  NextToken?: string;
@@ -1595,15 +1818,18 @@ export interface ListConnectionsResponse {
1595
1818
  */
1596
1819
  export interface ListEventBusesRequest {
1597
1820
  /**
1821
+ * @public
1598
1822
  * <p>Specifying this limits the results to only those event buses with names that start with
1599
1823
  * the specified prefix.</p>
1600
1824
  */
1601
1825
  NamePrefix?: string;
1602
1826
  /**
1827
+ * @public
1603
1828
  * <p>The token returned by a previous call to retrieve the next set of results.</p>
1604
1829
  */
1605
1830
  NextToken?: string;
1606
1831
  /**
1832
+ * @public
1607
1833
  * <p>Specifying this limits the number of results returned by this operation. The operation
1608
1834
  * also returns a NextToken which you can use in a subsequent operation to retrieve the next set
1609
1835
  * of results.</p>
@@ -1620,14 +1846,17 @@ export interface ListEventBusesRequest {
1620
1846
  */
1621
1847
  export interface EventBus {
1622
1848
  /**
1849
+ * @public
1623
1850
  * <p>The name of the event bus.</p>
1624
1851
  */
1625
1852
  Name?: string;
1626
1853
  /**
1854
+ * @public
1627
1855
  * <p>The ARN of the event bus.</p>
1628
1856
  */
1629
1857
  Arn?: string;
1630
1858
  /**
1859
+ * @public
1631
1860
  * <p>The permissions policy of the event bus, describing which other Amazon Web Services accounts can write
1632
1861
  * events to this event bus.</p>
1633
1862
  */
@@ -1638,10 +1867,12 @@ export interface EventBus {
1638
1867
  */
1639
1868
  export interface ListEventBusesResponse {
1640
1869
  /**
1870
+ * @public
1641
1871
  * <p>This list of event buses.</p>
1642
1872
  */
1643
1873
  EventBuses?: EventBus[];
1644
1874
  /**
1875
+ * @public
1645
1876
  * <p>A token you can use in a subsequent operation to retrieve the next set of results.</p>
1646
1877
  */
1647
1878
  NextToken?: string;
@@ -1651,15 +1882,18 @@ export interface ListEventBusesResponse {
1651
1882
  */
1652
1883
  export interface ListEventSourcesRequest {
1653
1884
  /**
1885
+ * @public
1654
1886
  * <p>Specifying this limits the results to only those partner event sources with names that
1655
1887
  * start with the specified prefix.</p>
1656
1888
  */
1657
1889
  NamePrefix?: string;
1658
1890
  /**
1891
+ * @public
1659
1892
  * <p>The token returned by a previous call to retrieve the next set of results.</p>
1660
1893
  */
1661
1894
  NextToken?: string;
1662
1895
  /**
1896
+ * @public
1663
1897
  * <p>Specifying this limits the number of results returned by this operation. The operation
1664
1898
  * also returns a NextToken which you can use in a subsequent operation to retrieve the next set
1665
1899
  * of results.</p>
@@ -1674,27 +1908,33 @@ export interface ListEventSourcesRequest {
1674
1908
  */
1675
1909
  export interface EventSource {
1676
1910
  /**
1911
+ * @public
1677
1912
  * <p>The ARN of the event source.</p>
1678
1913
  */
1679
1914
  Arn?: string;
1680
1915
  /**
1916
+ * @public
1681
1917
  * <p>The name of the partner that created the event source.</p>
1682
1918
  */
1683
1919
  CreatedBy?: string;
1684
1920
  /**
1921
+ * @public
1685
1922
  * <p>The date and time the event source was created.</p>
1686
1923
  */
1687
1924
  CreationTime?: Date;
1688
1925
  /**
1926
+ * @public
1689
1927
  * <p>The date and time that the event source will expire, if the Amazon Web Services account doesn't create a
1690
1928
  * matching event bus for it.</p>
1691
1929
  */
1692
1930
  ExpirationTime?: Date;
1693
1931
  /**
1932
+ * @public
1694
1933
  * <p>The name of the event source.</p>
1695
1934
  */
1696
1935
  Name?: string;
1697
1936
  /**
1937
+ * @public
1698
1938
  * <p>The state of the event source. If it is ACTIVE, you have already created a matching event
1699
1939
  * bus for this event source, and that event bus is active. If it is PENDING, either you haven't
1700
1940
  * yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have
@@ -1707,10 +1947,12 @@ export interface EventSource {
1707
1947
  */
1708
1948
  export interface ListEventSourcesResponse {
1709
1949
  /**
1950
+ * @public
1710
1951
  * <p>The list of event sources.</p>
1711
1952
  */
1712
1953
  EventSources?: EventSource[];
1713
1954
  /**
1955
+ * @public
1714
1956
  * <p>A token you can use in a subsequent operation to retrieve the next set of results.</p>
1715
1957
  */
1716
1958
  NextToken?: string;
@@ -1720,15 +1962,18 @@ export interface ListEventSourcesResponse {
1720
1962
  */
1721
1963
  export interface ListPartnerEventSourceAccountsRequest {
1722
1964
  /**
1965
+ * @public
1723
1966
  * <p>The name of the partner event source to display account information about.</p>
1724
1967
  */
1725
1968
  EventSourceName: string | undefined;
1726
1969
  /**
1970
+ * @public
1727
1971
  * <p>The token returned by a previous call to this operation. Specifying this retrieves the
1728
1972
  * next set of results.</p>
1729
1973
  */
1730
1974
  NextToken?: string;
1731
1975
  /**
1976
+ * @public
1732
1977
  * <p>Specifying this limits the number of results returned by this operation. The operation
1733
1978
  * also returns a NextToken which you can use in a subsequent operation to retrieve the next set
1734
1979
  * of results.</p>
@@ -1741,19 +1986,23 @@ export interface ListPartnerEventSourceAccountsRequest {
1741
1986
  */
1742
1987
  export interface PartnerEventSourceAccount {
1743
1988
  /**
1989
+ * @public
1744
1990
  * <p>The Amazon Web Services account ID that the partner event source was offered to.</p>
1745
1991
  */
1746
1992
  Account?: string;
1747
1993
  /**
1994
+ * @public
1748
1995
  * <p>The date and time the event source was created.</p>
1749
1996
  */
1750
1997
  CreationTime?: Date;
1751
1998
  /**
1999
+ * @public
1752
2000
  * <p>The date and time that the event source will expire, if the Amazon Web Services account doesn't create a
1753
2001
  * matching event bus for it.</p>
1754
2002
  */
1755
2003
  ExpirationTime?: Date;
1756
2004
  /**
2005
+ * @public
1757
2006
  * <p>The state of the event source. If it is ACTIVE, you have already created a matching event
1758
2007
  * bus for this event source, and that event bus is active. If it is PENDING, either you haven't
1759
2008
  * yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have
@@ -1766,10 +2015,12 @@ export interface PartnerEventSourceAccount {
1766
2015
  */
1767
2016
  export interface ListPartnerEventSourceAccountsResponse {
1768
2017
  /**
2018
+ * @public
1769
2019
  * <p>The list of partner event sources returned by the operation.</p>
1770
2020
  */
1771
2021
  PartnerEventSourceAccounts?: PartnerEventSourceAccount[];
1772
2022
  /**
2023
+ * @public
1773
2024
  * <p>A token you can use in a subsequent operation to retrieve the next set of results.</p>
1774
2025
  */
1775
2026
  NextToken?: string;
@@ -1779,16 +2030,19 @@ export interface ListPartnerEventSourceAccountsResponse {
1779
2030
  */
1780
2031
  export interface ListPartnerEventSourcesRequest {
1781
2032
  /**
2033
+ * @public
1782
2034
  * <p>If you specify this, the results are limited to only those partner event sources that
1783
2035
  * start with the string you specify.</p>
1784
2036
  */
1785
2037
  NamePrefix: string | undefined;
1786
2038
  /**
2039
+ * @public
1787
2040
  * <p>The token returned by a previous call to this operation. Specifying this retrieves the
1788
2041
  * next set of results.</p>
1789
2042
  */
1790
2043
  NextToken?: string;
1791
2044
  /**
2045
+ * @public
1792
2046
  * <p>pecifying this limits the number of results returned by this operation. The operation also
1793
2047
  * returns a NextToken which you can use in a subsequent operation to retrieve the next set of
1794
2048
  * results.</p>
@@ -1803,10 +2057,12 @@ export interface ListPartnerEventSourcesRequest {
1803
2057
  */
1804
2058
  export interface PartnerEventSource {
1805
2059
  /**
2060
+ * @public
1806
2061
  * <p>The ARN of the partner event source.</p>
1807
2062
  */
1808
2063
  Arn?: string;
1809
2064
  /**
2065
+ * @public
1810
2066
  * <p>The name of the partner event source.</p>
1811
2067
  */
1812
2068
  Name?: string;
@@ -1816,10 +2072,12 @@ export interface PartnerEventSource {
1816
2072
  */
1817
2073
  export interface ListPartnerEventSourcesResponse {
1818
2074
  /**
2075
+ * @public
1819
2076
  * <p>The list of partner event sources returned by the operation.</p>
1820
2077
  */
1821
2078
  PartnerEventSources?: PartnerEventSource[];
1822
2079
  /**
2080
+ * @public
1823
2081
  * <p>A token you can use in a subsequent operation to retrieve the next set of results.</p>
1824
2082
  */
1825
2083
  NextToken?: string;
@@ -1829,23 +2087,28 @@ export interface ListPartnerEventSourcesResponse {
1829
2087
  */
1830
2088
  export interface ListReplaysRequest {
1831
2089
  /**
2090
+ * @public
1832
2091
  * <p>A name prefix to filter the replays returned. Only replays with name that match the prefix
1833
2092
  * are returned.</p>
1834
2093
  */
1835
2094
  NamePrefix?: string;
1836
2095
  /**
2096
+ * @public
1837
2097
  * <p>The state of the replay.</p>
1838
2098
  */
1839
2099
  State?: ReplayState | string;
1840
2100
  /**
2101
+ * @public
1841
2102
  * <p>The ARN of the archive from which the events are replayed.</p>
1842
2103
  */
1843
2104
  EventSourceArn?: string;
1844
2105
  /**
2106
+ * @public
1845
2107
  * <p>The token returned by a previous call to retrieve the next set of results.</p>
1846
2108
  */
1847
2109
  NextToken?: string;
1848
2110
  /**
2111
+ * @public
1849
2112
  * <p>The maximum number of replays to retrieve.</p>
1850
2113
  */
1851
2114
  Limit?: number;
@@ -1856,40 +2119,49 @@ export interface ListReplaysRequest {
1856
2119
  */
1857
2120
  export interface Replay {
1858
2121
  /**
2122
+ * @public
1859
2123
  * <p>The name of the replay.</p>
1860
2124
  */
1861
2125
  ReplayName?: string;
1862
2126
  /**
2127
+ * @public
1863
2128
  * <p>The ARN of the archive to replay event from.</p>
1864
2129
  */
1865
2130
  EventSourceArn?: string;
1866
2131
  /**
2132
+ * @public
1867
2133
  * <p>The current state of the replay.</p>
1868
2134
  */
1869
2135
  State?: ReplayState | string;
1870
2136
  /**
2137
+ * @public
1871
2138
  * <p>A description of why the replay is in the current state.</p>
1872
2139
  */
1873
2140
  StateReason?: string;
1874
2141
  /**
2142
+ * @public
1875
2143
  * <p>A time stamp for the time to start replaying events. This is determined by the time in the
1876
2144
  * event as described in <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEventsRequestEntry.html#eventbridge-Type-PutEventsRequestEntry-Time">Time</a>.</p>
1877
2145
  */
1878
2146
  EventStartTime?: Date;
1879
2147
  /**
2148
+ * @public
1880
2149
  * <p>A time stamp for the time to start replaying events. Any event with a creation time prior
1881
2150
  * to the <code>EventEndTime</code> specified is replayed.</p>
1882
2151
  */
1883
2152
  EventEndTime?: Date;
1884
2153
  /**
2154
+ * @public
1885
2155
  * <p>A time stamp for the time that the last event was replayed.</p>
1886
2156
  */
1887
2157
  EventLastReplayedTime?: Date;
1888
2158
  /**
2159
+ * @public
1889
2160
  * <p>A time stamp for the time that the replay started.</p>
1890
2161
  */
1891
2162
  ReplayStartTime?: Date;
1892
2163
  /**
2164
+ * @public
1893
2165
  * <p>A time stamp for the time that the replay completed.</p>
1894
2166
  */
1895
2167
  ReplayEndTime?: Date;
@@ -1899,10 +2171,12 @@ export interface Replay {
1899
2171
  */
1900
2172
  export interface ListReplaysResponse {
1901
2173
  /**
2174
+ * @public
1902
2175
  * <p>An array of <code>Replay</code> objects that contain information about the replay.</p>
1903
2176
  */
1904
2177
  Replays?: Replay[];
1905
2178
  /**
2179
+ * @public
1906
2180
  * <p>The token returned by a previous call to retrieve the next set of results.</p>
1907
2181
  */
1908
2182
  NextToken?: string;
@@ -1912,19 +2186,23 @@ export interface ListReplaysResponse {
1912
2186
  */
1913
2187
  export interface ListRuleNamesByTargetRequest {
1914
2188
  /**
2189
+ * @public
1915
2190
  * <p>The Amazon Resource Name (ARN) of the target resource.</p>
1916
2191
  */
1917
2192
  TargetArn: string | undefined;
1918
2193
  /**
2194
+ * @public
1919
2195
  * <p>The name or ARN of the event bus to list rules for. If you omit this, the default event
1920
2196
  * bus is used.</p>
1921
2197
  */
1922
2198
  EventBusName?: string;
1923
2199
  /**
2200
+ * @public
1924
2201
  * <p>The token returned by a previous call to retrieve the next set of results.</p>
1925
2202
  */
1926
2203
  NextToken?: string;
1927
2204
  /**
2205
+ * @public
1928
2206
  * <p>The maximum number of results to return.</p>
1929
2207
  */
1930
2208
  Limit?: number;
@@ -1934,10 +2212,12 @@ export interface ListRuleNamesByTargetRequest {
1934
2212
  */
1935
2213
  export interface ListRuleNamesByTargetResponse {
1936
2214
  /**
2215
+ * @public
1937
2216
  * <p>The names of the rules that can invoke the given target.</p>
1938
2217
  */
1939
2218
  RuleNames?: string[];
1940
2219
  /**
2220
+ * @public
1941
2221
  * <p>Indicates whether there are additional results to retrieve. If there are no more results,
1942
2222
  * the value is null.</p>
1943
2223
  */
@@ -1948,19 +2228,23 @@ export interface ListRuleNamesByTargetResponse {
1948
2228
  */
1949
2229
  export interface ListRulesRequest {
1950
2230
  /**
2231
+ * @public
1951
2232
  * <p>The prefix matching the rule name.</p>
1952
2233
  */
1953
2234
  NamePrefix?: string;
1954
2235
  /**
2236
+ * @public
1955
2237
  * <p>The name or ARN of the event bus to list the rules for. If you omit this, the default
1956
2238
  * event bus is used.</p>
1957
2239
  */
1958
2240
  EventBusName?: string;
1959
2241
  /**
2242
+ * @public
1960
2243
  * <p>The token returned by a previous call to retrieve the next set of results.</p>
1961
2244
  */
1962
2245
  NextToken?: string;
1963
2246
  /**
2247
+ * @public
1964
2248
  * <p>The maximum number of results to return.</p>
1965
2249
  */
1966
2250
  Limit?: number;
@@ -1971,31 +2255,38 @@ export interface ListRulesRequest {
1971
2255
  */
1972
2256
  export interface Rule {
1973
2257
  /**
2258
+ * @public
1974
2259
  * <p>The name of the rule.</p>
1975
2260
  */
1976
2261
  Name?: string;
1977
2262
  /**
2263
+ * @public
1978
2264
  * <p>The Amazon Resource Name (ARN) of the rule.</p>
1979
2265
  */
1980
2266
  Arn?: string;
1981
2267
  /**
2268
+ * @public
1982
2269
  * <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
1983
2270
  * Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
1984
2271
  */
1985
2272
  EventPattern?: string;
1986
2273
  /**
2274
+ * @public
1987
2275
  * <p>The state of the rule.</p>
1988
2276
  */
1989
2277
  State?: RuleState | string;
1990
2278
  /**
2279
+ * @public
1991
2280
  * <p>The description of the rule.</p>
1992
2281
  */
1993
2282
  Description?: string;
1994
2283
  /**
2284
+ * @public
1995
2285
  * <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>
1996
2286
  */
1997
2287
  ScheduleExpression?: string;
1998
2288
  /**
2289
+ * @public
1999
2290
  * <p>The Amazon Resource Name (ARN) of the role that is used for target invocation.</p>
2000
2291
  * <p>If you're setting an event bus in another account as the target and that account granted
2001
2292
  * permission to your account through an organization instead of directly by the account ID, you
@@ -2004,11 +2295,13 @@ export interface Rule {
2004
2295
  */
2005
2296
  RoleArn?: string;
2006
2297
  /**
2298
+ * @public
2007
2299
  * <p>If the rule was created on behalf of your account by an Amazon Web Services service, this field displays
2008
2300
  * the principal name of the service that created the rule.</p>
2009
2301
  */
2010
2302
  ManagedBy?: string;
2011
2303
  /**
2304
+ * @public
2012
2305
  * <p>The name or ARN of the event bus associated with the rule. If you omit this, the default
2013
2306
  * event bus is used.</p>
2014
2307
  */
@@ -2019,10 +2312,12 @@ export interface Rule {
2019
2312
  */
2020
2313
  export interface ListRulesResponse {
2021
2314
  /**
2315
+ * @public
2022
2316
  * <p>The rules that match the specified criteria.</p>
2023
2317
  */
2024
2318
  Rules?: Rule[];
2025
2319
  /**
2320
+ * @public
2026
2321
  * <p>Indicates whether there are additional results to retrieve. If there are no more results,
2027
2322
  * the value is null.</p>
2028
2323
  */
@@ -2033,6 +2328,7 @@ export interface ListRulesResponse {
2033
2328
  */
2034
2329
  export interface ListTagsForResourceRequest {
2035
2330
  /**
2331
+ * @public
2036
2332
  * <p>The ARN of the EventBridge resource for which you want to view tags.</p>
2037
2333
  */
2038
2334
  ResourceARN: string | undefined;
@@ -2042,6 +2338,7 @@ export interface ListTagsForResourceRequest {
2042
2338
  */
2043
2339
  export interface ListTagsForResourceResponse {
2044
2340
  /**
2341
+ * @public
2045
2342
  * <p>The list of tag keys and values associated with the resource you specified</p>
2046
2343
  */
2047
2344
  Tags?: Tag[];
@@ -2051,19 +2348,23 @@ export interface ListTagsForResourceResponse {
2051
2348
  */
2052
2349
  export interface ListTargetsByRuleRequest {
2053
2350
  /**
2351
+ * @public
2054
2352
  * <p>The name of the rule.</p>
2055
2353
  */
2056
2354
  Rule: string | undefined;
2057
2355
  /**
2356
+ * @public
2058
2357
  * <p>The name or ARN of the event bus associated with the rule. If you omit this, the default
2059
2358
  * event bus is used.</p>
2060
2359
  */
2061
2360
  EventBusName?: string;
2062
2361
  /**
2362
+ * @public
2063
2363
  * <p>The token returned by a previous call to retrieve the next set of results.</p>
2064
2364
  */
2065
2365
  NextToken?: string;
2066
2366
  /**
2367
+ * @public
2067
2368
  * <p>The maximum number of results to return.</p>
2068
2369
  */
2069
2370
  Limit?: number;
@@ -2076,6 +2377,7 @@ export interface ListTargetsByRuleRequest {
2076
2377
  */
2077
2378
  export interface BatchArrayProperties {
2078
2379
  /**
2380
+ * @public
2079
2381
  * <p>The size of the array, if this is an array batch job. Valid values are integers between 2
2080
2382
  * and 10,000.</p>
2081
2383
  */
@@ -2089,6 +2391,7 @@ export interface BatchArrayProperties {
2089
2391
  */
2090
2392
  export interface BatchRetryStrategy {
2091
2393
  /**
2394
+ * @public
2092
2395
  * <p>The number of times to attempt to retry, if the job fails. Valid values are 1–10.</p>
2093
2396
  */
2094
2397
  Attempts?: number;
@@ -2099,21 +2402,25 @@ export interface BatchRetryStrategy {
2099
2402
  */
2100
2403
  export interface BatchParameters {
2101
2404
  /**
2405
+ * @public
2102
2406
  * <p>The ARN or name of the job definition to use if the event target is an Batch job. This
2103
2407
  * job definition must already exist.</p>
2104
2408
  */
2105
2409
  JobDefinition: string | undefined;
2106
2410
  /**
2411
+ * @public
2107
2412
  * <p>The name to use for this execution of the job, if the target is an Batch job.</p>
2108
2413
  */
2109
2414
  JobName: string | undefined;
2110
2415
  /**
2416
+ * @public
2111
2417
  * <p>The array properties for the submitted job, such as the size of the array. The array size
2112
2418
  * can be between 2 and 10,000. If you specify array properties for a job, it becomes an array
2113
2419
  * job. This parameter is used only if the target is an Batch job.</p>
2114
2420
  */
2115
2421
  ArrayProperties?: BatchArrayProperties;
2116
2422
  /**
2423
+ * @public
2117
2424
  * <p>The retry strategy to use for failed jobs, if the target is an Batch job. The retry
2118
2425
  * strategy is the number of times to retry the failed job execution. Valid values are 1–10. When
2119
2426
  * you specify a retry strategy here, it overrides the retry strategy defined in the job
@@ -2128,6 +2435,7 @@ export interface BatchParameters {
2128
2435
  */
2129
2436
  export interface DeadLetterConfig {
2130
2437
  /**
2438
+ * @public
2131
2439
  * <p>The ARN of the SQS queue specified as the target for the dead-letter queue.</p>
2132
2440
  */
2133
2441
  Arn?: string;
@@ -2138,16 +2446,19 @@ export interface DeadLetterConfig {
2138
2446
  */
2139
2447
  export interface CapacityProviderStrategyItem {
2140
2448
  /**
2449
+ * @public
2141
2450
  * <p>The short name of the capacity provider.</p>
2142
2451
  */
2143
2452
  capacityProvider: string | undefined;
2144
2453
  /**
2454
+ * @public
2145
2455
  * <p>The weight value designates the relative percentage of the total number of tasks launched
2146
2456
  * that should use the specified capacity provider. The weight value is taken into consideration
2147
2457
  * after the base value, if defined, is satisfied.</p>
2148
2458
  */
2149
2459
  weight?: number;
2150
2460
  /**
2461
+ * @public
2151
2462
  * <p>The base value designates how many tasks, at a minimum, to run on the specified capacity
2152
2463
  * provider. Only one capacity provider in a capacity provider strategy can have a base defined.
2153
2464
  * If no value is specified, the default value of 0 is used. </p>
@@ -2175,17 +2486,20 @@ export type LaunchType = (typeof LaunchType)[keyof typeof LaunchType];
2175
2486
  */
2176
2487
  export interface AwsVpcConfiguration {
2177
2488
  /**
2489
+ * @public
2178
2490
  * <p>Specifies the subnets associated with the task. These subnets must all be in the same VPC.
2179
2491
  * You can specify as many as 16 subnets.</p>
2180
2492
  */
2181
2493
  Subnets: string[] | undefined;
2182
2494
  /**
2495
+ * @public
2183
2496
  * <p>Specifies the security groups associated with the task. These security groups must all be
2184
2497
  * in the same VPC. You can specify as many as five security groups. If you do not specify a
2185
2498
  * security group, the default security group for the VPC is used.</p>
2186
2499
  */
2187
2500
  SecurityGroups?: string[];
2188
2501
  /**
2502
+ * @public
2189
2503
  * <p>Specifies whether the task's elastic network interface receives a public IP address. You
2190
2504
  * can specify <code>ENABLED</code> only when <code>LaunchType</code> in
2191
2505
  * <code>EcsParameters</code> is set to <code>FARGATE</code>.</p>
@@ -2198,6 +2512,7 @@ export interface AwsVpcConfiguration {
2198
2512
  */
2199
2513
  export interface NetworkConfiguration {
2200
2514
  /**
2515
+ * @public
2201
2516
  * <p>Use this structure to specify the VPC subnets and security groups for the task, and
2202
2517
  * whether a public IP address is to be used. This structure is relevant only for ECS tasks that
2203
2518
  * use the <code>awsvpc</code> network mode.</p>
@@ -2223,12 +2538,14 @@ export type PlacementConstraintType = (typeof PlacementConstraintType)[keyof typ
2223
2538
  */
2224
2539
  export interface PlacementConstraint {
2225
2540
  /**
2541
+ * @public
2226
2542
  * <p>The type of constraint. Use distinctInstance to ensure that each task in a particular
2227
2543
  * group is running on a different container instance. Use memberOf to restrict the selection to
2228
2544
  * a group of valid candidates. </p>
2229
2545
  */
2230
2546
  type?: PlacementConstraintType | string;
2231
2547
  /**
2548
+ * @public
2232
2549
  * <p>A cluster query language expression to apply to the constraint. You cannot specify an
2233
2550
  * 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.
2234
2551
  * </p>
@@ -2255,6 +2572,7 @@ export type PlacementStrategyType = (typeof PlacementStrategyType)[keyof typeof
2255
2572
  */
2256
2573
  export interface PlacementStrategy {
2257
2574
  /**
2575
+ * @public
2258
2576
  * <p>The type of placement strategy. The random placement strategy randomly places tasks on
2259
2577
  * available candidates. The spread placement strategy spreads placement across available
2260
2578
  * candidates evenly based on the field parameter. The binpack strategy places tasks on available
@@ -2264,6 +2582,7 @@ export interface PlacementStrategy {
2264
2582
  */
2265
2583
  type?: PlacementStrategyType | string;
2266
2584
  /**
2585
+ * @public
2267
2586
  * <p>The field to apply the placement strategy against. For the spread placement strategy,
2268
2587
  * valid values are instanceId (or host, which has the same effect), or any platform or custom
2269
2588
  * attribute that is applied to a container instance, such as attribute:ecs.availability-zone.
@@ -2289,15 +2608,18 @@ export type PropagateTags = (typeof PropagateTags)[keyof typeof PropagateTags];
2289
2608
  */
2290
2609
  export interface EcsParameters {
2291
2610
  /**
2611
+ * @public
2292
2612
  * <p>The ARN of the task definition to use if the event target is an Amazon ECS task. </p>
2293
2613
  */
2294
2614
  TaskDefinitionArn: string | undefined;
2295
2615
  /**
2616
+ * @public
2296
2617
  * <p>The number of tasks to create based on <code>TaskDefinition</code>. The default is
2297
2618
  * 1.</p>
2298
2619
  */
2299
2620
  TaskCount?: number;
2300
2621
  /**
2622
+ * @public
2301
2623
  * <p>Specifies the launch type on which your task is running. The launch type that you specify
2302
2624
  * here must match one of the launch type (compatibilities) of the target task. The
2303
2625
  * <code>FARGATE</code> value is supported only in the Regions where Fargate witt Amazon ECS
@@ -2306,6 +2628,7 @@ export interface EcsParameters {
2306
2628
  */
2307
2629
  LaunchType?: LaunchType | string;
2308
2630
  /**
2631
+ * @public
2309
2632
  * <p>Use this structure if the Amazon ECS task uses the <code>awsvpc</code> network mode. This
2310
2633
  * structure specifies the VPC subnets and security groups associated with the task, and whether
2311
2634
  * a public IP address is to be used. This structure is required if <code>LaunchType</code> is
@@ -2316,6 +2639,7 @@ export interface EcsParameters {
2316
2639
  */
2317
2640
  NetworkConfiguration?: NetworkConfiguration;
2318
2641
  /**
2642
+ * @public
2319
2643
  * <p>Specifies the platform version for the task. Specify only the numeric portion of the
2320
2644
  * platform version, such as <code>1.1.0</code>.</p>
2321
2645
  * <p>This structure is used only if <code>LaunchType</code> is <code>FARGATE</code>. For more
@@ -2325,10 +2649,12 @@ export interface EcsParameters {
2325
2649
  */
2326
2650
  PlatformVersion?: string;
2327
2651
  /**
2652
+ * @public
2328
2653
  * <p>Specifies an ECS task group for the task. The maximum length is 255 characters.</p>
2329
2654
  */
2330
2655
  Group?: string;
2331
2656
  /**
2657
+ * @public
2332
2658
  * <p>The capacity provider strategy to use for the task.</p>
2333
2659
  * <p>If a <code>capacityProviderStrategy</code> is specified, the <code>launchType</code>
2334
2660
  * parameter must be omitted. If no <code>capacityProviderStrategy</code> or launchType is
@@ -2336,39 +2662,46 @@ export interface EcsParameters {
2336
2662
  */
2337
2663
  CapacityProviderStrategy?: CapacityProviderStrategyItem[];
2338
2664
  /**
2665
+ * @public
2339
2666
  * <p>Specifies whether to enable Amazon ECS managed tags for the task. For more information,
2340
2667
  * 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
2341
2668
  * Guide. </p>
2342
2669
  */
2343
2670
  EnableECSManagedTags?: boolean;
2344
2671
  /**
2672
+ * @public
2345
2673
  * <p>Whether or not to enable the execute command functionality for the containers in this
2346
2674
  * task. If true, this enables execute command functionality on all containers in the
2347
2675
  * task.</p>
2348
2676
  */
2349
2677
  EnableExecuteCommand?: boolean;
2350
2678
  /**
2679
+ * @public
2351
2680
  * <p>An array of placement constraint objects to use for the task. You can specify up to 10
2352
2681
  * constraints per task (including constraints in the task definition and those specified at
2353
2682
  * runtime).</p>
2354
2683
  */
2355
2684
  PlacementConstraints?: PlacementConstraint[];
2356
2685
  /**
2686
+ * @public
2357
2687
  * <p>The placement strategy objects to use for the task. You can specify a maximum of five
2358
2688
  * strategy rules per task. </p>
2359
2689
  */
2360
2690
  PlacementStrategy?: PlacementStrategy[];
2361
2691
  /**
2692
+ * @public
2362
2693
  * <p>Specifies whether to propagate the tags from the task definition to the task. If no value
2363
2694
  * is specified, the tags are not propagated. Tags can only be propagated to the task during task
2364
2695
  * creation. To add tags to a task after task creation, use the TagResource API action. </p>
2365
2696
  */
2366
2697
  PropagateTags?: PropagateTags | string;
2367
2698
  /**
2699
+ * @public
2368
2700
  * <p>The reference ID to use for the task.</p>
2369
2701
  */
2370
2702
  ReferenceId?: string;
2371
2703
  /**
2704
+ * @public
2372
2705
  * <p>The metadata that you apply to the task to help you categorize and organize them. Each tag
2373
2706
  * 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>
2374
2707
  */
@@ -2383,16 +2716,19 @@ export interface EcsParameters {
2383
2716
  */
2384
2717
  export interface HttpParameters {
2385
2718
  /**
2719
+ * @public
2386
2720
  * <p>The path parameter values to be used to populate API Gateway REST API or EventBridge
2387
2721
  * ApiDestination path wildcards ("*").</p>
2388
2722
  */
2389
2723
  PathParameterValues?: string[];
2390
2724
  /**
2725
+ * @public
2391
2726
  * <p>The headers that need to be sent as part of request invoking the API Gateway REST API or
2392
2727
  * EventBridge ApiDestination.</p>
2393
2728
  */
2394
2729
  HeaderParameters?: Record<string, string>;
2395
2730
  /**
2731
+ * @public
2396
2732
  * <p>The query string keys/values that need to be sent as part of request invoking the API Gateway
2397
2733
  * REST API or EventBridge ApiDestination.</p>
2398
2734
  */
@@ -2405,6 +2741,7 @@ export interface HttpParameters {
2405
2741
  */
2406
2742
  export interface InputTransformer {
2407
2743
  /**
2744
+ * @public
2408
2745
  * <p>Map of JSON paths to be extracted from the event. You can then insert these in the
2409
2746
  * template in <code>InputTemplate</code> to produce the output you want to be sent to the
2410
2747
  * target.</p>
@@ -2416,6 +2753,7 @@ export interface InputTransformer {
2416
2753
  */
2417
2754
  InputPathsMap?: Record<string, string>;
2418
2755
  /**
2756
+ * @public
2419
2757
  * <p>Input template where you specify placeholders that will be filled with the values of the
2420
2758
  * keys from <code>InputPathsMap</code> to customize the data sent to the target. Enclose each
2421
2759
  * <code>InputPathsMaps</code> value in brackets: <<i>value</i>> The
@@ -2495,6 +2833,7 @@ export interface InputTransformer {
2495
2833
  */
2496
2834
  export interface KinesisParameters {
2497
2835
  /**
2836
+ * @public
2498
2837
  * <p>The JSON path to be extracted from the event and used as the partition key. For more
2499
2838
  * information, see <a href="https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html#partition-key">Amazon Kinesis Streams Key
2500
2839
  * Concepts</a> in the <i>Amazon Kinesis Streams Developer Guide</i>.</p>
@@ -2508,28 +2847,34 @@ export interface KinesisParameters {
2508
2847
  */
2509
2848
  export interface RedshiftDataParameters {
2510
2849
  /**
2850
+ * @public
2511
2851
  * <p>The name or ARN of the secret that enables access to the database. Required when
2512
2852
  * authenticating using Amazon Web Services Secrets Manager.</p>
2513
2853
  */
2514
2854
  SecretManagerArn?: string;
2515
2855
  /**
2856
+ * @public
2516
2857
  * <p>The name of the database. Required when authenticating using temporary credentials.</p>
2517
2858
  */
2518
2859
  Database: string | undefined;
2519
2860
  /**
2861
+ * @public
2520
2862
  * <p>The database user name. Required when authenticating using temporary credentials.</p>
2521
2863
  */
2522
2864
  DbUser?: string;
2523
2865
  /**
2866
+ * @public
2524
2867
  * <p>The SQL statement text to run.</p>
2525
2868
  */
2526
2869
  Sql: string | undefined;
2527
2870
  /**
2871
+ * @public
2528
2872
  * <p>The name of the SQL statement. You can name the SQL statement when you create it to
2529
2873
  * identify the query.</p>
2530
2874
  */
2531
2875
  StatementName?: string;
2532
2876
  /**
2877
+ * @public
2533
2878
  * <p>Indicates whether to send an event back to EventBridge after the SQL statement
2534
2879
  * runs.</p>
2535
2880
  */
@@ -2542,12 +2887,14 @@ export interface RedshiftDataParameters {
2542
2887
  */
2543
2888
  export interface RetryPolicy {
2544
2889
  /**
2890
+ * @public
2545
2891
  * <p>The maximum number of retry attempts to make before the request fails. Retry attempts
2546
2892
  * continue until either the maximum number of attempts is made or until the duration of the
2547
2893
  * <code>MaximumEventAgeInSeconds</code> is met.</p>
2548
2894
  */
2549
2895
  MaximumRetryAttempts?: number;
2550
2896
  /**
2897
+ * @public
2551
2898
  * <p>The maximum amount of time, in seconds, to continue to make retry attempts.</p>
2552
2899
  */
2553
2900
  MaximumEventAgeInSeconds?: number;
@@ -2560,12 +2907,14 @@ export interface RetryPolicy {
2560
2907
  */
2561
2908
  export interface RunCommandTarget {
2562
2909
  /**
2910
+ * @public
2563
2911
  * <p>Can be either <code>tag:</code>
2564
2912
  * <i>tag-key</i> or
2565
2913
  * <code>InstanceIds</code>.</p>
2566
2914
  */
2567
2915
  Key: string | undefined;
2568
2916
  /**
2917
+ * @public
2569
2918
  * <p>If <code>Key</code> is <code>tag:</code>
2570
2919
  * <i>tag-key</i>, <code>Values</code>
2571
2920
  * is a list of tag values. If <code>Key</code> is <code>InstanceIds</code>, <code>Values</code>
@@ -2580,6 +2929,7 @@ export interface RunCommandTarget {
2580
2929
  */
2581
2930
  export interface RunCommandParameters {
2582
2931
  /**
2932
+ * @public
2583
2933
  * <p>Currently, we support including only one RunCommandTarget block, which specifies either an
2584
2934
  * array of InstanceIds or a tag.</p>
2585
2935
  */
@@ -2592,10 +2942,12 @@ export interface RunCommandParameters {
2592
2942
  */
2593
2943
  export interface SageMakerPipelineParameter {
2594
2944
  /**
2945
+ * @public
2595
2946
  * <p>Name of parameter to start execution of a SageMaker Model Building Pipeline.</p>
2596
2947
  */
2597
2948
  Name: string | undefined;
2598
2949
  /**
2950
+ * @public
2599
2951
  * <p>Value of parameter to start execution of a SageMaker Model Building Pipeline.</p>
2600
2952
  */
2601
2953
  Value: string | undefined;
@@ -2607,6 +2959,7 @@ export interface SageMakerPipelineParameter {
2607
2959
  */
2608
2960
  export interface SageMakerPipelineParameters {
2609
2961
  /**
2962
+ * @public
2610
2963
  * <p>List of Parameter names and values for SageMaker Model Building Pipeline execution.</p>
2611
2964
  */
2612
2965
  PipelineParameterList?: SageMakerPipelineParameter[];
@@ -2618,6 +2971,7 @@ export interface SageMakerPipelineParameters {
2618
2971
  */
2619
2972
  export interface SqsParameters {
2620
2973
  /**
2974
+ * @public
2621
2975
  * <p>The FIFO message group ID to use as the target.</p>
2622
2976
  */
2623
2977
  MessageGroupId?: string;
@@ -2636,48 +2990,57 @@ export interface SqsParameters {
2636
2990
  */
2637
2991
  export interface Target {
2638
2992
  /**
2993
+ * @public
2639
2994
  * <p>The ID of the target. We recommend using a memorable and unique string.</p>
2640
2995
  */
2641
2996
  Id: string | undefined;
2642
2997
  /**
2998
+ * @public
2643
2999
  * <p>The Amazon Resource Name (ARN) of the target.</p>
2644
3000
  */
2645
3001
  Arn: string | undefined;
2646
3002
  /**
3003
+ * @public
2647
3004
  * <p>The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is
2648
3005
  * triggered. If one rule triggers multiple targets, you can use a different IAM role for each
2649
3006
  * target.</p>
2650
3007
  */
2651
3008
  RoleArn?: string;
2652
3009
  /**
3010
+ * @public
2653
3011
  * <p>Valid JSON text passed to the target. In this case, nothing from the event itself is
2654
3012
  * passed to the target. For more information, see <a href="http://www.rfc-editor.org/rfc/rfc7159.txt">The JavaScript Object Notation (JSON) Data
2655
3013
  * Interchange Format</a>.</p>
2656
3014
  */
2657
3015
  Input?: string;
2658
3016
  /**
3017
+ * @public
2659
3018
  * <p>The value of the JSONPath that is used for extracting part of the matched event when
2660
3019
  * passing it to the target. You must use JSON dot notation, not bracket notation. For more
2661
3020
  * information about JSON paths, see <a href="http://goessner.net/articles/JsonPath/">JSONPath</a>.</p>
2662
3021
  */
2663
3022
  InputPath?: string;
2664
3023
  /**
3024
+ * @public
2665
3025
  * <p>Settings to enable you to provide custom input to a target based on certain event data.
2666
3026
  * You can extract one or more key-value pairs from the event and then use that data to send
2667
3027
  * customized input to the target.</p>
2668
3028
  */
2669
3029
  InputTransformer?: InputTransformer;
2670
3030
  /**
3031
+ * @public
2671
3032
  * <p>The custom parameter you can use to control the shard assignment, when the target is a
2672
3033
  * Kinesis data stream. If you do not include this parameter, the default is to use the
2673
3034
  * <code>eventId</code> as the partition key.</p>
2674
3035
  */
2675
3036
  KinesisParameters?: KinesisParameters;
2676
3037
  /**
3038
+ * @public
2677
3039
  * <p>Parameters used when you are using the rule to invoke Amazon EC2 Run Command.</p>
2678
3040
  */
2679
3041
  RunCommandParameters?: RunCommandParameters;
2680
3042
  /**
3043
+ * @public
2681
3044
  * <p>Contains the Amazon ECS task definition and task count to be used, if the event target is
2682
3045
  * 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
2683
3046
  * Definitions </a> in the <i>Amazon EC2 Container Service Developer
@@ -2685,18 +3048,21 @@ export interface Target {
2685
3048
  */
2686
3049
  EcsParameters?: EcsParameters;
2687
3050
  /**
3051
+ * @public
2688
3052
  * <p>If the event target is an Batch job, this contains the job definition, job name, and
2689
3053
  * 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
2690
3054
  * Guide</i>.</p>
2691
3055
  */
2692
3056
  BatchParameters?: BatchParameters;
2693
3057
  /**
3058
+ * @public
2694
3059
  * <p>Contains the message group ID to use when the target is a FIFO queue.</p>
2695
3060
  * <p>If you specify an SQS FIFO queue as a target, the queue must have content-based
2696
3061
  * deduplication enabled.</p>
2697
3062
  */
2698
3063
  SqsParameters?: SqsParameters;
2699
3064
  /**
3065
+ * @public
2700
3066
  * <p>Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or
2701
3067
  * EventBridge ApiDestination.</p>
2702
3068
  * <p>If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can
@@ -2707,6 +3073,7 @@ export interface Target {
2707
3073
  */
2708
3074
  HttpParameters?: HttpParameters;
2709
3075
  /**
3076
+ * @public
2710
3077
  * <p>Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift
2711
3078
  * cluster.</p>
2712
3079
  * <p>If you specify a Amazon Redshift Cluster as a Target, you can use this to specify parameters to
@@ -2714,6 +3081,7 @@ export interface Target {
2714
3081
  */
2715
3082
  RedshiftDataParameters?: RedshiftDataParameters;
2716
3083
  /**
3084
+ * @public
2717
3085
  * <p>Contains the SageMaker Model Building Pipeline parameters to start execution of a
2718
3086
  * SageMaker Model Building Pipeline.</p>
2719
3087
  * <p>If you specify a SageMaker Model Building Pipeline as a target, you can use this to
@@ -2721,11 +3089,13 @@ export interface Target {
2721
3089
  */
2722
3090
  SageMakerPipelineParameters?: SageMakerPipelineParameters;
2723
3091
  /**
3092
+ * @public
2724
3093
  * <p>The <code>DeadLetterConfig</code> that defines the target queue to send dead-letter queue
2725
3094
  * events to.</p>
2726
3095
  */
2727
3096
  DeadLetterConfig?: DeadLetterConfig;
2728
3097
  /**
3098
+ * @public
2729
3099
  * <p>The <code>RetryPolicy</code> object that contains the retry policy configuration to use
2730
3100
  * for the dead-letter queue.</p>
2731
3101
  */
@@ -2736,10 +3106,12 @@ export interface Target {
2736
3106
  */
2737
3107
  export interface ListTargetsByRuleResponse {
2738
3108
  /**
3109
+ * @public
2739
3110
  * <p>The targets assigned to the rule.</p>
2740
3111
  */
2741
3112
  Targets?: Target[];
2742
3113
  /**
3114
+ * @public
2743
3115
  * <p>Indicates whether there are additional results to retrieve. If there are no more results,
2744
3116
  * the value is null.</p>
2745
3117
  */
@@ -2751,34 +3123,41 @@ export interface ListTargetsByRuleResponse {
2751
3123
  */
2752
3124
  export interface PutEventsRequestEntry {
2753
3125
  /**
3126
+ * @public
2754
3127
  * <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>
2755
3128
  */
2756
3129
  Time?: Date;
2757
3130
  /**
3131
+ * @public
2758
3132
  * <p>The source of the event.</p>
2759
3133
  */
2760
3134
  Source?: string;
2761
3135
  /**
3136
+ * @public
2762
3137
  * <p>Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily
2763
3138
  * concerns. Any number, including zero, may be present.</p>
2764
3139
  */
2765
3140
  Resources?: string[];
2766
3141
  /**
3142
+ * @public
2767
3143
  * <p>Free-form string used to decide what fields to expect in the event detail.</p>
2768
3144
  */
2769
3145
  DetailType?: string;
2770
3146
  /**
3147
+ * @public
2771
3148
  * <p>A valid JSON string. There is no other schema imposed. The JSON string may contain fields
2772
3149
  * and nested subobjects.</p>
2773
3150
  */
2774
3151
  Detail?: string;
2775
3152
  /**
3153
+ * @public
2776
3154
  * <p>The name or ARN of the event bus to receive the event. Only the rules that are associated
2777
3155
  * with this event bus are used to match the event. If you omit this, the default event bus is
2778
3156
  * used.</p>
2779
3157
  */
2780
3158
  EventBusName?: string;
2781
3159
  /**
3160
+ * @public
2782
3161
  * <p>An X-Ray trade header, which is an http header (X-Amzn-Trace-Id) that contains the
2783
3162
  * trace-id associated with the event.</p>
2784
3163
  * <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>
@@ -2790,6 +3169,7 @@ export interface PutEventsRequestEntry {
2790
3169
  */
2791
3170
  export interface PutEventsRequest {
2792
3171
  /**
3172
+ * @public
2793
3173
  * <p>The entry that defines an event in your system. You can specify several parameters for the
2794
3174
  * entry such as the source and type of the event, resources associated with the event, and so
2795
3175
  * on.</p>
@@ -2802,14 +3182,17 @@ export interface PutEventsRequest {
2802
3182
  */
2803
3183
  export interface PutEventsResultEntry {
2804
3184
  /**
3185
+ * @public
2805
3186
  * <p>The ID of the event.</p>
2806
3187
  */
2807
3188
  EventId?: string;
2808
3189
  /**
3190
+ * @public
2809
3191
  * <p>The error code that indicates why the event submission failed.</p>
2810
3192
  */
2811
3193
  ErrorCode?: string;
2812
3194
  /**
3195
+ * @public
2813
3196
  * <p>The error message that explains why the event submission failed.</p>
2814
3197
  */
2815
3198
  ErrorMessage?: string;
@@ -2819,10 +3202,12 @@ export interface PutEventsResultEntry {
2819
3202
  */
2820
3203
  export interface PutEventsResponse {
2821
3204
  /**
3205
+ * @public
2822
3206
  * <p>The number of failed entries.</p>
2823
3207
  */
2824
3208
  FailedEntryCount?: number;
2825
3209
  /**
3210
+ * @public
2826
3211
  * <p>The successfully and unsuccessfully ingested events results. If the ingestion was
2827
3212
  * successful, the entry has the event ID in it. Otherwise, you can use the error code and error
2828
3213
  * message to identify the problem with the entry.</p>
@@ -2835,23 +3220,28 @@ export interface PutEventsResponse {
2835
3220
  */
2836
3221
  export interface PutPartnerEventsRequestEntry {
2837
3222
  /**
3223
+ * @public
2838
3224
  * <p>The date and time of the event.</p>
2839
3225
  */
2840
3226
  Time?: Date;
2841
3227
  /**
3228
+ * @public
2842
3229
  * <p>The event source that is generating the entry.</p>
2843
3230
  */
2844
3231
  Source?: string;
2845
3232
  /**
3233
+ * @public
2846
3234
  * <p>Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily
2847
3235
  * concerns. Any number, including zero, may be present.</p>
2848
3236
  */
2849
3237
  Resources?: string[];
2850
3238
  /**
3239
+ * @public
2851
3240
  * <p>A free-form string used to decide what fields to expect in the event detail.</p>
2852
3241
  */
2853
3242
  DetailType?: string;
2854
3243
  /**
3244
+ * @public
2855
3245
  * <p>A valid JSON string. There is no other schema imposed. The JSON string may contain fields
2856
3246
  * and nested subobjects.</p>
2857
3247
  */
@@ -2862,6 +3252,7 @@ export interface PutPartnerEventsRequestEntry {
2862
3252
  */
2863
3253
  export interface PutPartnerEventsRequest {
2864
3254
  /**
3255
+ * @public
2865
3256
  * <p>The list of events to write to the event bus.</p>
2866
3257
  */
2867
3258
  Entries: PutPartnerEventsRequestEntry[] | undefined;
@@ -2872,14 +3263,17 @@ export interface PutPartnerEventsRequest {
2872
3263
  */
2873
3264
  export interface PutPartnerEventsResultEntry {
2874
3265
  /**
3266
+ * @public
2875
3267
  * <p>The ID of the event.</p>
2876
3268
  */
2877
3269
  EventId?: string;
2878
3270
  /**
3271
+ * @public
2879
3272
  * <p>The error code that indicates why the event submission failed.</p>
2880
3273
  */
2881
3274
  ErrorCode?: string;
2882
3275
  /**
3276
+ * @public
2883
3277
  * <p>The error message that explains why the event submission failed.</p>
2884
3278
  */
2885
3279
  ErrorMessage?: string;
@@ -2889,11 +3283,13 @@ export interface PutPartnerEventsResultEntry {
2889
3283
  */
2890
3284
  export interface PutPartnerEventsResponse {
2891
3285
  /**
3286
+ * @public
2892
3287
  * <p>The number of events from this operation that could not be written to the partner event
2893
3288
  * bus.</p>
2894
3289
  */
2895
3290
  FailedEntryCount?: number;
2896
3291
  /**
3292
+ * @public
2897
3293
  * <p>The list of events from this operation that were successfully written to the partner event
2898
3294
  * bus.</p>
2899
3295
  */
@@ -2925,16 +3321,19 @@ export declare class PolicyLengthExceededException extends __BaseException {
2925
3321
  */
2926
3322
  export interface Condition {
2927
3323
  /**
3324
+ * @public
2928
3325
  * <p>Specifies the type of condition. Currently the only supported value is
2929
3326
  * <code>StringEquals</code>.</p>
2930
3327
  */
2931
3328
  Type: string | undefined;
2932
3329
  /**
3330
+ * @public
2933
3331
  * <p>Specifies the key for the condition. Currently the only supported key is
2934
3332
  * <code>aws:PrincipalOrgID</code>.</p>
2935
3333
  */
2936
3334
  Key: string | undefined;
2937
3335
  /**
3336
+ * @public
2938
3337
  * <p>Specifies the value for the key. Currently, this must be the ID of the
2939
3338
  * organization.</p>
2940
3339
  */
@@ -2945,15 +3344,18 @@ export interface Condition {
2945
3344
  */
2946
3345
  export interface PutPermissionRequest {
2947
3346
  /**
3347
+ * @public
2948
3348
  * <p>The name of the event bus associated with the rule. If you omit this, the default event
2949
3349
  * bus is used.</p>
2950
3350
  */
2951
3351
  EventBusName?: string;
2952
3352
  /**
3353
+ * @public
2953
3354
  * <p>The action that you are enabling the other account to perform.</p>
2954
3355
  */
2955
3356
  Action?: string;
2956
3357
  /**
3358
+ * @public
2957
3359
  * <p>The 12-digit Amazon Web Services account ID that you are permitting to put events to your default event
2958
3360
  * bus. Specify "*" to permit any account to put events to your default event bus.</p>
2959
3361
  *
@@ -2965,12 +3367,14 @@ export interface PutPermissionRequest {
2965
3367
  */
2966
3368
  Principal?: string;
2967
3369
  /**
3370
+ * @public
2968
3371
  * <p>An identifier string for the external account that you are granting permissions to. If you
2969
3372
  * later want to revoke the permission for this external account, specify this
2970
3373
  * <code>StatementId</code> when you run <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemovePermission.html">RemovePermission</a>.</p>
2971
3374
  */
2972
3375
  StatementId?: string;
2973
3376
  /**
3377
+ * @public
2974
3378
  * <p>This parameter enables you to limit the permission to accounts that fulfill a certain
2975
3379
  * condition, such as being a member of a certain Amazon Web Services organization. For more information about
2976
3380
  * Amazon Web Services Organizations, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html">What Is Amazon Web Services
@@ -2984,6 +3388,7 @@ export interface PutPermissionRequest {
2984
3388
  */
2985
3389
  Condition?: Condition;
2986
3390
  /**
3391
+ * @public
2987
3392
  * <p>A JSON string that describes the permission policy statement. You can include a
2988
3393
  * <code>Policy</code> parameter in the request instead of using the <code>StatementId</code>,
2989
3394
  * <code>Action</code>, <code>Principal</code>, or <code>Condition</code> parameters.</p>
@@ -2995,27 +3400,33 @@ export interface PutPermissionRequest {
2995
3400
  */
2996
3401
  export interface PutRuleRequest {
2997
3402
  /**
3403
+ * @public
2998
3404
  * <p>The name of the rule that you are creating or updating.</p>
2999
3405
  */
3000
3406
  Name: string | undefined;
3001
3407
  /**
3408
+ * @public
3002
3409
  * <p>The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".</p>
3003
3410
  */
3004
3411
  ScheduleExpression?: string;
3005
3412
  /**
3413
+ * @public
3006
3414
  * <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
3007
3415
  * Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
3008
3416
  */
3009
3417
  EventPattern?: string;
3010
3418
  /**
3419
+ * @public
3011
3420
  * <p>Indicates whether the rule is enabled or disabled.</p>
3012
3421
  */
3013
3422
  State?: RuleState | string;
3014
3423
  /**
3424
+ * @public
3015
3425
  * <p>A description of the rule.</p>
3016
3426
  */
3017
3427
  Description?: string;
3018
3428
  /**
3429
+ * @public
3019
3430
  * <p>The Amazon Resource Name (ARN) of the IAM role associated with the rule.</p>
3020
3431
  * <p>If you're setting an event bus in another account as the target and that account granted
3021
3432
  * permission to your account through an organization instead of directly by the account ID, you
@@ -3024,10 +3435,12 @@ export interface PutRuleRequest {
3024
3435
  */
3025
3436
  RoleArn?: string;
3026
3437
  /**
3438
+ * @public
3027
3439
  * <p>The list of key-value pairs to associate with the rule.</p>
3028
3440
  */
3029
3441
  Tags?: Tag[];
3030
3442
  /**
3443
+ * @public
3031
3444
  * <p>The name or ARN of the event bus to associate with this rule. If you omit this, the
3032
3445
  * default event bus is used.</p>
3033
3446
  */
@@ -3038,6 +3451,7 @@ export interface PutRuleRequest {
3038
3451
  */
3039
3452
  export interface PutRuleResponse {
3040
3453
  /**
3454
+ * @public
3041
3455
  * <p>The Amazon Resource Name (ARN) of the rule.</p>
3042
3456
  */
3043
3457
  RuleArn?: string;
@@ -3047,15 +3461,18 @@ export interface PutRuleResponse {
3047
3461
  */
3048
3462
  export interface PutTargetsRequest {
3049
3463
  /**
3464
+ * @public
3050
3465
  * <p>The name of the rule.</p>
3051
3466
  */
3052
3467
  Rule: string | undefined;
3053
3468
  /**
3469
+ * @public
3054
3470
  * <p>The name or ARN of the event bus associated with the rule. If you omit this, the default
3055
3471
  * event bus is used.</p>
3056
3472
  */
3057
3473
  EventBusName?: string;
3058
3474
  /**
3475
+ * @public
3059
3476
  * <p>The targets to update or add to the rule.</p>
3060
3477
  */
3061
3478
  Targets: Target[] | undefined;
@@ -3066,16 +3483,19 @@ export interface PutTargetsRequest {
3066
3483
  */
3067
3484
  export interface PutTargetsResultEntry {
3068
3485
  /**
3486
+ * @public
3069
3487
  * <p>The ID of the target.</p>
3070
3488
  */
3071
3489
  TargetId?: string;
3072
3490
  /**
3491
+ * @public
3073
3492
  * <p>The error code that indicates why the target addition failed. If the value is
3074
3493
  * <code>ConcurrentModificationException</code>, too many requests were made at the same
3075
3494
  * time.</p>
3076
3495
  */
3077
3496
  ErrorCode?: string;
3078
3497
  /**
3498
+ * @public
3079
3499
  * <p>The error message that explains why the target addition failed.</p>
3080
3500
  */
3081
3501
  ErrorMessage?: string;
@@ -3085,10 +3505,12 @@ export interface PutTargetsResultEntry {
3085
3505
  */
3086
3506
  export interface PutTargetsResponse {
3087
3507
  /**
3508
+ * @public
3088
3509
  * <p>The number of failed entries.</p>
3089
3510
  */
3090
3511
  FailedEntryCount?: number;
3091
3512
  /**
3513
+ * @public
3092
3514
  * <p>The failed target entries.</p>
3093
3515
  */
3094
3516
  FailedEntries?: PutTargetsResultEntry[];
@@ -3098,15 +3520,18 @@ export interface PutTargetsResponse {
3098
3520
  */
3099
3521
  export interface RemovePermissionRequest {
3100
3522
  /**
3523
+ * @public
3101
3524
  * <p>The statement ID corresponding to the account that is no longer allowed to put events to
3102
3525
  * the default event bus.</p>
3103
3526
  */
3104
3527
  StatementId?: string;
3105
3528
  /**
3529
+ * @public
3106
3530
  * <p>Specifies whether to remove all permissions.</p>
3107
3531
  */
3108
3532
  RemoveAllPermissions?: boolean;
3109
3533
  /**
3534
+ * @public
3110
3535
  * <p>The name of the event bus to revoke permissions for. If you omit this, the default event
3111
3536
  * bus is used.</p>
3112
3537
  */
@@ -3117,19 +3542,23 @@ export interface RemovePermissionRequest {
3117
3542
  */
3118
3543
  export interface RemoveTargetsRequest {
3119
3544
  /**
3545
+ * @public
3120
3546
  * <p>The name of the rule.</p>
3121
3547
  */
3122
3548
  Rule: string | undefined;
3123
3549
  /**
3550
+ * @public
3124
3551
  * <p>The name or ARN of the event bus associated with the rule. If you omit this, the default
3125
3552
  * event bus is used.</p>
3126
3553
  */
3127
3554
  EventBusName?: string;
3128
3555
  /**
3556
+ * @public
3129
3557
  * <p>The IDs of the targets to remove from the rule.</p>
3130
3558
  */
3131
3559
  Ids: string[] | undefined;
3132
3560
  /**
3561
+ * @public
3133
3562
  * <p>If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify
3134
3563
  * <code>Force</code> as <code>True</code> to remove targets. This parameter is ignored for
3135
3564
  * rules that are not managed rules. You can check whether a rule is a managed rule by using
@@ -3144,16 +3573,19 @@ export interface RemoveTargetsRequest {
3144
3573
  */
3145
3574
  export interface RemoveTargetsResultEntry {
3146
3575
  /**
3576
+ * @public
3147
3577
  * <p>The ID of the target.</p>
3148
3578
  */
3149
3579
  TargetId?: string;
3150
3580
  /**
3581
+ * @public
3151
3582
  * <p>The error code that indicates why the target removal failed. If the value is
3152
3583
  * <code>ConcurrentModificationException</code>, too many requests were made at the same
3153
3584
  * time.</p>
3154
3585
  */
3155
3586
  ErrorCode?: string;
3156
3587
  /**
3588
+ * @public
3157
3589
  * <p>The error message that explains why the target removal failed.</p>
3158
3590
  */
3159
3591
  ErrorMessage?: string;
@@ -3163,10 +3595,12 @@ export interface RemoveTargetsResultEntry {
3163
3595
  */
3164
3596
  export interface RemoveTargetsResponse {
3165
3597
  /**
3598
+ * @public
3166
3599
  * <p>The number of failed entries.</p>
3167
3600
  */
3168
3601
  FailedEntryCount?: number;
3169
3602
  /**
3603
+ * @public
3170
3604
  * <p>The failed target entries.</p>
3171
3605
  */
3172
3606
  FailedEntries?: RemoveTargetsResultEntry[];
@@ -3176,28 +3610,34 @@ export interface RemoveTargetsResponse {
3176
3610
  */
3177
3611
  export interface StartReplayRequest {
3178
3612
  /**
3613
+ * @public
3179
3614
  * <p>The name of the replay to start.</p>
3180
3615
  */
3181
3616
  ReplayName: string | undefined;
3182
3617
  /**
3618
+ * @public
3183
3619
  * <p>A description for the replay to start.</p>
3184
3620
  */
3185
3621
  Description?: string;
3186
3622
  /**
3623
+ * @public
3187
3624
  * <p>The ARN of the archive to replay events from.</p>
3188
3625
  */
3189
3626
  EventSourceArn: string | undefined;
3190
3627
  /**
3628
+ * @public
3191
3629
  * <p>A time stamp for the time to start replaying events. Only events that occurred between the
3192
3630
  * <code>EventStartTime</code> and <code>EventEndTime</code> are replayed.</p>
3193
3631
  */
3194
3632
  EventStartTime: Date | undefined;
3195
3633
  /**
3634
+ * @public
3196
3635
  * <p>A time stamp for the time to stop replaying events. Only events that occurred between the
3197
3636
  * <code>EventStartTime</code> and <code>EventEndTime</code> are replayed.</p>
3198
3637
  */
3199
3638
  EventEndTime: Date | undefined;
3200
3639
  /**
3640
+ * @public
3201
3641
  * <p>A <code>ReplayDestination</code> object that includes details about the destination for
3202
3642
  * the replay.</p>
3203
3643
  */
@@ -3208,18 +3648,22 @@ export interface StartReplayRequest {
3208
3648
  */
3209
3649
  export interface StartReplayResponse {
3210
3650
  /**
3651
+ * @public
3211
3652
  * <p>The ARN of the replay.</p>
3212
3653
  */
3213
3654
  ReplayArn?: string;
3214
3655
  /**
3656
+ * @public
3215
3657
  * <p>The state of the replay.</p>
3216
3658
  */
3217
3659
  State?: ReplayState | string;
3218
3660
  /**
3661
+ * @public
3219
3662
  * <p>The reason that the replay is in the state.</p>
3220
3663
  */
3221
3664
  StateReason?: string;
3222
3665
  /**
3666
+ * @public
3223
3667
  * <p>The time at which the replay started.</p>
3224
3668
  */
3225
3669
  ReplayStartTime?: Date;
@@ -3229,10 +3673,12 @@ export interface StartReplayResponse {
3229
3673
  */
3230
3674
  export interface TagResourceRequest {
3231
3675
  /**
3676
+ * @public
3232
3677
  * <p>The ARN of the EventBridge resource that you're adding tags to.</p>
3233
3678
  */
3234
3679
  ResourceARN: string | undefined;
3235
3680
  /**
3681
+ * @public
3236
3682
  * <p>The list of key-value pairs to associate with the resource.</p>
3237
3683
  */
3238
3684
  Tags: Tag[] | undefined;
@@ -3247,11 +3693,13 @@ export interface TagResourceResponse {
3247
3693
  */
3248
3694
  export interface TestEventPatternRequest {
3249
3695
  /**
3696
+ * @public
3250
3697
  * <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
3251
3698
  * Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
3252
3699
  */
3253
3700
  EventPattern: string | undefined;
3254
3701
  /**
3702
+ * @public
3255
3703
  * <p>The event, in JSON format, to test against the event pattern. The JSON must follow the
3256
3704
  * format specified in <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/aws-events.html">Amazon Web Services Events</a>, and the following
3257
3705
  * fields are mandatory:</p>
@@ -3300,6 +3748,7 @@ export interface TestEventPatternRequest {
3300
3748
  */
3301
3749
  export interface TestEventPatternResponse {
3302
3750
  /**
3751
+ * @public
3303
3752
  * <p>Indicates whether the event matches the event pattern.</p>
3304
3753
  */
3305
3754
  Result?: boolean;
@@ -3309,10 +3758,12 @@ export interface TestEventPatternResponse {
3309
3758
  */
3310
3759
  export interface UntagResourceRequest {
3311
3760
  /**
3761
+ * @public
3312
3762
  * <p>The ARN of the EventBridge resource from which you are removing tags.</p>
3313
3763
  */
3314
3764
  ResourceARN: string | undefined;
3315
3765
  /**
3766
+ * @public
3316
3767
  * <p>The list of tag keys to remove from the resource.</p>
3317
3768
  */
3318
3769
  TagKeys: string[] | undefined;
@@ -3327,26 +3778,32 @@ export interface UntagResourceResponse {
3327
3778
  */
3328
3779
  export interface UpdateApiDestinationRequest {
3329
3780
  /**
3781
+ * @public
3330
3782
  * <p>The name of the API destination to update.</p>
3331
3783
  */
3332
3784
  Name: string | undefined;
3333
3785
  /**
3786
+ * @public
3334
3787
  * <p>The name of the API destination to update.</p>
3335
3788
  */
3336
3789
  Description?: string;
3337
3790
  /**
3791
+ * @public
3338
3792
  * <p>The ARN of the connection to use for the API destination.</p>
3339
3793
  */
3340
3794
  ConnectionArn?: string;
3341
3795
  /**
3796
+ * @public
3342
3797
  * <p>The URL to the endpoint to use for the API destination.</p>
3343
3798
  */
3344
3799
  InvocationEndpoint?: string;
3345
3800
  /**
3801
+ * @public
3346
3802
  * <p>The method to use for the API destination.</p>
3347
3803
  */
3348
3804
  HttpMethod?: ApiDestinationHttpMethod | string;
3349
3805
  /**
3806
+ * @public
3350
3807
  * <p>The maximum number of invocations per second to send to the API destination.</p>
3351
3808
  */
3352
3809
  InvocationRateLimitPerSecond?: number;
@@ -3356,18 +3813,22 @@ export interface UpdateApiDestinationRequest {
3356
3813
  */
3357
3814
  export interface UpdateApiDestinationResponse {
3358
3815
  /**
3816
+ * @public
3359
3817
  * <p>The ARN of the API destination that was updated.</p>
3360
3818
  */
3361
3819
  ApiDestinationArn?: string;
3362
3820
  /**
3821
+ * @public
3363
3822
  * <p>The state of the API destination that was updated.</p>
3364
3823
  */
3365
3824
  ApiDestinationState?: ApiDestinationState | string;
3366
3825
  /**
3826
+ * @public
3367
3827
  * <p>A time stamp for the time that the API destination was created.</p>
3368
3828
  */
3369
3829
  CreationTime?: Date;
3370
3830
  /**
3831
+ * @public
3371
3832
  * <p>A time stamp for the time that the API destination was last modified.</p>
3372
3833
  */
3373
3834
  LastModifiedTime?: Date;
@@ -3377,18 +3838,22 @@ export interface UpdateApiDestinationResponse {
3377
3838
  */
3378
3839
  export interface UpdateArchiveRequest {
3379
3840
  /**
3841
+ * @public
3380
3842
  * <p>The name of the archive to update.</p>
3381
3843
  */
3382
3844
  ArchiveName: string | undefined;
3383
3845
  /**
3846
+ * @public
3384
3847
  * <p>The description for the archive.</p>
3385
3848
  */
3386
3849
  Description?: string;
3387
3850
  /**
3851
+ * @public
3388
3852
  * <p>The event pattern to use to filter events sent to the archive.</p>
3389
3853
  */
3390
3854
  EventPattern?: string;
3391
3855
  /**
3856
+ * @public
3392
3857
  * <p>The number of days to retain events in the archive.</p>
3393
3858
  */
3394
3859
  RetentionDays?: number;
@@ -3398,18 +3863,22 @@ export interface UpdateArchiveRequest {
3398
3863
  */
3399
3864
  export interface UpdateArchiveResponse {
3400
3865
  /**
3866
+ * @public
3401
3867
  * <p>The ARN of the archive.</p>
3402
3868
  */
3403
3869
  ArchiveArn?: string;
3404
3870
  /**
3871
+ * @public
3405
3872
  * <p>The state of the archive.</p>
3406
3873
  */
3407
3874
  State?: ArchiveState | string;
3408
3875
  /**
3876
+ * @public
3409
3877
  * <p>The reason that the archive is in the current state.</p>
3410
3878
  */
3411
3879
  StateReason?: string;
3412
3880
  /**
3881
+ * @public
3413
3882
  * <p>The time at which the archive was updated.</p>
3414
3883
  */
3415
3884
  CreationTime?: Date;
@@ -3420,10 +3889,12 @@ export interface UpdateArchiveResponse {
3420
3889
  */
3421
3890
  export interface UpdateConnectionApiKeyAuthRequestParameters {
3422
3891
  /**
3892
+ * @public
3423
3893
  * <p>The name of the API key to use for authorization.</p>
3424
3894
  */
3425
3895
  ApiKeyName?: string;
3426
3896
  /**
3897
+ * @public
3427
3898
  * <p>The value associated with teh API key to use for authorization.</p>
3428
3899
  */
3429
3900
  ApiKeyValue?: string;
@@ -3434,10 +3905,12 @@ export interface UpdateConnectionApiKeyAuthRequestParameters {
3434
3905
  */
3435
3906
  export interface UpdateConnectionBasicAuthRequestParameters {
3436
3907
  /**
3908
+ * @public
3437
3909
  * <p>The user name to use for Basic authorization.</p>
3438
3910
  */
3439
3911
  Username?: string;
3440
3912
  /**
3913
+ * @public
3441
3914
  * <p>The password associated with the user name to use for Basic authorization.</p>
3442
3915
  */
3443
3916
  Password?: string;
@@ -3448,10 +3921,12 @@ export interface UpdateConnectionBasicAuthRequestParameters {
3448
3921
  */
3449
3922
  export interface UpdateConnectionOAuthClientRequestParameters {
3450
3923
  /**
3924
+ * @public
3451
3925
  * <p>The client ID to use for OAuth authorization.</p>
3452
3926
  */
3453
3927
  ClientID?: string;
3454
3928
  /**
3929
+ * @public
3455
3930
  * <p>The client secret assciated with the client ID to use for OAuth authorization.</p>
3456
3931
  */
3457
3932
  ClientSecret?: string;
@@ -3462,21 +3937,25 @@ export interface UpdateConnectionOAuthClientRequestParameters {
3462
3937
  */
3463
3938
  export interface UpdateConnectionOAuthRequestParameters {
3464
3939
  /**
3940
+ * @public
3465
3941
  * <p>A <code>UpdateConnectionOAuthClientRequestParameters</code> object that contains the
3466
3942
  * client parameters to use for the connection when OAuth is specified as the authorization
3467
3943
  * type.</p>
3468
3944
  */
3469
3945
  ClientParameters?: UpdateConnectionOAuthClientRequestParameters;
3470
3946
  /**
3947
+ * @public
3471
3948
  * <p>The URL to the authorization endpoint when OAuth is specified as the authorization
3472
3949
  * type.</p>
3473
3950
  */
3474
3951
  AuthorizationEndpoint?: string;
3475
3952
  /**
3953
+ * @public
3476
3954
  * <p>The method used to connect to the HTTP endpoint.</p>
3477
3955
  */
3478
3956
  HttpMethod?: ConnectionOAuthHttpMethod | string;
3479
3957
  /**
3958
+ * @public
3480
3959
  * <p>The additional HTTP parameters used for the OAuth authorization request.</p>
3481
3960
  */
3482
3961
  OAuthHttpParameters?: ConnectionHttpParameters;
@@ -3487,21 +3966,25 @@ export interface UpdateConnectionOAuthRequestParameters {
3487
3966
  */
3488
3967
  export interface UpdateConnectionAuthRequestParameters {
3489
3968
  /**
3969
+ * @public
3490
3970
  * <p>A <code>UpdateConnectionBasicAuthRequestParameters</code> object that contains the
3491
3971
  * authorization parameters for Basic authorization.</p>
3492
3972
  */
3493
3973
  BasicAuthParameters?: UpdateConnectionBasicAuthRequestParameters;
3494
3974
  /**
3975
+ * @public
3495
3976
  * <p>A <code>UpdateConnectionOAuthRequestParameters</code> object that contains the
3496
3977
  * authorization parameters for OAuth authorization.</p>
3497
3978
  */
3498
3979
  OAuthParameters?: UpdateConnectionOAuthRequestParameters;
3499
3980
  /**
3981
+ * @public
3500
3982
  * <p>A <code>UpdateConnectionApiKeyAuthRequestParameters</code> object that contains the
3501
3983
  * authorization parameters for API key authorization.</p>
3502
3984
  */
3503
3985
  ApiKeyAuthParameters?: UpdateConnectionApiKeyAuthRequestParameters;
3504
3986
  /**
3987
+ * @public
3505
3988
  * <p>A <code>ConnectionHttpParameters</code> object that contains the additional parameters to
3506
3989
  * use for the connection.</p>
3507
3990
  */
@@ -3512,18 +3995,22 @@ export interface UpdateConnectionAuthRequestParameters {
3512
3995
  */
3513
3996
  export interface UpdateConnectionRequest {
3514
3997
  /**
3998
+ * @public
3515
3999
  * <p>The name of the connection to update.</p>
3516
4000
  */
3517
4001
  Name: string | undefined;
3518
4002
  /**
4003
+ * @public
3519
4004
  * <p>A description for the connection.</p>
3520
4005
  */
3521
4006
  Description?: string;
3522
4007
  /**
4008
+ * @public
3523
4009
  * <p>The type of authorization to use for the connection.</p>
3524
4010
  */
3525
4011
  AuthorizationType?: ConnectionAuthorizationType | string;
3526
4012
  /**
4013
+ * @public
3527
4014
  * <p>The authorization parameters to use for the connection.</p>
3528
4015
  */
3529
4016
  AuthParameters?: UpdateConnectionAuthRequestParameters;
@@ -3533,22 +4020,27 @@ export interface UpdateConnectionRequest {
3533
4020
  */
3534
4021
  export interface UpdateConnectionResponse {
3535
4022
  /**
4023
+ * @public
3536
4024
  * <p>The ARN of the connection that was updated.</p>
3537
4025
  */
3538
4026
  ConnectionArn?: string;
3539
4027
  /**
4028
+ * @public
3540
4029
  * <p>The state of the connection that was updated.</p>
3541
4030
  */
3542
4031
  ConnectionState?: ConnectionState | string;
3543
4032
  /**
4033
+ * @public
3544
4034
  * <p>A time stamp for the time that the connection was created.</p>
3545
4035
  */
3546
4036
  CreationTime?: Date;
3547
4037
  /**
4038
+ * @public
3548
4039
  * <p>A time stamp for the time that the connection was last modified.</p>
3549
4040
  */
3550
4041
  LastModifiedTime?: Date;
3551
4042
  /**
4043
+ * @public
3552
4044
  * <p>A time stamp for the time that the connection was last authorized.</p>
3553
4045
  */
3554
4046
  LastAuthorizedTime?: Date;