@aws-sdk/client-pipes 3.296.0 → 3.297.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,10 +1,14 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { PipesServiceException as __BaseException } from "./PipesServiceException";
3
+ /**
4
+ * @public
5
+ */
3
6
  export declare enum AssignPublicIp {
4
7
  DISABLED = "DISABLED",
5
8
  ENABLED = "ENABLED"
6
9
  }
7
10
  /**
11
+ * @public
8
12
  * <p>This structure specifies the VPC subnets and security groups for the task, and whether a public IP address is to be used.
9
13
  * This structure is relevant only for ECS tasks that use the <code>awsvpc</code> network mode.</p>
10
14
  */
@@ -25,6 +29,7 @@ export interface AwsVpcConfiguration {
25
29
  AssignPublicIp?: AssignPublicIp | string;
26
30
  }
27
31
  /**
32
+ * @public
28
33
  * <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.
29
34
  * 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>
30
35
  */
@@ -35,6 +40,7 @@ export interface BatchArrayProperties {
35
40
  Size?: number;
36
41
  }
37
42
  /**
43
+ * @public
38
44
  * <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
39
45
  * environment variables from the Docker image or the task definition.</p>
40
46
  * <note>
@@ -51,12 +57,16 @@ export interface BatchEnvironmentVariable {
51
57
  */
52
58
  Value?: string;
53
59
  }
60
+ /**
61
+ * @public
62
+ */
54
63
  export declare enum BatchResourceRequirementType {
55
64
  GPU = "GPU",
56
65
  MEMORY = "MEMORY",
57
66
  VCPU = "VCPU"
58
67
  }
59
68
  /**
69
+ * @public
60
70
  * <p>The type and amount of a resource to assign to a container. The supported resources include <code>GPU</code>, <code>MEMORY</code>, and <code>VCPU</code>.</p>
61
71
  */
