@aws-sdk/client-pipes 3.379.1 → 3.382.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -19,15 +19,18 @@ export type AssignPublicIp = (typeof AssignPublicIp)[keyof typeof AssignPublicIp
19
19
  */
20
20
  export interface AwsVpcConfiguration {
21
21
  /**
22
+ * @public
22
23
  * <p>Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.</p>
23
24
  */
24
25
  Subnets: string[] | undefined;
25
26
  /**
27
+ * @public
26
28
  * <p>Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many
27
29
  * as five security groups. If you do not specify a security group, the default security group for the VPC is used.</p>
28
30
  */
29
31
  SecurityGroups?: string[];
30
32
  /**
33
+ * @public
31
34
  * <p>Specifies whether the task's elastic network interface receives a public IP address. You can specify <code>ENABLED</code> only when
32
35
  * <code>LaunchType</code> in <code>EcsParameters</code> is set to <code>FARGATE</code>.</p>
33
36
  */
@@ -40,6 +43,7 @@ export interface AwsVpcConfiguration {
40
43
  */
41
44
  export interface BatchArrayProperties {
42
45
  /**
46
+ * @public
43
47
  * <p>The size of the array, if this is an array batch job.</p>
44
48
  */
45
49
  Size?: number;
@@ -54,10 +58,12 @@ export interface BatchArrayProperties {
54
58
  */
55
59
  export interface BatchEnvironmentVariable {
56
60
  /**
61
+ * @public
57
62
  * <p>The name of the key-value pair. For environment variables, this is the name of the environment variable.</p>
58
63
  */
59
64
  Name?: string;
60
65
  /**
66
+ * @public
61
67
  * <p>The value of the key-value pair. For environment variables, this is the value of the environment variable.</p>
62
68
  */
63
69
  Value?: string;
@@ -81,10 +87,12 @@ export type BatchResourceRequirementType = (typeof BatchResourceRequirementType)
81
87
  */
82
88
  export interface BatchResourceRequirement {
83
89
  /**
90
+ * @public
84
91
  * <p>The type of resource to assign to a container. The supported resources include <code>GPU</code>, <code>MEMORY</code>, and <code>VCPU</code>.</p>
85
92
  */
86
93
  Type: BatchResourceRequirementType | string | undefined;
87
94
  /**
95
+ * @public
88
96
  * <p>The quantity of the specified resource to reserve for the container. The values vary based on the
89
97
  * <code>type</code> specified.</p>
90
98
  * <dl>
@@ -255,10 +263,12 @@ export interface BatchResourceRequirement {
255
263
  */
256
264
  export interface BatchContainerOverrides {
257
265
  /**
266
+ * @public
258
267
  * <p>The command to send to the container that overrides the default command from the Docker image or the task definition.</p>
259
268
  */
260
269
  Command?: string[];
261
270
  /**
271
+ * @public
262
272
  * <p>The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing
263
273
  * environment variables from the Docker image or the task definition.</p>
264
274
  * <note>
@@ -267,6 +277,7 @@ export interface BatchContainerOverrides {
267
277
  */
268
278
  Environment?: BatchEnvironmentVariable[];
269
279
  /**
280
+ * @public
270
281
  * <p>The instance type to use for a multi-node parallel job.</p>
271
282
  * <note>
272
283
  * <p>This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.</p>
@@ -274,6 +285,7 @@ export interface BatchContainerOverrides {
274
285
  */
275
286
  InstanceType?: string;
276
287
  /**
288
+ * @public
277
289
  * <p>The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include <code>GPU</code>, <code>MEMORY</code>,
278
290
  * and <code>VCPU</code>.</p>
279
291
  */
@@ -297,10 +309,12 @@ export type BatchJobDependencyType = (typeof BatchJobDependencyType)[keyof typeo
297
309
  */
298
310
  export interface BatchJobDependency {
299
311
  /**
312
+ * @public
300
313
  * <p>The job ID of the Batch job that's associated with this dependency.</p>
301
314
  */
302
315
  JobId?: string;
303
316
  /**
317
+ * @public
304
318
  * <p>The type of the job dependency.</p>
305
319
  */
306
320
  Type?: BatchJobDependencyType | string;
@@ -312,6 +326,7 @@ export interface BatchJobDependency {
312
326
  */
313
327
  export interface BatchRetryStrategy {
314
328
  /**
329
+ * @public
315
330
  * <p>The number of times to move a job to the <code>RUNNABLE</code> status. If the value of <code>attempts</code> is greater than one, the job is retried on
316
331
  * failure the same number of attempts as the value.</p>
317
332
  */
@@ -323,16 +338,19 @@ export interface BatchRetryStrategy {
323
338
  */
324
339
  export interface CapacityProviderStrategyItem {
325
340
  /**
341
+ * @public
326
342
  * <p>The short name of the capacity provider.</p>
327
343
  */
328
344
  capacityProvider: string | undefined;
329
345
  /**
346
+ * @public
330
347
  * <p>The weight value designates the relative percentage of the total number of tasks launched
331
348
  * that should use the specified capacity provider. The weight value is taken into consideration
332
349
  * after the base value, if defined, is satisfied.</p>
333
350
  */
334
351
  weight?: number;
335
352
  /**
353
+ * @public
336
354
  * <p>The base value designates how many tasks, at a minimum, to run on the specified capacity
337
355
  * provider. Only one capacity provider in a capacity provider strategy can have a base defined.
338
356
  * If no value is specified, the default value of 0 is used. </p>
@@ -347,10 +365,12 @@ export declare class ConflictException extends __BaseException {
347
365
  readonly name: "ConflictException";
348
366
  readonly $fault: "client";
349
367
  /**
368
+ * @public
350
369
  * <p>The ID of the resource that caused the exception.</p>
351
370
  */
352
371
  resourceId: string | undefined;
353
372
  /**
373
+ * @public
354
374
  * <p>The type of resource that caused the exception.</p>
355
375
  */
356
376
  resourceType: string | undefined;
@@ -380,16 +400,19 @@ export type RequestedPipeState = (typeof RequestedPipeState)[keyof typeof Reques
380
400
  */
381
401
  export interface PipeEnrichmentHttpParameters {
382
402
  /**
403
+ * @public
383
404
  * <p>The path parameter values to be used to populate API Gateway REST API or EventBridge
384
405
  * ApiDestination path wildcards ("*").</p>
385
406
  */
386
407
  PathParameterValues?: string[];
387
408
  /**
409
+ * @public
388
410
  * <p>The headers that need to be sent as part of request invoking the API Gateway REST API or
389
411
  * EventBridge ApiDestination.</p>
390
412
  */
391
413
  HeaderParameters?: Record<string, string>;
392
414
  /**
415
+ * @public
393
416
  * <p>The query string keys/values that need to be sent as part of request invoking the API Gateway
394
417
  * REST API or EventBridge ApiDestination.</p>
395
418
  */
@@ -401,12 +424,14 @@ export interface PipeEnrichmentHttpParameters {
401
424
  */
402
425
  export interface PipeEnrichmentParameters {
403
426
  /**
427
+ * @public
404
428
  * <p>Valid JSON text passed to the enrichment. In this case, nothing from the event itself is
405
429
  * passed to the enrichment. For more information, see <a href="http://www.rfc-editor.org/rfc/rfc7159.txt">The JavaScript Object Notation (JSON) Data
406
430
  * Interchange Format</a>.</p>
407
431
  */
408
432
  InputTemplate?: string;
409
433
  /**
434
+ * @public
410
435
  * <p>Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or
411
436
  * EventBridge ApiDestination.</p>
412
437
  * <p>If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can
@@ -427,12 +452,16 @@ export type MQBrokerAccessCredentials = MQBrokerAccessCredentials.BasicAuthMembe
427
452
  */
428
453
  export declare namespace MQBrokerAccessCredentials {
429
454
  /**
455
+ * @public
430
456
  * <p>The ARN of the Secrets Manager secret.</p>
431
457
  */
432
458
  interface BasicAuthMember {
433
459
  BasicAuth: string;
434
460
  $unknown?: never;
435
461
  }
462
+ /**
463
+ * @public
464
+ */
436
465
  interface $UnknownMember {
437
466
  BasicAuth?: never;
438
467
  $unknown: [string, any];
@@ -449,18 +478,22 @@ export declare namespace MQBrokerAccessCredentials {
449
478
  */
450
479
  export interface PipeSourceActiveMQBrokerParameters {
451
480
  /**
481
+ * @public
452
482
  * <p>The credentials needed to access the resource.</p>
453
483
  */
454
484
  Credentials: MQBrokerAccessCredentials | undefined;
455
485
  /**
486
+ * @public
456
487
  * <p>The name of the destination queue to consume.</p>
457
488
  */
458
489
  QueueName: string | undefined;
459
490
  /**
491
+ * @public
460
492
  * <p>The maximum number of records to include in each batch.</p>
461
493
  */
462
494
  BatchSize?: number;
463
495
  /**
496
+ * @public
464
497
  * <p>The maximum length of a time to wait for events.</p>
465
498
  */
466
499
  MaximumBatchingWindowInSeconds?: number;
@@ -471,6 +504,7 @@ export interface PipeSourceActiveMQBrokerParameters {
471
504
  */
472
505
  export interface DeadLetterConfig {
473
506
  /**
507
+ * @public
474
508
  * <p>The ARN of the Amazon SQS queue specified as the target for the dead-letter queue.</p>
475
509
  */
476
510
  Arn?: string;
@@ -504,37 +538,45 @@ export type DynamoDBStreamStartPosition = (typeof DynamoDBStreamStartPosition)[k
504
538
  */
505
539
  export interface PipeSourceDynamoDBStreamParameters {
506
540
  /**
541
+ * @public
507
542
  * <p>The maximum number of records to include in each batch.</p>
508
543
  */
509
544
  BatchSize?: number;
510
545
  /**
546
+ * @public
511
547
  * <p>Define the target queue to send dead-letter queue events to.</p>
512
548
  */
513
549
  DeadLetterConfig?: DeadLetterConfig;
514
550
  /**
551
+ * @public
515
552
  * <p>(Streams only) Define how to handle item process failures. <code>AUTOMATIC_BISECT</code> halves each batch and retry each half
516
553
  * until all the records are processed or there is one failed message left in the batch.</p>
517
554
  */
518
555
  OnPartialBatchItemFailure?: OnPartialBatchItemFailureStreams | string;
519
556
  /**
557
+ * @public
520
558
  * <p>The maximum length of a time to wait for events.</p>
521
559
  */
522
560
  MaximumBatchingWindowInSeconds?: number;
523
561
  /**
562
+ * @public
524
563
  * <p>(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite.
525
564
  * When the value is set to infinite, EventBridge never discards old records. </p>
526
565
  */
527
566
  MaximumRecordAgeInSeconds?: number;
528
567
  /**
568
+ * @public
529
569
  * <p>(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of
530
570
  * retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.</p>
531
571
  */
532
572
  MaximumRetryAttempts?: number;
533
573
  /**
574
+ * @public
534
575
  * <p>(Streams only) The number of batches to process concurrently from each shard. The default value is 1.</p>
535
576
  */
536
577
  ParallelizationFactor?: number;
537
578
  /**
579
+ * @public
538
580
  * <p>(Streams only) The position in a stream from which to start reading.</p>
539
581
  */
540
582
  StartingPosition: DynamoDBStreamStartPosition | string | undefined;
@@ -546,6 +588,7 @@ export interface PipeSourceDynamoDBStreamParameters {
546
588
  */
547
589
  export interface Filter {
548
590
  /**
591
+ * @public
549
592
  * <p>The event pattern.</p>
550
593
  */
551
594
  Pattern?: string;
@@ -557,6 +600,7 @@ export interface Filter {
557
600
  */
558
601
  export interface FilterCriteria {
559
602
  /**
603
+ * @public
560
604
  * <p>The event patterns.</p>
561
605
  */
562
606
  Filters?: Filter[];
@@ -580,41 +624,50 @@ export type KinesisStreamStartPosition = (typeof KinesisStreamStartPosition)[key
580
624
  */
581
625
  export interface PipeSourceKinesisStreamParameters {
582
626
  /**
627
+ * @public
583
628
  * <p>The maximum number of records to include in each batch.</p>
584
629
  */
585
630
  BatchSize?: number;
586
631
  /**
632
+ * @public
587
633
  * <p>Define the target queue to send dead-letter queue events to.</p>
588
634
  */
589
635
  DeadLetterConfig?: DeadLetterConfig;
590
636
  /**
637
+ * @public
591
638
  * <p>(Streams only) Define how to handle item process failures. <code>AUTOMATIC_BISECT</code> halves each batch and retry each half
592
639
  * until all the records are processed or there is one failed message left in the batch.</p>
593
640
  */
594
641
  OnPartialBatchItemFailure?: OnPartialBatchItemFailureStreams | string;
595
642
  /**
643
+ * @public
596
644
  * <p>The maximum length of a time to wait for events.</p>
597
645
  */
598
646
  MaximumBatchingWindowInSeconds?: number;
599
647
  /**
648
+ * @public
600
649
  * <p>(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite.
601
650
  * When the value is set to infinite, EventBridge never discards old records. </p>
602
651
  */
603
652
  MaximumRecordAgeInSeconds?: number;
604
653
  /**
654
+ * @public
605
655
  * <p>(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of
606
656
  * retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.</p>
607
657
  */
608
658
  MaximumRetryAttempts?: number;
609
659
  /**
660
+ * @public
610
661
  * <p>(Streams only) The number of batches to process concurrently from each shard. The default value is 1.</p>
611
662
  */
612
663
  ParallelizationFactor?: number;
613
664
  /**
665
+ * @public
614
666
  * <p>(Streams only) The position in a stream from which to start reading.</p>
615
667
  */
616
668
  StartingPosition: KinesisStreamStartPosition | string | undefined;
617
669
  /**
670
+ * @public
618
671
  * <p>With <code>StartingPosition</code> set to <code>AT_TIMESTAMP</code>, the time from which to start reading, in Unix time seconds.</p>
619
672
  */
620
673
  StartingPositionTimestamp?: Date;
@@ -629,6 +682,7 @@ export type MSKAccessCredentials = MSKAccessCredentials.ClientCertificateTlsAuth
629
682
  */
630
683
  export declare namespace MSKAccessCredentials {
631
684
  /**
685
+ * @public
632
686
  * <p>The ARN of the Secrets Manager secret.</p>
633
687
  */
634
688
  interface SaslScram512AuthMember {
@@ -637,6 +691,7 @@ export declare namespace MSKAccessCredentials {
637
691
  $unknown?: never;
638
692
  }
639
693
  /**
694
+ * @public
640
695
  * <p>The ARN of the Secrets Manager secret.</p>
641
696
  */
642
697
  interface ClientCertificateTlsAuthMember {
@@ -644,6 +699,9 @@ export declare namespace MSKAccessCredentials {
644
699
  ClientCertificateTlsAuth: string;
645
700
  $unknown?: never;
646
701
  }
702
+ /**
703
+ * @public
704
+ */
647
705
  interface $UnknownMember {
648
706
  SaslScram512Auth?: never;
649
707
  ClientCertificateTlsAuth?: never;
@@ -674,26 +732,32 @@ export type MSKStartPosition = (typeof MSKStartPosition)[keyof typeof MSKStartPo
674
732
  */
675
733
  export interface PipeSourceManagedStreamingKafkaParameters {
676
734
  /**
735
+ * @public
677
736
  * <p>The name of the topic that the pipe will read from.</p>
678
737
  */
679
738
  TopicName: string | undefined;
680
739
  /**
740
+ * @public
681
741
  * <p>(Streams only) The position in a stream from which to start reading.</p>
682
742
  */
683
743
  StartingPosition?: MSKStartPosition | string;
684
744
  /**
745
+ * @public
685
746
  * <p>The maximum number of records to include in each batch.</p>
686
747
  */
687
748
  BatchSize?: number;
688
749
  /**
750
+ * @public
689
751
  * <p>The maximum length of a time to wait for events.</p>
690
752
  */
691
753
  MaximumBatchingWindowInSeconds?: number;
692
754
  /**
755
+ * @public
693
756
  * <p>The name of the destination queue to consume.</p>
694
757
  */
695
758
  ConsumerGroupID?: string;
696
759
  /**
760
+ * @public
697
761
  * <p>The credentials needed to access the resource.</p>
698
762
  */
699
763
  Credentials?: MSKAccessCredentials;
@@ -704,22 +768,27 @@ export interface PipeSourceManagedStreamingKafkaParameters {
704
768
  */
705
769
  export interface PipeSourceRabbitMQBrokerParameters {
706
770
  /**
771
+ * @public
707
772
  * <p>The credentials needed to access the resource.</p>
708
773
  */
709
774
  Credentials: MQBrokerAccessCredentials | undefined;
710
775
  /**
776
+ * @public
711
777
  * <p>The name of the destination queue to consume.</p>
712
778
  */
713
779
  QueueName: string | undefined;
714
780
  /**
781
+ * @public
715
782
  * <p>The name of the virtual host associated with the source broker.</p>
716
783
  */
717
784
  VirtualHost?: string;
718
785
  /**
786
+ * @public
719
787
  * <p>The maximum number of records to include in each batch.</p>
720
788
  */
721
789
  BatchSize?: number;
722
790
  /**
791
+ * @public
723
792
  * <p>The maximum length of a time to wait for events.</p>
724
793
  */
725
794
  MaximumBatchingWindowInSeconds?: number;
@@ -734,6 +803,7 @@ export type SelfManagedKafkaAccessConfigurationCredentials = SelfManagedKafkaAcc
734
803
  */
735
804
  export declare namespace SelfManagedKafkaAccessConfigurationCredentials {
736
805
  /**
806
+ * @public
737
807
  * <p>The ARN of the Secrets Manager secret.</p>
738
808
  */
739
809
  interface BasicAuthMember {
@@ -744,6 +814,7 @@ export declare namespace SelfManagedKafkaAccessConfigurationCredentials {
744
814
  $unknown?: never;
745
815
  }
746
816
  /**
817
+ * @public
747
818
  * <p>The ARN of the Secrets Manager secret.</p>
748
819
  */
749
820
  interface SaslScram512AuthMember {
@@ -754,6 +825,7 @@ export declare namespace SelfManagedKafkaAccessConfigurationCredentials {
754
825
  $unknown?: never;
755
826
  }
756
827
  /**
828
+ * @public
757
829
  * <p>The ARN of the Secrets Manager secret.</p>
758
830
  */
759
831
  interface SaslScram256AuthMember {
@@ -764,6 +836,7 @@ export declare namespace SelfManagedKafkaAccessConfigurationCredentials {
764
836
  $unknown?: never;
765
837
  }
766
838
  /**
839
+ * @public
767
840
  * <p>The ARN of the Secrets Manager secret.</p>
768
841
  */
769
842
  interface ClientCertificateTlsAuthMember {
@@ -773,6 +846,9 @@ export declare namespace SelfManagedKafkaAccessConfigurationCredentials {
773
846
  ClientCertificateTlsAuth: string;
774
847
  $unknown?: never;
775
848
  }
849
+ /**
850
+ * @public
851
+ */
776
852
  interface $UnknownMember {
777
853
  BasicAuth?: never;
778
854
  SaslScram512Auth?: never;
@@ -807,10 +883,12 @@ export type SelfManagedKafkaStartPosition = (typeof SelfManagedKafkaStartPositio
807
883
  */
808
884
  export interface SelfManagedKafkaAccessConfigurationVpc {
809
885
  /**
886
+ * @public
810
887
  * <p>Specifies the subnets associated with the stream. These subnets must all be in the same VPC. You can specify as many as 16 subnets.</p>
811
888
  */
812
889
  Subnets?: string[];
813
890
  /**
891
+ * @public
814
892
  * <p>Specifies the security groups associated with the stream. These security groups must all be in the same VPC. You can specify as many
815
893
  * as five security groups. If you do not specify a security group, the default security group for the VPC is used.</p>
816
894
  */
@@ -822,38 +900,47 @@ export interface SelfManagedKafkaAccessConfigurationVpc {
822
900
  */
823
901
  export interface PipeSourceSelfManagedKafkaParameters {
824
902
  /**
903
+ * @public
825
904
  * <p>The name of the topic that the pipe will read from.</p>
826
905
  */
827
906
  TopicName: string | undefined;
828
907
  /**
908
+ * @public
829
909
  * <p>(Streams only) The position in a stream from which to start reading.</p>
830
910
  */
831
911
  StartingPosition?: SelfManagedKafkaStartPosition | string;
832
912
  /**
913
+ * @public
833
914
  * <p>An array of server URLs.</p>
834
915
  */
835
916
  AdditionalBootstrapServers?: string[];
836
917
  /**
918
+ * @public
837
919
  * <p>The maximum number of records to include in each batch.</p>
838
920
  */
839
921
  BatchSize?: number;
840
922
  /**
923
+ * @public
841
924
  * <p>The maximum length of a time to wait for events.</p>
842
925
  */
843
926
  MaximumBatchingWindowInSeconds?: number;
844
927
  /**
928
+ * @public
845
929
  * <p>The name of the destination queue to consume.</p>
846
930
  */
847
931
  ConsumerGroupID?: string;
848
932
  /**
933
+ * @public
849
934
  * <p>The credentials needed to access the resource.</p>
850
935
  */
851
936
  Credentials?: SelfManagedKafkaAccessConfigurationCredentials;
852
937
  /**
938
+ * @public
853
939
  * <p>The ARN of the Secrets Manager secret used for certification.</p>
854
940
  */
855
941
  ServerRootCaCertificate?: string;
856
942
  /**
943
+ * @public
857
944
  * <p>This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.</p>
858
945
  */
859
946
  Vpc?: SelfManagedKafkaAccessConfigurationVpc;
@@ -864,10 +951,12 @@ export interface PipeSourceSelfManagedKafkaParameters {
864
951
  */
865
952
  export interface PipeSourceSqsQueueParameters {
866
953
  /**
954
+ * @public
867
955
  * <p>The maximum number of records to include in each batch.</p>
868
956
  */
869
957
  BatchSize?: number;
870
958
  /**
959
+ * @public
871
960
  * <p>The maximum length of a time to wait for events.</p>
872
961
  */
873
962
  MaximumBatchingWindowInSeconds?: number;
@@ -878,35 +967,43 @@ export interface PipeSourceSqsQueueParameters {
878
967
  */
879
968
  export interface PipeSourceParameters {
880
969
  /**
970
+ * @public
881
971
  * <p>The collection of event patterns used to filter events. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html">Events and Event
882
972
  * Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
883
973
  */
884
974
  FilterCriteria?: FilterCriteria;
885
975
  /**
976
+ * @public
886
977
  * <p>The parameters for using a Kinesis stream as a source.</p>
887
978
  */
888
979
  KinesisStreamParameters?: PipeSourceKinesisStreamParameters;
889
980
  /**
981
+ * @public
890
982
  * <p>The parameters for using a DynamoDB stream as a source.</p>
891
983
  */
892
984
  DynamoDBStreamParameters?: PipeSourceDynamoDBStreamParameters;
893
985
  /**
986
+ * @public
894
987
  * <p>The parameters for using a Amazon SQS stream as a source.</p>
895
988
  */
896
989
  SqsQueueParameters?: PipeSourceSqsQueueParameters;
897
990
  /**
991
+ * @public
898
992
  * <p>The parameters for using an Active MQ broker as a source.</p>
899
993
  */
900
994
  ActiveMQBrokerParameters?: PipeSourceActiveMQBrokerParameters;
901
995
  /**
996
+ * @public
902
997
  * <p>The parameters for using a Rabbit MQ broker as a source.</p>
903
998
  */
904
999
  RabbitMQBrokerParameters?: PipeSourceRabbitMQBrokerParameters;
905
1000
  /**
1001
+ * @public
906
1002
  * <p>The parameters for using an MSK stream as a source.</p>
907
1003
  */
908
1004
  ManagedStreamingKafkaParameters?: PipeSourceManagedStreamingKafkaParameters;
909
1005
  /**
1006
+ * @public
910
1007
  * <p>The parameters for using a self-managed Apache Kafka stream as a source.</p>
911
1008
  */
912
1009
  SelfManagedKafkaParameters?: PipeSourceSelfManagedKafkaParameters;
@@ -917,29 +1014,35 @@ export interface PipeSourceParameters {
917
1014
  */
918
1015
  export interface PipeTargetBatchJobParameters {
919
1016
  /**
1017
+ * @public
920
1018
  * <p>The job definition used by this job. This value can be one of <code>name</code>, <code>name:revision</code>, or the Amazon Resource Name (ARN) for the job definition.
921
1019
  * If name is specified without a revision then the latest active revision is used.</p>
922
1020
  */
923
1021
  JobDefinition: string | undefined;
924
1022
  /**
1023
+ * @public
925
1024
  * <p>The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-),
926
1025
  * and underscores (_).</p>
927
1026
  */
928
1027
  JobName: string | undefined;
929
1028
  /**
1029
+ * @public
930
1030
  * <p>The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000.
931
1031
  * If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an Batch job.</p>
932
1032
  */
933
1033
  ArrayProperties?: BatchArrayProperties;
934
1034
  /**
1035
+ * @public
935
1036
  * <p>The retry strategy to use for failed jobs. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.</p>
936
1037
  */
937
1038
  RetryStrategy?: BatchRetryStrategy;
938
1039
  /**
1040
+ * @public
939
1041
  * <p>The overrides that are sent to a container.</p>
940
1042
  */
941
1043
  ContainerOverrides?: BatchContainerOverrides;
942
1044
  /**
1045
+ * @public
943
1046
  * <p>A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a <code>SEQUENTIAL</code> type dependency without
944
1047
  * specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an <code>N_TO_N</code>
945
1048
  * type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each
@@ -947,6 +1050,7 @@ export interface PipeTargetBatchJobParameters {
947
1050
  */
948
1051
  DependsOn?: BatchJobDependency[];
949
1052
  /**
1053
+ * @public
950
1054
  * <p>Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and
951
1055
  * value pair mapping. Parameters included here override any corresponding parameter defaults from the job definition.</p>
952
1056
  */
@@ -958,10 +1062,12 @@ export interface PipeTargetBatchJobParameters {
958
1062
  */
959
1063
  export interface PipeTargetCloudWatchLogsParameters {
960
1064
  /**
1065
+ * @public
961
1066
  * <p>The name of the log stream.</p>
962
1067
  */
963
1068
  LogStreamName?: string;
964
1069
  /**
1070
+ * @public
965
1071
  * <p>The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.</p>
966
1072
  */
967
1073
  Timestamp?: string;
@@ -985,6 +1091,7 @@ export type LaunchType = (typeof LaunchType)[keyof typeof LaunchType];
985
1091
  */
986
1092
  export interface NetworkConfiguration {
987
1093
  /**
1094
+ * @public
988
1095
  * <p>Use this structure to specify the VPC subnets and security groups for the task, and
989
1096
  * whether a public IP address is to be used. This structure is relevant only for ECS tasks that
990
1097
  * use the <code>awsvpc</code> network mode.</p>
@@ -998,10 +1105,12 @@ export interface NetworkConfiguration {
998
1105
  */
999
1106
  export interface EcsEnvironmentVariable {
1000
1107
  /**
1108
+ * @public
1001
1109
  * <p>The name of the key-value pair. For environment variables, this is the name of the environment variable.</p>
1002
1110
  */
1003
1111
  name?: string;
1004
1112
  /**
1113
+ * @public
1005
1114
  * <p>The value of the key-value pair. For environment variables, this is the value of the environment variable.</p>
1006
1115
  */
1007
1116
  value?: string;
@@ -1045,10 +1154,12 @@ export type EcsEnvironmentFileType = (typeof EcsEnvironmentFileType)[keyof typeo
1045
1154
  */
1046
1155
  export interface EcsEnvironmentFile {
1047
1156
  /**
1157
+ * @public
1048
1158
  * <p>The file type to use. The only supported value is <code>s3</code>.</p>
1049
1159
  */
1050
1160
  type: EcsEnvironmentFileType | string | undefined;
1051
1161
  /**
1162
+ * @public
1052
1163
  * <p>The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.</p>
1053
1164
  */
1054
1165
  value: string | undefined;
@@ -1076,11 +1187,13 @@ export type EcsResourceRequirementType = (typeof EcsResourceRequirementType)[key
1076
1187
  */
1077
1188
  export interface EcsResourceRequirement {
1078
1189
  /**
1190
+ * @public
1079
1191
  * <p>The type of resource to assign to a container. The supported values are
1080
1192
  * <code>GPU</code> or <code>InferenceAccelerator</code>.</p>
1081
1193
  */
1082
1194
  type: EcsResourceRequirementType | string | undefined;
1083
1195
  /**
1196
+ * @public
1084
1197
  * <p>The value for the specified resource type.</p>
1085
1198
  * <p>If the <code>GPU</code> type is used, the value is the number of physical
1086
1199
  * <code>GPUs</code> the Amazon ECS container agent reserves for the container. The number
@@ -1099,37 +1212,45 @@ export interface EcsResourceRequirement {
1099
1212
  */
1100
1213
  export interface EcsContainerOverride {
1101
1214
  /**
1215
+ * @public
1102
1216
  * <p>The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.</p>
1103
1217
  */
1104
1218
  Command?: string[];
1105
1219
  /**
1220
+ * @public
1106
1221
  * <p>The number of <code>cpu</code> units reserved for the container, instead of the default value from the task definition. You must also specify a container name.</p>
1107
1222
  */
1108
1223
  Cpu?: number;
1109
1224
  /**
1225
+ * @public
1110
1226
  * <p>The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can
1111
1227
  * override the existing environment variables from the Docker image or the task definition. You must also specify a container name.</p>
1112
1228
  */
1113
1229
  Environment?: EcsEnvironmentVariable[];
1114
1230
  /**
1231
+ * @public
1115
1232
  * <p>A list of files containing the environment variables to pass to a container, instead of the value from the container definition.</p>
1116
1233
  */
1117
1234
  EnvironmentFiles?: EcsEnvironmentFile[];
1118
1235
  /**
1236
+ * @public
1119
1237
  * <p>The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition.
1120
1238
  * If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.</p>
1121
1239
  */
1122
1240
  Memory?: number;
1123
1241
  /**
1242
+ * @public
1124
1243
  * <p>The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition.
1125
1244
  * You must also specify a container name.</p>
1126
1245
  */
1127
1246
  MemoryReservation?: number;
1128
1247
  /**
1248
+ * @public
1129
1249
  * <p>The name of the container that receives the override. This parameter is required if any override is specified.</p>
1130
1250
  */
1131
1251
  Name?: string;
1132
1252
  /**
1253
+ * @public
1133
1254
  * <p>The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.</p>
1134
1255
  */
1135
1256
  ResourceRequirements?: EcsResourceRequirement[];
@@ -1148,6 +1269,7 @@ export interface EcsContainerOverride {
1148
1269
  */
1149
1270
  export interface EcsEphemeralStorage {
1150
1271
  /**
1272
+ * @public
1151
1273
  * <p>The total amount, in GiB, of ephemeral storage to set for the task. The minimum
1152
1274
  * supported value is <code>21</code> GiB and the maximum supported value is
1153
1275
  * <code>200</code> GiB.</p>
@@ -1164,10 +1286,12 @@ export interface EcsEphemeralStorage {
1164
1286
  */
1165
1287
  export interface EcsInferenceAcceleratorOverride {
1166
1288
  /**
1289
+ * @public
1167
1290
  * <p>The Elastic Inference accelerator device name to override for the task. This parameter must match a <code>deviceName</code> specified in the task definition.</p>
1168
1291
  */
1169
1292
  deviceName?: string;
1170
1293
  /**
1294
+ * @public
1171
1295
  * <p>The Elastic Inference accelerator type to use.</p>
1172
1296
  */
1173
1297
  deviceType?: string;
@@ -1178,14 +1302,17 @@ export interface EcsInferenceAcceleratorOverride {
1178
1302
  */
1179
1303
  export interface EcsTaskOverride {
1180
1304
  /**
1305
+ * @public
1181
1306
  * <p>One or more container overrides that are sent to a task.</p>
1182
1307
  */
1183
1308
  ContainerOverrides?: EcsContainerOverride[];
1184
1309
  /**
1310
+ * @public
1185
1311
  * <p>The cpu override for the task.</p>
1186
1312
  */
1187
1313
  Cpu?: string;
1188
1314
  /**
1315
+ * @public
1189
1316
  * <p>The ephemeral storage setting override for the task.</p>
1190
1317
  * <note>
1191
1318
  * <p>This parameter is only supported for tasks hosted on Fargate that
@@ -1202,20 +1329,24 @@ export interface EcsTaskOverride {
1202
1329
  */
1203
1330
  EphemeralStorage?: EcsEphemeralStorage;
1204
1331
  /**
1332
+ * @public
1205
1333
  * <p>The Amazon Resource Name (ARN) of the task execution IAM role override for the task. For more
1206
1334
  * information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html">Amazon ECS task
1207
1335
  * execution IAM role</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
1208
1336
  */
1209
1337
  ExecutionRoleArn?: string;
1210
1338
  /**
1339
+ * @public
1211
1340
  * <p>The Elastic Inference accelerator override for the task.</p>
1212
1341
  */
1213
1342
  InferenceAcceleratorOverrides?: EcsInferenceAcceleratorOverride[];
1214
1343
  /**
1344
+ * @public
1215
1345
  * <p>The memory override for the task.</p>
1216
1346
  */
1217
1347
  Memory?: string;
1218
1348
  /**
1349
+ * @public
1219
1350
  * <p>The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers
1220
1351
  * in this task are granted the permissions that are specified in this role. For more
1221
1352
  * information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html">IAM Role for Tasks</a>
@@ -1242,12 +1373,14 @@ export type PlacementConstraintType = (typeof PlacementConstraintType)[keyof typ
1242
1373
  */
1243
1374
  export interface PlacementConstraint {
1244
1375
  /**
1376
+ * @public
1245
1377
  * <p>The type of constraint. Use distinctInstance to ensure that each task in a particular
1246
1378
  * group is running on a different container instance. Use memberOf to restrict the selection to
1247
1379
  * a group of valid candidates. </p>
1248
1380
  */
1249
1381
  type?: PlacementConstraintType | string;
1250
1382
  /**
1383
+ * @public
1251
1384
  * <p>A cluster query language expression to apply to the constraint. You cannot specify an
1252
1385
  * 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.
1253
1386
  * </p>
@@ -1274,6 +1407,7 @@ export type PlacementStrategyType = (typeof PlacementStrategyType)[keyof typeof
1274
1407
  */
1275
1408
  export interface PlacementStrategy {
1276
1409
  /**
1410
+ * @public
1277
1411
  * <p>The type of placement strategy. The random placement strategy randomly places tasks on
1278
1412
  * available candidates. The spread placement strategy spreads placement across available
1279
1413
  * candidates evenly based on the field parameter. The binpack strategy places tasks on available
@@ -1283,6 +1417,7 @@ export interface PlacementStrategy {
1283
1417
  */
1284
1418
  type?: PlacementStrategyType | string;
1285
1419
  /**
1420
+ * @public
1286
1421
  * <p>The field to apply the placement strategy against. For the spread placement strategy,
1287
1422
  * valid values are instanceId (or host, which has the same effect), or any platform or custom
1288
1423
  * attribute that is applied to a container instance, such as attribute:ecs.availability-zone.
@@ -1309,11 +1444,13 @@ export type PropagateTags = (typeof PropagateTags)[keyof typeof PropagateTags];
1309
1444
  */
1310
1445
  export interface Tag {
1311
1446
  /**
1447
+ * @public
1312
1448
  * <p>A string you can use to assign a value. The combination of tag keys and values can help
1313
1449
  * you organize and categorize your resources.</p>
1314
1450
  */
1315
1451
  Key: string | undefined;
1316
1452
  /**
1453
+ * @public
1317
1454
  * <p>The value for the specified tag key.</p>
1318
1455
  */
1319
1456
  Value: string | undefined;
@@ -1324,14 +1461,17 @@ export interface Tag {
1324
1461
  */
1325
1462
  export interface PipeTargetEcsTaskParameters {
1326
1463
  /**
1464
+ * @public
1327
1465
  * <p>The ARN of the task definition to use if the event target is an Amazon ECS task. </p>
1328
1466
  */
1329
1467
  TaskDefinitionArn: string | undefined;
1330
1468
  /**
1469
+ * @public
1331
1470
  * <p>The number of tasks to create based on <code>TaskDefinition</code>. The default is 1.</p>
1332
1471
  */
1333
1472
  TaskCount?: number;
1334
1473
  /**
1474
+ * @public
1335
1475
  * <p>Specifies the launch type on which your task is running. The launch type that you specify
1336
1476
  * here must match one of the launch type (compatibilities) of the target task. The
1337
1477
  * <code>FARGATE</code> value is supported only in the Regions where Fargate with Amazon ECS
@@ -1340,6 +1480,7 @@ export interface PipeTargetEcsTaskParameters {
1340
1480
  */
1341
1481
  LaunchType?: LaunchType | string;
1342
1482
  /**
1483
+ * @public
1343
1484
  * <p>Use this structure if the Amazon ECS task uses the <code>awsvpc</code> network mode. This
1344
1485
  * structure specifies the VPC subnets and security groups associated with the task, and whether
1345
1486
  * a public IP address is to be used. This structure is required if <code>LaunchType</code> is
@@ -1350,6 +1491,7 @@ export interface PipeTargetEcsTaskParameters {
1350
1491
  */
1351
1492
  NetworkConfiguration?: NetworkConfiguration;
1352
1493
  /**
1494
+ * @public
1353
1495
  * <p>Specifies the platform version for the task. Specify only the numeric portion of the
1354
1496
  * platform version, such as <code>1.1.0</code>.</p>
1355
1497
  * <p>This structure is used only if <code>LaunchType</code> is <code>FARGATE</code>. For more
@@ -1359,10 +1501,12 @@ export interface PipeTargetEcsTaskParameters {
1359
1501
  */
1360
1502
  PlatformVersion?: string;
1361
1503
  /**
1504
+ * @public
1362
1505
  * <p>Specifies an Amazon ECS task group for the task. The maximum length is 255 characters.</p>
1363
1506
  */
1364
1507
  Group?: string;
1365
1508
  /**
1509
+ * @public
1366
1510
  * <p>The capacity provider strategy to use for the task.</p>
1367
1511
  * <p>If a <code>capacityProviderStrategy</code> is specified, the <code>launchType</code>
1368
1512
  * parameter must be omitted. If no <code>capacityProviderStrategy</code> or launchType is
@@ -1370,43 +1514,51 @@ export interface PipeTargetEcsTaskParameters {
1370
1514
  */
1371
1515
  CapacityProviderStrategy?: CapacityProviderStrategyItem[];
1372
1516
  /**
1517
+ * @public
1373
1518
  * <p>Specifies whether to enable Amazon ECS managed tags for the task. For more information,
1374
1519
  * 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
1375
1520
  * Guide. </p>
1376
1521
  */
1377
1522
  EnableECSManagedTags?: boolean;
1378
1523
  /**
1524
+ * @public
1379
1525
  * <p>Whether or not to enable the execute command functionality for the containers in this
1380
1526
  * task. If true, this enables execute command functionality on all containers in the
1381
1527
  * task.</p>
1382
1528
  */
1383
1529
  EnableExecuteCommand?: boolean;
1384
1530
  /**
1531
+ * @public
1385
1532
  * <p>An array of placement constraint objects to use for the task. You can specify up to 10
1386
1533
  * constraints per task (including constraints in the task definition and those specified at
1387
1534
  * runtime).</p>
1388
1535
  */
1389
1536
  PlacementConstraints?: PlacementConstraint[];
1390
1537
  /**
1538
+ * @public
1391
1539
  * <p>The placement strategy objects to use for the task. You can specify a maximum of five
1392
1540
  * strategy rules per task. </p>
1393
1541
  */
1394
1542
  PlacementStrategy?: PlacementStrategy[];
1395
1543
  /**
1544
+ * @public
1396
1545
  * <p>Specifies whether to propagate the tags from the task definition to the task. If no value
1397
1546
  * is specified, the tags are not propagated. Tags can only be propagated to the task during task
1398
1547
  * creation. To add tags to a task after task creation, use the <code>TagResource</code> API action. </p>
1399
1548
  */
1400
1549
  PropagateTags?: PropagateTags | string;
1401
1550
  /**
1551
+ * @public
1402
1552
  * <p>The reference ID to use for the task.</p>
1403
1553
  */
1404
1554
  ReferenceId?: string;
1405
1555
  /**
1556
+ * @public
1406
1557
  * <p>The overrides that are associated with a task.</p>
1407
1558
  */
1408
1559
  Overrides?: EcsTaskOverride;
1409
1560
  /**
1561
+ * @public
1410
1562
  * <p>The metadata that you apply to the task to help you categorize and organize them. Each tag
1411
1563
  * 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>
1412
1564
  */
@@ -1418,6 +1570,7 @@ export interface PipeTargetEcsTaskParameters {
1418
1570
  */
1419
1571
  export interface PipeTargetEventBridgeEventBusParameters {
1420
1572
  /**
1573
+ * @public
1421
1574
  * <p>The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is <code>abcde.veo</code>.</p>
1422
1575
  * <important>
1423
1576
  * <p>When using Java, you must include <code>auth-crt</code> on the class path.</p>
@@ -1425,19 +1578,23 @@ export interface PipeTargetEventBridgeEventBusParameters {
1425
1578
  */
1426
1579
  EndpointId?: string;
1427
1580
  /**
1581
+ * @public
1428
1582
  * <p>A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.</p>
1429
1583
  */
1430
1584
  DetailType?: string;
1431
1585
  /**
1586
+ * @public
1432
1587
  * <p>The source of the event.</p>
1433
1588
  */
1434
1589
  Source?: string;
1435
1590
  /**
1591
+ * @public
1436
1592
  * <p>Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily
1437
1593
  * concerns. Any number, including zero, may be present.</p>
1438
1594
  */
1439
1595
  Resources?: string[];
1440
1596
  /**
1597
+ * @public
1441
1598
  * <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>
1442
1599
  */
1443
1600
  Time?: string;
@@ -1449,16 +1606,19 @@ export interface PipeTargetEventBridgeEventBusParameters {
1449
1606
  */
1450
1607
  export interface PipeTargetHttpParameters {
1451
1608
  /**
1609
+ * @public
1452
1610
  * <p>The path parameter values to be used to populate API Gateway REST API or EventBridge
1453
1611
  * ApiDestination path wildcards ("*").</p>
1454
1612
  */
1455
1613
  PathParameterValues?: string[];
1456
1614
  /**
1615
+ * @public
1457
1616
  * <p>The headers that need to be sent as part of request invoking the API Gateway REST API or
1458
1617
  * EventBridge ApiDestination.</p>
1459
1618
  */
1460
1619
  HeaderParameters?: Record<string, string>;
1461
1620
  /**
1621
+ * @public
1462
1622
  * <p>The query string keys/values that need to be sent as part of request invoking the API Gateway
1463
1623
  * REST API or EventBridge ApiDestination.</p>
1464
1624
  */
@@ -1470,6 +1630,7 @@ export interface PipeTargetHttpParameters {
1470
1630
  */
1471
1631
  export interface PipeTargetKinesisStreamParameters {
1472
1632
  /**
1633
+ * @public
1473
1634
  * <p>Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters
1474
1635
  * for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard.
1475
1636
  * Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this
@@ -1495,6 +1656,7 @@ export type PipeTargetInvocationType = (typeof PipeTargetInvocationType)[keyof t
1495
1656
  */
1496
1657
  export interface PipeTargetLambdaFunctionParameters {
1497
1658
  /**
1659
+ * @public
1498
1660
  * <p>Choose from the following options.</p>
1499
1661
  * <ul>
1500
1662
  * <li>
@@ -1524,29 +1686,35 @@ export interface PipeTargetLambdaFunctionParameters {
1524
1686
  */
1525
1687
  export interface PipeTargetRedshiftDataParameters {
1526
1688
  /**
1689
+ * @public
1527
1690
  * <p>The name or ARN of the secret that enables access to the database. Required when
1528
1691
  * authenticating using SageMaker.</p>
1529
1692
  */
1530
1693
  SecretManagerArn?: string;
1531
1694
  /**
1695
+ * @public
1532
1696
  * <p>The name of the database. Required when authenticating using temporary credentials.</p>
1533
1697
  */
1534
1698
  Database: string | undefined;
1535
1699
  /**
1700
+ * @public
1536
1701
  * <p>The database user name. Required when authenticating using temporary credentials.</p>
1537
1702
  */
1538
1703
  DbUser?: string;
1539
1704
  /**
1705
+ * @public
1540
1706
  * <p>The name of the SQL statement. You can name the SQL statement when you create it to
1541
1707
  * identify the query.</p>
1542
1708
  */
1543
1709
  StatementName?: string;
1544
1710
  /**
1711
+ * @public
1545
1712
  * <p>Indicates whether to send an event back to EventBridge after the SQL statement
1546
1713
  * runs.</p>
1547
1714
  */
1548
1715
  WithEvent?: boolean;
1549
1716
  /**
1717
+ * @public
1550
1718
  * <p>The SQL statement text to run.</p>
1551
1719
  */
1552
1720
  Sqls: string[] | undefined;
@@ -1558,10 +1726,12 @@ export interface PipeTargetRedshiftDataParameters {
1558
1726
  */
1559
1727
  export interface SageMakerPipelineParameter {
1560
1728
  /**
1729
+ * @public
1561
1730
  * <p>Name of parameter to start execution of a SageMaker Model Building Pipeline.</p>
1562
1731
  */
1563
1732
  Name: string | undefined;
1564
1733
  /**
1734
+ * @public
1565
1735
  * <p>Value of parameter to start execution of a SageMaker Model Building Pipeline.</p>
1566
1736
  */
1567
1737
  Value: string | undefined;
@@ -1572,6 +1742,7 @@ export interface SageMakerPipelineParameter {
1572
1742
  */
1573
1743
  export interface PipeTargetSageMakerPipelineParameters {
1574
1744
  /**
1745
+ * @public
1575
1746
  * <p>List of Parameter names and values for SageMaker Model Building Pipeline execution.</p>
1576
1747
  */
1577
1748
  PipelineParameterList?: SageMakerPipelineParameter[];
@@ -1582,10 +1753,12 @@ export interface PipeTargetSageMakerPipelineParameters {
1582
1753
  */
1583
1754
  export interface PipeTargetSqsQueueParameters {
1584
1755
  /**
1756
+ * @public
1585
1757
  * <p>The FIFO message group ID to use as the target.</p>
1586
1758
  */
1587
1759
  MessageGroupId?: string;
1588
1760
  /**
1761
+ * @public
1589
1762
  * <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
1590
1763
  * <p>The token used for deduplication of sent messages.</p>
1591
1764
  */
@@ -1597,6 +1770,7 @@ export interface PipeTargetSqsQueueParameters {
1597
1770
  */
1598
1771
  export interface PipeTargetStateMachineParameters {
1599
1772
  /**
1773
+ * @public
1600
1774
  * <p>Specify whether to wait for the state machine to finish or not.</p>
1601
1775
  */
1602
1776
  InvocationType?: PipeTargetInvocationType | string;
@@ -1607,54 +1781,66 @@ export interface PipeTargetStateMachineParameters {
1607
1781
  */
1608
1782
  export interface PipeTargetParameters {
1609
1783
  /**
1784
+ * @public
1610
1785
  * <p>Valid JSON text passed to the target. In this case, nothing from the event itself is
1611
1786
  * passed to the target. For more information, see <a href="http://www.rfc-editor.org/rfc/rfc7159.txt">The JavaScript Object Notation (JSON) Data
1612
1787
  * Interchange Format</a>.</p>
1613
1788
  */
1614
1789
  InputTemplate?: string;
1615
1790
  /**
1791
+ * @public
1616
1792
  * <p>The parameters for using a Lambda function as a target.</p>
1617
1793
  */
1618
1794
  LambdaFunctionParameters?: PipeTargetLambdaFunctionParameters;
1619
1795
  /**
1796
+ * @public
1620
1797
  * <p>The parameters for using a Step Functions state machine as a target.</p>
1621
1798
  */
1622
1799
  StepFunctionStateMachineParameters?: PipeTargetStateMachineParameters;
1623
1800
  /**
1801
+ * @public
1624
1802
  * <p>The parameters for using a Kinesis stream as a source.</p>
1625
1803
  */
1626
1804
  KinesisStreamParameters?: PipeTargetKinesisStreamParameters;
1627
1805
  /**
1806
+ * @public
1628
1807
  * <p>The parameters for using an Amazon ECS task as a target.</p>
1629
1808
  */
1630
1809
  EcsTaskParameters?: PipeTargetEcsTaskParameters;
1631
1810
  /**
1811
+ * @public
1632
1812
  * <p>The parameters for using an Batch job as a target.</p>
1633
1813
  */
1634
1814
  BatchJobParameters?: PipeTargetBatchJobParameters;
1635
1815
  /**
1816
+ * @public
1636
1817
  * <p>The parameters for using a Amazon SQS stream as a source.</p>
1637
1818
  */
1638
1819
  SqsQueueParameters?: PipeTargetSqsQueueParameters;
1639
1820
  /**
1821
+ * @public
1640
1822
  * <p>These are custom parameter to be used when the target is an API Gateway REST APIs or
1641
1823
  * EventBridge ApiDestinations.</p>
1642
1824
  */
1643
1825
  HttpParameters?: PipeTargetHttpParameters;
1644
1826
  /**
1827
+ * @public
1645
1828
  * <p>These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the
1646
1829
  * Amazon Redshift Data API ExecuteStatement.</p>
1647
1830
  */
1648
1831
  RedshiftDataParameters?: PipeTargetRedshiftDataParameters;
1649
1832
  /**
1833
+ * @public
1650
1834
  * <p>The parameters for using a SageMaker pipeline as a target.</p>
1651
1835
  */
1652
1836
  SageMakerPipelineParameters?: PipeTargetSageMakerPipelineParameters;
1653
1837
  /**
1838
+ * @public
1654
1839
  * <p>The parameters for using an EventBridge event bus as a target.</p>
1655
1840
  */
1656
1841
  EventBridgeEventBusParameters?: PipeTargetEventBridgeEventBusParameters;
1657
1842
  /**
1843
+ * @public
1658
1844
  * <p>The parameters for using an CloudWatch Logs log stream as a target.</p>
1659
1845
  */
1660
1846
  CloudWatchLogsParameters?: PipeTargetCloudWatchLogsParameters;
@@ -1664,46 +1850,57 @@ export interface PipeTargetParameters {
1664
1850
  */
1665
1851
  export interface CreatePipeRequest {
1666
1852
  /**
1853
+ * @public
1667
1854
  * <p>The name of the pipe.</p>
1668
1855
  */
1669
1856
  Name: string | undefined;
1670
1857
  /**
1858
+ * @public
1671
1859
  * <p>A description of the pipe.</p>
1672
1860
  */
1673
1861
  Description?: string;
1674
1862
  /**
1863
+ * @public
1675
1864
  * <p>The state the pipe should be in.</p>
1676
1865
  */
1677
1866
  DesiredState?: RequestedPipeState | string;
1678
1867
  /**
1868
+ * @public
1679
1869
  * <p>The ARN of the source resource.</p>
1680
1870
  */
1681
1871
  Source: string | undefined;
1682
1872
  /**
1873
+ * @public
1683
1874
  * <p>The parameters required to set up a source for your pipe.</p>
1684
1875
  */
1685
1876
  SourceParameters?: PipeSourceParameters;
1686
1877
  /**
1878
+ * @public
1687
1879
  * <p>The ARN of the enrichment resource.</p>
1688
1880
  */
1689
1881
  Enrichment?: string;
1690
1882
  /**
1883
+ * @public
1691
1884
  * <p>The parameters required to set up enrichment on your pipe.</p>
1692
1885
  */
1693
1886
  EnrichmentParameters?: PipeEnrichmentParameters;
1694
1887
  /**
1888
+ * @public
1695
1889
  * <p>The ARN of the target resource.</p>
1696
1890
  */
1697
1891
  Target: string | undefined;
1698
1892
  /**
1893
+ * @public
1699
1894
  * <p>The parameters required to set up a target for your pipe.</p>
1700
1895
  */
1701
1896
  TargetParameters?: PipeTargetParameters;
1702
1897
  /**
1898
+ * @public
1703
1899
  * <p>The ARN of the role that allows the pipe to send data to the target.</p>
1704
1900
  */
1705
1901
  RoleArn: string | undefined;
1706
1902
  /**
1903
+ * @public
1707
1904
  * <p>The list of key-value pairs to associate with the pipe.</p>
1708
1905
  */
1709
1906
  Tags?: Record<string, string>;
@@ -1734,26 +1931,32 @@ export type PipeState = (typeof PipeState)[keyof typeof PipeState];
1734
1931
  */
1735
1932
  export interface CreatePipeResponse {
1736
1933
  /**
1934
+ * @public
1737
1935
  * <p>The ARN of the pipe.</p>
1738
1936
  */
1739
1937
  Arn?: string;
1740
1938
  /**
1939
+ * @public
1741
1940
  * <p>The name of the pipe.</p>
1742
1941
  */
1743
1942
  Name?: string;
1744
1943
  /**
1944
+ * @public
1745
1945
  * <p>The state the pipe should be in.</p>
1746
1946
  */
1747
1947
  DesiredState?: RequestedPipeState | string;
1748
1948
  /**
1949
+ * @public
1749
1950
  * <p>The state the pipe is in.</p>
1750
1951
  */
1751
1952
  CurrentState?: PipeState | string;
1752
1953
  /**
1954
+ * @public
1753
1955
  * <p>The time the pipe was created.</p>
1754
1956
  */
1755
1957
  CreationTime?: Date;
1756
1958
  /**
1959
+ * @public
1757
1960
  * <p>When the pipe was last updated, in <a href="https://www.w3.org/TR/NOTE-datetime">ISO-8601 format</a> (YYYY-MM-DDThh:mm:ss.sTZD).</p>
1758
1961
  */
1759
1962
  LastModifiedTime?: Date;
@@ -1766,6 +1969,7 @@ export declare class InternalException extends __BaseException {
1766
1969
  readonly name: "InternalException";
1767
1970
  readonly $fault: "server";
1768
1971
  /**
1972
+ * @public
1769
1973
  * <p>The number of seconds to wait before retrying the action that caused the exception.</p>
1770
1974
  */
1771
1975
  retryAfterSeconds?: number;
@@ -1794,18 +1998,22 @@ export declare class ServiceQuotaExceededException extends __BaseException {
1794
1998
  readonly name: "ServiceQuotaExceededException";
1795
1999
  readonly $fault: "client";
1796
2000
  /**
2001
+ * @public
1797
2002
  * <p>The ID of the resource that caused the exception.</p>
1798
2003
  */
1799
2004
  resourceId: string | undefined;
1800
2005
  /**
2006
+ * @public
1801
2007
  * <p>The type of resource that caused the exception.</p>
1802
2008
  */
1803
2009
  resourceType: string | undefined;
1804
2010
  /**
2011
+ * @public
1805
2012
  * <p>The identifier of the service that caused the exception.</p>
1806
2013
  */
1807
2014
  serviceCode: string | undefined;
1808
2015
  /**
2016
+ * @public
1809
2017
  * <p>The identifier of the quota that caused the exception.</p>
1810
2018
  */
1811
2019
  quotaCode: string | undefined;
@@ -1822,14 +2030,17 @@ export declare class ThrottlingException extends __BaseException {
1822
2030
  readonly name: "ThrottlingException";
1823
2031
  readonly $fault: "client";
1824
2032
  /**
2033
+ * @public
1825
2034
  * <p>The identifier of the service that caused the exception.</p>
1826
2035
  */
1827
2036
  serviceCode?: string;
1828
2037
  /**
2038
+ * @public
1829
2039
  * <p>The identifier of the quota that caused the exception.</p>
1830
2040
  */
1831
2041
  quotaCode?: string;
1832
2042
  /**
2043
+ * @public
1833
2044
  * <p>The number of seconds to wait before retrying the action that caused the exception.</p>
1834
2045
  */
1835
2046
  retryAfterSeconds?: number;
@@ -1844,10 +2055,12 @@ export declare class ThrottlingException extends __BaseException {
1844
2055
  */
1845
2056
  export interface ValidationExceptionField {
1846
2057
  /**
2058
+ * @public
1847
2059
  * <p>The name of the exception.</p>
1848
2060
  */
1849
2061
  name: string | undefined;
1850
2062
  /**
2063
+ * @public
1851
2064
  * <p>The message of the exception.</p>
1852
2065
  */
1853
2066
  message: string | undefined;
@@ -1860,6 +2073,7 @@ export declare class ValidationException extends __BaseException {
1860
2073
  readonly name: "ValidationException";
1861
2074
  readonly $fault: "client";
1862
2075
  /**
2076
+ * @public
1863
2077
  * <p>The list of fields for which validation failed and the corresponding failure messages.</p>
1864
2078
  */
1865
2079
  fieldList?: ValidationExceptionField[];
@@ -1873,6 +2087,7 @@ export declare class ValidationException extends __BaseException {
1873
2087
  */
1874
2088
  export interface DeletePipeRequest {
1875
2089
  /**
2090
+ * @public
1876
2091
  * <p>The name of the pipe.</p>
1877
2092
  */
1878
2093
  Name: string | undefined;
@@ -1895,26 +2110,32 @@ export type RequestedPipeStateDescribeResponse = (typeof RequestedPipeStateDescr
1895
2110
  */
1896
2111
  export interface DeletePipeResponse {
1897
2112
  /**
2113
+ * @public
1898
2114
  * <p>The ARN of the pipe.</p>
1899
2115
  */
1900
2116
  Arn?: string;
1901
2117
  /**
2118
+ * @public
1902
2119
  * <p>The name of the pipe.</p>
1903
2120
  */
1904
2121
  Name?: string;
1905
2122
  /**
2123
+ * @public
1906
2124
  * <p>The state the pipe should be in.</p>
1907
2125
  */
1908
2126
  DesiredState?: RequestedPipeStateDescribeResponse | string;
1909
2127
  /**
2128
+ * @public
1910
2129
  * <p>The state the pipe is in.</p>
1911
2130
  */
1912
2131
  CurrentState?: PipeState | string;
1913
2132
  /**
2133
+ * @public
1914
2134
  * <p>The time the pipe was created.</p>
1915
2135
  */
1916
2136
  CreationTime?: Date;
1917
2137
  /**
2138
+ * @public
1918
2139
  * <p>When the pipe was last updated, in <a href="https://www.w3.org/TR/NOTE-datetime">ISO-8601 format</a> (YYYY-MM-DDThh:mm:ss.sTZD).</p>
1919
2140
  */
1920
2141
  LastModifiedTime?: Date;
@@ -1924,6 +2145,7 @@ export interface DeletePipeResponse {
1924
2145
  */
1925
2146
  export interface DescribePipeRequest {
1926
2147
  /**
2148
+ * @public
1927
2149
  * <p>The name of the pipe.</p>
1928
2150
  */
1929
2151
  Name: string | undefined;
@@ -1933,66 +2155,82 @@ export interface DescribePipeRequest {
1933
2155
  */
1934
2156
  export interface DescribePipeResponse {
1935
2157
  /**
2158
+ * @public
1936
2159
  * <p>The ARN of the pipe.</p>
1937
2160
  */
1938
2161
  Arn?: string;
1939
2162
  /**
2163
+ * @public
1940
2164
  * <p>The name of the pipe.</p>
1941
2165
  */
1942
2166
  Name?: string;
1943
2167
  /**
2168
+ * @public
1944
2169
  * <p>A description of the pipe.</p>
1945
2170
  */
1946
2171
  Description?: string;
1947
2172
  /**
2173
+ * @public
1948
2174
  * <p>The state the pipe should be in.</p>
1949
2175
  */
1950
2176
  DesiredState?: RequestedPipeStateDescribeResponse | string;
1951
2177
  /**
2178
+ * @public
1952
2179
  * <p>The state the pipe is in.</p>
1953
2180
  */
1954
2181
  CurrentState?: PipeState | string;
1955
2182
  /**
2183
+ * @public
1956
2184
  * <p>The reason the pipe is in its current state.</p>
1957
2185
  */
1958
2186
  StateReason?: string;
1959
2187
  /**
2188
+ * @public
1960
2189
  * <p>The ARN of the source resource.</p>
1961
2190
  */
1962
2191
  Source?: string;
1963
2192
  /**
2193
+ * @public
1964
2194
  * <p>The parameters required to set up a source for your pipe.</p>
1965
2195
  */
1966
2196
  SourceParameters?: PipeSourceParameters;
1967
2197
  /**
2198
+ * @public
1968
2199
  * <p>The ARN of the enrichment resource.</p>
1969
2200
  */
1970
2201
  Enrichment?: string;
1971
2202
  /**
2203
+ * @public
1972
2204
  * <p>The parameters required to set up enrichment on your pipe.</p>
1973
2205
  */
1974
2206
  EnrichmentParameters?: PipeEnrichmentParameters;
1975
2207
  /**
2208
+ * @public
1976
2209
  * <p>The ARN of the target resource.</p>
1977
2210
  */
1978
2211
  Target?: string;
1979
2212
  /**
2213
+ * @public
1980
2214
  * <p>The parameters required to set up a target for your pipe.</p>
1981
2215
  */
1982
2216
  TargetParameters?: PipeTargetParameters;
1983
2217
  /**
2218
+ * @public
1984
2219
  * <p>The ARN of the role that allows the pipe to send data to the target.</p>
1985
2220
  */
1986
2221
  RoleArn?: string;
1987
2222
  /**
2223
+ * @public
1988
2224
  * <p>The list of key-value pairs to associate with the pipe.</p>
1989
2225
  */
1990
2226
  Tags?: Record<string, string>;
1991
2227
  /**
2228
+ * @public
1992
2229
  * <p>The time the pipe was created.</p>
1993
2230
  */
1994
2231
  CreationTime?: Date;
1995
2232
  /**
2233
+ * @public
1996
2234
  * <p>When the pipe was last updated, in <a href="https://www.w3.org/TR/NOTE-datetime">ISO-8601 format</a> (YYYY-MM-DDThh:mm:ss.sTZD).</p>
1997
2235
  */
1998
2236
  LastModifiedTime?: Date;
@@ -2002,33 +2240,40 @@ export interface DescribePipeResponse {
2002
2240
  */
2003
2241
  export interface ListPipesRequest {
2004
2242
  /**
2243
+ * @public
2005
2244
  * <p>A value that will return a subset of the pipes associated with this account. For example, <code>"NamePrefix": "ABC"</code> will return
2006
2245
  * all endpoints with "ABC" in the name.</p>
2007
2246
  */
2008
2247
  NamePrefix?: string;
2009
2248
  /**
2249
+ * @public
2010
2250
  * <p>The state the pipe should be in.</p>
2011
2251
  */
2012
2252
  DesiredState?: RequestedPipeState | string;
2013
2253
  /**
2254
+ * @public
2014
2255
  * <p>The state the pipe is in.</p>
2015
2256
  */
2016
2257
  CurrentState?: PipeState | string;
2017
2258
  /**
2259
+ * @public
2018
2260
  * <p>The prefix matching the pipe source.</p>
2019
2261
  */
2020
2262
  SourcePrefix?: string;
2021
2263
  /**
2264
+ * @public
2022
2265
  * <p>The prefix matching the pipe target.</p>
2023
2266
  */
2024
2267
  TargetPrefix?: string;
2025
2268
  /**
2269
+ * @public
2026
2270
  * <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page.
2027
2271
  * Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination
2028
2272
  * token will return an HTTP 400 InvalidToken error.</p>
2029
2273
  */
2030
2274
  NextToken?: string;
2031
2275
  /**
2276
+ * @public
2032
2277
  * <p>The maximum number of pipes to include in the response.</p>
2033
2278
  */
2034
2279
  Limit?: number;
@@ -2039,42 +2284,52 @@ export interface ListPipesRequest {
2039
2284
  */
2040
2285
  export interface Pipe {
2041
2286
  /**
2287
+ * @public
2042
2288
  * <p>The name of the pipe.</p>
2043
2289
  */
2044
2290
  Name?: string;
2045
2291
  /**
2292
+ * @public
2046
2293
  * <p>The ARN of the pipe.</p>
2047
2294
  */
2048
2295
  Arn?: string;
2049
2296
  /**
2297
+ * @public
2050
2298
  * <p>The state the pipe should be in.</p>
2051
2299
  */
2052
2300
  DesiredState?: RequestedPipeState | string;
2053
2301
  /**
2302
+ * @public
2054
2303
  * <p>The state the pipe is in.</p>
2055
2304
  */
2056
2305
  CurrentState?: PipeState | string;
2057
2306
  /**
2307
+ * @public
2058
2308
  * <p>The reason the pipe is in its current state.</p>
2059
2309
  */
2060
2310
  StateReason?: string;
2061
2311
  /**
2312
+ * @public
2062
2313
  * <p>The time the pipe was created.</p>
2063
2314
  */
2064
2315
  CreationTime?: Date;
2065
2316
  /**
2317
+ * @public
2066
2318
  * <p>When the pipe was last updated, in <a href="https://www.w3.org/TR/NOTE-datetime">ISO-8601 format</a> (YYYY-MM-DDThh:mm:ss.sTZD).</p>
2067
2319
  */
2068
2320
  LastModifiedTime?: Date;
2069
2321
  /**
2322
+ * @public
2070
2323
  * <p>The ARN of the source resource.</p>
2071
2324
  */
2072
2325
  Source?: string;
2073
2326
  /**
2327
+ * @public
2074
2328
  * <p>The ARN of the target resource.</p>
2075
2329
  */
2076
2330
  Target?: string;
2077
2331
  /**
2332
+ * @public
2078
2333
  * <p>The ARN of the enrichment resource.</p>
2079
2334
  */
2080
2335
  Enrichment?: string;
@@ -2084,10 +2339,12 @@ export interface Pipe {
2084
2339
  */
2085
2340
  export interface ListPipesResponse {
2086
2341
  /**
2342
+ * @public
2087
2343
  * <p>The pipes returned by the call.</p>
2088
2344
  */
2089
2345
  Pipes?: Pipe[];
2090
2346
  /**
2347
+ * @public
2091
2348
  * <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page.
2092
2349
  * Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination
2093
2350
  * token will return an HTTP 400 InvalidToken error.</p>
@@ -2099,6 +2356,7 @@ export interface ListPipesResponse {
2099
2356
  */
2100
2357
  export interface ListTagsForResourceRequest {
2101
2358
  /**
2359
+ * @public
2102
2360
  * <p>The ARN of the pipe for which you want to view tags.</p>
2103
2361
  */
2104
2362
  resourceArn: string | undefined;
@@ -2108,6 +2366,7 @@ export interface ListTagsForResourceRequest {
2108
2366
  */
2109
2367
  export interface ListTagsForResourceResponse {
2110
2368
  /**
2369
+ * @public
2111
2370
  * <p>The list of key-value pairs to associate with the pipe.</p>
2112
2371
  */
2113
2372
  tags?: Record<string, string>;
@@ -2117,6 +2376,7 @@ export interface ListTagsForResourceResponse {
2117
2376
  */
2118
2377
  export interface StartPipeRequest {
2119
2378
  /**
2379
+ * @public
2120
2380
  * <p>The name of the pipe.</p>
2121
2381
  */
2122
2382
  Name: string | undefined;
@@ -2126,26 +2386,32 @@ export interface StartPipeRequest {
2126
2386
  */
2127
2387
  export interface StartPipeResponse {
2128
2388
  /**
2389
+ * @public
2129
2390
  * <p>The ARN of the pipe.</p>
2130
2391
  */
2131
2392
  Arn?: string;
2132
2393
  /**
2394
+ * @public
2133
2395
  * <p>The name of the pipe.</p>
2134
2396
  */
2135
2397
  Name?: string;
2136
2398
  /**
2399
+ * @public
2137
2400
  * <p>The state the pipe should be in.</p>
2138
2401
  */
2139
2402
  DesiredState?: RequestedPipeState | string;
2140
2403
  /**
2404
+ * @public
2141
2405
  * <p>The state the pipe is in.</p>
2142
2406
  */
2143
2407
  CurrentState?: PipeState | string;
2144
2408
  /**
2409
+ * @public
2145
2410
  * <p>The time the pipe was created.</p>
2146
2411
  */
2147
2412
  CreationTime?: Date;
2148
2413
  /**
2414
+ * @public
2149
2415
  * <p>When the pipe was last updated, in <a href="https://www.w3.org/TR/NOTE-datetime">ISO-8601 format</a> (YYYY-MM-DDThh:mm:ss.sTZD).</p>
2150
2416
  */
2151
2417
  LastModifiedTime?: Date;
@@ -2155,6 +2421,7 @@ export interface StartPipeResponse {
2155
2421
  */
2156
2422
  export interface StopPipeRequest {
2157
2423
  /**
2424
+ * @public
2158
2425
  * <p>The name of the pipe.</p>
2159
2426
  */
2160
2427
  Name: string | undefined;
@@ -2164,26 +2431,32 @@ export interface StopPipeRequest {
2164
2431
  */
2165
2432
  export interface StopPipeResponse {
2166
2433
  /**
2434
+ * @public
2167
2435
  * <p>The ARN of the pipe.</p>
2168
2436
  */
2169
2437
  Arn?: string;
2170
2438
  /**
2439
+ * @public
2171
2440
  * <p>The name of the pipe.</p>
2172
2441
  */
2173
2442
  Name?: string;
2174
2443
  /**
2444
+ * @public
2175
2445
  * <p>The state the pipe should be in.</p>
2176
2446
  */
2177
2447
  DesiredState?: RequestedPipeState | string;
2178
2448
  /**
2449
+ * @public
2179
2450
  * <p>The state the pipe is in.</p>
2180
2451
  */
2181
2452
  CurrentState?: PipeState | string;
2182
2453
  /**
2454
+ * @public
2183
2455
  * <p>The time the pipe was created.</p>
2184
2456
  */
2185
2457
  CreationTime?: Date;
2186
2458
  /**
2459
+ * @public
2187
2460
  * <p>When the pipe was last updated, in <a href="https://www.w3.org/TR/NOTE-datetime">ISO-8601 format</a> (YYYY-MM-DDThh:mm:ss.sTZD).</p>
2188
2461
  */
2189
2462
  LastModifiedTime?: Date;
@@ -2194,14 +2467,17 @@ export interface StopPipeResponse {
2194
2467
  */
2195
2468
  export interface UpdatePipeSourceActiveMQBrokerParameters {
2196
2469
  /**
2470
+ * @public
2197
2471
  * <p>The credentials needed to access the resource.</p>
2198
2472
  */
2199
2473
  Credentials: MQBrokerAccessCredentials | undefined;
2200
2474
  /**
2475
+ * @public
2201
2476
  * <p>The maximum number of records to include in each batch.</p>
2202
2477
  */
2203
2478
  BatchSize?: number;
2204
2479
  /**
2480
+ * @public
2205
2481
  * <p>The maximum length of a time to wait for events.</p>
2206
2482
  */
2207
2483
  MaximumBatchingWindowInSeconds?: number;
@@ -2212,33 +2488,40 @@ export interface UpdatePipeSourceActiveMQBrokerParameters {
2212
2488
  */
2213
2489
  export interface UpdatePipeSourceDynamoDBStreamParameters {
2214
2490
  /**
2491
+ * @public
2215
2492
  * <p>The maximum number of records to include in each batch.</p>
2216
2493
  */
2217
2494
  BatchSize?: number;
2218
2495
  /**
2496
+ * @public
2219
2497
  * <p>Define the target queue to send dead-letter queue events to.</p>
2220
2498
  */
2221
2499
  DeadLetterConfig?: DeadLetterConfig;
2222
2500
  /**
2501
+ * @public
2223
2502
  * <p>(Streams only) Define how to handle item process failures. <code>AUTOMATIC_BISECT</code> halves each batch and retry each half
2224
2503
  * until all the records are processed or there is one failed message left in the batch.</p>
2225
2504
  */
2226
2505
  OnPartialBatchItemFailure?: OnPartialBatchItemFailureStreams | string;
2227
2506
  /**
2507
+ * @public
2228
2508
  * <p>The maximum length of a time to wait for events.</p>
2229
2509
  */
2230
2510
  MaximumBatchingWindowInSeconds?: number;
2231
2511
  /**
2512
+ * @public
2232
2513
  * <p>(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite.
2233
2514
  * When the value is set to infinite, EventBridge never discards old records. </p>
2234
2515
  */
2235
2516
  MaximumRecordAgeInSeconds?: number;
2236
2517
  /**
2518
+ * @public
2237
2519
  * <p>(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of
2238
2520
  * retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.</p>
2239
2521
  */
2240
2522
  MaximumRetryAttempts?: number;
2241
2523
  /**
2524
+ * @public
2242
2525
  * <p>(Streams only) The number of batches to process concurrently from each shard. The default value is 1.</p>
2243
2526
  */
2244
2527
  ParallelizationFactor?: number;
@@ -2249,33 +2532,40 @@ export interface UpdatePipeSourceDynamoDBStreamParameters {
2249
2532
  */
2250
2533
  export interface UpdatePipeSourceKinesisStreamParameters {
2251
2534
  /**
2535
+ * @public
2252
2536
  * <p>The maximum number of records to include in each batch.</p>
2253
2537
  */
2254
2538
  BatchSize?: number;
2255
2539
  /**
2540
+ * @public
2256
2541
  * <p>Define the target queue to send dead-letter queue events to.</p>
2257
2542
  */
2258
2543
  DeadLetterConfig?: DeadLetterConfig;
2259
2544
  /**
2545
+ * @public
2260
2546
  * <p>(Streams only) Define how to handle item process failures. <code>AUTOMATIC_BISECT</code> halves each batch and retry each half
2261
2547
  * until all the records are processed or there is one failed message left in the batch.</p>
2262
2548
  */
2263
2549
  OnPartialBatchItemFailure?: OnPartialBatchItemFailureStreams | string;
2264
2550
  /**
2551
+ * @public
2265
2552
  * <p>The maximum length of a time to wait for events.</p>
2266
2553
  */
2267
2554
  MaximumBatchingWindowInSeconds?: number;
2268
2555
  /**
2556
+ * @public
2269
2557
  * <p>(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite.
2270
2558
  * When the value is set to infinite, EventBridge never discards old records. </p>
2271
2559
  */
2272
2560
  MaximumRecordAgeInSeconds?: number;
2273
2561
  /**
2562
+ * @public
2274
2563
  * <p>(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of
2275
2564
  * retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.</p>
2276
2565
  */
2277
2566
  MaximumRetryAttempts?: number;
2278
2567
  /**
2568
+ * @public
2279
2569
  * <p>(Streams only) The number of batches to process concurrently from each shard. The default value is 1.</p>
2280
2570
  */
2281
2571
  ParallelizationFactor?: number;
@@ -2286,14 +2576,17 @@ export interface UpdatePipeSourceKinesisStreamParameters {
2286
2576
  */
2287
2577
  export interface UpdatePipeSourceManagedStreamingKafkaParameters {
2288
2578
  /**
2579
+ * @public
2289
2580
  * <p>The maximum number of records to include in each batch.</p>
2290
2581
  */
2291
2582
  BatchSize?: number;
2292
2583
  /**
2584
+ * @public
2293
2585
  * <p>The credentials needed to access the resource.</p>
2294
2586
  */
2295
2587
  Credentials?: MSKAccessCredentials;
2296
2588
  /**
2589
+ * @public
2297
2590
  * <p>The maximum length of a time to wait for events.</p>
2298
2591
  */
2299
2592
  MaximumBatchingWindowInSeconds?: number;
@@ -2304,14 +2597,17 @@ export interface UpdatePipeSourceManagedStreamingKafkaParameters {
2304
2597
  */
2305
2598
  export interface UpdatePipeSourceRabbitMQBrokerParameters {
2306
2599
  /**
2600
+ * @public
2307
2601
  * <p>The credentials needed to access the resource.</p>
2308
2602
  */
2309
2603
  Credentials: MQBrokerAccessCredentials | undefined;
2310
2604
  /**
2605
+ * @public
2311
2606
  * <p>The maximum number of records to include in each batch.</p>
2312
2607
  */
2313
2608
  BatchSize?: number;
2314
2609
  /**
2610
+ * @public
2315
2611
  * <p>The maximum length of a time to wait for events.</p>
2316
2612
  */
2317
2613
  MaximumBatchingWindowInSeconds?: number;
@@ -2322,22 +2618,27 @@ export interface UpdatePipeSourceRabbitMQBrokerParameters {
2322
2618
  */
2323
2619
  export interface UpdatePipeSourceSelfManagedKafkaParameters {
2324
2620
  /**
2621
+ * @public
2325
2622
  * <p>The maximum number of records to include in each batch.</p>
2326
2623
  */
2327
2624
  BatchSize?: number;
2328
2625
  /**
2626
+ * @public
2329
2627
  * <p>The maximum length of a time to wait for events.</p>
2330
2628
  */
2331
2629
  MaximumBatchingWindowInSeconds?: number;
2332
2630
  /**
2631
+ * @public
2333
2632
  * <p>The credentials needed to access the resource.</p>
2334
2633
  */
2335
2634
  Credentials?: SelfManagedKafkaAccessConfigurationCredentials;
2336
2635
  /**
2636
+ * @public
2337
2637
  * <p>The ARN of the Secrets Manager secret used for certification.</p>
2338
2638
  */
2339
2639
  ServerRootCaCertificate?: string;
2340
2640
  /**
2641
+ * @public
2341
2642
  * <p>This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.</p>
2342
2643
  */
2343
2644
  Vpc?: SelfManagedKafkaAccessConfigurationVpc;
@@ -2348,10 +2649,12 @@ export interface UpdatePipeSourceSelfManagedKafkaParameters {
2348
2649
  */
2349
2650
  export interface UpdatePipeSourceSqsQueueParameters {
2350
2651
  /**
2652
+ * @public
2351
2653
  * <p>The maximum number of records to include in each batch.</p>
2352
2654
  */
2353
2655
  BatchSize?: number;
2354
2656
  /**
2657
+ * @public
2355
2658
  * <p>The maximum length of a time to wait for events.</p>
2356
2659
  */
2357
2660
  MaximumBatchingWindowInSeconds?: number;
@@ -2362,35 +2665,43 @@ export interface UpdatePipeSourceSqsQueueParameters {
2362
2665
  */
2363
2666
  export interface UpdatePipeSourceParameters {
2364
2667
  /**
2668
+ * @public
2365
2669
  * <p>The collection of event patterns used to filter events. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html">Events and Event
2366
2670
  * Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
2367
2671
  */
2368
2672
  FilterCriteria?: FilterCriteria;
2369
2673
  /**
2674
+ * @public
2370
2675
  * <p>The parameters for using a Kinesis stream as a source.</p>
2371
2676
  */
2372
2677
  KinesisStreamParameters?: UpdatePipeSourceKinesisStreamParameters;
2373
2678
  /**
2679
+ * @public
2374
2680
  * <p>The parameters for using a DynamoDB stream as a source.</p>
2375
2681
  */
2376
2682
  DynamoDBStreamParameters?: UpdatePipeSourceDynamoDBStreamParameters;
2377
2683
  /**
2684
+ * @public
2378
2685
  * <p>The parameters for using a Amazon SQS stream as a source.</p>
2379
2686
  */
2380
2687
  SqsQueueParameters?: UpdatePipeSourceSqsQueueParameters;
2381
2688
  /**
2689
+ * @public
2382
2690
  * <p>The parameters for using an Active MQ broker as a source.</p>
2383
2691
  */
2384
2692
  ActiveMQBrokerParameters?: UpdatePipeSourceActiveMQBrokerParameters;
2385
2693
  /**
2694
+ * @public
2386
2695
  * <p>The parameters for using a Rabbit MQ broker as a source.</p>
2387
2696
  */
2388
2697
  RabbitMQBrokerParameters?: UpdatePipeSourceRabbitMQBrokerParameters;
2389
2698
  /**
2699
+ * @public
2390
2700
  * <p>The parameters for using an MSK stream as a source.</p>
2391
2701
  */
2392
2702
  ManagedStreamingKafkaParameters?: UpdatePipeSourceManagedStreamingKafkaParameters;
2393
2703
  /**
2704
+ * @public
2394
2705
  * <p>The parameters for using a self-managed Apache Kafka stream as a source.</p>
2395
2706
  */
2396
2707
  SelfManagedKafkaParameters?: UpdatePipeSourceSelfManagedKafkaParameters;
@@ -2400,38 +2711,47 @@ export interface UpdatePipeSourceParameters {
2400
2711
  */
2401
2712
  export interface UpdatePipeRequest {
2402
2713
  /**
2714
+ * @public
2403
2715
  * <p>The name of the pipe.</p>
2404
2716
  */
2405
2717
  Name: string | undefined;
2406
2718
  /**
2719
+ * @public
2407
2720
  * <p>A description of the pipe.</p>
2408
2721
  */
2409
2722
  Description?: string;
2410
2723
  /**
2724
+ * @public
2411
2725
  * <p>The state the pipe should be in.</p>
2412
2726
  */
2413
2727
  DesiredState?: RequestedPipeState | string;
2414
2728
  /**
2729
+ * @public
2415
2730
  * <p>The parameters required to set up a source for your pipe.</p>
2416
2731
  */
2417
2732
  SourceParameters?: UpdatePipeSourceParameters;
2418
2733
  /**
2734
+ * @public
2419
2735
  * <p>The ARN of the enrichment resource.</p>
2420
2736
  */
2421
2737
  Enrichment?: string;
2422
2738
  /**
2739
+ * @public
2423
2740
  * <p>The parameters required to set up enrichment on your pipe.</p>
2424
2741
  */
2425
2742
  EnrichmentParameters?: PipeEnrichmentParameters;
2426
2743
  /**
2744
+ * @public
2427
2745
  * <p>The ARN of the target resource.</p>
2428
2746
  */
2429
2747
  Target?: string;
2430
2748
  /**
2749
+ * @public
2431
2750
  * <p>The parameters required to set up a target for your pipe.</p>
2432
2751
  */
2433
2752
  TargetParameters?: PipeTargetParameters;
2434
2753
  /**
2754
+ * @public
2435
2755
  * <p>The ARN of the role that allows the pipe to send data to the target.</p>
2436
2756
  */
2437
2757
  RoleArn: string | undefined;
@@ -2441,26 +2761,32 @@ export interface UpdatePipeRequest {
2441
2761
  */
2442
2762
  export interface UpdatePipeResponse {
2443
2763
  /**
2764
+ * @public
2444
2765
  * <p>The ARN of the pipe.</p>
2445
2766
  */
2446
2767
  Arn?: string;
2447
2768
  /**
2769
+ * @public
2448
2770
  * <p>The name of the pipe.</p>
2449
2771
  */
2450
2772
  Name?: string;
2451
2773
  /**
2774
+ * @public
2452
2775
  * <p>The state the pipe should be in.</p>
2453
2776
  */
2454
2777
  DesiredState?: RequestedPipeState | string;
2455
2778
  /**
2779
+ * @public
2456
2780
  * <p>The state the pipe is in.</p>
2457
2781
  */
2458
2782
  CurrentState?: PipeState | string;
2459
2783
  /**
2784
+ * @public
2460
2785
  * <p>The time the pipe was created.</p>
2461
2786
  */
2462
2787
  CreationTime?: Date;
2463
2788
  /**
2789
+ * @public
2464
2790
  * <p>When the pipe was last updated, in <a href="https://www.w3.org/TR/NOTE-datetime">ISO-8601 format</a> (YYYY-MM-DDThh:mm:ss.sTZD).</p>
2465
2791
  */
2466
2792
  LastModifiedTime?: Date;
@@ -2470,10 +2796,12 @@ export interface UpdatePipeResponse {
2470
2796
  */
2471
2797
  export interface TagResourceRequest {
2472
2798
  /**
2799
+ * @public
2473
2800
  * <p>The ARN of the pipe.</p>
2474
2801
  */
2475
2802
  resourceArn: string | undefined;
2476
2803
  /**
2804
+ * @public
2477
2805
  * <p>The list of key-value pairs associated with the pipe.</p>
2478
2806
  */
2479
2807
  tags: Record<string, string> | undefined;
@@ -2488,10 +2816,12 @@ export interface TagResourceResponse {
2488
2816
  */
2489
2817
  export interface UntagResourceRequest {
2490
2818
  /**
2819
+ * @public
2491
2820
  * <p>The ARN of the pipe.</p>
2492
2821
  */
2493
2822
  resourceArn: string | undefined;
2494
2823
  /**
2824
+ * @public
2495
2825
  * <p>The list of tag keys to remove from the pipe.</p>
2496
2826
  */
2497
2827
  tagKeys: string[] | undefined;