@aws-sdk/client-pipes 3.529.1 → 3.535.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. package/dist-types/Pipes.d.ts +2 -1
  2. package/dist-types/PipesClient.d.ts +1 -1
  3. package/dist-types/commands/CreatePipeCommand.d.ts +2 -1
  4. package/dist-types/commands/DeletePipeCommand.d.ts +2 -1
  5. package/dist-types/commands/DescribePipeCommand.d.ts +2 -1
  6. package/dist-types/commands/ListPipesCommand.d.ts +2 -1
  7. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
  8. package/dist-types/commands/StartPipeCommand.d.ts +2 -1
  9. package/dist-types/commands/StopPipeCommand.d.ts +2 -1
  10. package/dist-types/commands/TagResourceCommand.d.ts +2 -1
  11. package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
  12. package/dist-types/commands/UpdatePipeCommand.d.ts +2 -1
  13. package/dist-types/models/models_0.d.ts +419 -419
  14. package/dist-types/runtimeConfig.browser.d.ts +2 -2
  15. package/dist-types/runtimeConfig.d.ts +2 -2
  16. package/dist-types/runtimeConfig.native.d.ts +2 -2
  17. package/dist-types/runtimeConfig.shared.d.ts +2 -2
  18. package/dist-types/ts3.4/Pipes.d.ts +1 -0
  19. package/dist-types/ts3.4/commands/CreatePipeCommand.d.ts +9 -0
  20. package/dist-types/ts3.4/commands/DeletePipeCommand.d.ts +9 -0
  21. package/dist-types/ts3.4/commands/DescribePipeCommand.d.ts +9 -0
  22. package/dist-types/ts3.4/commands/ListPipesCommand.d.ts +9 -0
  23. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
  24. package/dist-types/ts3.4/commands/StartPipeCommand.d.ts +9 -0
  25. package/dist-types/ts3.4/commands/StopPipeCommand.d.ts +9 -0
  26. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
  27. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
  28. package/dist-types/ts3.4/commands/UpdatePipeCommand.d.ts +9 -0
  29. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -2
  30. package/dist-types/ts3.4/runtimeConfig.d.ts +2 -2
  31. package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -2
  32. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -2
  33. package/package.json +40 -40