62
72
  export interface BatchResourceRequirement {
@@ -230,6 +240,7 @@ export interface BatchResourceRequirement {
230
240
  Value: string | undefined;
231
241
  }
232
242
  /**
243
+ * @public
233
244
  * <p>The overrides that are sent to a container.</p>
234
245
  */
235
246
  export interface BatchContainerOverrides {
@@ -258,11 +269,15 @@ export interface BatchContainerOverrides {
258
269
  */
259
270
  ResourceRequirements?: BatchResourceRequirement[];
260
271
  }
272
+ /**
273
+ * @public
274
+ */
261
275
  export declare enum BatchJobDependencyType {
262
276
  N_TO_N = "N_TO_N",
263
277
  SEQUENTIAL = "SEQUENTIAL"
264
278
  }
265
279
  /**
280
+ * @public
266
281
  * <p>An object that represents an Batch job dependency.</p>
267
282
  */
268
283
  export interface BatchJobDependency {
@@ -276,6 +291,7 @@ export interface BatchJobDependency {
276
291
  Type?: BatchJobDependencyType | string;
277
292
  }
278
293
  /**
294
+ * @public
279
295
  * <p>The retry strategy that's associated with a job. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/job_retries.html">
280
296
  * Automated job retries</a> in the <i>Batch User Guide</i>.</p>
281
297
  */
@@ -287,6 +303,7 @@ export interface BatchRetryStrategy {
287
303
  Attempts?: number;
288
304
  }
289
305
  /**
306
+ * @public
290
307
  * <p>The details of a capacity provider strategy. To learn more, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html">CapacityProviderStrategyItem</a> in the Amazon ECS API Reference.</p>
291
308
  */
292
309
  export interface CapacityProviderStrategyItem {
@@ -308,6 +325,7 @@ export interface CapacityProviderStrategyItem {
308
325
  base?: number;
309
326
  }
310
327
  /**
328
+ * @public
311
329
  * <p>An action you attempted resulted in an exception.</p>
312
330
  */
313
331
  export declare class ConflictException extends __BaseException {
@@ -326,11 +344,15 @@ export declare class ConflictException extends __BaseException {
326
344
  */
327
345
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
328
346
  }
347
+ /**
348
+ * @public
349
+ */
329
350
  export declare enum RequestedPipeState {
330
351
  RUNNING = "RUNNING",
331
352
  STOPPED = "STOPPED"
332
353
  }
333
354
  /**
355
+ * @public
334
356
  * <p>These are custom parameter to be used when the target is an API Gateway REST APIs or
335
357
  * EventBridge ApiDestinations. In the latter case, these are merged with any
336
358
  * InvocationParameters specified on the Connection, with any values from the Connection taking
@@ -354,6 +376,7 @@ export interface PipeEnrichmentHttpParameters {
354
376
  QueryStringParameters?: Record<string, string>;
355
377
  }
356
378
  /**
379
+ * @public
357
380
  * <p>The parameters required to set up enrichment on your pipe.</p>
358
381
  */
359
382
  export interface PipeEnrichmentParameters {
@@ -375,9 +398,13 @@ export interface PipeEnrichmentParameters {
375
398
  HttpParameters?: PipeEnrichmentHttpParameters;
376
399
  }
377
400
  /**
401
+ * @public
378
402
  * <p>The Secrets Manager secret that stores your broker credentials.</p>
379
403
  */
380
404
  export type MQBrokerAccessCredentials = MQBrokerAccessCredentials.BasicAuthMember | MQBrokerAccessCredentials.$UnknownMember;
405
+ /**
406
+ * @public
407
+ */
381
408
  export declare namespace MQBrokerAccessCredentials {
382
409
  /**
383
410
  * <p>The ARN of the Secrets Manager secret.</p>
@@ -397,6 +424,7 @@ export declare namespace MQBrokerAccessCredentials {
397
424
  const visit: <T>(value: MQBrokerAccessCredentials, visitor: Visitor<T>) => T;
398
425
  }
399
426
  /**
427
+ * @public
400
428
  * <p>The parameters for using an Active MQ broker as a source.</p>
401
429
  */
402
430
  export interface PipeSourceActiveMQBrokerParameters {
@@ -418,6 +446,7 @@ export interface PipeSourceActiveMQBrokerParameters {
418
446
  MaximumBatchingWindowInSeconds?: number;
419
447
  }
420
448
  /**
449
+ * @public
421
450
  * <p>A <code>DeadLetterConfig</code> object that contains information about a dead-letter queue configuration.</p>
422
451
  */
423
452
  export interface DeadLetterConfig {
@@ -426,14 +455,21 @@ export interface DeadLetterConfig {
426
455
  */
427
456
  Arn?: string;
428
457
  }
458
+ /**
459
+ * @public
460
+ */
429
461
  export declare enum OnPartialBatchItemFailureStreams {
430
462
  AUTOMATIC_BISECT = "AUTOMATIC_BISECT"
431
463
  }
464
+ /**
465
+ * @public
466
+ */
432
467
  export declare enum DynamoDBStreamStartPosition {
433
468
  LATEST = "LATEST",
434
469
  TRIM_HORIZON = "TRIM_HORIZON"
435
470
  }
436
471
  /**
472
+ * @public
437
473
  * <p>The parameters for using a DynamoDB stream as a source.</p>
438
474
  */
439
475
  export interface PipeSourceDynamoDBStreamParameters {
@@ -474,6 +510,7 @@ export interface PipeSourceDynamoDBStreamParameters {
474
510
  StartingPosition: DynamoDBStreamStartPosition | string | undefined;
475
511
  }
476
512
  /**
513
+ * @public
477
514
  * <p>Filter events using an event pattern. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html">Events and Event
478
515
  * Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
479
516
  */
@@ -484,6 +521,7 @@ export interface Filter {
484
521
  Pattern?: string;
485
522
  }
486
523
  /**
524
+ * @public
487
525
  * <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
488
526
  * Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
489
527
  */
@@ -493,12 +531,16 @@ export interface FilterCriteria {
493
531
  */
494
532
  Filters?: Filter[];
495
533
  }
534
+ /**
535
+ * @public
536
+ */
496
537
  export declare enum KinesisStreamStartPosition {
497
538
  AT_TIMESTAMP = "AT_TIMESTAMP",
498
539
  LATEST = "LATEST",
499
540
  TRIM_HORIZON = "TRIM_HORIZON"
500
541
  }
501
542
  /**
543
+ * @public
502
544
  * <p>The parameters for using a Kinesis stream as a source.</p>
503
545
  */
504
546
  export interface PipeSourceKinesisStreamParameters {
@@ -543,9 +585,13 @@ export interface PipeSourceKinesisStreamParameters {
543
585
  StartingPositionTimestamp?: Date;
544
586
  }
545
587
  /**
588
+ * @public
546
589
  * <p>The Secrets Manager secret that stores your stream credentials.</p>
547
590
  */
548
591
  export type MSKAccessCredentials = MSKAccessCredentials.ClientCertificateTlsAuthMember | MSKAccessCredentials.SaslScram512AuthMember | MSKAccessCredentials.$UnknownMember;
592
+ /**
593
+ * @public
594
+ */
549
595
  export declare namespace MSKAccessCredentials {
550
596
  /**
551
597
  * <p>The ARN of the Secrets Manager secret.</p>
@@ -575,11 +621,15 @@ export declare namespace MSKAccessCredentials {
575
621
  }
576
622
  const visit: <T>(value: MSKAccessCredentials, visitor: Visitor<T>) => T;
577
623
  }
624
+ /**
625
+ * @public
626
+ */
578
627
  export declare enum MSKStartPosition {
579
628
  LATEST = "LATEST",
580
629
  TRIM_HORIZON = "TRIM_HORIZON"
581
630
  }
582
631
  /**
632
+ * @public
583
633
  * <p>The parameters for using an MSK stream as a source.</p>
584
634
  */
585
635
  export interface PipeSourceManagedStreamingKafkaParameters {
@@ -609,6 +659,7 @@ export interface PipeSourceManagedStreamingKafkaParameters {
609
659
  Credentials?: MSKAccessCredentials;
610
660
  }
611
661
  /**
662
+ * @public
612
663
  * <p>The parameters for using a Rabbit MQ broker as a source.</p>
613
664
  */
614
665
  export interface PipeSourceRabbitMQBrokerParameters {
@@ -634,9 +685,13 @@ export interface PipeSourceRabbitMQBrokerParameters {
634
685
  MaximumBatchingWindowInSeconds?: number;
635
686
  }
636
687
  /**
688
+ * @public
637
689
  * <p>The Secrets Manager secret that stores your stream credentials.</p>
638
690
  */
639
691
  export type SelfManagedKafkaAccessConfigurationCredentials = SelfManagedKafkaAccessConfigurationCredentials.BasicAuthMember | SelfManagedKafkaAccessConfigurationCredentials.ClientCertificateTlsAuthMember | SelfManagedKafkaAccessConfigurationCredentials.SaslScram256AuthMember | SelfManagedKafkaAccessConfigurationCredentials.SaslScram512AuthMember | SelfManagedKafkaAccessConfigurationCredentials.$UnknownMember;
692
+ /**
693
+ * @public
694
+ */
640
695
  export declare namespace SelfManagedKafkaAccessConfigurationCredentials {
641
696
  /**
642
697
  * <p>The ARN of the Secrets Manager secret.</p>
@@ -694,11 +749,15 @@ export declare namespace SelfManagedKafkaAccessConfigurationCredentials {
694
749
  }
695
750
  const visit: <T>(value: SelfManagedKafkaAccessConfigurationCredentials, visitor: Visitor<T>) => T;
696
751
  }
752
+ /**
753
+ * @public
754
+ */
697
755
  export declare enum SelfManagedKafkaStartPosition {
698
756
  LATEST = "LATEST",
699
757
  TRIM_HORIZON = "TRIM_HORIZON"
700
758
  }
701
759
  /**
760
+ * @public
702
761
  * <p>This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.</p>
703
762
  */
704
763
  export interface SelfManagedKafkaAccessConfigurationVpc {
@@ -713,6 +772,7 @@ export interface SelfManagedKafkaAccessConfigurationVpc {
713
772
  SecurityGroup?: string[];
714
773
  }
715
774
  /**
775
+ * @public
716
776
  * <p>The parameters for using a self-managed Apache Kafka stream as a source.</p>
717
777
  */
718
778
  export interface PipeSourceSelfManagedKafkaParameters {
@@ -754,6 +814,7 @@ export interface PipeSourceSelfManagedKafkaParameters {
754
814
  Vpc?: SelfManagedKafkaAccessConfigurationVpc;
755
815
  }
756
816
  /**
817
+ * @public
757
818
  * <p>The parameters for using a Amazon SQS stream as a source.</p>
758
819
  */
759
820
  export interface PipeSourceSqsQueueParameters {
@@ -767,6 +828,7 @@ export interface PipeSourceSqsQueueParameters {
767
828
  MaximumBatchingWindowInSeconds?: number;
768
829
  }
769
830
  /**
831
+ * @public
770
832
  * <p>The parameters required to set up a source for your pipe.</p>
771
833
  */
772
834
  export interface PipeSourceParameters {
@@ -805,6 +867,7 @@ export interface PipeSourceParameters {
805
867
  SelfManagedKafkaParameters?: PipeSourceSelfManagedKafkaParameters;
806
868
  }
807
869
  /**
870
+ * @public
808
871
  * <p>The parameters for using an Batch job as a target.</p>
809
872
  */
810
873
  export interface PipeTargetBatchJobParameters {
@@ -845,6 +908,7 @@ export interface PipeTargetBatchJobParameters {
845
908
  Parameters?: Record<string, string>;
846
909
  }
847
910
  /**
911
+ * @public
848
912
  * <p>The parameters for using an CloudWatch Logs log stream as a target.</p>
849
913
  */
850
914
  export interface PipeTargetCloudWatchLogsParameters {
@@ -857,12 +921,16 @@ export interface PipeTargetCloudWatchLogsParameters {
857
921
  */
858
922
  Timestamp?: string;
859
923
  }
924
+ /**
925
+ * @public
926
+ */
860
927
  export declare enum LaunchType {
861
928
  EC2 = "EC2",
862
929
  EXTERNAL = "EXTERNAL",
863
930
  FARGATE = "FARGATE"
864
931
  }
865
932
  /**
933
+ * @public
866
934
  * <p>This structure specifies the network configuration for an Amazon ECS task.</p>
867
935
  */
868
936
  export interface NetworkConfiguration {
@@ -874,6 +942,7 @@ export interface NetworkConfiguration {
874
942
  awsvpcConfiguration?: AwsVpcConfiguration;
875
943
  }
876
944
  /**
945
+ * @public
877
946
  * <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
878
947
  * override the existing environment variables from the Docker image or the task definition. You must also specify a container name.</p>
879
948
  */
@@ -887,10 +956,14 @@ export interface EcsEnvironmentVariable {
887
956
  */
888
957
  value?: string;
889
958
  }
959
+ /**
960
+ * @public
961
+ */
890
962
  export declare enum EcsEnvironmentFileType {
891
963
  s3 = "s3"
892
964
  }
893
965
  /**
966
+ * @public
894
967
  * <p>A list of files containing the environment variables to pass to a container. You can
895
968
  * specify up to ten environment files. The file must have a <code>.env</code> file
896
969
  * extension. Each line in an environment file should contain an environment variable in
@@ -925,11 +998,15 @@ export interface EcsEnvironmentFile {
925
998
  */
926
999
  value: string | undefined;
927
1000
  }
1001
+ /**
1002
+ * @public
1003
+ */
928
1004
  export declare enum EcsResourceRequirementType {
929
1005
  GPU = "GPU",
930
1006
  InferenceAccelerator = "InferenceAccelerator"
931
1007
  }
932
1008
  /**
1009
+ * @public
933
1010
  * <p>The type and amount of a resource to assign to a container. The supported resource
934
1011
  * types are GPUs and Elastic Inference accelerators. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html">Working with
935
1012
  * GPUs on Amazon ECS</a> or <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html">Working with
@@ -956,8 +1033,9 @@ export interface EcsResourceRequirement {
956
1033
  value: string | undefined;
957
1034
  }
958
1035
  /**
1036
+ * @public
959
1037
  * <p>The overrides that are sent to a container. An empty container override can be passed in. An example of an empty
960
- * container override is <code>{"containerOverrides": [ ] }</code>. If a non-empty container override is specified, the <code>name</code> parameter must be included.</p>
1038
+ * container override is <code>\{"containerOverrides": [ ] \}</code>. If a non-empty container override is specified, the <code>name</code> parameter must be included.</p>
961
1039
  */
962
1040
  export interface EcsContainerOverride {
963
1041
  /**
@@ -997,6 +1075,7 @@ export interface EcsContainerOverride {
997
1075
  ResourceRequirements?: EcsResourceRequirement[];
998
1076
  }
999
1077
  /**
1078
+ * @public
1000
1079
  * <p>The amount of ephemeral storage to allocate for the task. This parameter is used to
1001
1080
  * expand the total amount of ephemeral storage available, beyond the default amount, for
1002
1081
  * tasks hosted on Fargate. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html">Fargate task
@@ -1016,6 +1095,7 @@ export interface EcsEphemeralStorage {
1016
1095
  sizeInGiB: number | undefined;
1017
1096
  }
1018
1097
  /**
1098
+ * @public
1019
1099
  * <p>Details on an Elastic Inference accelerator task override. This parameter is used to
1020
1100
  * override the Elastic Inference accelerator specified in the task definition. For more
1021
1101
  * information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/userguide/ecs-inference.html">Working with Amazon
@@ -1033,6 +1113,7 @@ export interface EcsInferenceAcceleratorOverride {
1033
1113
  deviceType?: string;
1034
1114
  }
1035
1115
  /**
1116
+ * @public
1036
1117
  * <p>The overrides that are associated with a task.</p>
1037
1118
  */
1038
1119
  export interface EcsTaskOverride {
@@ -1082,11 +1163,15 @@ export interface EcsTaskOverride {
1082
1163
  */
1083
1164
  TaskRoleArn?: string;
1084
1165
  }
1166
+ /**
1167
+ * @public
1168
+ */
1085
1169
  export declare enum PlacementConstraintType {
1086
1170
  DISTINCT_INSTANCE = "distinctInstance",
1087
1171
  MEMBER_OF = "memberOf"
1088
1172
  }
1089
1173
  /**
1174
+ * @public
1090
1175
  * <p>An object representing a constraint on task placement. To learn more, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html">Task Placement Constraints</a> in the Amazon Elastic Container Service Developer
1091
1176
  * Guide.</p>
1092
1177
  */
@@ -1104,12 +1189,16 @@ export interface PlacementConstraint {
1104
1189
  */
1105
1190
  expression?: string;
1106
1191
  }
1192
+ /**
1193
+ * @public
1194
+ */
1107
1195
  export declare enum PlacementStrategyType {
1108
1196
  BINPACK = "binpack",
1109
1197
  RANDOM = "random",
1110
1198
  SPREAD = "spread"
1111
1199
  }
1112
1200
  /**
1201
+ * @public
1113
1202
  * <p>The task placement strategy for a task or service. To learn more, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html">Task Placement Strategies</a> in the Amazon Elastic Container Service Service Developer
1114
1203
  * Guide.</p>
1115
1204
  */
@@ -1132,10 +1221,14 @@ export interface PlacementStrategy {
1132
1221
  */
1133
1222
  field?: string;
1134
1223
  }
1224
+ /**
1225
+ * @public
1226
+ */
1135
1227
  export declare enum PropagateTags {
1136
1228
  TASK_DEFINITION = "TASK_DEFINITION"
1137
1229
  }
1138
1230
  /**
1231
+ * @public
1139
1232
  * <p>A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses
1140
1233
  * support tagging.</p>
1141
1234
  */
@@ -1151,6 +1244,7 @@ export interface Tag {
1151
1244
  Value: string | undefined;
1152
1245
  }
1153
1246
  /**
1247
+ * @public
1154
1248
  * <p>The parameters for using an Amazon ECS task as a target.</p>
1155
1249
  */
1156
1250
  export interface PipeTargetEcsTaskParameters {
@@ -1244,6 +1338,7 @@ export interface PipeTargetEcsTaskParameters {
1244
1338
  Tags?: Tag[];
1245
1339
  }
1246
1340
  /**
1341
+ * @public
1247
1342
  * <p>The parameters for using an EventBridge event bus as a target.</p>
1248
1343
  */
1249
1344
  export interface PipeTargetEventBridgeEventBusParameters {
@@ -1273,6 +1368,7 @@ export interface PipeTargetEventBridgeEventBusParameters {
1273
1368
  Time?: string;
1274
1369
  }
1275
1370
  /**
1371
+ * @public
1276
1372
  * <p>These are custom parameter to be used when the target is an API Gateway REST APIs or
1277
1373
  * EventBridge ApiDestinations.</p>
1278
1374
  */
@@ -1294,6 +1390,7 @@ export interface PipeTargetHttpParameters {
1294
1390
  QueryStringParameters?: Record<string, string>;
1295
1391
  }
1296
1392
  /**
1393
+ * @public
1297
1394
  * <p>The parameters for using a Kinesis stream as a source.</p>
1298
1395
  */
1299
1396
  export interface PipeTargetKinesisStreamParameters {
@@ -1305,11 +1402,15 @@ export interface PipeTargetKinesisStreamParameters {
1305
1402
  */
1306
1403
  PartitionKey: string | undefined;
1307
1404
  }
1405
+ /**
1406
+ * @public
1407
+ */
1308
1408
  export declare enum PipeTargetInvocationType {
1309
1409
  FIRE_AND_FORGET = "FIRE_AND_FORGET",
1310
1410
  REQUEST_RESPONSE = "REQUEST_RESPONSE"
1311
1411
  }
1312
1412
  /**
1413
+ * @public
1313
1414
  * <p>The parameters for using a Lambda function as a target.</p>
1314
1415
  */
1315
1416
  export interface PipeTargetLambdaFunctionParameters {
@@ -1337,6 +1438,7 @@ export interface PipeTargetLambdaFunctionParameters {
1337
1438
  InvocationType?: PipeTargetInvocationType | string;
1338
1439
  }
1339
1440
  /**
1441
+ * @public
1340
1442
  * <p>These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the
1341
1443
  * Amazon Redshift Data API ExecuteStatement.</p>
1342
1444
  */
@@ -1370,6 +1472,7 @@ export interface PipeTargetRedshiftDataParameters {
1370
1472
  Sqls: string[] | undefined;
1371
1473
  }
1372
1474
  /**
1475
+ * @public
1373
1476
  * <p>Name/Value pair of a parameter to start execution of a SageMaker Model Building
1374
1477
  * Pipeline.</p>
1375
1478
  */
@@ -1384,6 +1487,7 @@ export interface SageMakerPipelineParameter {
1384
1487
  Value: string | undefined;
1385
1488
  }
1386
1489
  /**
1490
+ * @public
1387
1491
  * <p>The parameters for using a SageMaker pipeline as a target.</p>
1388
1492
  */
1389
1493
  export interface PipeTargetSageMakerPipelineParameters {
@@ -1393,6 +1497,7 @@ export interface PipeTargetSageMakerPipelineParameters {
1393
1497
  PipelineParameterList?: SageMakerPipelineParameter[];
1394
1498
  }
1395
1499
  /**
1500
+ * @public
1396
1501
  * <p>The parameters for using a Amazon SQS stream as a source.</p>
1397
1502
  */
1398
1503
  export interface PipeTargetSqsQueueParameters {
@@ -1407,6 +1512,7 @@ export interface PipeTargetSqsQueueParameters {
1407
1512
  MessageDeduplicationId?: string;
1408
1513
  }
1409
1514
  /**
1515
+ * @public
1410
1516
  * <p>The parameters for using a Step Functions state machine as a target.</p>
1411
1517
  */
1412
1518
  export interface PipeTargetStateMachineParameters {
@@ -1416,6 +1522,7 @@ export interface PipeTargetStateMachineParameters {
1416
1522
  InvocationType?: PipeTargetInvocationType | string;
1417
1523
  }
1418
1524
  /**
1525
+ * @public
1419
1526
  * <p>The parameters required to set up a target for your pipe.</p>
1420
1527
  */
1421
1528
  export interface PipeTargetParameters {
@@ -1472,6 +1579,9 @@ export interface PipeTargetParameters {
1472
1579
  */
1473
1580
  CloudWatchLogsParameters?: PipeTargetCloudWatchLogsParameters;
1474
1581
  }
1582
+ /**
1583
+ * @public
1584
+ */
1475
1585
  export interface CreatePipeRequest {
1476
1586
  /**
1477
1587
  * <p>The name of the pipe.</p>
@@ -1518,6 +1628,9 @@ export interface CreatePipeRequest {
1518
1628
  */
1519
1629
  Tags?: Record<string, string>;
1520
1630
  }
1631
+ /**
1632
+ * @public
1633
+ */
1521
1634
  export declare enum PipeState {
1522
1635
  CREATE_FAILED = "CREATE_FAILED",
1523
1636
  CREATING = "CREATING",
@@ -1531,6 +1644,9 @@ export declare enum PipeState {
1531
1644
  UPDATE_FAILED = "UPDATE_FAILED",
1532
1645
  UPDATING = "UPDATING"
1533
1646
  }
1647
+ /**
1648
+ * @public
1649
+ */
1534
1650
  export interface CreatePipeResponse {
1535
1651
  /**
1536
1652
  * <p>The ARN of the pipe.</p>
@@ -1558,6 +1674,7 @@ export interface CreatePipeResponse {
1558
1674
  LastModifiedTime?: Date;
1559
1675
  }
1560
1676
  /**
1677
+ * @public
1561
1678
  * <p>This exception occurs due to unexpected causes.</p>
1562
1679
  */
1563
1680
  export declare class InternalException extends __BaseException {
@@ -1573,6 +1690,7 @@ export declare class InternalException extends __BaseException {
1573
1690
  constructor(opts: __ExceptionOptionType<InternalException, __BaseException>);
1574
1691
  }
1575
1692
  /**
1693
+ * @public
1576
1694
  * <p>An entity that you specified does not exist.</p>
1577
1695
  */
1578
1696
  export declare class NotFoundException extends __BaseException {
@@ -1584,6 +1702,7 @@ export declare class NotFoundException extends __BaseException {
1584
1702
  constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
1585
1703
  }
1586
1704
  /**
1705
+ * @public
1587
1706
  * <p>A quota has been exceeded.</p>
1588
1707
  */
1589
1708
  export declare class ServiceQuotaExceededException extends __BaseException {
@@ -1611,6 +1730,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
1611
1730
  constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
1612
1731
  }
1613
1732
  /**
1733
+ * @public
1614
1734
  * <p>An action was throttled.</p>
1615
1735
  */
1616
1736
  export declare class ThrottlingException extends __BaseException {
@@ -1634,6 +1754,7 @@ export declare class ThrottlingException extends __BaseException {
1634
1754
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
1635
1755
  }
1636
1756
  /**
1757
+ * @public
1637
1758
  * <p>Indicates that an error has occurred while performing a validate operation.</p>
1638
1759
  */
1639
1760
  export interface ValidationExceptionField {
@@ -1647,6 +1768,7 @@ export interface ValidationExceptionField {
1647
1768
  message: string | undefined;
1648
1769
  }
1649
1770
  /**
1771
+ * @public
1650
1772
  * <p>Indicates that an error has occurred while performing a validate operation.</p>
1651
1773
  */
1652
1774
  export declare class ValidationException extends __BaseException {
@@ -1661,17 +1783,26 @@ export declare class ValidationException extends __BaseException {
1661
1783
  */
1662
1784
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
1663
1785
  }
1786
+ /**
1787
+ * @public
1788
+ */
1664
1789
  export interface DeletePipeRequest {
1665
1790
  /**
1666
1791
  * <p>The name of the pipe.</p>
1667
1792
  */
1668
1793
  Name: string | undefined;
1669
1794
  }
1795
+ /**
1796
+ * @public
1797
+ */
1670
1798
  export declare enum RequestedPipeStateDescribeResponse {
1671
1799
  DELETED = "DELETED",
1672
1800
  RUNNING = "RUNNING",
1673
1801
  STOPPED = "STOPPED"
1674
1802
  }
1803
+ /**
1804
+ * @public
1805
+ */
1675
1806
  export interface DeletePipeResponse {
1676
1807
  /**
1677
1808
  * <p>The ARN of the pipe.</p>
@@ -1698,12 +1829,18 @@ export interface DeletePipeResponse {
1698
1829
  */
1699
1830
  LastModifiedTime?: Date;
1700
1831
  }
1832
+ /**
1833
+ * @public
1834
+ */
1701
1835
  export interface DescribePipeRequest {
1702
1836
  /**
1703
1837
  * <p>The name of the pipe.</p>
1704
1838
  */
1705
1839
  Name: string | undefined;
1706
1840
  }
1841
+ /**
1842
+ * @public
1843
+ */
1707
1844
  export interface DescribePipeResponse {
1708
1845
  /**
1709
1846
  * <p>The ARN of the pipe.</p>
@@ -1770,6 +1907,9 @@ export interface DescribePipeResponse {
1770
1907
  */
1771
1908
  LastModifiedTime?: Date;
1772
1909
  }
1910
+ /**
1911
+ * @public
1912
+ */
1773
1913
  export interface ListPipesRequest {
1774
1914
  /**
1775
1915
  * <p>A value that will return a subset of the pipes associated with this account. For example, <code>"NamePrefix": "ABC"</code> will return
@@ -1804,6 +1944,7 @@ export interface ListPipesRequest {
1804
1944
  Limit?: number;
1805
1945
  }
1806
1946
  /**
1947
+ * @public
1807
1948
  * <p>An object that represents a pipe. Amazon EventBridgePipes connect event sources to targets and reduces the need for specialized knowledge and integration code.</p>
1808
1949
  */
1809
1950
  export interface Pipe {
@@ -1848,6 +1989,9 @@ export interface Pipe {
1848
1989
  */
1849
1990
  Enrichment?: string;
1850
1991
  }
1992
+ /**
1993
+ * @public
1994
+ */
1851
1995
  export interface ListPipesResponse {
1852
1996
  /**
1853
1997
  * <p>The pipes returned by the call.</p>
@@ -1860,24 +2004,36 @@ export interface ListPipesResponse {
1860
2004
  */
1861
2005
  NextToken?: string;
1862
2006
  }
2007
+ /**
2008
+ * @public
2009
+ */
1863
2010
  export interface ListTagsForResourceRequest {
1864
2011
  /**
1865
2012
  * <p>The ARN of the pipe for which you want to view tags.</p>
1866
2013
  */
1867
2014
  resourceArn: string | undefined;
1868
2015
  }
2016
+ /**
2017
+ * @public
2018
+ */
1869
2019
  export interface ListTagsForResourceResponse {
1870
2020
  /**
1871
2021
  * <p>The list of key-value pairs to associate with the pipe.</p>
1872
2022
  */
1873
2023
  tags?: Record<string, string>;
1874
2024
  }
2025
+ /**
2026
+ * @public
2027
+ */
1875
2028
  export interface StartPipeRequest {
1876
2029
  /**
1877
2030
  * <p>The name of the pipe.</p>
1878
2031
  */
1879
2032
  Name: string | undefined;
1880
2033
  }
2034
+ /**
2035
+ * @public
2036
+ */
1881
2037
  export interface StartPipeResponse {
1882
2038
  /**
1883
2039
  * <p>The ARN of the pipe.</p>
@@ -1904,12 +2060,18 @@ export interface StartPipeResponse {
1904
2060
  */
1905
2061
  LastModifiedTime?: Date;
1906
2062
  }
2063
+ /**
2064
+ * @public
2065
+ */
1907
2066
  export interface StopPipeRequest {
1908
2067
  /**
1909
2068
  * <p>The name of the pipe.</p>
1910
2069
  */
1911
2070
  Name: string | undefined;
1912
2071
  }
2072
+ /**
2073
+ * @public
2074
+ */
1913
2075
  export interface StopPipeResponse {
1914
2076
  /**
1915
2077
  * <p>The ARN of the pipe.</p>
@@ -1937,6 +2099,7 @@ export interface StopPipeResponse {
1937
2099
  LastModifiedTime?: Date;
1938
2100
  }
1939
2101
  /**
2102
+ * @public
1940
2103
  * <p>The parameters for using an Active MQ broker as a source.</p>
1941
2104
  */
1942
2105
  export interface UpdatePipeSourceActiveMQBrokerParameters {
@@ -1954,6 +2117,7 @@ export interface UpdatePipeSourceActiveMQBrokerParameters {
1954
2117
  MaximumBatchingWindowInSeconds?: number;
1955
2118
  }
1956
2119
  /**
2120
+ * @public
1957
2121
  * <p>The parameters for using a DynamoDB stream as a source.</p>
1958
2122
  */
1959
2123
  export interface UpdatePipeSourceDynamoDBStreamParameters {
@@ -1990,6 +2154,7 @@ export interface UpdatePipeSourceDynamoDBStreamParameters {
1990
2154
  ParallelizationFactor?: number;
1991
2155
  }
1992
2156
  /**
2157
+ * @public
1993
2158
  * <p>The parameters for using a Kinesis stream as a source.</p>
1994
2159
  */
1995
2160
  export interface UpdatePipeSourceKinesisStreamParameters {
@@ -2026,6 +2191,7 @@ export interface UpdatePipeSourceKinesisStreamParameters {
2026
2191
  ParallelizationFactor?: number;
2027
2192
  }
2028
2193
  /**
2194
+ * @public
2029
2195
  * <p>The parameters for using an MSK stream as a source.</p>
2030
2196
  */
2031
2197
  export interface UpdatePipeSourceManagedStreamingKafkaParameters {
@@ -2043,6 +2209,7 @@ export interface UpdatePipeSourceManagedStreamingKafkaParameters {
2043
2209
  MaximumBatchingWindowInSeconds?: number;
2044
2210
  }
2045
2211
  /**
2212
+ * @public
2046
2213
  * <p>The parameters for using a Rabbit MQ broker as a source.</p>
2047
2214
  */
2048
2215
  export interface UpdatePipeSourceRabbitMQBrokerParameters {
@@ -2060,6 +2227,7 @@ export interface UpdatePipeSourceRabbitMQBrokerParameters {
2060
2227
  MaximumBatchingWindowInSeconds?: number;
2061
2228
  }
2062
2229
  /**
2230
+ * @public
2063
2231
  * <p>The parameters for using a self-managed Apache Kafka stream as a source.</p>
2064
2232
  */
2065
2233
  export interface UpdatePipeSourceSelfManagedKafkaParameters {
@@ -2085,6 +2253,7 @@ export interface UpdatePipeSourceSelfManagedKafkaParameters {
2085
2253
  Vpc?: SelfManagedKafkaAccessConfigurationVpc;
2086
2254
  }
2087
2255
  /**
2256
+ * @public
2088
2257
  * <p>The parameters for using a Amazon SQS stream as a source.</p>
2089
2258
  */
2090
2259
  export interface UpdatePipeSourceSqsQueueParameters {
@@ -2098,6 +2267,7 @@ export interface UpdatePipeSourceSqsQueueParameters {
2098
2267
  MaximumBatchingWindowInSeconds?: number;
2099
2268
  }
2100
2269
  /**
2270
+ * @public
2101
2271
  * <p>The parameters required to set up a source for your pipe.</p>
2102
2272
  */
2103
2273
  export interface UpdatePipeSourceParameters {
@@ -2135,6 +2305,9 @@ export interface UpdatePipeSourceParameters {
2135
2305
  */
2136
2306
  SelfManagedKafkaParameters?: UpdatePipeSourceSelfManagedKafkaParameters;
2137
2307
  }
2308
+ /**
2309
+ * @public
2310
+ */
2138
2311
  export interface UpdatePipeRequest {
2139
2312
  /**
2140
2313
  * <p>The name of the pipe.</p>
@@ -2173,6 +2346,9 @@ export interface UpdatePipeRequest {
2173
2346
  */
2174
2347
  RoleArn: string | undefined;
2175
2348
  }
2349
+ /**
2350
+ * @public
2351
+ */
2176
2352
  export interface UpdatePipeResponse {
2177
2353
  /**
2178
2354
  * <p>The ARN of the pipe.</p>
@@ -2199,6 +2375,9 @@ export interface UpdatePipeResponse {
2199
2375
  */
2200
2376
  LastModifiedTime?: Date;
2201
2377
  }
2378
+ /**
2379
+ * @public
2380
+ */
2202
2381
  export interface TagResourceRequest {
2203
2382
  /**
2204
2383
  * <p>The ARN of the pipe.</p>
@@ -2209,8 +2388,14 @@ export interface TagResourceRequest {
2209
2388
  */
2210
2389
  tags: Record<string, string> | undefined;
2211
2390
  }
2391
+ /**
2392
+ * @public
2393
+ */
2212
2394
  export interface TagResourceResponse {
2213
2395
  }
2396
+ /**
2397
+ * @public
2398
+ */
2214
2399
  export interface UntagResourceRequest {
2215
2400
  /**
2216
2401
  * <p>The ARN of the pipe.</p>
@@ -2221,6 +2406,9 @@ export interface UntagResourceRequest {
2221
2406
  */
2222
2407
  tagKeys: string[] | undefined;
2223
2408
  }
2409
+ /**
2410
+ * @public
2411
+ */
2224
2412
  export interface UntagResourceResponse {
2225
2413
  }
2226
2414
  /**