@@ -13,58 +13,58 @@ export declare const AssignPublicIp: {
13
13
  */
14
14
  export type AssignPublicIp = (typeof AssignPublicIp)[keyof typeof AssignPublicIp];
15
15
  /**
16
- * @public
17
16
  * <p>This structure specifies the VPC subnets and security groups for the task, and whether a public IP address is to be used.
18
17
  * This structure is relevant only for ECS tasks that use the <code>awsvpc</code> network mode.</p>
18
+ * @public
19
19
  */
20
20
  export interface AwsVpcConfiguration {
21
21
  /**
22
- * @public
23
22
  * <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
+ * @public
24
24
  */
25
25
  Subnets: string[] | undefined;
26
26
  /**
27
- * @public
28
27
  * <p>Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many
29
28
  * as five security groups. If you do not specify a security group, the default security group for the VPC is used.</p>
29
+ * @public
30
30
  */
31
31
  SecurityGroups?: string[];
32
32
  /**
33
- * @public
34
33
  * <p>Specifies whether the task's elastic network interface receives a public IP address. You can specify <code>ENABLED</code> only when
35
34
  * <code>LaunchType</code> in <code>EcsParameters</code> is set to <code>FARGATE</code>.</p>
35
+ * @public
36
36
  */
37
37
  AssignPublicIp?: AssignPublicIp;
38
38
  }
39
39
  /**
40
- * @public
41
40
  * <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.
42
41
  * 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>
42
+ * @public
43
43
  */
44
44
  export interface BatchArrayProperties {
45
45
  /**
46
- * @public
47
46
  * <p>The size of the array, if this is an array batch job.</p>
47
+ * @public
48
48
  */
49
49
  Size?: number;
50
50
  }
51
51
  /**
52
- * @public
53
52
  * <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
54
53
  * environment variables from the Docker image or the task definition.</p>
55
54
  * <note>
56
55
  * <p>Environment variables cannot start with "<code>Batch</code>". This naming convention is reserved for variables that Batch sets.</p>
57
56
  * </note>
57
+ * @public
58
58
  */
59
59
  export interface BatchEnvironmentVariable {
60
60
  /**
61
- * @public
62
61
  * <p>The name of the key-value pair. For environment variables, this is the name of the environment variable.</p>
62
+ * @public
63
63
  */
64
64
  Name?: string;
65
65
  /**
66
- * @public
67
66
  * <p>The value of the key-value pair. For environment variables, this is the value of the environment variable.</p>
67
+ * @public
68
68
  */
69
69
  Value?: string;
70
70
  }
@@ -82,17 +82,16 @@ export declare const BatchResourceRequirementType: {
82
82
  */
83
83
  export type BatchResourceRequirementType = (typeof BatchResourceRequirementType)[keyof typeof BatchResourceRequirementType];
84
84
  /**
85
- * @public
86
85
  * <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>
86
+ * @public
87
87
  */
88
88
  export interface BatchResourceRequirement {
89
89
  /**
90
- * @public
91
90
  * <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>
91
+ * @public
92
92
  */
93
93
  Type: BatchResourceRequirementType | undefined;
94
94
  /**
95
- * @public
96
95
  * <p>The quantity of the specified resource to reserve for the container. The values vary based on the
97
96
  * <code>type</code> specified.</p>
98
97
  * <dl>
@@ -254,40 +253,41 @@ export interface BatchResourceRequirement {
254
253
  * </dl>
255
254
  * </dd>
256
255
  * </dl>
256
+ * @public
257
257
  */
258
258
  Value: string | undefined;
259
259
  }
260
260
  /**
261
- * @public
262
261
  * <p>The overrides that are sent to a container.</p>
262
+ * @public
263
263
  */
264
264
  export interface BatchContainerOverrides {
265
265
  /**
266
- * @public
267
266
  * <p>The command to send to the container that overrides the default command from the Docker image or the task definition.</p>
267
+ * @public
268
268
  */
269
269
  Command?: string[];
270
270
  /**
271
- * @public
272
271
  * <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
273
272
  * environment variables from the Docker image or the task definition.</p>
274
273
  * <note>
275
274
  * <p>Environment variables cannot start with "<code>Batch</code>". This naming convention is reserved for variables that Batch sets.</p>
276
275
  * </note>
276
+ * @public
277
277
  */
278
278
  Environment?: BatchEnvironmentVariable[];
279
279
  /**
280
- * @public
281
280
  * <p>The instance type to use for a multi-node parallel job.</p>
282
281
  * <note>
283
282
  * <p>This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.</p>
284
283
  * </note>
284
+ * @public
285
285
  */
286
286
  InstanceType?: string;
287
287
  /**
288
- * @public
289
288
  * <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>,
290
289
  * and <code>VCPU</code>.</p>
290
+ * @public
291
291
  */
292
292
  ResourceRequirements?: BatchResourceRequirement[];
293
293
  }
@@ -304,96 +304,96 @@ export declare const BatchJobDependencyType: {
304
304
  */
305
305
  export type BatchJobDependencyType = (typeof BatchJobDependencyType)[keyof typeof BatchJobDependencyType];
306
306
  /**
307
- * @public
308
307
  * <p>An object that represents an Batch job dependency.</p>
308
+ * @public
309
309
  */
310
310
  export interface BatchJobDependency {
311
311
  /**
312
- * @public
313
312
  * <p>The job ID of the Batch job that's associated with this dependency.</p>
313
+ * @public
314
314
  */
315
315
  JobId?: string;
316
316
  /**
317
- * @public
318
317
  * <p>The type of the job dependency.</p>
318
+ * @public
319
319
  */
320
320
  Type?: BatchJobDependencyType;
321
321
  }
322
322
  /**
323
- * @public
324
323
  * <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">
325
324
  * Automated job retries</a> in the <i>Batch User Guide</i>.</p>
325
+ * @public
326
326
  */
327
327
  export interface BatchRetryStrategy {
328
328
  /**
329
- * @public
330
329
  * <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
331
330
  * failure the same number of attempts as the value.</p>
331
+ * @public
332
332
  */
333
333
  Attempts?: number;
334
334
  }
335
335
  /**
336
- * @public
337
336
  * <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>
337
+ * @public
338
338
  */
339
339
  export interface CapacityProviderStrategyItem {
340
340
  /**
341
- * @public
342
341
  * <p>The short name of the capacity provider.</p>
342
+ * @public
343
343
  */
344
344
  capacityProvider: string | undefined;
345
345
  /**
346
- * @public
347
346
  * <p>The weight value designates the relative percentage of the total number of tasks launched
348
347
  * that should use the specified capacity provider. The weight value is taken into consideration
349
348
  * after the base value, if defined, is satisfied.</p>
349
+ * @public
350
350
  */
351
351
  weight?: number;
352
352
  /**
353
- * @public
354
353
  * <p>The base value designates how many tasks, at a minimum, to run on the specified capacity
355
354
  * provider. Only one capacity provider in a capacity provider strategy can have a base defined.
356
355
  * If no value is specified, the default value of 0 is used. </p>
356
+ * @public
357
357
  */
358
358
  base?: number;
359
359
  }
360
360
  /**
361
- * @public
362
361
  * <p>The Amazon CloudWatch Logs logging configuration settings for the pipe.</p>
362
+ * @public
363
363
  */
364
364
  export interface CloudwatchLogsLogDestination {
365
365
  /**
366
- * @public
367
366
  * <p>The Amazon Web Services Resource Name (ARN) for the CloudWatch log group to which EventBridge sends the log records.</p>
367
+ * @public
368
368
  */
369
369
  LogGroupArn?: string;
370
370
  }
371
371
  /**
372
- * @public
373
372
  * <p>The Amazon CloudWatch Logs logging configuration settings for the pipe.</p>
373
+ * @public
374
374
  */
375
375
  export interface CloudwatchLogsLogDestinationParameters {
376
376
  /**
377
- * @public
378
377
  * <p>The Amazon Web Services Resource Name (ARN) for the CloudWatch log group to which EventBridge sends the log records.</p>
378
+ * @public
379
379
  */
380
380
  LogGroupArn: string | undefined;
381
381
  }
382
382
  /**
383
- * @public
384
383
  * <p>An action you attempted resulted in an exception.</p>
384
+ * @public
385
385
  */
386
386
  export declare class ConflictException extends __BaseException {
387
387
  readonly name: "ConflictException";
388
388
  readonly $fault: "client";
389
389
  /**
390
- * @public
391
390
  * <p>The ID of the resource that caused the exception.</p>
391
+ * @public
392
392
  */
393
393
  resourceId: string | undefined;
394
394
  /**
395
- * @public
396
395
  * <p>The type of resource that caused the exception.</p>
396
+ * @public
397
397
  */
398
398
  resourceType: string | undefined;
399
399
  /**
@@ -414,47 +414,46 @@ export declare const RequestedPipeState: {
414
414
  */
415
415
  export type RequestedPipeState = (typeof RequestedPipeState)[keyof typeof RequestedPipeState];
416
416
  /**
417
- * @public
418
417
  * <p>These are custom parameter to be used when the target is an API Gateway REST APIs or
419
418
  * EventBridge ApiDestinations. In the latter case, these are merged with any
420
419
  * InvocationParameters specified on the Connection, with any values from the Connection taking
421
420
  * precedence.</p>
421
+ * @public
422
422
  */
423
423
  export interface PipeEnrichmentHttpParameters {
424
424
  /**
425
- * @public
426
425
  * <p>The path parameter values to be used to populate API Gateway REST API or EventBridge
427
426
  * ApiDestination path wildcards ("*").</p>
427
+ * @public
428
428
  */
429
429
  PathParameterValues?: string[];
430
430
  /**
431
- * @public
432
431
  * <p>The headers that need to be sent as part of request invoking the API Gateway REST API or
433
432
  * EventBridge ApiDestination.</p>
433
+ * @public
434
434
  */
435
435
  HeaderParameters?: Record<string, string>;
436
436
  /**
437
- * @public
438
437
  * <p>The query string keys/values that need to be sent as part of request invoking the API Gateway
439
438
  * REST API or EventBridge ApiDestination.</p>
439
+ * @public
440
440
  */
441
441
  QueryStringParameters?: Record<string, string>;
442
442
  }
443
443
  /**
444
- * @public
445
444
  * <p>The parameters required to set up enrichment on your pipe.</p>
445
+ * @public
446
446
  */
447
447
  export interface PipeEnrichmentParameters {
448
448
  /**
449
- * @public
450
449
  * <p>Valid JSON text passed to the enrichment. In this case, nothing from the event itself is
451
450
  * passed to the enrichment. For more information, see <a href="http://www.rfc-editor.org/rfc/rfc7159.txt">The JavaScript Object Notation (JSON) Data
452
451
  * Interchange Format</a>.</p>
453
452
  * <p>To remove an input template, specify an empty string.</p>
453
+ * @public
454
454
  */
455
455
  InputTemplate?: string;
456
456
  /**
457
- * @public
458
457
  * <p>Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or
459
458
  * EventBridge ApiDestination.</p>
460
459
  * <p>If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can
@@ -462,17 +461,18 @@ export interface PipeEnrichmentParameters {
462
461
  * of your target invoking request. If you're using ApiDestinations, the corresponding Connection
463
462
  * can also have these values configured. In case of any conflicting keys, values from the
464
463
  * Connection take precedence.</p>
464
+ * @public
465
465
  */
466
466
  HttpParameters?: PipeEnrichmentHttpParameters;
467
467
  }
468
468
  /**
469
- * @public
470
469
  * <p>The Amazon Kinesis Data Firehose logging configuration settings for the pipe.</p>
470
+ * @public
471
471
  */
472
472
  export interface FirehoseLogDestinationParameters {
473
473
  /**
474
- * @public
475
474
  * <p>Specifies the Amazon Resource Name (ARN) of the Kinesis Data Firehose delivery stream to which EventBridge delivers the pipe log records.</p>
475
+ * @public
476
476
  */
477
477
  DeliveryStreamArn: string | undefined;
478
478
  }
@@ -515,22 +515,21 @@ export declare const S3OutputFormat: {
515
515
  */
516
516
  export type S3OutputFormat = (typeof S3OutputFormat)[keyof typeof S3OutputFormat];
517
517
  /**
518
- * @public
519
518
  * <p>The Amazon S3 logging configuration settings for the pipe.</p>
519
+ * @public
520
520
  */
521
521
  export interface S3LogDestinationParameters {
522
522
  /**
523
- * @public
524
523
  * <p>Specifies the name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.</p>
524
+ * @public
525
525
  */
526
526
  BucketName: string | undefined;
527
527
  /**
528
- * @public
529
528
  * <p>Specifies the Amazon Web Services account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.</p>
529
+ * @public
530
530
  */
531
531
  BucketOwner: string | undefined;
532
532
  /**
533
- * @public
534
533
  * <p>How EventBridge should format the log records.</p>
535
534
  * <ul>
536
535
  * <li>
@@ -547,21 +546,21 @@ export interface S3LogDestinationParameters {
547
546
  * </p>
548
547
  * </li>
549
548
  * </ul>
549
+ * @public
550
550
  */
551
551
  OutputFormat?: S3OutputFormat;
552
552
  /**
553
- * @public
554
553
  * <p>Specifies any prefix text with which to begin Amazon S3 log object names.</p>
555
554
  * <p>You can use prefixes to organize the data that you store in Amazon S3 buckets.
556
555
  * A prefix is a string of characters at the beginning of the object key name.
557
556
  * A prefix can be any length, subject to the maximum length of the object key name (1,024 bytes).
558
557
  * For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html">Organizing objects using prefixes</a>
559
558
  * in the <i>Amazon Simple Storage Service User Guide</i>.</p>
559
+ * @public
560
560
  */
561
561
  Prefix?: string;
562
562
  }
563
563
  /**
564
- * @public
565
564
  * <p>Specifies the logging configuration settings for the pipe.</p>
566
565
  * <p>When you call <code>UpdatePipe</code>, EventBridge updates the fields in the
567
566
  * <code>PipeLogConfigurationParameters</code> object atomically as one and overrides
@@ -578,41 +577,42 @@ export interface S3LogDestinationParameters {
578
577
  * specify the fields in the <code>FirehoseLogDestinationParameters</code> object in order to
579
578
  * retain the Kinesis Data Firehose stream log destination. </p>
580
579
  * <p>For more information on generating pipe log records, see <a href="eventbridge/latest/userguide/eb-pipes-logs.html">Log EventBridge Pipes</a> in the <i>Amazon EventBridge User Guide</i>.</p>
580
+ * @public
581
581
  */
582
582
  export interface PipeLogConfigurationParameters {
583
583
  /**
584
- * @public
585
584
  * <p>The Amazon S3 logging configuration settings for the pipe.</p>
585
+ * @public
586
586
  */
587
587
  S3LogDestination?: S3LogDestinationParameters;
588
588
  /**
589
- * @public
590
589
  * <p>The Amazon Kinesis Data Firehose logging configuration settings for the pipe.</p>
590
+ * @public
591
591
  */
592
592
  FirehoseLogDestination?: FirehoseLogDestinationParameters;
593
593
  /**
594
- * @public
595
594
  * <p>The Amazon CloudWatch Logs logging configuration settings for the pipe.</p>
595
+ * @public
596
596
  */
597
597
  CloudwatchLogsLogDestination?: CloudwatchLogsLogDestinationParameters;
598
598
  /**
599
- * @public
600
599
  * <p>The level of logging detail to include. This applies to all log destinations for the pipe.</p>
601
600
  * <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs.html#eb-pipes-logs-level">Specifying EventBridge Pipes log level</a> in the <i>Amazon EventBridge User Guide</i>.</p>
601
+ * @public
602
602
  */
603
603
  Level: LogLevel | undefined;
604
604
  /**
605
- * @public
606
605
  * <p>Specify <code>ON</code> to include the execution data (specifically, the <code>payload</code> and <code>awsRequest</code> fields) in the log messages for this pipe.</p>
607
606
  * <p>This applies to all log destinations for the pipe.</p>
608
607
  * <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs.html#eb-pipes-logs-execution-data">Including execution data in logs</a> in the <i>Amazon EventBridge User Guide</i>.</p>
609
608
  * <p>The default is <code>OFF</code>.</p>
609
+ * @public
610
610
  */
611
611
  IncludeExecutionData?: IncludeExecutionDataOption[];
612
612
  }
613
613
  /**
614
- * @public
615
614
  * <p>The Secrets Manager secret that stores your broker credentials.</p>
615
+ * @public
616
616
  */
617
617
  export type MQBrokerAccessCredentials = MQBrokerAccessCredentials.BasicAuthMember | MQBrokerAccessCredentials.$UnknownMember;
618
618
  /**
@@ -620,8 +620,8 @@ export type MQBrokerAccessCredentials = MQBrokerAccessCredentials.BasicAuthMembe
620
620
  */
621
621
  export declare namespace MQBrokerAccessCredentials {
622
622
  /**
623
- * @public
624
623
  * <p>The ARN of the Secrets Manager secret.</p>
624
+ * @public
625
625
  */
626
626
  interface BasicAuthMember {
627
627
  BasicAuth: string;
@@ -641,41 +641,41 @@ export declare namespace MQBrokerAccessCredentials {
641
641
  const visit: <T>(value: MQBrokerAccessCredentials, visitor: Visitor<T>) => T;
642
642
  }
643
643
  /**
644
- * @public
645
644
  * <p>The parameters for using an Active MQ broker as a source.</p>
645
+ * @public
646
646
  */
647
647
  export interface PipeSourceActiveMQBrokerParameters {
648
648
  /**
649
- * @public
650
649
  * <p>The credentials needed to access the resource.</p>
650
+ * @public
651
651
  */
652
652
  Credentials: MQBrokerAccessCredentials | undefined;
653
653
  /**
654
- * @public
655
654
  * <p>The name of the destination queue to consume.</p>
655
+ * @public
656
656
  */
657
657
  QueueName: string | undefined;
658
658
  /**
659
- * @public
660
659
  * <p>The maximum number of records to include in each batch.</p>
660
+ * @public
661
661
  */
662
662
  BatchSize?: number;
663
663
  /**
664
- * @public
665
664
  * <p>The maximum length of a time to wait for events.</p>
665
+ * @public
666
666
  */
667
667
  MaximumBatchingWindowInSeconds?: number;
668
668
  }
669
669
  /**
670
- * @public
671
670
  * <p>A <code>DeadLetterConfig</code> object that contains information about a dead-letter queue configuration.</p>
671
+ * @public
672
672
  */
673
673
  export interface DeadLetterConfig {
674
674
  /**
675
- * @public
676
675
  * <p>The ARN of the specified target for the dead-letter queue. </p>
677
676
  * <p>For Amazon Kinesis stream and Amazon DynamoDB stream sources, specify
678
677
  * either an Amazon SNS topic or Amazon SQS queue ARN.</p>
678
+ * @public
679
679
  */
680
680
  Arn?: string;
681
681
  }
@@ -703,77 +703,77 @@ export declare const DynamoDBStreamStartPosition: {
703
703
  */
704
704
  export type DynamoDBStreamStartPosition = (typeof DynamoDBStreamStartPosition)[keyof typeof DynamoDBStreamStartPosition];
705
705
  /**
706
- * @public
707
706
  * <p>The parameters for using a DynamoDB stream as a source.</p>
707
+ * @public
708
708
  */
709
709
  export interface PipeSourceDynamoDBStreamParameters {
710
710
  /**
711
- * @public
712
711
  * <p>The maximum number of records to include in each batch.</p>
712
+ * @public
713
713
  */
714
714
  BatchSize?: number;
715
715
  /**
716
- * @public
717
716
  * <p>Define the target queue to send dead-letter queue events to.</p>
717
+ * @public
718
718
  */
719
719
  DeadLetterConfig?: DeadLetterConfig;
720
720
  /**
721
- * @public
722
721
  * <p>(Streams only) Define how to handle item process failures. <code>AUTOMATIC_BISECT</code> halves each batch and retry each half
723
722
  * until all the records are processed or there is one failed message left in the batch.</p>
723
+ * @public
724
724
  */
725
725
  OnPartialBatchItemFailure?: OnPartialBatchItemFailureStreams;
726
726
  /**
727
- * @public
728
727
  * <p>The maximum length of a time to wait for events.</p>
728
+ * @public
729
729
  */
730
730
  MaximumBatchingWindowInSeconds?: number;
731
731
  /**
732
- * @public
733
732
  * <p>(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite.
734
733
  * When the value is set to infinite, EventBridge never discards old records. </p>
734
+ * @public
735
735
  */
736
736
  MaximumRecordAgeInSeconds?: number;
737
737
  /**
738
- * @public
739
738
  * <p>(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of
740
739
  * retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.</p>
740
+ * @public
741
741
  */
742
742
  MaximumRetryAttempts?: number;
743
743
  /**
744
- * @public
745
744
  * <p>(Streams only) The number of batches to process concurrently from each shard. The default value is 1.</p>
745
+ * @public
746
746
  */
747
747
  ParallelizationFactor?: number;
748
748
  /**
749
- * @public
750
749
  * <p>(Streams only) The position in a stream from which to start reading.</p>
750
+ * @public
751
751
  */
752
752
  StartingPosition: DynamoDBStreamStartPosition | undefined;
753
753
  }
754
754
  /**
755
- * @public
756
755
  * <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
757
756
  * Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
757
+ * @public
758
758
  */
759
759
  export interface Filter {
760
760
  /**
761
- * @public
762
761
  * <p>The event pattern.</p>
762
+ * @public
763
763
  */
764
764
  Pattern?: string;
765
765
  }
766
766
  /**
767
- * @public
768
767
  * <p>The collection of event patterns used to filter events.</p>
769
768
  * <p>To remove a filter, specify a <code>FilterCriteria</code> object with an empty array of <code>Filter</code> objects.</p>
770
769
  * <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html">Events and Event
771
770
  * Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
771
+ * @public
772
772
  */
773
773
  export interface FilterCriteria {
774
774
  /**
775
- * @public
776
775
  * <p>The event patterns.</p>
776
+ * @public
777
777
  */
778
778
  Filters?: Filter[];
779
779
  }
@@ -791,62 +791,62 @@ export declare const KinesisStreamStartPosition: {
791
791
  */
792
792
  export type KinesisStreamStartPosition = (typeof KinesisStreamStartPosition)[keyof typeof KinesisStreamStartPosition];
793
793
  /**
794
- * @public
795
794
  * <p>The parameters for using a Kinesis stream as a source.</p>
795
+ * @public
796
796
  */
797
797
  export interface PipeSourceKinesisStreamParameters {
798
798
  /**
799
- * @public
800
799
  * <p>The maximum number of records to include in each batch.</p>
800
+ * @public
801
801
  */
802
802
  BatchSize?: number;
803
803
  /**
804
- * @public
805
804
  * <p>Define the target queue to send dead-letter queue events to.</p>
805
+ * @public
806
806
  */
807
807
  DeadLetterConfig?: DeadLetterConfig;
808
808
  /**
809
- * @public
810
809
  * <p>(Streams only) Define how to handle item process failures. <code>AUTOMATIC_BISECT</code> halves each batch and retry each half
811
810
  * until all the records are processed or there is one failed message left in the batch.</p>
811
+ * @public
812
812
  */
813
813
  OnPartialBatchItemFailure?: OnPartialBatchItemFailureStreams;
814
814
  /**
815
- * @public
816
815
  * <p>The maximum length of a time to wait for events.</p>
816
+ * @public
817
817
  */
818
818
  MaximumBatchingWindowInSeconds?: number;
819
819
  /**
820
- * @public
821
820
  * <p>(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite.
822
821
  * When the value is set to infinite, EventBridge never discards old records. </p>
822
+ * @public
823
823
  */
824
824
  MaximumRecordAgeInSeconds?: number;
825
825
  /**
826
- * @public
827
826
  * <p>(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of
828
827
  * retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.</p>
828
+ * @public
829
829
  */
830
830
  MaximumRetryAttempts?: number;
831
831
  /**
832
- * @public
833
832
  * <p>(Streams only) The number of batches to process concurrently from each shard. The default value is 1.</p>
833
+ * @public
834
834
  */
835
835
  ParallelizationFactor?: number;
836
836
  /**
837
- * @public
838
837
  * <p>(Streams only) The position in a stream from which to start reading.</p>
838
+ * @public
839
839
  */
840
840
  StartingPosition: KinesisStreamStartPosition | undefined;
841
841
  /**
842
- * @public
843
842
  * <p>With <code>StartingPosition</code> set to <code>AT_TIMESTAMP</code>, the time from which to start reading, in Unix time seconds.</p>
843
+ * @public
844
844
  */
845
845
  StartingPositionTimestamp?: Date;
846
846
  }
847
847
  /**
848
- * @public
849
848
  * <p>The Secrets Manager secret that stores your stream credentials.</p>
849
+ * @public
850
850
  */
851
851
  export type MSKAccessCredentials = MSKAccessCredentials.ClientCertificateTlsAuthMember | MSKAccessCredentials.SaslScram512AuthMember | MSKAccessCredentials.$UnknownMember;
852
852
  /**
@@ -854,8 +854,8 @@ export type MSKAccessCredentials = MSKAccessCredentials.ClientCertificateTlsAuth
854
854
  */
855
855
  export declare namespace MSKAccessCredentials {
856
856
  /**
857
- * @public
858
857
  * <p>The ARN of the Secrets Manager secret.</p>
858
+ * @public
859
859
  */
860
860
  interface SaslScram512AuthMember {
861
861
  SaslScram512Auth: string;
@@ -863,8 +863,8 @@ export declare namespace MSKAccessCredentials {
863
863
  $unknown?: never;
864
864
  }
865
865
  /**
866
- * @public
867
866
  * <p>The ARN of the Secrets Manager secret.</p>
867
+ * @public
868
868
  */
869
869
  interface ClientCertificateTlsAuthMember {
870
870
  SaslScram512Auth?: never;
@@ -899,75 +899,75 @@ export declare const MSKStartPosition: {
899
899
  */
900
900
  export type MSKStartPosition = (typeof MSKStartPosition)[keyof typeof MSKStartPosition];
901
901
  /**
902
- * @public
903
902
  * <p>The parameters for using an MSK stream as a source.</p>
903
+ * @public
904
904
  */
905
905
  export interface PipeSourceManagedStreamingKafkaParameters {
906
906
  /**
907
- * @public
908
907
  * <p>The name of the topic that the pipe will read from.</p>
908
+ * @public
909
909
  */
910
910
  TopicName: string | undefined;
911
911
  /**
912
- * @public
913
912
  * <p>(Streams only) The position in a stream from which to start reading.</p>
913
+ * @public
914
914
  */
915
915
  StartingPosition?: MSKStartPosition;
916
916
  /**
917
- * @public
918
917
  * <p>The maximum number of records to include in each batch.</p>
918
+ * @public
919
919
  */
920
920
  BatchSize?: number;
921
921
  /**
922
- * @public
923
922
  * <p>The maximum length of a time to wait for events.</p>
923
+ * @public
924
924
  */
925
925
  MaximumBatchingWindowInSeconds?: number;
926
926
  /**
927
- * @public
928
927
  * <p>The name of the destination queue to consume.</p>
928
+ * @public
929
929
  */
930
930
  ConsumerGroupID?: string;
931
931
  /**
932
- * @public
933
932
  * <p>The credentials needed to access the resource.</p>
933
+ * @public
934
934
  */
935
935
  Credentials?: MSKAccessCredentials;
936
936
  }
937
937
  /**
938
- * @public
939
938
  * <p>The parameters for using a Rabbit MQ broker as a source.</p>
939
+ * @public
940
940
  */
941
941
  export interface PipeSourceRabbitMQBrokerParameters {
942
942
  /**
943
- * @public
944
943
  * <p>The credentials needed to access the resource.</p>
944
+ * @public
945
945
  */
946
946
  Credentials: MQBrokerAccessCredentials | undefined;
947
947
  /**
948
- * @public
949
948
  * <p>The name of the destination queue to consume.</p>
949
+ * @public
950
950
  */
951
951
  QueueName: string | undefined;
952
952
  /**
953
- * @public
954
953
  * <p>The name of the virtual host associated with the source broker.</p>
954
+ * @public
955
955
  */
956
956
  VirtualHost?: string;
957
957
  /**
958
- * @public
959
958
  * <p>The maximum number of records to include in each batch.</p>
959
+ * @public
960
960
  */
961
961
  BatchSize?: number;
962
962
  /**
963
- * @public
964
963
  * <p>The maximum length of a time to wait for events.</p>
964
+ * @public
965
965
  */
966
966
  MaximumBatchingWindowInSeconds?: number;
967
967
  }
968
968
  /**
969
- * @public
970
969
  * <p>The Secrets Manager secret that stores your stream credentials.</p>
970
+ * @public
971
971
  */
972
972
  export type SelfManagedKafkaAccessConfigurationCredentials = SelfManagedKafkaAccessConfigurationCredentials.BasicAuthMember | SelfManagedKafkaAccessConfigurationCredentials.ClientCertificateTlsAuthMember | SelfManagedKafkaAccessConfigurationCredentials.SaslScram256AuthMember | SelfManagedKafkaAccessConfigurationCredentials.SaslScram512AuthMember | SelfManagedKafkaAccessConfigurationCredentials.$UnknownMember;
973
973
  /**
@@ -975,8 +975,8 @@ export type SelfManagedKafkaAccessConfigurationCredentials = SelfManagedKafkaAcc
975
975
  */
976
976
  export declare namespace SelfManagedKafkaAccessConfigurationCredentials {
977
977
  /**
978
- * @public
979
978
  * <p>The ARN of the Secrets Manager secret.</p>
979
+ * @public
980
980
  */
981
981
  interface BasicAuthMember {
982
982
  BasicAuth: string;
@@ -986,8 +986,8 @@ export declare namespace SelfManagedKafkaAccessConfigurationCredentials {
986
986
  $unknown?: never;
987
987
  }
988
988
  /**
989
- * @public
990
989
  * <p>The ARN of the Secrets Manager secret.</p>
990
+ * @public
991
991
  */
992
992
  interface SaslScram512AuthMember {
993
993
  BasicAuth?: never;
@@ -997,8 +997,8 @@ export declare namespace SelfManagedKafkaAccessConfigurationCredentials {
997
997
  $unknown?: never;
998
998
  }
999
999
  /**
1000
- * @public
1001
1000
  * <p>The ARN of the Secrets Manager secret.</p>
1001
+ * @public
1002
1002
  */
1003
1003
  interface SaslScram256AuthMember {
1004
1004
  BasicAuth?: never;
@@ -1008,8 +1008,8 @@ export declare namespace SelfManagedKafkaAccessConfigurationCredentials {
1008
1008
  $unknown?: never;
1009
1009
  }
1010
1010
  /**
1011
- * @public
1012
1011
  * <p>The ARN of the Secrets Manager secret.</p>
1012
+ * @public
1013
1013
  */
1014
1014
  interface ClientCertificateTlsAuthMember {
1015
1015
  BasicAuth?: never;
@@ -1050,199 +1050,199 @@ export declare const SelfManagedKafkaStartPosition: {
1050
1050
  */
1051
1051
  export type SelfManagedKafkaStartPosition = (typeof SelfManagedKafkaStartPosition)[keyof typeof SelfManagedKafkaStartPosition];
1052
1052
  /**
1053
- * @public
1054
1053
  * <p>This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.</p>
1054
+ * @public
1055
1055
  */
1056
1056
  export interface SelfManagedKafkaAccessConfigurationVpc {
1057
1057
  /**
1058
- * @public
1059
1058
  * <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>
1059
+ * @public
1060
1060
  */
1061
1061
  Subnets?: string[];
1062
1062
  /**
1063
- * @public
1064
1063
  * <p>Specifies the security groups associated with the stream. These security groups must all be in the same VPC. You can specify as many
1065
1064
  * as five security groups. If you do not specify a security group, the default security group for the VPC is used.</p>
1065
+ * @public
1066
1066
  */
1067
1067
  SecurityGroup?: string[];
1068
1068
  }
1069
1069
  /**
1070
- * @public
1071
1070
  * <p>The parameters for using a self-managed Apache Kafka stream as a source.</p>
1071
+ * @public
1072
1072
  */
1073
1073
  export interface PipeSourceSelfManagedKafkaParameters {
1074
1074
  /**
1075
- * @public
1076
1075
  * <p>The name of the topic that the pipe will read from.</p>
1076
+ * @public
1077
1077
  */
1078
1078
  TopicName: string | undefined;
1079
1079
  /**
1080
- * @public
1081
1080
  * <p>(Streams only) The position in a stream from which to start reading.</p>
1081
+ * @public
1082
1082
  */
1083
1083
  StartingPosition?: SelfManagedKafkaStartPosition;
1084
1084
  /**
1085
- * @public
1086
1085
  * <p>An array of server URLs.</p>
1086
+ * @public
1087
1087
  */
1088
1088
  AdditionalBootstrapServers?: string[];
1089
1089
  /**
1090
- * @public
1091
1090
  * <p>The maximum number of records to include in each batch.</p>
1091
+ * @public
1092
1092
  */
1093
1093
  BatchSize?: number;
1094
1094
  /**
1095
- * @public
1096
1095
  * <p>The maximum length of a time to wait for events.</p>
1096
+ * @public
1097
1097
  */
1098
1098
  MaximumBatchingWindowInSeconds?: number;
1099
1099
  /**
1100
- * @public
1101
1100
  * <p>The name of the destination queue to consume.</p>
1101
+ * @public
1102
1102
  */
1103
1103
  ConsumerGroupID?: string;
1104
1104
  /**
1105
- * @public
1106
1105
  * <p>The credentials needed to access the resource.</p>
1106
+ * @public
1107
1107
  */
1108
1108
  Credentials?: SelfManagedKafkaAccessConfigurationCredentials;
1109
1109
  /**
1110
- * @public
1111
1110
  * <p>The ARN of the Secrets Manager secret used for certification.</p>
1111
+ * @public
1112
1112
  */
1113
1113
  ServerRootCaCertificate?: string;
1114
1114
  /**
1115
- * @public
1116
1115
  * <p>This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.</p>
1116
+ * @public
1117
1117
  */
1118
1118
  Vpc?: SelfManagedKafkaAccessConfigurationVpc;
1119
1119
  }
1120
1120
  /**
1121
- * @public
1122
1121
  * <p>The parameters for using a Amazon SQS stream as a source.</p>
1122
+ * @public
1123
1123
  */
1124
1124
  export interface PipeSourceSqsQueueParameters {
1125
1125
  /**
1126
- * @public
1127
1126
  * <p>The maximum number of records to include in each batch.</p>
1127
+ * @public
1128
1128
  */
1129
1129
  BatchSize?: number;
1130
1130
  /**
1131
- * @public
1132
1131
  * <p>The maximum length of a time to wait for events.</p>
1132
+ * @public
1133
1133
  */
1134
1134
  MaximumBatchingWindowInSeconds?: number;
1135
1135
  }
1136
1136
  /**
1137
- * @public
1138
1137
  * <p>The parameters required to set up a source for your pipe.</p>
1138
+ * @public
1139
1139
  */
1140
1140
  export interface PipeSourceParameters {
1141
1141
  /**
1142
- * @public
1143
1142
  * <p>The collection of event patterns used to filter events.</p>
1144
1143
  * <p>To remove a filter, specify a <code>FilterCriteria</code> object with an empty array of <code>Filter</code> objects.</p>
1145
1144
  * <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html">Events and Event
1146
1145
  * Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
1146
+ * @public
1147
1147
  */
1148
1148
  FilterCriteria?: FilterCriteria;
1149
1149
  /**
1150
- * @public
1151
1150
  * <p>The parameters for using a Kinesis stream as a source.</p>
1151
+ * @public
1152
1152
  */
1153
1153
  KinesisStreamParameters?: PipeSourceKinesisStreamParameters;
1154
1154
  /**
1155
- * @public
1156
1155
  * <p>The parameters for using a DynamoDB stream as a source.</p>
1156
+ * @public
1157
1157
  */
1158
1158
  DynamoDBStreamParameters?: PipeSourceDynamoDBStreamParameters;
1159
1159
  /**
1160
- * @public
1161
1160
  * <p>The parameters for using a Amazon SQS stream as a source.</p>
1161
+ * @public
1162
1162
  */
1163
1163
  SqsQueueParameters?: PipeSourceSqsQueueParameters;
1164
1164
  /**
1165
- * @public
1166
1165
  * <p>The parameters for using an Active MQ broker as a source.</p>
1166
+ * @public
1167
1167
  */
1168
1168
  ActiveMQBrokerParameters?: PipeSourceActiveMQBrokerParameters;
1169
1169
  /**
1170
- * @public
1171
1170
  * <p>The parameters for using a Rabbit MQ broker as a source.</p>
1171
+ * @public
1172
1172
  */
1173
1173
  RabbitMQBrokerParameters?: PipeSourceRabbitMQBrokerParameters;
1174
1174
  /**
1175
- * @public
1176
1175
  * <p>The parameters for using an MSK stream as a source.</p>
1176
+ * @public
1177
1177
  */
1178
1178
  ManagedStreamingKafkaParameters?: PipeSourceManagedStreamingKafkaParameters;
1179
1179
  /**
1180
- * @public
1181
1180
  * <p>The parameters for using a self-managed Apache Kafka stream as a source.</p>
1181
+ * @public
1182
1182
  */
1183
1183
  SelfManagedKafkaParameters?: PipeSourceSelfManagedKafkaParameters;
1184
1184
  }
1185
1185
  /**
1186
- * @public
1187
1186
  * <p>The parameters for using an Batch job as a target.</p>
1187
+ * @public
1188
1188
  */
1189
1189
  export interface PipeTargetBatchJobParameters {
1190
1190
  /**
1191
- * @public
1192
1191
  * <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.
1193
1192
  * If name is specified without a revision then the latest active revision is used.</p>
1193
+ * @public
1194
1194
  */
1195
1195
  JobDefinition: string | undefined;
1196
1196
  /**
1197
- * @public
1198
1197
  * <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 (-),
1199
1198
  * and underscores (_).</p>
1199
+ * @public
1200
1200
  */
1201
1201
  JobName: string | undefined;
1202
1202
  /**
1203
- * @public
1204
1203
  * <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.
1205
1204
  * 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>
1205
+ * @public
1206
1206
  */
1207
1207
  ArrayProperties?: BatchArrayProperties;
1208
1208
  /**
1209
- * @public
1210
1209
  * <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>
1210
+ * @public
1211
1211
  */
1212
1212
  RetryStrategy?: BatchRetryStrategy;
1213
1213
  /**
1214
- * @public
1215
1214
  * <p>The overrides that are sent to a container.</p>
1215
+ * @public
1216
1216
  */
1217
1217
  ContainerOverrides?: BatchContainerOverrides;
1218
1218
  /**
1219
- * @public
1220
1219
  * <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
1221
1220
  * 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>
1222
1221
  * 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
1223
1222
  * dependency to complete before it can begin.</p>
1223
+ * @public
1224
1224
  */
1225
1225
  DependsOn?: BatchJobDependency[];
1226
1226
  /**
1227
- * @public
1228
1227
  * <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
1229
1228
  * value pair mapping. Parameters included here override any corresponding parameter defaults from the job definition.</p>
1229
+ * @public
1230
1230
  */
1231
1231
  Parameters?: Record<string, string>;
1232
1232
  }
1233
1233
  /**
1234
- * @public
1235
1234
  * <p>The parameters for using an CloudWatch Logs log stream as a target.</p>
1235
+ * @public
1236
1236
  */
1237
1237
  export interface PipeTargetCloudWatchLogsParameters {
1238
1238
  /**
1239
- * @public
1240
1239
  * <p>The name of the log stream.</p>
1240
+ * @public
1241
1241
  */
1242
1242
  LogStreamName?: string;
1243
1243
  /**
1244
- * @public
1245
1244
  * <p>The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.</p>
1245
+ * @public
1246
1246
  */
1247
1247
  Timestamp?: string;
1248
1248
  }
@@ -1260,32 +1260,32 @@ export declare const LaunchType: {
1260
1260
  */
1261
1261
  export type LaunchType = (typeof LaunchType)[keyof typeof LaunchType];
1262
1262
  /**
1263
- * @public
1264
1263
  * <p>This structure specifies the network configuration for an Amazon ECS task.</p>
1264
+ * @public
1265
1265
  */
1266
1266
  export interface NetworkConfiguration {
1267
1267
  /**
1268
- * @public
1269
1268
  * <p>Use this structure to specify the VPC subnets and security groups for the task, and
1270
1269
  * whether a public IP address is to be used. This structure is relevant only for ECS tasks that
1271
1270
  * use the <code>awsvpc</code> network mode.</p>
1271
+ * @public
1272
1272
  */
1273
1273
  awsvpcConfiguration?: AwsVpcConfiguration;
1274
1274
  }
1275
1275
  /**
1276
- * @public
1277
1276
  * <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
1278
1277
  * override the existing environment variables from the Docker image or the task definition. You must also specify a container name.</p>
1278
+ * @public
1279
1279
  */
1280
1280
  export interface EcsEnvironmentVariable {
1281
1281
  /**
1282
- * @public
1283
1282
  * <p>The name of the key-value pair. For environment variables, this is the name of the environment variable.</p>
1283
+ * @public
1284
1284
  */
1285
1285
  name?: string;
1286
1286
  /**
1287
- * @public
1288
1287
  * <p>The value of the key-value pair. For environment variables, this is the value of the environment variable.</p>
1288
+ * @public
1289
1289
  */
1290
1290
  value?: string;
1291
1291
  }
@@ -1301,7 +1301,6 @@ export declare const EcsEnvironmentFileType: {
1301
1301
  */
1302
1302
  export type EcsEnvironmentFileType = (typeof EcsEnvironmentFileType)[keyof typeof EcsEnvironmentFileType];
1303
1303
  /**
1304
- * @public
1305
1304
  * <p>A list of files containing the environment variables to pass to a container. You can
1306
1305
  * specify up to ten environment files. The file must have a <code>.env</code> file
1307
1306
  * extension. Each line in an environment file should contain an environment variable in
@@ -1325,16 +1324,17 @@ export type EcsEnvironmentFileType = (typeof EcsEnvironmentFileType)[keyof typeo
1325
1324
  * <p>Windows platform version <code>1.0.0</code> or later.</p>
1326
1325
  * </li>
1327
1326
  * </ul>
1327
+ * @public
1328
1328
  */
1329
1329
  export interface EcsEnvironmentFile {
1330
1330
  /**
1331
- * @public
1332
1331
  * <p>The file type to use. The only supported value is <code>s3</code>.</p>
1332
+ * @public
1333
1333
  */
1334
1334
  type: EcsEnvironmentFileType | undefined;
1335
1335
  /**
1336
- * @public
1337
1336
  * <p>The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.</p>
1337
+ * @public
1338
1338
  */
1339
1339
  value: string | undefined;
1340
1340
  }
@@ -1351,23 +1351,22 @@ export declare const EcsResourceRequirementType: {
1351
1351
  */
1352
1352
  export type EcsResourceRequirementType = (typeof EcsResourceRequirementType)[keyof typeof EcsResourceRequirementType];
1353
1353
  /**
1354
- * @public
1355
1354
  * <p>The type and amount of a resource to assign to a container. The supported resource
1356
1355
  * 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
1357
1356
  * GPUs on Amazon ECS</a> or <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html">Working with
1358
1357
  * Amazon Elastic Inference on Amazon ECS</a> in the
1359
1358
  * <i>Amazon Elastic Container Service Developer Guide</i>
1360
1359
  * </p>
1360
+ * @public
1361
1361
  */
1362
1362
  export interface EcsResourceRequirement {
1363
1363
  /**
1364
- * @public
1365
1364
  * <p>The type of resource to assign to a container. The supported values are
1366
1365
  * <code>GPU</code> or <code>InferenceAccelerator</code>.</p>
1366
+ * @public
1367
1367
  */
1368
1368
  type: EcsResourceRequirementType | undefined;
1369
1369
  /**
1370
- * @public
1371
1370
  * <p>The value for the specified resource type.</p>
1372
1371
  * <p>If the <code>GPU</code> type is used, the value is the number of physical
1373
1372
  * <code>GPUs</code> the Amazon ECS container agent reserves for the container. The number
@@ -1376,61 +1375,61 @@ export interface EcsResourceRequirement {
1376
1375
  * <p>If the <code>InferenceAccelerator</code> type is used, the <code>value</code> matches
1377
1376
  * the <code>deviceName</code> for an InferenceAccelerator specified in a
1378
1377
  * task definition.</p>
1378
+ * @public
1379
1379
  */
1380
1380
  value: string | undefined;
1381
1381
  }
1382
1382
  /**
1383
- * @public
1384
1383
  * <p>The overrides that are sent to a container. An empty container override can be passed in. An example of an empty
1385
1384
  * container override is <code>\{"containerOverrides": [ ] \}</code>. If a non-empty container override is specified, the <code>name</code> parameter must be included.</p>
1385
+ * @public
1386
1386
  */
1387
1387
  export interface EcsContainerOverride {
1388
1388
  /**
1389
- * @public
1390
1389
  * <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>
1390
+ * @public
1391
1391
  */
1392
1392
  Command?: string[];
1393
1393
  /**
1394
- * @public
1395
1394
  * <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>
1395
+ * @public
1396
1396
  */
1397
1397
  Cpu?: number;
1398
1398
  /**
1399
- * @public
1400
1399
  * <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
1401
1400
  * override the existing environment variables from the Docker image or the task definition. You must also specify a container name.</p>
1401
+ * @public
1402
1402
  */
1403
1403
  Environment?: EcsEnvironmentVariable[];
1404
1404
  /**
1405
- * @public
1406
1405
  * <p>A list of files containing the environment variables to pass to a container, instead of the value from the container definition.</p>
1406
+ * @public
1407
1407
  */
1408
1408
  EnvironmentFiles?: EcsEnvironmentFile[];
1409
1409
  /**
1410
- * @public
1411
1410
  * <p>The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition.
1412
1411
  * If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.</p>
1412
+ * @public
1413
1413
  */
1414
1414
  Memory?: number;
1415
1415
  /**
1416
- * @public
1417
1416
  * <p>The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition.
1418
1417
  * You must also specify a container name.</p>
1418
+ * @public
1419
1419
  */
1420
1420
  MemoryReservation?: number;
1421
1421
  /**
1422
- * @public
1423
1422
  * <p>The name of the container that receives the override. This parameter is required if any override is specified.</p>
1423
+ * @public
1424
1424
  */
1425
1425
  Name?: string;
1426
1426
  /**
1427
- * @public
1428
1427
  * <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>
1428
+ * @public
1429
1429
  */
1430
1430
  ResourceRequirements?: EcsResourceRequirement[];
1431
1431
  }
1432
1432
  /**
1433
- * @public
1434
1433
  * <p>The amount of ephemeral storage to allocate for the task. This parameter is used to
1435
1434
  * expand the total amount of ephemeral storage available, beyond the default amount, for
1436
1435
  * tasks hosted on Fargate. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html">Fargate task
@@ -1440,53 +1439,53 @@ export interface EcsContainerOverride {
1440
1439
  * Linux platform version <code>1.4.0</code> or later. This parameter is not supported
1441
1440
  * for Windows containers on Fargate.</p>
1442
1441
  * </note>
1442
+ * @public
1443
1443
  */
1444
1444
  export interface EcsEphemeralStorage {
1445
1445
  /**
1446
- * @public
1447
1446
  * <p>The total amount, in GiB, of ephemeral storage to set for the task. The minimum
1448
1447
  * supported value is <code>21</code> GiB and the maximum supported value is
1449
1448
  * <code>200</code> GiB.</p>
1449
+ * @public
1450
1450
  */
1451
1451
  sizeInGiB: number | undefined;
1452
1452
  }
1453
1453
  /**
1454
- * @public
1455
1454
  * <p>Details on an Elastic Inference accelerator task override. This parameter is used to
1456
1455
  * override the Elastic Inference accelerator specified in the task definition. For more
1457
1456
  * information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/userguide/ecs-inference.html">Working with Amazon
1458
1457
  * Elastic Inference on Amazon ECS</a> in the
1459
1458
  * <i>Amazon Elastic Container Service Developer Guide</i>.</p>
1459
+ * @public
1460
1460
  */
1461
1461
  export interface EcsInferenceAcceleratorOverride {
1462
1462
  /**
1463
- * @public
1464
1463
  * <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>
1464
+ * @public
1465
1465
  */
1466
1466
  deviceName?: string;
1467
1467
  /**
1468
- * @public
1469
1468
  * <p>The Elastic Inference accelerator type to use.</p>
1469
+ * @public
1470
1470
  */
1471
1471
  deviceType?: string;
1472
1472
  }
1473
1473
  /**
1474
- * @public
1475
1474
  * <p>The overrides that are associated with a task.</p>
1475
+ * @public
1476
1476
  */
1477
1477
  export interface EcsTaskOverride {
1478
1478
  /**
1479
- * @public
1480
1479
  * <p>One or more container overrides that are sent to a task.</p>
1480
+ * @public
1481
1481
  */
1482
1482
  ContainerOverrides?: EcsContainerOverride[];
1483
1483
  /**
1484
- * @public
1485
1484
  * <p>The cpu override for the task.</p>
1485
+ * @public
1486
1486
  */
1487
1487
  Cpu?: string;
1488
1488
  /**
1489
- * @public
1490
1489
  * <p>The ephemeral storage setting override for the task.</p>
1491
1490
  * <note>
1492
1491
  * <p>This parameter is only supported for tasks hosted on Fargate that
@@ -1500,31 +1499,32 @@ export interface EcsTaskOverride {
1500
1499
  * </li>
1501
1500
  * </ul>
1502
1501
  * </note>
1502
+ * @public
1503
1503
  */
1504
1504
  EphemeralStorage?: EcsEphemeralStorage;
1505
1505
  /**
1506
- * @public
1507
1506
  * <p>The Amazon Resource Name (ARN) of the task execution IAM role override for the task. For more
1508
1507
  * information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html">Amazon ECS task
1509
1508
  * execution IAM role</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
1509
+ * @public
1510
1510
  */
1511
1511
  ExecutionRoleArn?: string;
1512
1512
  /**
1513
- * @public
1514
1513
  * <p>The Elastic Inference accelerator override for the task.</p>
1514
+ * @public
1515
1515
  */
1516
1516
  InferenceAcceleratorOverrides?: EcsInferenceAcceleratorOverride[];
1517
1517
  /**
1518
- * @public
1519
1518
  * <p>The memory override for the task.</p>
1519
+ * @public
1520
1520
  */
1521
1521
  Memory?: string;
1522
1522
  /**
1523
- * @public
1524
1523
  * <p>The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers
1525
1524
  * in this task are granted the permissions that are specified in this role. For more
1526
1525
  * information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html">IAM Role for Tasks</a>
1527
1526
  * in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
1527
+ * @public
1528
1528
  */
1529
1529
  TaskRoleArn?: string;
1530
1530
  }
@@ -1541,23 +1541,23 @@ export declare const PlacementConstraintType: {
1541
1541
  */
1542
1542
  export type PlacementConstraintType = (typeof PlacementConstraintType)[keyof typeof PlacementConstraintType];
1543
1543
  /**
1544
- * @public
1545
1544
  * <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
1546
1545
  * Guide.</p>
1546
+ * @public
1547
1547
  */
1548
1548
  export interface PlacementConstraint {
1549
1549
  /**
1550
- * @public
1551
1550
  * <p>The type of constraint. Use distinctInstance to ensure that each task in a particular
1552
1551
  * group is running on a different container instance. Use memberOf to restrict the selection to
1553
1552
  * a group of valid candidates. </p>
1553
+ * @public
1554
1554
  */
1555
1555
  type?: PlacementConstraintType;
1556
1556
  /**
1557
- * @public
1558
1557
  * <p>A cluster query language expression to apply to the constraint. You cannot specify an
1559
1558
  * 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.
1560
1559
  * </p>
1560
+ * @public
1561
1561
  */
1562
1562
  expression?: string;
1563
1563
  }
@@ -1575,28 +1575,28 @@ export declare const PlacementStrategyType: {
1575
1575
  */
1576
1576
  export type PlacementStrategyType = (typeof PlacementStrategyType)[keyof typeof PlacementStrategyType];
1577
1577
  /**
1578
- * @public
1579
1578
  * <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
1580
1579
  * Guide.</p>
1580
+ * @public
1581
1581
  */
1582
1582
  export interface PlacementStrategy {
1583
1583
  /**
1584
- * @public
1585
1584
  * <p>The type of placement strategy. The random placement strategy randomly places tasks on
1586
1585
  * available candidates. The spread placement strategy spreads placement across available
1587
1586
  * candidates evenly based on the field parameter. The binpack strategy places tasks on available
1588
1587
  * candidates that have the least available amount of the resource that is specified with the
1589
1588
  * field parameter. For example, if you binpack on memory, a task is placed on the instance with
1590
1589
  * the least amount of remaining memory (but still enough to run the task). </p>
1590
+ * @public
1591
1591
  */
1592
1592
  type?: PlacementStrategyType;
1593
1593
  /**
1594
- * @public
1595
1594
  * <p>The field to apply the placement strategy against. For the spread placement strategy,
1596
1595
  * valid values are instanceId (or host, which has the same effect), or any platform or custom
1597
1596
  * attribute that is applied to a container instance, such as attribute:ecs.availability-zone.
1598
1597
  * For the binpack placement strategy, valid values are cpu and memory. For the random placement
1599
1598
  * strategy, this field is not used. </p>
1599
+ * @public
1600
1600
  */
1601
1601
  field?: string;
1602
1602
  }
@@ -1612,49 +1612,48 @@ export declare const PropagateTags: {
1612
1612
  */
1613
1613
  export type PropagateTags = (typeof PropagateTags)[keyof typeof PropagateTags];
1614
1614
  /**
1615
- * @public
1616
1615
  * <p>A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses
1617
1616
  * support tagging.</p>
1617
+ * @public
1618
1618
  */
1619
1619
  export interface Tag {
1620
1620
  /**
1621
- * @public
1622
1621
  * <p>A string you can use to assign a value. The combination of tag keys and values can help
1623
1622
  * you organize and categorize your resources.</p>
1623
+ * @public
1624
1624
  */
1625
1625
  Key: string | undefined;
1626
1626
  /**
1627
- * @public
1628
1627
  * <p>The value for the specified tag key.</p>
1628
+ * @public
1629
1629
  */
1630
1630
  Value: string | undefined;
1631
1631
  }
1632
1632
  /**
1633
- * @public
1634
1633
  * <p>The parameters for using an Amazon ECS task as a target.</p>
1634
+ * @public
1635
1635
  */
1636
1636
  export interface PipeTargetEcsTaskParameters {
1637
1637
  /**
1638
- * @public
1639
1638
  * <p>The ARN of the task definition to use if the event target is an Amazon ECS task. </p>
1639
+ * @public
1640
1640
  */
1641
1641
  TaskDefinitionArn: string | undefined;
1642
1642
  /**
1643
- * @public
1644
1643
  * <p>The number of tasks to create based on <code>TaskDefinition</code>. The default is 1.</p>
1644
+ * @public
1645
1645
  */
1646
1646
  TaskCount?: number;
1647
1647
  /**
1648
- * @public
1649
1648
  * <p>Specifies the launch type on which your task is running. The launch type that you specify
1650
1649
  * here must match one of the launch type (compatibilities) of the target task. The
1651
1650
  * <code>FARGATE</code> value is supported only in the Regions where Fargate with Amazon ECS
1652
1651
  * is supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html">Fargate on Amazon ECS</a> in
1653
1652
  * the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
1653
+ * @public
1654
1654
  */
1655
1655
  LaunchType?: LaunchType;
1656
1656
  /**
1657
- * @public
1658
1657
  * <p>Use this structure if the Amazon ECS task uses the <code>awsvpc</code> network mode. This
1659
1658
  * structure specifies the VPC subnets and security groups associated with the task, and whether
1660
1659
  * a public IP address is to be used. This structure is required if <code>LaunchType</code> is
@@ -1662,150 +1661,151 @@ export interface PipeTargetEcsTaskParameters {
1662
1661
  * tasks.</p>
1663
1662
  * <p>If you specify <code>NetworkConfiguration</code> when the target ECS task does not use the
1664
1663
  * <code>awsvpc</code> network mode, the task fails.</p>
1664
+ * @public
1665
1665
  */
1666
1666
  NetworkConfiguration?: NetworkConfiguration;
1667
1667
  /**
1668
- * @public
1669
1668
  * <p>Specifies the platform version for the task. Specify only the numeric portion of the
1670
1669
  * platform version, such as <code>1.1.0</code>.</p>
1671
1670
  * <p>This structure is used only if <code>LaunchType</code> is <code>FARGATE</code>. For more
1672
1671
  * information about valid platform versions, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html">Fargate Platform
1673
1672
  * Versions</a> in the <i>Amazon Elastic Container Service Developer
1674
1673
  * Guide</i>.</p>
1674
+ * @public
1675
1675
  */
1676
1676
  PlatformVersion?: string;
1677
1677
  /**
1678
- * @public
1679
1678
  * <p>Specifies an Amazon ECS task group for the task. The maximum length is 255 characters.</p>
1679
+ * @public
1680
1680
  */
1681
1681
  Group?: string;
1682
1682
  /**
1683
- * @public
1684
1683
  * <p>The capacity provider strategy to use for the task.</p>
1685
1684
  * <p>If a <code>capacityProviderStrategy</code> is specified, the <code>launchType</code>
1686
1685
  * parameter must be omitted. If no <code>capacityProviderStrategy</code> or launchType is
1687
1686
  * specified, the <code>defaultCapacityProviderStrategy</code> for the cluster is used. </p>
1687
+ * @public
1688
1688
  */
1689
1689
  CapacityProviderStrategy?: CapacityProviderStrategyItem[];
1690
1690
  /**
1691
- * @public
1692
1691
  * <p>Specifies whether to enable Amazon ECS managed tags for the task. For more information,
1693
1692
  * 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
1694
1693
  * Guide. </p>
1694
+ * @public
1695
1695
  */
1696
1696
  EnableECSManagedTags?: boolean;
1697
1697
  /**
1698
- * @public
1699
1698
  * <p>Whether or not to enable the execute command functionality for the containers in this
1700
1699
  * task. If true, this enables execute command functionality on all containers in the
1701
1700
  * task.</p>
1701
+ * @public
1702
1702
  */
1703
1703
  EnableExecuteCommand?: boolean;
1704
1704
  /**
1705
- * @public
1706
1705
  * <p>An array of placement constraint objects to use for the task. You can specify up to 10
1707
1706
  * constraints per task (including constraints in the task definition and those specified at
1708
1707
  * runtime).</p>
1708
+ * @public
1709
1709
  */
1710
1710
  PlacementConstraints?: PlacementConstraint[];
1711
1711
  /**
1712
- * @public
1713
1712
  * <p>The placement strategy objects to use for the task. You can specify a maximum of five
1714
1713
  * strategy rules per task. </p>
1714
+ * @public
1715
1715
  */
1716
1716
  PlacementStrategy?: PlacementStrategy[];
1717
1717
  /**
1718
- * @public
1719
1718
  * <p>Specifies whether to propagate the tags from the task definition to the task. If no value
1720
1719
  * is specified, the tags are not propagated. Tags can only be propagated to the task during task
1721
1720
  * creation. To add tags to a task after task creation, use the <code>TagResource</code> API action. </p>
1721
+ * @public
1722
1722
  */
1723
1723
  PropagateTags?: PropagateTags;
1724
1724
  /**
1725
- * @public
1726
1725
  * <p>The reference ID to use for the task.</p>
1726
+ * @public
1727
1727
  */
1728
1728
  ReferenceId?: string;
1729
1729
  /**
1730
- * @public
1731
1730
  * <p>The overrides that are associated with a task.</p>
1731
+ * @public
1732
1732
  */
1733
1733
  Overrides?: EcsTaskOverride;
1734
1734
  /**
1735
- * @public
1736
1735
  * <p>The metadata that you apply to the task to help you categorize and organize them. Each tag
1737
1736
  * 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>
1737
+ * @public
1738
1738
  */
1739
1739
  Tags?: Tag[];
1740
1740
  }
1741
1741
  /**
1742
- * @public
1743
1742
  * <p>The parameters for using an EventBridge event bus as a target.</p>
1743
+ * @public
1744
1744
  */
1745
1745
  export interface PipeTargetEventBridgeEventBusParameters {
1746
1746
  /**
1747
- * @public
1748
1747
  * <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>
1748
+ * @public
1749
1749
  */
1750
1750
  EndpointId?: string;
1751
1751
  /**
1752
- * @public
1753
1752
  * <p>A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.</p>
1753
+ * @public
1754
1754
  */
1755
1755
  DetailType?: string;
1756
1756
  /**
1757
- * @public
1758
1757
  * <p>The source of the event.</p>
1758
+ * @public
1759
1759
  */
1760
1760
  Source?: string;
1761
1761
  /**
1762
- * @public
1763
1762
  * <p>Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily
1764
1763
  * concerns. Any number, including zero, may be present.</p>
1764
+ * @public
1765
1765
  */
1766
1766
  Resources?: string[];
1767
1767
  /**
1768
- * @public
1769
1768
  * <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>
1769
+ * @public
1770
1770
  */
1771
1771
  Time?: string;
1772
1772
  }
1773
1773
  /**
1774
- * @public
1775
1774
  * <p>These are custom parameter to be used when the target is an API Gateway REST APIs or
1776
1775
  * EventBridge ApiDestinations.</p>
1776
+ * @public
1777
1777
  */
1778
1778
  export interface PipeTargetHttpParameters {
1779
1779
  /**
1780
- * @public
1781
1780
  * <p>The path parameter values to be used to populate API Gateway REST API or EventBridge
1782
1781
  * ApiDestination path wildcards ("*").</p>
1782
+ * @public
1783
1783
  */
1784
1784
  PathParameterValues?: string[];
1785
1785
  /**
1786
- * @public
1787
1786
  * <p>The headers that need to be sent as part of request invoking the API Gateway REST API or
1788
1787
  * EventBridge ApiDestination.</p>
1788
+ * @public
1789
1789
  */
1790
1790
  HeaderParameters?: Record<string, string>;
1791
1791
  /**
1792
- * @public
1793
1792
  * <p>The query string keys/values that need to be sent as part of request invoking the API Gateway
1794
1793
  * REST API or EventBridge ApiDestination.</p>
1794
+ * @public
1795
1795
  */
1796
1796
  QueryStringParameters?: Record<string, string>;
1797
1797
  }
1798
1798
  /**
1799
- * @public
1800
1799
  * <p>The parameters for using a Kinesis stream as a target.</p>
1800
+ * @public
1801
1801
  */
1802
1802
  export interface PipeTargetKinesisStreamParameters {
1803
1803
  /**
1804
- * @public
1805
1804
  * <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
1806
1805
  * 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.
1807
1806
  * 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
1808
1807
  * hashing mechanism, all data records with the same partition key map to the same shard within the stream.</p>
1808
+ * @public
1809
1809
  */
1810
1810
  PartitionKey: string | undefined;
1811
1811
  }
@@ -1822,12 +1822,11 @@ export declare const PipeTargetInvocationType: {
1822
1822
  */
1823
1823
  export type PipeTargetInvocationType = (typeof PipeTargetInvocationType)[keyof typeof PipeTargetInvocationType];
1824
1824
  /**
1825
- * @public
1826
1825
  * <p>The parameters for using a Lambda function as a target.</p>
1826
+ * @public
1827
1827
  */
1828
1828
  export interface PipeTargetLambdaFunctionParameters {
1829
1829
  /**
1830
- * @public
1831
1830
  * <p>Specify whether to invoke the function synchronously or asynchronously.</p>
1832
1831
  * <ul>
1833
1832
  * <li>
@@ -1840,101 +1839,101 @@ export interface PipeTargetLambdaFunctionParameters {
1840
1839
  * </li>
1841
1840
  * </ul>
1842
1841
  * <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html#pipes-invocation">Invocation types</a> in the <i>Amazon EventBridge User Guide</i>.</p>
1842
+ * @public
1843
1843
  */
1844
1844
  InvocationType?: PipeTargetInvocationType;
1845
1845
  }
1846
1846
  /**
1847
- * @public
1848
1847
  * <p>These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the
1849
1848
  * Amazon Redshift Data API BatchExecuteStatement.</p>
1849
+ * @public
1850
1850
  */
1851
1851
  export interface PipeTargetRedshiftDataParameters {
1852
1852
  /**
1853
- * @public
1854
1853
  * <p>The name or ARN of the secret that enables access to the database. Required when
1855
1854
  * authenticating using Secrets Manager.</p>
1855
+ * @public
1856
1856
  */
1857
1857
  SecretManagerArn?: string;
1858
1858
  /**
1859
- * @public
1860
1859
  * <p>The name of the database. Required when authenticating using temporary credentials.</p>
1860
+ * @public
1861
1861
  */
1862
1862
  Database: string | undefined;
1863
1863
  /**
1864
- * @public
1865
1864
  * <p>The database user name. Required when authenticating using temporary credentials.</p>
1865
+ * @public
1866
1866
  */
1867
1867
  DbUser?: string;
1868
1868
  /**
1869
- * @public
1870
1869
  * <p>The name of the SQL statement. You can name the SQL statement when you create it to
1871
1870
  * identify the query.</p>
1871
+ * @public
1872
1872
  */
1873
1873
  StatementName?: string;
1874
1874
  /**
1875
- * @public
1876
1875
  * <p>Indicates whether to send an event back to EventBridge after the SQL statement
1877
1876
  * runs.</p>
1877
+ * @public
1878
1878
  */
1879
1879
  WithEvent?: boolean;
1880
1880
  /**
1881
- * @public
1882
1881
  * <p>The SQL statement text to run.</p>
1882
+ * @public
1883
1883
  */
1884
1884
  Sqls: string[] | undefined;
1885
1885
  }
1886
1886
  /**
1887
- * @public
1888
1887
  * <p>Name/Value pair of a parameter to start execution of a SageMaker Model Building
1889
1888
  * Pipeline.</p>
1889
+ * @public
1890
1890
  */
1891
1891
  export interface SageMakerPipelineParameter {
1892
1892
  /**
1893
- * @public
1894
1893
  * <p>Name of parameter to start execution of a SageMaker Model Building Pipeline.</p>
1894
+ * @public
1895
1895
  */
1896
1896
  Name: string | undefined;
1897
1897
  /**
1898
- * @public
1899
1898
  * <p>Value of parameter to start execution of a SageMaker Model Building Pipeline.</p>
1899
+ * @public
1900
1900
  */
1901
1901
  Value: string | undefined;
1902
1902
  }
1903
1903
  /**
1904
- * @public
1905
1904
  * <p>The parameters for using a SageMaker pipeline as a target.</p>
1905
+ * @public
1906
1906
  */
1907
1907
  export interface PipeTargetSageMakerPipelineParameters {
1908
1908
  /**
1909
- * @public
1910
1909
  * <p>List of Parameter names and values for SageMaker Model Building Pipeline execution.</p>
1910
+ * @public
1911
1911
  */
1912
1912
  PipelineParameterList?: SageMakerPipelineParameter[];
1913
1913
  }
1914
1914
  /**
1915
- * @public
1916
1915
  * <p>The parameters for using a Amazon SQS stream as a target.</p>
1916
+ * @public
1917
1917
  */
1918
1918
  export interface PipeTargetSqsQueueParameters {
1919
1919
  /**
1920
- * @public
1921
1920
  * <p>The FIFO message group ID to use as the target.</p>
1921
+ * @public
1922
1922
  */
1923
1923
  MessageGroupId?: string;
1924
1924
  /**
1925
- * @public
1926
1925
  * <p>This parameter applies only to FIFO (first-in-first-out) queues.</p>
1927
1926
  * <p>The token used for deduplication of sent messages.</p>
1927
+ * @public
1928
1928
  */
1929
1929
  MessageDeduplicationId?: string;
1930
1930
  }
1931
1931
  /**
1932
- * @public
1933
1932
  * <p>The parameters for using a Step Functions state machine as a target.</p>
1933
+ * @public
1934
1934
  */
1935
1935
  export interface PipeTargetStateMachineParameters {
1936
1936
  /**
1937
- * @public
1938
1937
  * <p>Specify whether to invoke the Step Functions state machine synchronously or asynchronously.</p>
1939
1938
  * <ul>
1940
1939
  * <li>
@@ -1951,78 +1950,79 @@ export interface PipeTargetStateMachineParameters {
1951
1950
  * </li>
1952
1951
  * </ul>
1953
1952
  * <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html#pipes-invocation">Invocation types</a> in the <i>Amazon EventBridge User Guide</i>.</p>
1953
+ * @public
1954
1954
  */
1955
1955
  InvocationType?: PipeTargetInvocationType;
1956
1956
  }
1957
1957
  /**
1958
- * @public
1959
1958
  * <p>The parameters required to set up a target for your pipe.</p>
1960
1959
  * <p>For more information about pipe target parameters, including how to use dynamic path parameters, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html">Target parameters</a> in the <i>Amazon EventBridge User Guide</i>.</p>
1960
+ * @public
1961
1961
  */
1962
1962
  export interface PipeTargetParameters {
1963
1963
  /**
1964
- * @public
1965
1964
  * <p>Valid JSON text passed to the target. In this case, nothing from the event itself is
1966
1965
  * passed to the target. For more information, see <a href="http://www.rfc-editor.org/rfc/rfc7159.txt">The JavaScript Object Notation (JSON) Data
1967
1966
  * Interchange Format</a>.</p>
1968
1967
  * <p>To remove an input template, specify an empty string.</p>
1968
+ * @public
1969
1969
  */
1970
1970
  InputTemplate?: string;
1971
1971
  /**
1972
- * @public
1973
1972
  * <p>The parameters for using a Lambda function as a target.</p>
1973
+ * @public
1974
1974
  */
1975
1975
  LambdaFunctionParameters?: PipeTargetLambdaFunctionParameters;
1976
1976
  /**
1977
- * @public
1978
1977
  * <p>The parameters for using a Step Functions state machine as a target.</p>
1978
+ * @public
1979
1979
  */
1980
1980
  StepFunctionStateMachineParameters?: PipeTargetStateMachineParameters;
1981
1981
  /**
1982
- * @public
1983
1982
  * <p>The parameters for using a Kinesis stream as a target.</p>
1983
+ * @public
1984
1984
  */
1985
1985
  KinesisStreamParameters?: PipeTargetKinesisStreamParameters;
1986
1986
  /**
1987
- * @public
1988
1987
  * <p>The parameters for using an Amazon ECS task as a target.</p>
1988
+ * @public
1989
1989
  */
1990
1990
  EcsTaskParameters?: PipeTargetEcsTaskParameters;
1991
1991
  /**
1992
- * @public
1993
1992
  * <p>The parameters for using an Batch job as a target.</p>
1993
+ * @public
1994
1994
  */
1995
1995
  BatchJobParameters?: PipeTargetBatchJobParameters;
1996
1996
  /**
1997
- * @public
1998
1997
  * <p>The parameters for using a Amazon SQS stream as a target.</p>
1998
+ * @public
1999
1999
  */
2000
2000
  SqsQueueParameters?: PipeTargetSqsQueueParameters;
2001
2001
  /**
2002
- * @public
2003
2002
  * <p>These are custom parameter to be used when the target is an API Gateway REST APIs or
2004
2003
  * EventBridge ApiDestinations.</p>
2004
+ * @public
2005
2005
  */
2006
2006
  HttpParameters?: PipeTargetHttpParameters;
2007
2007
  /**
2008
- * @public
2009
2008
  * <p>These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the
2010
2009
  * Amazon Redshift Data API BatchExecuteStatement.</p>
2010
+ * @public
2011
2011
  */
2012
2012
  RedshiftDataParameters?: PipeTargetRedshiftDataParameters;
2013
2013
  /**
2014
- * @public
2015
2014
  * <p>The parameters for using a SageMaker pipeline as a target.</p>
2015
+ * @public
2016
2016
  */
2017
2017
  SageMakerPipelineParameters?: PipeTargetSageMakerPipelineParameters;
2018
2018
  /**
2019
- * @public
2020
2019
  * <p>The parameters for using an EventBridge event bus as a target.</p>
2020
+ * @public
2021
2021
  */
2022
2022
  EventBridgeEventBusParameters?: PipeTargetEventBridgeEventBusParameters;
2023
2023
  /**
2024
- * @public
2025
2024
  * <p>The parameters for using an CloudWatch Logs log stream as a target.</p>
2025
+ * @public
2026
2026
  */
2027
2027
  CloudWatchLogsParameters?: PipeTargetCloudWatchLogsParameters;
2028
2028
  }
@@ -2031,64 +2031,64 @@ export interface PipeTargetParameters {
2031
2031
  */
2032
2032
  export interface CreatePipeRequest {
2033
2033
  /**
2034
- * @public
2035
2034
  * <p>The name of the pipe.</p>
2035
+ * @public
2036
2036
  */
2037
2037
  Name: string | undefined;
2038
2038
  /**
2039
- * @public
2040
2039
  * <p>A description of the pipe.</p>
2040
+ * @public
2041
2041
  */
2042
2042
  Description?: string;
2043
2043
  /**
2044
- * @public
2045
2044
  * <p>The state the pipe should be in.</p>
2045
+ * @public
2046
2046
  */
2047
2047
  DesiredState?: RequestedPipeState;
2048
2048
  /**
2049
- * @public
2050
2049
  * <p>The ARN of the source resource.</p>
2050
+ * @public
2051
2051
  */
2052
2052
  Source: string | undefined;
2053
2053
  /**
2054
- * @public
2055
2054
  * <p>The parameters required to set up a source for your pipe.</p>
2055
+ * @public
2056
2056
  */
2057
2057
  SourceParameters?: PipeSourceParameters;
2058
2058
  /**
2059
- * @public
2060
2059
  * <p>The ARN of the enrichment resource.</p>
2060
+ * @public
2061
2061
  */
2062
2062
  Enrichment?: string;
2063
2063
  /**
2064
- * @public
2065
2064
  * <p>The parameters required to set up enrichment on your pipe.</p>
2065
+ * @public
2066
2066
  */
2067
2067
  EnrichmentParameters?: PipeEnrichmentParameters;
2068
2068
  /**
2069
- * @public
2070
2069
  * <p>The ARN of the target resource.</p>
2070
+ * @public
2071
2071
  */
2072
2072
  Target: string | undefined;
2073
2073
  /**
2074
- * @public
2075
2074
  * <p>The parameters required to set up a target for your pipe.</p>
2076
2075
  * <p>For more information about pipe target parameters, including how to use dynamic path parameters, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html">Target parameters</a> in the <i>Amazon EventBridge User Guide</i>.</p>
2076
+ * @public
2077
2077
  */
2078
2078
  TargetParameters?: PipeTargetParameters;
2079
2079
  /**
2080
- * @public
2081
2080
  * <p>The ARN of the role that allows the pipe to send data to the target.</p>
2081
+ * @public
2082
2082
  */
2083
2083
  RoleArn: string | undefined;
2084
2084
  /**
2085
- * @public
2086
2085
  * <p>The list of key-value pairs to associate with the pipe.</p>
2086
+ * @public
2087
2087
  */
2088
2088
  Tags?: Record<string, string>;
2089
2089
  /**
2090
- * @public
2091
2090
  * <p>The logging configuration settings for the pipe.</p>
2091
+ * @public
2092
2092
  */
2093
2093
  LogConfiguration?: PipeLogConfigurationParameters;
2094
2094
  }
@@ -2122,46 +2122,46 @@ export type PipeState = (typeof PipeState)[keyof typeof PipeState];
2122
2122
  */
2123
2123
  export interface CreatePipeResponse {
2124
2124
  /**
2125
- * @public
2126
2125
  * <p>The ARN of the pipe.</p>
2126
+ * @public
2127
2127
  */
2128
2128
  Arn?: string;
2129
2129
  /**
2130
- * @public
2131
2130
  * <p>The name of the pipe.</p>
2131
+ * @public
2132
2132
  */
2133
2133
  Name?: string;
2134
2134
  /**
2135
- * @public
2136
2135
  * <p>The state the pipe should be in.</p>
2136
+ * @public
2137
2137
  */
2138
2138
  DesiredState?: RequestedPipeState;
2139
2139
  /**
2140
- * @public
2141
2140
  * <p>The state the pipe is in.</p>
2141
+ * @public
2142
2142
  */
2143
2143
  CurrentState?: PipeState;
2144
2144
  /**
2145
- * @public
2146
2145
  * <p>The time the pipe was created.</p>
2146
+ * @public
2147
2147
  */
2148
2148
  CreationTime?: Date;
2149
2149
  /**
2150
- * @public
2151
2150
  * <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>
2151
+ * @public
2152
2152
  */
2153
2153
  LastModifiedTime?: Date;
2154
2154
  }
2155
2155
  /**
2156
- * @public
2157
2156
  * <p>This exception occurs due to unexpected causes.</p>
2157
+ * @public
2158
2158
  */
2159
2159
  export declare class InternalException extends __BaseException {
2160
2160
  readonly name: "InternalException";
2161
2161
  readonly $fault: "server";
2162
2162
  /**
2163
- * @public
2164
2163
  * <p>The number of seconds to wait before retrying the action that caused the exception.</p>
2164
+ * @public
2165
2165
  */
2166
2166
  retryAfterSeconds?: number;
2167
2167
  /**
@@ -2170,8 +2170,8 @@ export declare class InternalException extends __BaseException {
2170
2170
  constructor(opts: __ExceptionOptionType<InternalException, __BaseException>);
2171
2171
  }
2172
2172
  /**
2173
- * @public
2174
2173
  * <p>An entity that you specified does not exist.</p>
2174
+ * @public
2175
2175
  */
2176
2176
  export declare class NotFoundException extends __BaseException {
2177
2177
  readonly name: "NotFoundException";
@@ -2182,30 +2182,30 @@ export declare class NotFoundException extends __BaseException {
2182
2182
  constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
2183
2183
  }
2184
2184
  /**
2185
- * @public
2186
2185
  * <p>A quota has been exceeded.</p>
2186
+ * @public
2187
2187
  */
2188
2188
  export declare class ServiceQuotaExceededException extends __BaseException {
2189
2189
  readonly name: "ServiceQuotaExceededException";
2190
2190
  readonly $fault: "client";
2191
2191
  /**
2192
- * @public
2193
2192
  * <p>The ID of the resource that caused the exception.</p>
2193
+ * @public
2194
2194
  */
2195
2195
  resourceId: string | undefined;
2196
2196
  /**
2197
- * @public
2198
2197
  * <p>The type of resource that caused the exception.</p>
2198
+ * @public
2199
2199
  */
2200
2200
  resourceType: string | undefined;
2201
2201
  /**
2202
- * @public
2203
2202
  * <p>The identifier of the service that caused the exception.</p>
2203
+ * @public
2204
2204
  */
2205
2205
  serviceCode: string | undefined;
2206
2206
  /**
2207
- * @public
2208
2207
  * <p>The identifier of the quota that caused the exception.</p>
2208
+ * @public
2209
2209
  */
2210
2210
  quotaCode: string | undefined;
2211
2211
  /**
@@ -2214,25 +2214,25 @@ export declare class ServiceQuotaExceededException extends __BaseException {
2214
2214
  constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
2215
2215
  }
2216
2216
  /**
2217
- * @public
2218
2217
  * <p>An action was throttled.</p>
2218
+ * @public
2219
2219
  */
2220
2220
  export declare class ThrottlingException extends __BaseException {
2221
2221
  readonly name: "ThrottlingException";
2222
2222
  readonly $fault: "client";
2223
2223
  /**
2224
- * @public
2225
2224
  * <p>The identifier of the service that caused the exception.</p>
2225
+ * @public
2226
2226
  */
2227
2227
  serviceCode?: string;
2228
2228
  /**
2229
- * @public
2230
2229
  * <p>The identifier of the quota that caused the exception.</p>
2230
+ * @public
2231
2231
  */
2232
2232
  quotaCode?: string;
2233
2233
  /**
2234
- * @public
2235
2234
  * <p>The number of seconds to wait before retrying the action that caused the exception.</p>
2235
+ * @public
2236
2236
  */
2237
2237
  retryAfterSeconds?: number;
2238
2238
  /**
@@ -2241,31 +2241,31 @@ export declare class ThrottlingException extends __BaseException {
2241
2241
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
2242
2242
  }
2243
2243
  /**
2244
- * @public
2245
2244
  * <p>Indicates that an error has occurred while performing a validate operation.</p>
2245
+ * @public
2246
2246
  */
2247
2247
  export interface ValidationExceptionField {
2248
2248
  /**
2249
- * @public
2250
2249
  * <p>The name of the exception.</p>
2250
+ * @public
2251
2251
  */
2252
2252
  name: string | undefined;
2253
2253
  /**
2254
- * @public
2255
2254
  * <p>The message of the exception.</p>
2255
+ * @public
2256
2256
  */
2257
2257
  message: string | undefined;
2258
2258
  }
2259
2259
  /**
2260
- * @public
2261
2260
  * <p>Indicates that an error has occurred while performing a validate operation.</p>
2261
+ * @public
2262
2262
  */
2263
2263
  export declare class ValidationException extends __BaseException {
2264
2264
  readonly name: "ValidationException";
2265
2265
  readonly $fault: "client";
2266
2266
  /**
2267
- * @public
2268
2267
  * <p>The list of fields for which validation failed and the corresponding failure messages.</p>
2268
+ * @public
2269
2269
  */
2270
2270
  fieldList?: ValidationExceptionField[];
2271
2271
  /**
@@ -2278,8 +2278,8 @@ export declare class ValidationException extends __BaseException {
2278
2278
  */
2279
2279
  export interface DeletePipeRequest {
2280
2280
  /**
2281
- * @public
2282
2281
  * <p>The name of the pipe.</p>
2282
+ * @public
2283
2283
  */
2284
2284
  Name: string | undefined;
2285
2285
  }
@@ -2301,33 +2301,33 @@ export type RequestedPipeStateDescribeResponse = (typeof RequestedPipeStateDescr
2301
2301
  */
2302
2302
  export interface DeletePipeResponse {
2303
2303
  /**
2304
- * @public
2305
2304
  * <p>The ARN of the pipe.</p>
2305
+ * @public
2306
2306
  */
2307
2307
  Arn?: string;
2308
2308
  /**
2309
- * @public
2310
2309
  * <p>The name of the pipe.</p>
2310
+ * @public
2311
2311
  */
2312
2312
  Name?: string;
2313
2313
  /**
2314
- * @public
2315
2314
  * <p>The state the pipe should be in.</p>
2315
+ * @public
2316
2316
  */
2317
2317
  DesiredState?: RequestedPipeStateDescribeResponse;
2318
2318
  /**
2319
- * @public
2320
2319
  * <p>The state the pipe is in.</p>
2320
+ * @public
2321
2321
  */
2322
2322
  CurrentState?: PipeState;
2323
2323
  /**
2324
- * @public
2325
2324
  * <p>The time the pipe was created.</p>
2325
+ * @public
2326
2326
  */
2327
2327
  CreationTime?: Date;
2328
2328
  /**
2329
- * @public
2330
2329
  * <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>
2330
+ * @public
2331
2331
  */
2332
2332
  LastModifiedTime?: Date;
2333
2333
  }
@@ -2336,46 +2336,45 @@ export interface DeletePipeResponse {
2336
2336
  */
2337
2337
  export interface DescribePipeRequest {
2338
2338
  /**
2339
- * @public
2340
2339
  * <p>The name of the pipe.</p>
2340
+ * @public
2341
2341
  */
2342
2342
  Name: string | undefined;
2343
2343
  }
2344
2344
  /**
2345
- * @public
2346
2345
  * <p>The Amazon Kinesis Data Firehose logging configuration settings for the pipe.</p>
2346
+ * @public
2347
2347
  */
2348
2348
  export interface FirehoseLogDestination {
2349
2349
  /**
2350
- * @public
2351
2350
  * <p>The Amazon Resource Name (ARN) of the Kinesis Data Firehose delivery stream to which EventBridge delivers the pipe log records.</p>
2351
+ * @public
2352
2352
  */
2353
2353
  DeliveryStreamArn?: string;
2354
2354
  }
2355
2355
  /**
2356
- * @public
2357
2356
  * <p>The Amazon S3 logging configuration settings for the pipe.</p>
2357
+ * @public
2358
2358
  */
2359
2359
  export interface S3LogDestination {
2360
2360
  /**
2361
- * @public
2362
2361
  * <p>The name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.</p>
2362
+ * @public
2363
2363
  */
2364
2364
  BucketName?: string;
2365
2365
  /**
2366
- * @public
2367
2366
  * <p>The prefix text with which to begin Amazon S3 log object names.</p>
2368
2367
  * <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html">Organizing objects using prefixes</a>
2369
2368
  * in the <i>Amazon Simple Storage Service User Guide</i>.</p>
2369
+ * @public
2370
2370
  */
2371
2371
  Prefix?: string;
2372
2372
  /**
2373
- * @public
2374
2373
  * <p>The Amazon Web Services account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.</p>
2374
+ * @public
2375
2375
  */
2376
2376
  BucketOwner?: string;
2377
2377
  /**
2378
- * @public
2379
2378
  * <p>The format EventBridge uses for the log records.</p>
2380
2379
  * <ul>
2381
2380
  * <li>
@@ -2392,39 +2391,40 @@ export interface S3LogDestination {
2392
2391
  * </p>
2393
2392
  * </li>
2394
2393
  * </ul>
2394
+ * @public
2395
2395
  */
2396
2396
  OutputFormat?: S3OutputFormat;
2397
2397
  }
2398
2398
  /**
2399
- * @public
2400
2399
  * <p>The logging configuration settings for the pipe.</p>
2400
+ * @public
2401
2401
  */
2402
2402
  export interface PipeLogConfiguration {
2403
2403
  /**
2404
- * @public
2405
2404
  * <p>The Amazon S3 logging configuration settings for the pipe.</p>
2405
+ * @public
2406
2406
  */
2407
2407
  S3LogDestination?: S3LogDestination;
2408
2408
  /**
2409
- * @public
2410
2409
  * <p>The Amazon Kinesis Data Firehose logging configuration settings for the pipe.</p>
2410
+ * @public
2411
2411
  */
2412
2412
  FirehoseLogDestination?: FirehoseLogDestination;
2413
2413
  /**
2414
- * @public
2415
2414
  * <p>The Amazon CloudWatch Logs logging configuration settings for the pipe.</p>
2415
+ * @public
2416
2416
  */
2417
2417
  CloudwatchLogsLogDestination?: CloudwatchLogsLogDestination;
2418
2418
  /**
2419
- * @public
2420
2419
  * <p>The level of logging detail to include. This applies to all log destinations for the pipe.</p>
2420
+ * @public
2421
2421
  */
2422
2422
  Level?: LogLevel;
2423
2423
  /**
2424
- * @public
2425
2424
  * <p>Whether the execution data (specifically, the <code>payload</code>, <code>awsRequest</code>, and <code>awsResponse</code> fields) is included in the log messages for this pipe.</p>
2426
2425
  * <p>This applies to all log destinations for the pipe.</p>
2427
2426
  * <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs.html#eb-pipes-logs-execution-data">Including execution data in logs</a> in the <i>Amazon EventBridge User Guide</i>.</p>
2427
+ * @public
2428
2428
  */
2429
2429
  IncludeExecutionData?: IncludeExecutionDataOption[];
2430
2430
  }
@@ -2433,89 +2433,89 @@ export interface PipeLogConfiguration {
2433
2433
  */
2434
2434
  export interface DescribePipeResponse {
2435
2435
  /**
2436
- * @public
2437
2436
  * <p>The ARN of the pipe.</p>
2437
+ * @public
2438
2438
  */
2439
2439
  Arn?: string;
2440
2440
  /**
2441
- * @public
2442
2441
  * <p>The name of the pipe.</p>
2442
+ * @public
2443
2443
  */
2444
2444
  Name?: string;
2445
2445
  /**
2446
- * @public
2447
2446
  * <p>A description of the pipe.</p>
2447
+ * @public
2448
2448
  */
2449
2449
  Description?: string;
2450
2450
  /**
2451
- * @public
2452
2451
  * <p>The state the pipe should be in.</p>
2452
+ * @public
2453
2453
  */
2454
2454
  DesiredState?: RequestedPipeStateDescribeResponse;
2455
2455
  /**
2456
- * @public
2457
2456
  * <p>The state the pipe is in.</p>
2457
+ * @public
2458
2458
  */
2459
2459
  CurrentState?: PipeState;
2460
2460
  /**
2461
- * @public
2462
2461
  * <p>The reason the pipe is in its current state.</p>
2462
+ * @public
2463
2463
  */
2464
2464
  StateReason?: string;
2465
2465
  /**
2466
- * @public
2467
2466
  * <p>The ARN of the source resource.</p>
2467
+ * @public
2468
2468
  */
2469
2469
  Source?: string;
2470
2470
  /**
2471
- * @public
2472
2471
  * <p>The parameters required to set up a source for your pipe.</p>
2472
+ * @public
2473
2473
  */
2474
2474
  SourceParameters?: PipeSourceParameters;
2475
2475
  /**
2476
- * @public
2477
2476
  * <p>The ARN of the enrichment resource.</p>
2477
+ * @public
2478
2478
  */
2479
2479
  Enrichment?: string;
2480
2480
  /**
2481
- * @public
2482
2481
  * <p>The parameters required to set up enrichment on your pipe.</p>
2482
+ * @public
2483
2483
  */
2484
2484
  EnrichmentParameters?: PipeEnrichmentParameters;
2485
2485
  /**
2486
- * @public
2487
2486
  * <p>The ARN of the target resource.</p>
2487
+ * @public
2488
2488
  */
2489
2489
  Target?: string;
2490
2490
  /**
2491
- * @public
2492
2491
  * <p>The parameters required to set up a target for your pipe.</p>
2493
2492
  * <p>For more information about pipe target parameters, including how to use dynamic path parameters, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html">Target parameters</a> in the <i>Amazon EventBridge User Guide</i>.</p>
2493
+ * @public
2494
2494
  */
2495
2495
  TargetParameters?: PipeTargetParameters;
2496
2496
  /**
2497
- * @public
2498
2497
  * <p>The ARN of the role that allows the pipe to send data to the target.</p>
2498
+ * @public
2499
2499
  */
2500
2500
  RoleArn?: string;
2501
2501
  /**
2502
- * @public
2503
2502
  * <p>The list of key-value pairs to associate with the pipe.</p>
2503
+ * @public
2504
2504
  */
2505
2505
  Tags?: Record<string, string>;
2506
2506
  /**
2507
- * @public
2508
2507
  * <p>The time the pipe was created.</p>
2508
+ * @public
2509
2509
  */
2510
2510
  CreationTime?: Date;
2511
2511
  /**
2512
- * @public
2513
2512
  * <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>
2513
+ * @public
2514
2514
  */
2515
2515
  LastModifiedTime?: Date;
2516
2516
  /**
2517
- * @public
2518
2517
  * <p>The logging configuration settings for the pipe.</p>
2518
+ * @public
2519
2519
  */
2520
2520
  LogConfiguration?: PipeLogConfiguration;
2521
2521
  }
@@ -2524,97 +2524,97 @@ export interface DescribePipeResponse {
2524
2524
  */
2525
2525
  export interface ListPipesRequest {
2526
2526
  /**
2527
- * @public
2528
2527
  * <p>A value that will return a subset of the pipes associated with this account. For example, <code>"NamePrefix": "ABC"</code> will return
2529
2528
  * all endpoints with "ABC" in the name.</p>
2529
+ * @public
2530
2530
  */
2531
2531
  NamePrefix?: string;
2532
2532
  /**
2533
- * @public
2534
2533
  * <p>The state the pipe should be in.</p>
2534
+ * @public
2535
2535
  */
2536
2536
  DesiredState?: RequestedPipeState;
2537
2537
  /**
2538
- * @public
2539
2538
  * <p>The state the pipe is in.</p>
2539
+ * @public
2540
2540
  */
2541
2541
  CurrentState?: PipeState;
2542
2542
  /**
2543
- * @public
2544
2543
  * <p>The prefix matching the pipe source.</p>
2544
+ * @public
2545
2545
  */
2546
2546
  SourcePrefix?: string;
2547
2547
  /**
2548
- * @public
2549
2548
  * <p>The prefix matching the pipe target.</p>
2549
+ * @public
2550
2550
  */
2551
2551
  TargetPrefix?: string;
2552
2552
  /**
2553
- * @public
2554
2553
  * <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.
2555
2554
  * 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
2556
2555
  * token will return an HTTP 400 InvalidToken error.</p>
2556
+ * @public
2557
2557
  */
2558
2558
  NextToken?: string;
2559
2559
  /**
2560
- * @public
2561
2560
  * <p>The maximum number of pipes to include in the response.</p>
2561
+ * @public
2562
2562
  */
2563
2563
  Limit?: number;
2564
2564
  }
2565
2565
  /**
2566
- * @public
2567
2566
  * <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>
2567
+ * @public
2568
2568
  */
2569
2569
  export interface Pipe {
2570
2570
  /**
2571
- * @public
2572
2571
  * <p>The name of the pipe.</p>
2572
+ * @public
2573
2573
  */
2574
2574
  Name?: string;
2575
2575
  /**
2576
- * @public
2577
2576
  * <p>The ARN of the pipe.</p>
2577
+ * @public
2578
2578
  */
2579
2579
  Arn?: string;
2580
2580
  /**
2581
- * @public
2582
2581
  * <p>The state the pipe should be in.</p>
2582
+ * @public
2583
2583
  */
2584
2584
  DesiredState?: RequestedPipeState;
2585
2585
  /**
2586
- * @public
2587
2586
  * <p>The state the pipe is in.</p>
2587
+ * @public
2588
2588
  */
2589
2589
  CurrentState?: PipeState;
2590
2590
  /**
2591
- * @public
2592
2591
  * <p>The reason the pipe is in its current state.</p>
2592
+ * @public
2593
2593
  */
2594
2594
  StateReason?: string;
2595
2595
  /**
2596
- * @public
2597
2596
  * <p>The time the pipe was created.</p>
2597
+ * @public
2598
2598
  */
2599
2599
  CreationTime?: Date;
2600
2600
  /**
2601
- * @public
2602
2601
  * <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>
2602
+ * @public
2603
2603
  */
2604
2604
  LastModifiedTime?: Date;
2605
2605
  /**
2606
- * @public
2607
2606
  * <p>The ARN of the source resource.</p>
2607
+ * @public
2608
2608
  */
2609
2609
  Source?: string;
2610
2610
  /**
2611
- * @public
2612
2611
  * <p>The ARN of the target resource.</p>
2612
+ * @public
2613
2613
  */
2614
2614
  Target?: string;
2615
2615
  /**
2616
- * @public
2617
2616
  * <p>The ARN of the enrichment resource.</p>
2617
+ * @public
2618
2618
  */
2619
2619
  Enrichment?: string;
2620
2620
  }
@@ -2623,15 +2623,15 @@ export interface Pipe {
2623
2623
  */
2624
2624
  export interface ListPipesResponse {
2625
2625
  /**
2626
- * @public
2627
2626
  * <p>The pipes returned by the call.</p>
2627
+ * @public
2628
2628
  */
2629
2629
  Pipes?: Pipe[];
2630
2630
  /**
2631
- * @public
2632
2631
  * <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.
2633
2632
  * 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
2634
2633
  * token will return an HTTP 400 InvalidToken error.</p>
2634
+ * @public
2635
2635
  */
2636
2636
  NextToken?: string;
2637
2637
  }
@@ -2640,8 +2640,8 @@ export interface ListPipesResponse {
2640
2640
  */
2641
2641
  export interface ListTagsForResourceRequest {
2642
2642
  /**
2643
- * @public
2644
2643
  * <p>The ARN of the pipe for which you want to view tags.</p>
2644
+ * @public
2645
2645
  */
2646
2646
  resourceArn: string | undefined;
2647
2647
  }
@@ -2650,8 +2650,8 @@ export interface ListTagsForResourceRequest {
2650
2650
  */
2651
2651
  export interface ListTagsForResourceResponse {
2652
2652
  /**
2653
- * @public
2654
2653
  * <p>The list of key-value pairs to associate with the pipe.</p>
2654
+ * @public
2655
2655
  */
2656
2656
  tags?: Record<string, string>;
2657
2657
  }
@@ -2660,8 +2660,8 @@ export interface ListTagsForResourceResponse {
2660
2660
  */
2661
2661
  export interface StartPipeRequest {
2662
2662
  /**
2663
- * @public
2664
2663
  * <p>The name of the pipe.</p>
2664
+ * @public
2665
2665
  */
2666
2666
  Name: string | undefined;
2667
2667
  }
@@ -2670,33 +2670,33 @@ export interface StartPipeRequest {
2670
2670
  */
2671
2671
  export interface StartPipeResponse {
2672
2672
  /**
2673
- * @public
2674
2673
  * <p>The ARN of the pipe.</p>
2674
+ * @public
2675
2675
  */
2676
2676
  Arn?: string;
2677
2677
  /**
2678
- * @public
2679
2678
  * <p>The name of the pipe.</p>
2679
+ * @public
2680
2680
  */
2681
2681
  Name?: string;
2682
2682
  /**
2683
- * @public
2684
2683
  * <p>The state the pipe should be in.</p>
2684
+ * @public
2685
2685
  */
2686
2686
  DesiredState?: RequestedPipeState;
2687
2687
  /**
2688
- * @public
2689
2688
  * <p>The state the pipe is in.</p>
2689
+ * @public
2690
2690
  */
2691
2691
  CurrentState?: PipeState;
2692
2692
  /**
2693
- * @public
2694
2693
  * <p>The time the pipe was created.</p>
2694
+ * @public
2695
2695
  */
2696
2696
  CreationTime?: Date;
2697
2697
  /**
2698
- * @public
2699
2698
  * <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>
2699
+ * @public
2700
2700
  */
2701
2701
  LastModifiedTime?: Date;
2702
2702
  }
@@ -2705,8 +2705,8 @@ export interface StartPipeResponse {
2705
2705
  */
2706
2706
  export interface StopPipeRequest {
2707
2707
  /**
2708
- * @public
2709
2708
  * <p>The name of the pipe.</p>
2709
+ * @public
2710
2710
  */
2711
2711
  Name: string | undefined;
2712
2712
  }
@@ -2715,280 +2715,280 @@ export interface StopPipeRequest {
2715
2715
  */
2716
2716
  export interface StopPipeResponse {
2717
2717
  /**
2718
- * @public
2719
2718
  * <p>The ARN of the pipe.</p>
2719
+ * @public
2720
2720
  */
2721
2721
  Arn?: string;
2722
2722
  /**
2723
- * @public
2724
2723
  * <p>The name of the pipe.</p>
2724
+ * @public
2725
2725
  */
2726
2726
  Name?: string;
2727
2727
  /**
2728
- * @public
2729
2728
  * <p>The state the pipe should be in.</p>
2729
+ * @public
2730
2730
  */
2731
2731
  DesiredState?: RequestedPipeState;
2732
2732
  /**
2733
- * @public
2734
2733
  * <p>The state the pipe is in.</p>
2734
+ * @public
2735
2735
  */
2736
2736
  CurrentState?: PipeState;
2737
2737
  /**
2738
- * @public
2739
2738
  * <p>The time the pipe was created.</p>
2739
+ * @public
2740
2740
  */
2741
2741
  CreationTime?: Date;
2742
2742
  /**
2743
- * @public
2744
2743
  * <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>
2744
+ * @public
2745
2745
  */
2746
2746
  LastModifiedTime?: Date;
2747
2747
  }
2748
2748
  /**
2749
- * @public
2750
2749
  * <p>The parameters for using an Active MQ broker as a source.</p>
2750
+ * @public
2751
2751
  */
2752
2752
  export interface UpdatePipeSourceActiveMQBrokerParameters {
2753
2753
  /**
2754
- * @public
2755
2754
  * <p>The credentials needed to access the resource.</p>
2755
+ * @public
2756
2756
  */
2757
2757
  Credentials: MQBrokerAccessCredentials | undefined;
2758
2758
  /**
2759
- * @public
2760
2759
  * <p>The maximum number of records to include in each batch.</p>
2760
+ * @public
2761
2761
  */
2762
2762
  BatchSize?: number;
2763
2763
  /**
2764
- * @public
2765
2764
  * <p>The maximum length of a time to wait for events.</p>
2765
+ * @public
2766
2766
  */
2767
2767
  MaximumBatchingWindowInSeconds?: number;
2768
2768
  }
2769
2769
  /**
2770
- * @public
2771
2770
  * <p>The parameters for using a DynamoDB stream as a source.</p>
2771
+ * @public
2772
2772
  */
2773
2773
  export interface UpdatePipeSourceDynamoDBStreamParameters {
2774
2774
  /**
2775
- * @public
2776
2775
  * <p>The maximum number of records to include in each batch.</p>
2776
+ * @public
2777
2777
  */
2778
2778
  BatchSize?: number;
2779
2779
  /**
2780
- * @public
2781
2780
  * <p>Define the target queue to send dead-letter queue events to.</p>
2781
+ * @public
2782
2782
  */
2783
2783
  DeadLetterConfig?: DeadLetterConfig;
2784
2784
  /**
2785
- * @public
2786
2785
  * <p>(Streams only) Define how to handle item process failures. <code>AUTOMATIC_BISECT</code> halves each batch and retry each half
2787
2786
  * until all the records are processed or there is one failed message left in the batch.</p>
2787
+ * @public
2788
2788
  */
2789
2789
  OnPartialBatchItemFailure?: OnPartialBatchItemFailureStreams;
2790
2790
  /**
2791
- * @public
2792
2791
  * <p>The maximum length of a time to wait for events.</p>
2792
+ * @public
2793
2793
  */
2794
2794
  MaximumBatchingWindowInSeconds?: number;
2795
2795
  /**
2796
- * @public
2797
2796
  * <p>(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite.
2798
2797
  * When the value is set to infinite, EventBridge never discards old records. </p>
2798
+ * @public
2799
2799
  */
2800
2800
  MaximumRecordAgeInSeconds?: number;
2801
2801
  /**
2802
- * @public
2803
2802
  * <p>(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of
2804
2803
  * retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.</p>
2804
+ * @public
2805
2805
  */
2806
2806
  MaximumRetryAttempts?: number;
2807
2807
  /**
2808
- * @public
2809
2808
  * <p>(Streams only) The number of batches to process concurrently from each shard. The default value is 1.</p>
2809
+ * @public
2810
2810
  */
2811
2811
  ParallelizationFactor?: number;
2812
2812
  }
2813
2813
  /**
2814
- * @public
2815
2814
  * <p>The parameters for using a Kinesis stream as a source.</p>
2815
+ * @public
2816
2816
  */
2817
2817
  export interface UpdatePipeSourceKinesisStreamParameters {
2818
2818
  /**
2819
- * @public
2820
2819
  * <p>The maximum number of records to include in each batch.</p>
2820
+ * @public
2821
2821
  */
2822
2822
  BatchSize?: number;
2823
2823
  /**
2824
- * @public
2825
2824
  * <p>Define the target queue to send dead-letter queue events to.</p>
2825
+ * @public
2826
2826
  */
2827
2827
  DeadLetterConfig?: DeadLetterConfig;
2828
2828
  /**
2829
- * @public
2830
2829
  * <p>(Streams only) Define how to handle item process failures. <code>AUTOMATIC_BISECT</code> halves each batch and retry each half
2831
2830
  * until all the records are processed or there is one failed message left in the batch.</p>
2831
+ * @public
2832
2832
  */
2833
2833
  OnPartialBatchItemFailure?: OnPartialBatchItemFailureStreams;
2834
2834
  /**
2835
- * @public
2836
2835
  * <p>The maximum length of a time to wait for events.</p>
2836
+ * @public
2837
2837
  */
2838
2838
  MaximumBatchingWindowInSeconds?: number;
2839
2839
  /**
2840
- * @public
2841
2840
  * <p>(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite.
2842
2841
  * When the value is set to infinite, EventBridge never discards old records. </p>
2842
+ * @public
2843
2843
  */
2844
2844
  MaximumRecordAgeInSeconds?: number;
2845
2845
  /**
2846
- * @public
2847
2846
  * <p>(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of
2848
2847
  * retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.</p>
2848
+ * @public
2849
2849
  */
2850
2850
  MaximumRetryAttempts?: number;
2851
2851
  /**
2852
- * @public
2853
2852
  * <p>(Streams only) The number of batches to process concurrently from each shard. The default value is 1.</p>
2853
+ * @public
2854
2854
  */
2855
2855
  ParallelizationFactor?: number;
2856
2856
  }
2857
2857
  /**
2858
- * @public
2859
2858
  * <p>The parameters for using an MSK stream as a source.</p>
2859
+ * @public
2860
2860
  */
2861
2861
  export interface UpdatePipeSourceManagedStreamingKafkaParameters {
2862
2862
  /**
2863
- * @public
2864
2863
  * <p>The maximum number of records to include in each batch.</p>
2864
+ * @public
2865
2865
  */
2866
2866
  BatchSize?: number;
2867
2867
  /**
2868
- * @public
2869
2868
  * <p>The credentials needed to access the resource.</p>
2869
+ * @public
2870
2870
  */
2871
2871
  Credentials?: MSKAccessCredentials;
2872
2872
  /**
2873
- * @public
2874
2873
  * <p>The maximum length of a time to wait for events.</p>
2874
+ * @public
2875
2875
  */
2876
2876
  MaximumBatchingWindowInSeconds?: number;
2877
2877
  }
2878
2878
  /**
2879
- * @public
2880
2879
  * <p>The parameters for using a Rabbit MQ broker as a source.</p>
2880
+ * @public
2881
2881
  */
2882
2882
  export interface UpdatePipeSourceRabbitMQBrokerParameters {
2883
2883
  /**
2884
- * @public
2885
2884
  * <p>The credentials needed to access the resource.</p>
2885
+ * @public
2886
2886
  */
2887
2887
  Credentials: MQBrokerAccessCredentials | undefined;
2888
2888
  /**
2889
- * @public
2890
2889
  * <p>The maximum number of records to include in each batch.</p>
2890
+ * @public
2891
2891
  */
2892
2892
  BatchSize?: number;
2893
2893
  /**
2894
- * @public
2895
2894
  * <p>The maximum length of a time to wait for events.</p>
2895
+ * @public
2896
2896
  */
2897
2897
  MaximumBatchingWindowInSeconds?: number;
2898
2898
  }
2899
2899
  /**
2900
- * @public
2901
2900
  * <p>The parameters for using a self-managed Apache Kafka stream as a source.</p>
2901
+ * @public
2902
2902
  */
2903
2903
  export interface UpdatePipeSourceSelfManagedKafkaParameters {
2904
2904
  /**
2905
- * @public
2906
2905
  * <p>The maximum number of records to include in each batch.</p>
2906
+ * @public
2907
2907
  */
2908
2908
  BatchSize?: number;
2909
2909
  /**
2910
- * @public
2911
2910
  * <p>The maximum length of a time to wait for events.</p>
2911
+ * @public
2912
2912
  */
2913
2913
  MaximumBatchingWindowInSeconds?: number;
2914
2914
  /**
2915
- * @public
2916
2915
  * <p>The credentials needed to access the resource.</p>
2916
+ * @public
2917
2917
  */
2918
2918
  Credentials?: SelfManagedKafkaAccessConfigurationCredentials;
2919
2919
  /**
2920
- * @public
2921
2920
  * <p>The ARN of the Secrets Manager secret used for certification.</p>
2921
+ * @public
2922
2922
  */
2923
2923
  ServerRootCaCertificate?: string;
2924
2924
  /**
2925
- * @public
2926
2925
  * <p>This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.</p>
2926
+ * @public
2927
2927
  */
2928
2928
  Vpc?: SelfManagedKafkaAccessConfigurationVpc;
2929
2929
  }
2930
2930
  /**
2931
- * @public
2932
2931
  * <p>The parameters for using a Amazon SQS stream as a source.</p>
2932
+ * @public
2933
2933
  */
2934
2934
  export interface UpdatePipeSourceSqsQueueParameters {
2935
2935
  /**
2936
- * @public
2937
2936
  * <p>The maximum number of records to include in each batch.</p>
2937
+ * @public
2938
2938
  */
2939
2939
  BatchSize?: number;
2940
2940
  /**
2941
- * @public
2942
2941
  * <p>The maximum length of a time to wait for events.</p>
2942
+ * @public
2943
2943
  */
2944
2944
  MaximumBatchingWindowInSeconds?: number;
2945
2945
  }
2946
2946
  /**
2947
- * @public
2948
2947
  * <p>The parameters required to set up a source for your pipe.</p>
2948
+ * @public
2949
2949
  */
2950
2950
  export interface UpdatePipeSourceParameters {
2951
2951
  /**
2952
- * @public
2953
2952
  * <p>The collection of event patterns used to filter events.</p>
2954
2953
  * <p>To remove a filter, specify a <code>FilterCriteria</code> object with an empty array of <code>Filter</code> objects.</p>
2955
2954
  * <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html">Events and Event
2956
2955
  * Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
2956
+ * @public
2957
2957
  */
2958
2958
  FilterCriteria?: FilterCriteria;
2959
2959
  /**
2960
- * @public
2961
2960
  * <p>The parameters for using a Kinesis stream as a source.</p>
2961
+ * @public
2962
2962
  */
2963
2963
  KinesisStreamParameters?: UpdatePipeSourceKinesisStreamParameters;
2964
2964
  /**
2965
- * @public
2966
2965
  * <p>The parameters for using a DynamoDB stream as a source.</p>
2966
+ * @public
2967
2967
  */
2968
2968
  DynamoDBStreamParameters?: UpdatePipeSourceDynamoDBStreamParameters;
2969
2969
  /**
2970
- * @public
2971
2970
  * <p>The parameters for using a Amazon SQS stream as a source.</p>
2971
+ * @public
2972
2972
  */
2973
2973
  SqsQueueParameters?: UpdatePipeSourceSqsQueueParameters;
2974
2974
  /**
2975
- * @public
2976
2975
  * <p>The parameters for using an Active MQ broker as a source.</p>
2976
+ * @public
2977
2977
  */
2978
2978
  ActiveMQBrokerParameters?: UpdatePipeSourceActiveMQBrokerParameters;
2979
2979
  /**
2980
- * @public
2981
2980
  * <p>The parameters for using a Rabbit MQ broker as a source.</p>
2981
+ * @public
2982
2982
  */
2983
2983
  RabbitMQBrokerParameters?: UpdatePipeSourceRabbitMQBrokerParameters;
2984
2984
  /**
2985
- * @public
2986
2985
  * <p>The parameters for using an MSK stream as a source.</p>
2986
+ * @public
2987
2987
  */
2988
2988
  ManagedStreamingKafkaParameters?: UpdatePipeSourceManagedStreamingKafkaParameters;
2989
2989
  /**
2990
- * @public
2991
2990
  * <p>The parameters for using a self-managed Apache Kafka stream as a source.</p>
2991
+ * @public
2992
2992
  */
2993
2993
  SelfManagedKafkaParameters?: UpdatePipeSourceSelfManagedKafkaParameters;
2994
2994
  }
@@ -2997,54 +2997,54 @@ export interface UpdatePipeSourceParameters {
2997
2997
  */
2998
2998
  export interface UpdatePipeRequest {
2999
2999
  /**
3000
- * @public
3001
3000
  * <p>The name of the pipe.</p>
3001
+ * @public
3002
3002
  */
3003
3003
  Name: string | undefined;
3004
3004
  /**
3005
- * @public
3006
3005
  * <p>A description of the pipe.</p>
3006
+ * @public
3007
3007
  */
3008
3008
  Description?: string;
3009
3009
  /**
3010
- * @public
3011
3010
  * <p>The state the pipe should be in.</p>
3011
+ * @public
3012
3012
  */
3013
3013
  DesiredState?: RequestedPipeState;
3014
3014
  /**
3015
- * @public
3016
3015
  * <p>The parameters required to set up a source for your pipe.</p>
3016
+ * @public
3017
3017
  */
3018
3018
  SourceParameters?: UpdatePipeSourceParameters;
3019
3019
  /**
3020
- * @public
3021
3020
  * <p>The ARN of the enrichment resource.</p>
3021
+ * @public
3022
3022
  */
3023
3023
  Enrichment?: string;
3024
3024
  /**
3025
- * @public
3026
3025
  * <p>The parameters required to set up enrichment on your pipe.</p>
3026
+ * @public
3027
3027
  */
3028
3028
  EnrichmentParameters?: PipeEnrichmentParameters;
3029
3029
  /**
3030
- * @public
3031
3030
  * <p>The ARN of the target resource.</p>
3031
+ * @public
3032
3032
  */
3033
3033
  Target?: string;
3034
3034
  /**
3035
- * @public
3036
3035
  * <p>The parameters required to set up a target for your pipe.</p>
3037
3036
  * <p>For more information about pipe target parameters, including how to use dynamic path parameters, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html">Target parameters</a> in the <i>Amazon EventBridge User Guide</i>.</p>
3037
+ * @public
3038
3038
  */
3039
3039
  TargetParameters?: PipeTargetParameters;
3040
3040
  /**
3041
- * @public
3042
3041
  * <p>The ARN of the role that allows the pipe to send data to the target.</p>
3042
+ * @public
3043
3043
  */
3044
3044
  RoleArn: string | undefined;
3045
3045
  /**
3046
- * @public
3047
3046
  * <p>The logging configuration settings for the pipe.</p>
3047
+ * @public
3048
3048
  */
3049
3049
  LogConfiguration?: PipeLogConfigurationParameters;
3050
3050
  }
@@ -3053,33 +3053,33 @@ export interface UpdatePipeRequest {
3053
3053
  */
3054
3054
  export interface UpdatePipeResponse {
3055
3055
  /**
3056
- * @public
3057
3056
  * <p>The ARN of the pipe.</p>
3057
+ * @public
3058
3058
  */
3059
3059
  Arn?: string;
3060
3060
  /**
3061
- * @public
3062
3061
  * <p>The name of the pipe.</p>
3062
+ * @public
3063
3063
  */
3064
3064
  Name?: string;
3065
3065
  /**
3066
- * @public
3067
3066
  * <p>The state the pipe should be in.</p>
3067
+ * @public
3068
3068
  */
3069
3069
  DesiredState?: RequestedPipeState;
3070
3070
  /**
3071
- * @public
3072
3071
  * <p>The state the pipe is in.</p>
3072
+ * @public
3073
3073
  */
3074
3074
  CurrentState?: PipeState;
3075
3075
  /**
3076
- * @public
3077
3076
  * <p>The time the pipe was created.</p>
3077
+ * @public
3078
3078
  */
3079
3079
  CreationTime?: Date;
3080
3080
  /**
3081
- * @public
3082
3081
  * <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>
3082
+ * @public
3083
3083
  */
3084
3084
  LastModifiedTime?: Date;
3085
3085
  }
@@ -3088,13 +3088,13 @@ export interface UpdatePipeResponse {
3088
3088
  */
3089
3089
  export interface TagResourceRequest {
3090
3090
  /**
3091
- * @public
3092
3091
  * <p>The ARN of the pipe.</p>
3092
+ * @public
3093
3093
  */
3094
3094
  resourceArn: string | undefined;
3095
3095
  /**
3096
- * @public
3097
3096
  * <p>The list of key-value pairs associated with the pipe.</p>
3097
+ * @public
3098
3098
  */
3099
3099
  tags: Record<string, string> | undefined;
3100
3100
  }
@@ -3108,13 +3108,13 @@ export interface TagResourceResponse {
3108
3108
  */
3109
3109
  export interface UntagResourceRequest {
3110
3110
  /**
3111
- * @public
3112
3111
  * <p>The ARN of the pipe.</p>
3112
+ * @public
3113
3113
  */
3114
3114
  resourceArn: string | undefined;
3115
3115
  /**
3116
- * @public
3117
3116
  * <p>The list of tag keys to remove from the pipe.</p>
3117
+ * @public
3118
3118
  */
3119
3119
  tagKeys: string[] | undefined;
3120
3120
  }