@aws-sdk/client-firehose 3.216.0 → 3.220.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,7 +1,22 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { FirehoseServiceException as __BaseException } from "./FirehoseServiceException";
3
- export interface AmazonopensearchserviceBufferingHints {
3
+ /**
4
+ * <p>Describes the buffering to perform before delivering data to the Serverless offering for
5
+ * Amazon OpenSearch Service destination.</p>
6
+ */
7
+ export interface AmazonOpenSearchServerlessBufferingHints {
8
+ /**
9
+ * <p>Buffer incoming data for the specified period of time, in seconds, before delivering it
10
+ * to the destination. The default value is 300 (5 minutes).</p>
11
+ */
4
12
  IntervalInSeconds?: number;
13
+ /**
14
+ * <p>Buffer incoming data to the specified size, in MBs, before delivering it to the
15
+ * destination. The default value is 5. </p>
16
+ * <p>We recommend setting this parameter to a value greater than the amount of data you
17
+ * typically ingest into the delivery stream in 10 seconds. For example, if you typically
18
+ * ingest data at 1 MB/sec, the value should be 10 MB or higher.</p>
19
+ */
5
20
  SizeInMBs?: number;
6
21
  }
7
22
  /**
@@ -23,13 +38,6 @@ export interface CloudWatchLoggingOptions {
23
38
  */
24
39
  LogStreamName?: string;
25
40
  }
26
- export declare enum AmazonopensearchserviceIndexRotationPeriod {
27
- NoRotation = "NoRotation",
28
- OneDay = "OneDay",
29
- OneHour = "OneHour",
30
- OneMonth = "OneMonth",
31
- OneWeek = "OneWeek"
32
- }
33
41
  export declare enum ProcessorParameterName {
34
42
  BUFFER_INTERVAL_IN_SECONDS = "BufferIntervalInSeconds",
35
43
  BUFFER_SIZE_IN_MB = "BufferSizeInMBs",
@@ -42,11 +50,15 @@ export declare enum ProcessorParameterName {
42
50
  SUB_RECORD_TYPE = "SubRecordType"
43
51
  }
44
52
  /**
45
- * <p>Describes the processor parameter.</p>
53
+ * <p>Describes the processor parameter. </p>
46
54
  */
47
55
  export interface ProcessorParameter {
48
56
  /**
49
- * <p>The name of the parameter.</p>
57
+ * <p>The name of the parameter. Currently the following default values are supported: 3
58
+ * for <code>NumberOfRetries</code> and 60 for the <code>BufferIntervalInSeconds</code>. The
59
+ * <code>BufferSizeInMBs</code> ranges between 0.2 MB and up to 3MB. The default buffering
60
+ * hint is 1MB for all destinations, except Splunk. For Splunk, the default buffering hint is
61
+ * 256 KB. </p>
50
62
  */
51
63
  ParameterName: ProcessorParameterName | string | undefined;
52
64
  /**
@@ -54,7 +66,12 @@ export interface ProcessorParameter {
54
66
  */
55
67
  ParameterValue: string | undefined;
56
68
  }
57
- export declare type ProcessorType = "AppendDelimiterToRecord" | "Lambda" | "MetadataExtraction" | "RecordDeAggregation";
69
+ export declare enum ProcessorType {
70
+ AppendDelimiterToRecord = "AppendDelimiterToRecord",
71
+ Lambda = "Lambda",
72
+ MetadataExtraction = "MetadataExtraction",
73
+ RecordDeAggregation = "RecordDeAggregation"
74
+ }
58
75
  /**
59
76
  * <p>Describes a data processor.</p>
60
77
  */
@@ -81,10 +98,21 @@ export interface ProcessingConfiguration {
81
98
  */
82
99
  Processors?: Processor[];
83
100
  }
84
- export interface AmazonopensearchserviceRetryOptions {
101
+ /**
102
+ * <p>Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents
103
+ * to the Serverless offering for Amazon OpenSearch Service.</p>
104
+ */
105
+ export interface AmazonOpenSearchServerlessRetryOptions {
106
+ /**
107
+ * <p>After an initial failure to deliver to the Serverless offering for Amazon OpenSearch
108
+ * Service, the total amount of time during which Kinesis Data Firehose retries delivery
109
+ * (including the first attempt). After this time has elapsed, the failed documents are
110
+ * written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results
111
+ * in no retries.</p>
112
+ */
85
113
  DurationInSeconds?: number;
86
114
  }
87
- export declare enum AmazonopensearchserviceS3BackupMode {
115
+ export declare enum AmazonOpenSearchServerlessS3BackupMode {
88
116
  AllDocuments = "AllDocuments",
89
117
  FailedDocumentsOnly = "FailedDocumentsOnly"
90
118
  }
@@ -126,13 +154,14 @@ export declare enum CompressionFormat {
126
154
  */
127
155
  export interface KMSEncryptionConfig {
128
156
  /**
129
- * <p>The Amazon Resource Name (ARN) of the encryption key. Must belong to the same AWS
130
- * Region as the destination Amazon S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
131
- * Resource Names (ARNs) and AWS Service Namespaces</a>.</p>
157
+ * <p>The Amazon Resource Name (ARN) of the encryption key. Must belong to the same Amazon Web Services Region as the destination Amazon S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
158
+ * Resource Names (ARNs) and Amazon Web Services Service Namespaces</a>.</p>
132
159
  */
133
160
  AWSKMSKeyARN: string | undefined;
134
161
  }
135
- export declare type NoEncryptionConfig = "NoEncryption";
162
+ export declare enum NoEncryptionConfig {
163
+ NoEncryption = "NoEncryption"
164
+ }
136
165
  /**
137
166
  * <p>Describes the encryption for a destination in Amazon S3.</p>
138
167
  */
@@ -152,14 +181,14 @@ export interface EncryptionConfiguration {
152
181
  */
153
182
  export interface S3DestinationConfiguration {
154
183
  /**
155
- * <p>The Amazon Resource Name (ARN) of the AWS credentials. For more information, see
156
- * <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
157
- * Resource Names (ARNs) and AWS Service Namespaces</a>.</p>
184
+ * <p>The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more
185
+ * information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
186
+ * Amazon Web Services Service Namespaces</a>.</p>
158
187
  */
159
188
  RoleARN: string | undefined;
160
189
  /**
161
190
  * <p>The ARN of the S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
162
- * AWS Service Namespaces</a>.</p>
191
+ * Amazon Web Services Service Namespaces</a>.</p>
163
192
  */
164
193
  BucketARN: string | undefined;
165
194
  /**
@@ -283,16 +312,46 @@ export interface VpcConfiguration {
283
312
  */
284
313
  SecurityGroupIds: string[] | undefined;
285
314
  }
286
- export interface AmazonopensearchserviceDestinationConfiguration {
315
+ /**
316
+ * <p>Describes the configuration of a destination in the Serverless offering for Amazon
317
+ * OpenSearch Service.</p>
318
+ */
319
+ export interface AmazonOpenSearchServerlessDestinationConfiguration {
320
+ /**
321
+ * <p>The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose
322
+ * for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for
323
+ * indexing documents.</p>
324
+ */
287
325
  RoleARN: string | undefined;
288
- DomainARN?: string;
289
- ClusterEndpoint?: string;
326
+ /**
327
+ * <p>The endpoint to use when communicating with the collection in the Serverless offering
328
+ * for Amazon OpenSearch Service.</p>
329
+ */
330
+ CollectionEndpoint?: string;
331
+ /**
332
+ * <p>The Serverless offering for Amazon OpenSearch Service index name.</p>
333
+ */
290
334
  IndexName: string | undefined;
291
- TypeName?: string;
292
- IndexRotationPeriod?: AmazonopensearchserviceIndexRotationPeriod | string;
293
- BufferingHints?: AmazonopensearchserviceBufferingHints;
294
- RetryOptions?: AmazonopensearchserviceRetryOptions;
295
- S3BackupMode?: AmazonopensearchserviceS3BackupMode | string;
335
+ /**
336
+ * <p>The buffering options. If no value is specified, the default values for
337
+ * AmazonopensearchserviceBufferingHints are used.</p>
338
+ */
339
+ BufferingHints?: AmazonOpenSearchServerlessBufferingHints;
340
+ /**
341
+ * <p>The retry behavior in case Kinesis Data Firehose is unable to deliver documents to the
342
+ * Serverless offering for Amazon OpenSearch Service. The default value is 300 (5
343
+ * minutes).</p>
344
+ */
345
+ RetryOptions?: AmazonOpenSearchServerlessRetryOptions;
346
+ /**
347
+ * <p>Defines how documents should be delivered to Amazon S3. When it is set to
348
+ * FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed
349
+ * to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to
350
+ * the key prefix. When set to AllDocuments, Kinesis Data Firehose delivers all incoming
351
+ * records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/
352
+ * appended to the prefix.</p>
353
+ */
354
+ S3BackupMode?: AmazonOpenSearchServerlessS3BackupMode | string;
296
355
  /**
297
356
  * <p>Describes the configuration of a destination in Amazon S3.</p>
298
357
  */
@@ -315,14 +374,14 @@ export interface AmazonopensearchserviceDestinationConfiguration {
315
374
  */
316
375
  export interface S3DestinationDescription {
317
376
  /**
318
- * <p>The Amazon Resource Name (ARN) of the AWS credentials. For more information, see
319
- * <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
320
- * Resource Names (ARNs) and AWS Service Namespaces</a>.</p>
377
+ * <p>The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more
378
+ * information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
379
+ * Amazon Web Services Service Namespaces</a>.</p>
321
380
  */
322
381
  RoleARN: string | undefined;
323
382
  /**
324
383
  * <p>The ARN of the S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
325
- * AWS Service Namespaces</a>.</p>
384
+ * Amazon Web Services Service Namespaces</a>.</p>
326
385
  */
327
386
  BucketARN: string | undefined;
328
387
  /**
@@ -446,16 +505,36 @@ export interface VpcConfigurationDescription {
446
505
  */
447
506
  VpcId: string | undefined;
448
507
  }
449
- export interface AmazonopensearchserviceDestinationDescription {
508
+ /**
509
+ * <p>The destination description in the Serverless offering for Amazon OpenSearch
510
+ * Service.</p>
511
+ */
512
+ export interface AmazonOpenSearchServerlessDestinationDescription {
513
+ /**
514
+ * <p>The Amazon Resource Name (ARN) of the AWS credentials.</p>
515
+ */
450
516
  RoleARN?: string;
451
- DomainARN?: string;
452
- ClusterEndpoint?: string;
517
+ /**
518
+ * <p>The endpoint to use when communicating with the collection in the Serverless offering
519
+ * for Amazon OpenSearch Service.</p>
520
+ */
521
+ CollectionEndpoint?: string;
522
+ /**
523
+ * <p>The Serverless offering for Amazon OpenSearch Service index name.</p>
524
+ */
453
525
  IndexName?: string;
454
- TypeName?: string;
455
- IndexRotationPeriod?: AmazonopensearchserviceIndexRotationPeriod | string;
456
- BufferingHints?: AmazonopensearchserviceBufferingHints;
457
- RetryOptions?: AmazonopensearchserviceRetryOptions;
458
- S3BackupMode?: AmazonopensearchserviceS3BackupMode | string;
526
+ /**
527
+ * <p>The buffering options.</p>
528
+ */
529
+ BufferingHints?: AmazonOpenSearchServerlessBufferingHints;
530
+ /**
531
+ * <p>The Serverless offering for Amazon OpenSearch Service retry options.</p>
532
+ */
533
+ RetryOptions?: AmazonOpenSearchServerlessRetryOptions;
534
+ /**
535
+ * <p>The Amazon S3 backup mode.</p>
536
+ */
537
+ S3BackupMode?: AmazonOpenSearchServerlessS3BackupMode | string;
459
538
  /**
460
539
  * <p>Describes a destination in Amazon S3.</p>
461
540
  */
@@ -478,14 +557,14 @@ export interface AmazonopensearchserviceDestinationDescription {
478
557
  */
479
558
  export interface S3DestinationUpdate {
480
559
  /**
481
- * <p>The Amazon Resource Name (ARN) of the AWS credentials. For more information, see
482
- * <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
483
- * Resource Names (ARNs) and AWS Service Namespaces</a>.</p>
560
+ * <p>The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more
561
+ * information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
562
+ * Amazon Web Services Service Namespaces</a>.</p>
484
563
  */
485
564
  RoleARN?: string;
486
565
  /**
487
566
  * <p>The ARN of the S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
488
- * AWS Service Namespaces</a>.</p>
567
+ * Amazon Web Services Service Namespaces</a>.</p>
489
568
  */
490
569
  BucketARN?: string;
491
570
  /**
@@ -524,14 +603,274 @@ export interface S3DestinationUpdate {
524
603
  */
525
604
  CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
526
605
  }
606
+ /**
607
+ * <p>Describes an update for a destination in the Serverless offering for Amazon OpenSearch
608
+ * Service.</p>
609
+ */
610
+ export interface AmazonOpenSearchServerlessDestinationUpdate {
611
+ /**
612
+ * <p>The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose
613
+ * for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for
614
+ * indexing documents.</p>
615
+ */
616
+ RoleARN?: string;
617
+ /**
618
+ * <p>The endpoint to use when communicating with the collection in the Serverless offering
619
+ * for Amazon OpenSearch Service.</p>
620
+ */
621
+ CollectionEndpoint?: string;
622
+ /**
623
+ * <p>The Serverless offering for Amazon OpenSearch Service index name.</p>
624
+ */
625
+ IndexName?: string;
626
+ /**
627
+ * <p>The buffering options. If no value is specified, AmazonopensearchBufferingHints object
628
+ * default values are used.</p>
629
+ */
630
+ BufferingHints?: AmazonOpenSearchServerlessBufferingHints;
631
+ /**
632
+ * <p>The retry behavior in case Kinesis Data Firehose is unable to deliver documents to the
633
+ * Serverless offering for Amazon OpenSearch Service. The default value is 300 (5
634
+ * minutes).</p>
635
+ */
636
+ RetryOptions?: AmazonOpenSearchServerlessRetryOptions;
637
+ /**
638
+ * <p>Describes an update for a destination in Amazon S3.</p>
639
+ */
640
+ S3Update?: S3DestinationUpdate;
641
+ /**
642
+ * <p>Describes a data processing configuration.</p>
643
+ */
644
+ ProcessingConfiguration?: ProcessingConfiguration;
645
+ /**
646
+ * <p>Describes the Amazon CloudWatch logging options for your delivery stream.</p>
647
+ */
648
+ CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
649
+ }
650
+ /**
651
+ * <p>Describes the buffering to perform before delivering data to the Amazon OpenSearch
652
+ * Service destination. </p>
653
+ */
654
+ export interface AmazonopensearchserviceBufferingHints {
655
+ /**
656
+ * <p>Buffer incoming data for the specified period of time, in seconds, before delivering it
657
+ * to the destination. The default value is 300 (5 minutes). </p>
658
+ */
659
+ IntervalInSeconds?: number;
660
+ /**
661
+ * <p>Buffer incoming data to the specified size, in MBs, before delivering it to the
662
+ * destination. The default value is 5.</p>
663
+ * <p>We recommend setting this parameter to a value greater than the amount of data you
664
+ * typically ingest into the delivery stream in 10 seconds. For example, if you typically
665
+ * ingest data at 1 MB/sec, the value should be 10 MB or higher. </p>
666
+ */
667
+ SizeInMBs?: number;
668
+ }
669
+ export declare enum AmazonopensearchserviceIndexRotationPeriod {
670
+ NoRotation = "NoRotation",
671
+ OneDay = "OneDay",
672
+ OneHour = "OneHour",
673
+ OneMonth = "OneMonth",
674
+ OneWeek = "OneWeek"
675
+ }
676
+ /**
677
+ * <p>Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents
678
+ * to Amazon OpenSearch Service. </p>
679
+ */
680
+ export interface AmazonopensearchserviceRetryOptions {
681
+ /**
682
+ * <p>After an initial failure to deliver to Amazon OpenSearch Service, the total amount of
683
+ * time during which Kinesis Data Firehose retries delivery (including the first attempt).
684
+ * After this time has elapsed, the failed documents are written to Amazon S3. Default value
685
+ * is 300 seconds (5 minutes). A value of 0 (zero) results in no retries. </p>
686
+ */
687
+ DurationInSeconds?: number;
688
+ }
689
+ export declare enum AmazonopensearchserviceS3BackupMode {
690
+ AllDocuments = "AllDocuments",
691
+ FailedDocumentsOnly = "FailedDocumentsOnly"
692
+ }
693
+ /**
694
+ * <p>Describes the configuration of a destination in Amazon OpenSearch Service</p>
695
+ */
696
+ export interface AmazonopensearchserviceDestinationConfiguration {
697
+ /**
698
+ * <p>The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose
699
+ * for calling the Amazon OpenSearch Service Configuration API and for indexing
700
+ * documents.</p>
701
+ */
702
+ RoleARN: string | undefined;
703
+ /**
704
+ * <p>The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for
705
+ * DescribeElasticsearchDomain, DescribeElasticsearchDomains, and
706
+ * DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN. </p>
707
+ */
708
+ DomainARN?: string;
709
+ /**
710
+ * <p>The endpoint to use when communicating with the cluster. Specify either this
711
+ * ClusterEndpoint or the DomainARN field. </p>
712
+ */
713
+ ClusterEndpoint?: string;
714
+ /**
715
+ * <p>The ElasticsearAmazon OpenSearch Service index name.</p>
716
+ */
717
+ IndexName: string | undefined;
718
+ /**
719
+ * <p>The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be only one
720
+ * type per index. If you try to specify a new type for an existing index that already has
721
+ * another type, Kinesis Data Firehose returns an error during run time. </p>
722
+ */
723
+ TypeName?: string;
724
+ /**
725
+ * <p>The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp
726
+ * to the IndexName to facilitate the expiration of old data.</p>
727
+ */
728
+ IndexRotationPeriod?: AmazonopensearchserviceIndexRotationPeriod | string;
729
+ /**
730
+ * <p>The buffering options. If no value is specified, the default values for
731
+ * AmazonopensearchserviceBufferingHints are used. </p>
732
+ */
733
+ BufferingHints?: AmazonopensearchserviceBufferingHints;
734
+ /**
735
+ * <p>The retry behavior in case Kinesis Data Firehose is unable to deliver documents to
736
+ * Amazon OpenSearch Service. The default value is 300 (5 minutes). </p>
737
+ */
738
+ RetryOptions?: AmazonopensearchserviceRetryOptions;
739
+ /**
740
+ * <p>Defines how documents should be delivered to Amazon S3. When it is set to
741
+ * FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed
742
+ * to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to
743
+ * the key prefix. When set to AllDocuments, Kinesis Data Firehose delivers all incoming
744
+ * records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/
745
+ * appended to the prefix. </p>
746
+ */
747
+ S3BackupMode?: AmazonopensearchserviceS3BackupMode | string;
748
+ /**
749
+ * <p>Describes the configuration of a destination in Amazon S3.</p>
750
+ */
751
+ S3Configuration: S3DestinationConfiguration | undefined;
752
+ /**
753
+ * <p>Describes a data processing configuration.</p>
754
+ */
755
+ ProcessingConfiguration?: ProcessingConfiguration;
756
+ /**
757
+ * <p>Describes the Amazon CloudWatch logging options for your delivery stream.</p>
758
+ */
759
+ CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
760
+ /**
761
+ * <p>The details of the VPC of the Amazon ES destination.</p>
762
+ */
763
+ VpcConfiguration?: VpcConfiguration;
764
+ }
765
+ /**
766
+ * <p>The destination description in Amazon OpenSearch Service.</p>
767
+ */
768
+ export interface AmazonopensearchserviceDestinationDescription {
769
+ /**
770
+ * <p>The Amazon Resource Name (ARN) of the Amazon Web Services credentials. </p>
771
+ */
772
+ RoleARN?: string;
773
+ /**
774
+ * <p>The ARN of the Amazon OpenSearch Service domain.</p>
775
+ */
776
+ DomainARN?: string;
777
+ /**
778
+ * <p>The endpoint to use when communicating with the cluster. Kinesis Data Firehose uses
779
+ * either this ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch
780
+ * Service. </p>
781
+ */
782
+ ClusterEndpoint?: string;
783
+ /**
784
+ * <p>The Amazon OpenSearch Service index name.</p>
785
+ */
786
+ IndexName?: string;
787
+ /**
788
+ * <p>The Amazon OpenSearch Service type name. This applies to Elasticsearch 6.x and lower
789
+ * versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName. </p>
790
+ */
791
+ TypeName?: string;
792
+ /**
793
+ * <p>The Amazon OpenSearch Service index rotation period</p>
794
+ */
795
+ IndexRotationPeriod?: AmazonopensearchserviceIndexRotationPeriod | string;
796
+ /**
797
+ * <p>The buffering options.</p>
798
+ */
799
+ BufferingHints?: AmazonopensearchserviceBufferingHints;
800
+ /**
801
+ * <p>The Amazon OpenSearch Service retry options.</p>
802
+ */
803
+ RetryOptions?: AmazonopensearchserviceRetryOptions;
804
+ /**
805
+ * <p>The Amazon S3 backup mode.</p>
806
+ */
807
+ S3BackupMode?: AmazonopensearchserviceS3BackupMode | string;
808
+ /**
809
+ * <p>Describes a destination in Amazon S3.</p>
810
+ */
811
+ S3DestinationDescription?: S3DestinationDescription;
812
+ /**
813
+ * <p>Describes a data processing configuration.</p>
814
+ */
815
+ ProcessingConfiguration?: ProcessingConfiguration;
816
+ /**
817
+ * <p>Describes the Amazon CloudWatch logging options for your delivery stream.</p>
818
+ */
819
+ CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
820
+ /**
821
+ * <p>The details of the VPC of the Amazon ES destination.</p>
822
+ */
823
+ VpcConfigurationDescription?: VpcConfigurationDescription;
824
+ }
825
+ /**
826
+ * <p>Describes an update for a destination in Amazon OpenSearch Service.</p>
827
+ */
527
828
  export interface AmazonopensearchserviceDestinationUpdate {
829
+ /**
830
+ * <p>The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose
831
+ * for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
832
+ * </p>
833
+ */
528
834
  RoleARN?: string;
835
+ /**
836
+ * <p>The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for
837
+ * DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM role
838
+ * specified in RoleARN.</p>
839
+ */
529
840
  DomainARN?: string;
841
+ /**
842
+ * <p>The endpoint to use when communicating with the cluster. Specify either this
843
+ * ClusterEndpoint or the DomainARN field. </p>
844
+ */
530
845
  ClusterEndpoint?: string;
846
+ /**
847
+ * <p>The Amazon OpenSearch Service index name.</p>
848
+ */
531
849
  IndexName?: string;
850
+ /**
851
+ * <p>The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be only one
852
+ * type per index. If you try to specify a new type for an existing index that already has
853
+ * another type, Kinesis Data Firehose returns an error during runtime. </p>
854
+ * <p>If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream,
855
+ * Kinesis Data Firehose still delivers data to Elasticsearch with the old index name and type
856
+ * name. If you want to update your delivery stream with a new index name, provide an empty
857
+ * string for TypeName. </p>
858
+ */
532
859
  TypeName?: string;
860
+ /**
861
+ * <p>The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp
862
+ * to IndexName to facilitate the expiration of old data.</p>
863
+ */
533
864
  IndexRotationPeriod?: AmazonopensearchserviceIndexRotationPeriod | string;
865
+ /**
866
+ * <p>The buffering options. If no value is specified, AmazonopensearchBufferingHints object
867
+ * default values are used. </p>
868
+ */
534
869
  BufferingHints?: AmazonopensearchserviceBufferingHints;
870
+ /**
871
+ * <p>The retry behavior in case Kinesis Data Firehose is unable to deliver documents to
872
+ * Amazon OpenSearch Service. The default value is 300 (5 minutes). </p>
873
+ */
535
874
  RetryOptions?: AmazonopensearchserviceRetryOptions;
536
875
  /**
537
876
  * <p>Describes an update for a destination in Amazon S3.</p>
@@ -609,18 +948,17 @@ export declare enum KeyType {
609
948
  export interface DeliveryStreamEncryptionConfigurationInput {
610
949
  /**
611
950
  * <p>If you set <code>KeyType</code> to <code>CUSTOMER_MANAGED_CMK</code>, you must specify
612
- * the Amazon Resource Name (ARN) of the CMK. If you set <code>KeyType</code> to
613
- * <code>AWS_OWNED_CMK</code>, Kinesis Data Firehose uses a service-account CMK.</p>
951
+ * the Amazon Resource Name (ARN) of the CMK. If you set <code>KeyType</code> to <code>Amazon Web Services_OWNED_CMK</code>, Kinesis Data Firehose uses a service-account CMK.</p>
614
952
  */
615
953
  KeyARN?: string;
616
954
  /**
617
955
  * <p>Indicates the type of customer master key (CMK) to use for encryption. The default
618
- * setting is <code>AWS_OWNED_CMK</code>. For more information about CMKs, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys">Customer
619
- * Master Keys (CMKs)</a>. When you invoke <a>CreateDeliveryStream</a> or
620
- * <a>StartDeliveryStreamEncryption</a> with <code>KeyType</code> set to
621
- * CUSTOMER_MANAGED_CMK, Kinesis Data Firehose invokes the Amazon KMS operation <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateGrant.html">CreateGrant</a> to create a grant that allows the Kinesis Data Firehose service to
622
- * use the customer managed CMK to perform encryption and decryption. Kinesis Data Firehose
623
- * manages that grant. </p>
956
+ * setting is <code>Amazon Web Services_OWNED_CMK</code>. For more information about CMKs, see
957
+ * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys">Customer Master Keys (CMKs)</a>. When you invoke <a>CreateDeliveryStream</a> or <a>StartDeliveryStreamEncryption</a> with
958
+ * <code>KeyType</code> set to CUSTOMER_MANAGED_CMK, Kinesis Data Firehose invokes the
959
+ * Amazon KMS operation <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateGrant.html">CreateGrant</a> to create a grant
960
+ * that allows the Kinesis Data Firehose service to use the customer managed CMK to perform
961
+ * encryption and decryption. Kinesis Data Firehose manages that grant. </p>
624
962
  * <p>When you invoke <a>StartDeliveryStreamEncryption</a> to change the CMK for a
625
963
  * delivery stream that is encrypted with a customer managed CMK, Kinesis Data Firehose
626
964
  * schedules the grant it had on the old CMK for retirement.</p>
@@ -631,13 +969,16 @@ export interface DeliveryStreamEncryptionConfigurationInput {
631
969
  * <important>
632
970
  * <p>To encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't
633
971
  * support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html">About
634
- * Symmetric and Asymmetric CMKs</a> in the AWS Key Management Service developer
635
- * guide.</p>
972
+ * Symmetric and Asymmetric CMKs</a> in the Amazon Web Services Key Management
973
+ * Service developer guide.</p>
636
974
  * </important>
637
975
  */
638
976
  KeyType: KeyType | string | undefined;
639
977
  }
640
- export declare type DeliveryStreamType = "DirectPut" | "KinesisStreamAsSource";
978
+ export declare enum DeliveryStreamType {
979
+ DirectPut = "DirectPut",
980
+ KinesisStreamAsSource = "KinesisStreamAsSource"
981
+ }
641
982
  /**
642
983
  * <p>Describes the buffering to perform before delivering data to the Amazon ES
643
984
  * destination.</p>
@@ -657,7 +998,13 @@ export interface ElasticsearchBufferingHints {
657
998
  */
658
999
  SizeInMBs?: number;
659
1000
  }
660
- export declare type ElasticsearchIndexRotationPeriod = "NoRotation" | "OneDay" | "OneHour" | "OneMonth" | "OneWeek";
1001
+ export declare enum ElasticsearchIndexRotationPeriod {
1002
+ NoRotation = "NoRotation",
1003
+ OneDay = "OneDay",
1004
+ OneHour = "OneHour",
1005
+ OneMonth = "OneMonth",
1006
+ OneWeek = "OneWeek"
1007
+ }
661
1008
  /**
662
1009
  * <p>Configures retry behavior in case Kinesis Data Firehose is unable to deliver
663
1010
  * documents to Amazon ES.</p>
@@ -671,7 +1018,10 @@ export interface ElasticsearchRetryOptions {
671
1018
  */
672
1019
  DurationInSeconds?: number;
673
1020
  }
674
- export declare type ElasticsearchS3BackupMode = "AllDocuments" | "FailedDocumentsOnly";
1021
+ export declare enum ElasticsearchS3BackupMode {
1022
+ AllDocuments = "AllDocuments",
1023
+ FailedDocumentsOnly = "FailedDocumentsOnly"
1024
+ }
675
1025
  /**
676
1026
  * <p>Describes the configuration of a destination in Amazon ES.</p>
677
1027
  */
@@ -681,15 +1031,14 @@ export interface ElasticsearchDestinationConfiguration {
681
1031
  * for calling the Amazon ES Configuration API and for indexing documents. For more
682
1032
  * information, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3">Grant Kinesis Data
683
1033
  * Firehose Access to an Amazon S3 Destination</a> and <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
684
- * AWS Service Namespaces</a>.</p>
1034
+ * Amazon Web Services Service Namespaces</a>.</p>
685
1035
  */
686
1036
  RoleARN: string | undefined;
687
1037
  /**
688
1038
  * <p>The ARN of the Amazon ES domain. The IAM role must have permissions
689
- * for <code>DescribeElasticsearchDomain</code>, <code>DescribeElasticsearchDomains</code>,
690
- * and <code>DescribeElasticsearchDomainConfig</code> after assuming the role specified in
691
- * <b>RoleARN</b>. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
692
- * Resource Names (ARNs) and AWS Service Namespaces</a>.</p>
1039
+ * for <code>DescribeDomain</code>, <code>DescribeDomains</code>, and
1040
+ * <code>DescribeDomainConfig</code> after assuming the role specified in <b>RoleARN</b>. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
1041
+ * Amazon Web Services Service Namespaces</a>.</p>
693
1042
  *
694
1043
  * <p>Specify either <code>ClusterEndpoint</code> or <code>DomainARN</code>.</p>
695
1044
  */
@@ -732,10 +1081,10 @@ export interface ElasticsearchDestinationConfiguration {
732
1081
  * <p>Defines how documents should be delivered to Amazon S3. When it is set to
733
1082
  * <code>FailedDocumentsOnly</code>, Kinesis Data Firehose writes any documents that could
734
1083
  * not be indexed to the configured Amazon S3 destination, with
735
- * <code>elasticsearch-failed/</code> appended to the key prefix. When set to
1084
+ * <code>AmazonOpenSearchService-failed/</code> appended to the key prefix. When set to
736
1085
  * <code>AllDocuments</code>, Kinesis Data Firehose delivers all incoming records to Amazon
737
- * S3, and also writes failed documents with <code>elasticsearch-failed/</code> appended to
738
- * the prefix. For more information, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-s3-backup">Amazon S3 Backup for the
1086
+ * S3, and also writes failed documents with <code>AmazonOpenSearchService-failed/</code>
1087
+ * appended to the prefix. For more information, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-s3-backup">Amazon S3 Backup for the
739
1088
  * Amazon ES Destination</a>. Default value is
740
1089
  * <code>FailedDocumentsOnly</code>.</p>
741
1090
  * <p>You can't change this backup mode after you create the delivery stream. </p>
@@ -997,9 +1346,9 @@ export interface OutputFormatConfiguration {
997
1346
  */
998
1347
  export interface SchemaConfiguration {
999
1348
  /**
1000
- * <p>The role that Kinesis Data Firehose can use to access AWS Glue. This role must be in
1001
- * the same account you use for Kinesis Data Firehose. Cross-account roles aren't
1002
- * allowed.</p>
1349
+ * <p>The role that Kinesis Data Firehose can use to access Amazon Web Services Glue. This
1350
+ * role must be in the same account you use for Kinesis Data Firehose. Cross-account roles
1351
+ * aren't allowed.</p>
1003
1352
  * <important>
1004
1353
  * <p>If the <code>SchemaConfiguration</code> request parameter is used as part of invoking
1005
1354
  * the <code>CreateDeliveryStream</code> API, then the <code>RoleARN</code> property is
@@ -1008,13 +1357,13 @@ export interface SchemaConfiguration {
1008
1357
  */
1009
1358
  RoleARN?: string;
1010
1359
  /**
1011
- * <p>The ID of the AWS Glue Data Catalog. If you don't supply this, the AWS account ID is
1012
- * used by default.</p>
1360
+ * <p>The ID of the Amazon Web Services Glue Data Catalog. If you don't supply this, the
1361
+ * Amazon Web Services account ID is used by default.</p>
1013
1362
  */
1014
1363
  CatalogId?: string;
1015
1364
  /**
1016
- * <p>Specifies the name of the AWS Glue database that contains the schema for the output
1017
- * data.</p>
1365
+ * <p>Specifies the name of the Amazon Web Services Glue database that contains the schema for
1366
+ * the output data.</p>
1018
1367
  * <important>
1019
1368
  * <p>If the <code>SchemaConfiguration</code> request parameter is used as part of invoking
1020
1369
  * the <code>CreateDeliveryStream</code> API, then the <code>DatabaseName</code> property
@@ -1023,8 +1372,8 @@ export interface SchemaConfiguration {
1023
1372
  */
1024
1373
  DatabaseName?: string;
1025
1374
  /**
1026
- * <p>Specifies the AWS Glue table that contains the column information that constitutes your
1027
- * data schema.</p>
1375
+ * <p>Specifies the Amazon Web Services Glue table that contains the column information that
1376
+ * constitutes your data schema.</p>
1028
1377
  * <important>
1029
1378
  * <p>If the <code>SchemaConfiguration</code> request parameter is used as part of invoking
1030
1379
  * the <code>CreateDeliveryStream</code> API, then the <code>TableName</code> property is
@@ -1033,7 +1382,8 @@ export interface SchemaConfiguration {
1033
1382
  */
1034
1383
  TableName?: string;
1035
1384
  /**
1036
- * <p>If you don't specify an AWS Region, the default is the current Region.</p>
1385
+ * <p>If you don't specify an Amazon Web Services Region, the default is the current
1386
+ * Region.</p>
1037
1387
  */
1038
1388
  Region?: string;
1039
1389
  /**
@@ -1048,14 +1398,14 @@ export interface SchemaConfiguration {
1048
1398
  * <p>Specifies that you want Kinesis Data Firehose to convert data from the JSON format to
1049
1399
  * the Parquet or ORC format before writing it to Amazon S3. Kinesis Data Firehose uses the
1050
1400
  * serializer and deserializer that you specify, in addition to the column information from
1051
- * the AWS Glue table, to deserialize your input data from JSON and then serialize it to the
1052
- * Parquet or ORC format. For more information, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/record-format-conversion.html">Kinesis Data Firehose Record
1053
- * Format Conversion</a>.</p>
1401
+ * the Amazon Web Services Glue table, to deserialize your input data from JSON and then
1402
+ * serialize it to the Parquet or ORC format. For more information, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/record-format-conversion.html">Kinesis
1403
+ * Data Firehose Record Format Conversion</a>.</p>
1054
1404
  */
1055
1405
  export interface DataFormatConversionConfiguration {
1056
1406
  /**
1057
- * <p>Specifies the AWS Glue Data Catalog table that contains the column information. This
1058
- * parameter is required if <code>Enabled</code> is set to true.</p>
1407
+ * <p>Specifies the Amazon Web Services Glue Data Catalog table that contains the column
1408
+ * information. This parameter is required if <code>Enabled</code> is set to true.</p>
1059
1409
  */
1060
1410
  SchemaConfiguration?: SchemaConfiguration;
1061
1411
  /**
@@ -1090,7 +1440,7 @@ export interface RetryOptions {
1090
1440
  /**
1091
1441
  * <p>The configuration of the dynamic partitioning mechanism that creates smaller data sets
1092
1442
  * from the streaming data by partitioning it based on partition keys. Currently, dynamic
1093
- * partitioning is only supported for Amazon S3 destinations. For more information, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/dynamic-partitioning.html">https://docs.aws.amazon.com/firehose/latest/dev/dynamic-partitioning.html</a>
1443
+ * partitioning is only supported for Amazon S3 destinations.
1094
1444
  * </p>
1095
1445
  */
1096
1446
  export interface DynamicPartitioningConfiguration {
@@ -1105,20 +1455,23 @@ export interface DynamicPartitioningConfiguration {
1105
1455
  */
1106
1456
  Enabled?: boolean;
1107
1457
  }
1108
- export declare type S3BackupMode = "Disabled" | "Enabled";
1458
+ export declare enum S3BackupMode {
1459
+ Disabled = "Disabled",
1460
+ Enabled = "Enabled"
1461
+ }
1109
1462
  /**
1110
1463
  * <p>Describes the configuration of a destination in Amazon S3.</p>
1111
1464
  */
1112
1465
  export interface ExtendedS3DestinationConfiguration {
1113
1466
  /**
1114
- * <p>The Amazon Resource Name (ARN) of the AWS credentials. For more information, see
1115
- * <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
1116
- * Resource Names (ARNs) and AWS Service Namespaces</a>.</p>
1467
+ * <p>The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more
1468
+ * information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
1469
+ * Amazon Web Services Service Namespaces</a>.</p>
1117
1470
  */
1118
1471
  RoleARN: string | undefined;
1119
1472
  /**
1120
1473
  * <p>The ARN of the S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
1121
- * AWS Service Namespaces</a>.</p>
1474
+ * Amazon Web Services Service Namespaces</a>.</p>
1122
1475
  */
1123
1476
  BucketARN: string | undefined;
1124
1477
  /**
@@ -1174,7 +1527,7 @@ export interface ExtendedS3DestinationConfiguration {
1174
1527
  /**
1175
1528
  * <p>The configuration of the dynamic partitioning mechanism that creates smaller data sets
1176
1529
  * from the streaming data by partitioning it based on partition keys. Currently, dynamic
1177
- * partitioning is only supported for Amazon S3 destinations. For more information, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/dynamic-partitioning.html">https://docs.aws.amazon.com/firehose/latest/dev/dynamic-partitioning.html</a>
1530
+ * partitioning is only supported for Amazon S3 destinations.
1178
1531
  * </p>
1179
1532
  */
1180
1533
  DynamicPartitioningConfiguration?: DynamicPartitioningConfiguration;
@@ -1267,7 +1620,10 @@ export interface HttpEndpointRetryOptions {
1267
1620
  */
1268
1621
  DurationInSeconds?: number;
1269
1622
  }
1270
- export declare type HttpEndpointS3BackupMode = "AllData" | "FailedDataOnly";
1623
+ export declare enum HttpEndpointS3BackupMode {
1624
+ AllData = "AllData",
1625
+ FailedDataOnly = "FailedDataOnly"
1626
+ }
1271
1627
  /**
1272
1628
  * <p>Describes the configuration of the HTTP endpoint destination.</p>
1273
1629
  */
@@ -1332,8 +1688,8 @@ export interface KinesisStreamSourceConfiguration {
1332
1688
  KinesisStreamARN: string | undefined;
1333
1689
  /**
1334
1690
  * <p>The ARN of the role that provides access to the source Kinesis data stream. For more
1335
- * information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">AWS Identity and
1336
- * Access Management (IAM) ARN Format</a>.</p>
1691
+ * information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">Amazon Web Services
1692
+ * Identity and Access Management (IAM) ARN Format</a>.</p>
1337
1693
  */
1338
1694
  RoleARN: string | undefined;
1339
1695
  }
@@ -1351,15 +1707,18 @@ export interface RedshiftRetryOptions {
1351
1707
  */
1352
1708
  DurationInSeconds?: number;
1353
1709
  }
1354
- export declare type RedshiftS3BackupMode = "Disabled" | "Enabled";
1710
+ export declare enum RedshiftS3BackupMode {
1711
+ Disabled = "Disabled",
1712
+ Enabled = "Enabled"
1713
+ }
1355
1714
  /**
1356
1715
  * <p>Describes the configuration of a destination in Amazon Redshift.</p>
1357
1716
  */
1358
1717
  export interface RedshiftDestinationConfiguration {
1359
1718
  /**
1360
- * <p>The Amazon Resource Name (ARN) of the AWS credentials. For more information, see
1361
- * <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
1362
- * Resource Names (ARNs) and AWS Service Namespaces</a>.</p>
1719
+ * <p>The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more
1720
+ * information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
1721
+ * Amazon Web Services Service Namespaces</a>.</p>
1363
1722
  */
1364
1723
  RoleARN: string | undefined;
1365
1724
  /**
@@ -1411,7 +1770,10 @@ export interface RedshiftDestinationConfiguration {
1411
1770
  */
1412
1771
  CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
1413
1772
  }
1414
- export declare type HECEndpointType = "Event" | "Raw";
1773
+ export declare enum HECEndpointType {
1774
+ Event = "Event",
1775
+ Raw = "Raw"
1776
+ }
1415
1777
  /**
1416
1778
  * <p>Configures retry behavior in case Kinesis Data Firehose is unable to deliver
1417
1779
  * documents to Splunk, or if it doesn't receive an acknowledgment from Splunk.</p>
@@ -1425,7 +1787,10 @@ export interface SplunkRetryOptions {
1425
1787
  */
1426
1788
  DurationInSeconds?: number;
1427
1789
  }
1428
- export declare type SplunkS3BackupMode = "AllEvents" | "FailedEventsOnly";
1790
+ export declare enum SplunkS3BackupMode {
1791
+ AllEvents = "AllEvents",
1792
+ FailedEventsOnly = "FailedEventsOnly"
1793
+ }
1429
1794
  /**
1430
1795
  * <p>Describes the configuration of a destination in Splunk.</p>
1431
1796
  */
@@ -1499,9 +1864,10 @@ export interface Tag {
1499
1864
  }
1500
1865
  export interface CreateDeliveryStreamInput {
1501
1866
  /**
1502
- * <p>The name of the delivery stream. This name must be unique per AWS account in the same
1503
- * AWS Region. If the delivery streams are in different accounts or different Regions, you can
1504
- * have multiple delivery streams with the same name.</p>
1867
+ * <p>The name of the delivery stream. This name must be unique per Amazon Web Services
1868
+ * account in the same Amazon Web Services Region. If the delivery streams are in different
1869
+ * accounts or different Regions, you can have multiple delivery streams with the same
1870
+ * name.</p>
1505
1871
  */
1506
1872
  DeliveryStreamName: string | undefined;
1507
1873
  /**
@@ -1550,6 +1916,10 @@ export interface CreateDeliveryStreamInput {
1550
1916
  * <p>The destination in Amazon ES. You can specify only one destination.</p>
1551
1917
  */
1552
1918
  ElasticsearchDestinationConfiguration?: ElasticsearchDestinationConfiguration;
1919
+ /**
1920
+ * <p>The destination in Amazon OpenSearch Service. You can specify only one
1921
+ * destination.</p>
1922
+ */
1553
1923
  AmazonopensearchserviceDestinationConfiguration?: AmazonopensearchserviceDestinationConfiguration;
1554
1924
  /**
1555
1925
  * <p>The destination in Splunk. You can specify only one destination.</p>
@@ -1562,14 +1932,20 @@ export interface CreateDeliveryStreamInput {
1562
1932
  HttpEndpointDestinationConfiguration?: HttpEndpointDestinationConfiguration;
1563
1933
  /**
1564
1934
  * <p>A set of tags to assign to the delivery stream. A tag is a key-value pair that you can
1565
- * define and assign to AWS resources. Tags are metadata. For example, you can add friendly
1566
- * names and descriptions or other types of information that can help you distinguish the
1567
- * delivery stream. For more information about tags, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Using Cost Allocation
1568
- * Tags</a> in the AWS Billing and Cost Management User Guide.</p>
1935
+ * define and assign to Amazon Web Services resources. Tags are metadata. For example, you can
1936
+ * add friendly names and descriptions or other types of information that can help you
1937
+ * distinguish the delivery stream. For more information about tags, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Using
1938
+ * Cost Allocation Tags</a> in the Amazon Web Services Billing and Cost Management User
1939
+ * Guide.</p>
1569
1940
  *
1570
1941
  * <p>You can specify up to 50 tags when creating a delivery stream.</p>
1571
1942
  */
1572
1943
  Tags?: Tag[];
1944
+ /**
1945
+ * <p>The destination in the Serverless offering for Amazon OpenSearch Service. You can
1946
+ * specify only one destination.</p>
1947
+ */
1948
+ AmazonOpenSearchServerlessDestinationConfiguration?: AmazonOpenSearchServerlessDestinationConfiguration;
1573
1949
  }
1574
1950
  export interface CreateDeliveryStreamOutput {
1575
1951
  /**
@@ -1637,8 +2013,8 @@ export interface DeleteDeliveryStreamInput {
1637
2013
  * the grant due to a customer error, such as when the CMK or the grant are in an invalid
1638
2014
  * state. If you force deletion, you can then use the <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_RevokeGrant.html">RevokeGrant</a> operation to
1639
2015
  * revoke the grant you gave to Kinesis Data Firehose. If a failure to retire the grant
1640
- * happens due to an AWS KMS issue, Kinesis Data Firehose keeps retrying the delete
1641
- * operation.</p>
2016
+ * happens due to an Amazon Web Services KMS issue, Kinesis Data Firehose keeps retrying the
2017
+ * delete operation.</p>
1642
2018
  * <p>The default value is false.</p>
1643
2019
  */
1644
2020
  AllowForceDelete?: boolean;
@@ -1704,15 +2080,14 @@ export declare enum DeliveryStreamEncryptionStatus {
1704
2080
  export interface DeliveryStreamEncryptionConfiguration {
1705
2081
  /**
1706
2082
  * <p>If <code>KeyType</code> is <code>CUSTOMER_MANAGED_CMK</code>, this field contains the
1707
- * ARN of the customer managed CMK. If <code>KeyType</code> is <code>AWS_OWNED_CMK</code>,
1708
- * <code>DeliveryStreamEncryptionConfiguration</code> doesn't contain a value for
1709
- * <code>KeyARN</code>.</p>
2083
+ * ARN of the customer managed CMK. If <code>KeyType</code> is <code>Amazon Web Services_OWNED_CMK</code>, <code>DeliveryStreamEncryptionConfiguration</code> doesn't contain
2084
+ * a value for <code>KeyARN</code>.</p>
1710
2085
  */
1711
2086
  KeyARN?: string;
1712
2087
  /**
1713
2088
  * <p>Indicates the type of customer master key (CMK) that is used for encryption. The default
1714
- * setting is <code>AWS_OWNED_CMK</code>. For more information about CMKs, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys">Customer
1715
- * Master Keys (CMKs)</a>.</p>
2089
+ * setting is <code>Amazon Web Services_OWNED_CMK</code>. For more information about CMKs, see
2090
+ * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys">Customer Master Keys (CMKs)</a>.</p>
1716
2091
  */
1717
2092
  KeyType?: KeyType | string;
1718
2093
  /**
@@ -1741,14 +2116,14 @@ export declare enum DeliveryStreamStatus {
1741
2116
  */
1742
2117
  export interface ElasticsearchDestinationDescription {
1743
2118
  /**
1744
- * <p>The Amazon Resource Name (ARN) of the AWS credentials. For more information, see
1745
- * <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
1746
- * Resource Names (ARNs) and AWS Service Namespaces</a>.</p>
2119
+ * <p>The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more
2120
+ * information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
2121
+ * Amazon Web Services Service Namespaces</a>.</p>
1747
2122
  */
1748
2123
  RoleARN?: string;
1749
2124
  /**
1750
2125
  * <p>The ARN of the Amazon ES domain. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
1751
- * Resource Names (ARNs) and AWS Service Namespaces</a>.</p>
2126
+ * Resource Names (ARNs) and Amazon Web Services Service Namespaces</a>.</p>
1752
2127
  *
1753
2128
  * <p>Kinesis Data Firehose uses either <code>ClusterEndpoint</code> or <code>DomainARN</code>
1754
2129
  * to send data to Amazon ES.</p>
@@ -1766,7 +2141,8 @@ export interface ElasticsearchDestinationDescription {
1766
2141
  IndexName?: string;
1767
2142
  /**
1768
2143
  * <p>The Elasticsearch type name. This applies to Elasticsearch 6.x and lower versions.
1769
- * For Elasticsearch 7.x, there's no value for <code>TypeName</code>.</p>
2144
+ * For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for
2145
+ * <code>TypeName</code>.</p>
1770
2146
  */
1771
2147
  TypeName?: string;
1772
2148
  /**
@@ -1807,14 +2183,14 @@ export interface ElasticsearchDestinationDescription {
1807
2183
  */
1808
2184
  export interface ExtendedS3DestinationDescription {
1809
2185
  /**
1810
- * <p>The Amazon Resource Name (ARN) of the AWS credentials. For more information, see
1811
- * <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
1812
- * Resource Names (ARNs) and AWS Service Namespaces</a>.</p>
2186
+ * <p>The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more
2187
+ * information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
2188
+ * Amazon Web Services Service Namespaces</a>.</p>
1813
2189
  */
1814
2190
  RoleARN: string | undefined;
1815
2191
  /**
1816
2192
  * <p>The ARN of the S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
1817
- * AWS Service Namespaces</a>.</p>
2193
+ * Amazon Web Services Service Namespaces</a>.</p>
1818
2194
  */
1819
2195
  BucketARN: string | undefined;
1820
2196
  /**
@@ -1868,7 +2244,7 @@ export interface ExtendedS3DestinationDescription {
1868
2244
  /**
1869
2245
  * <p>The configuration of the dynamic partitioning mechanism that creates smaller data sets
1870
2246
  * from the streaming data by partitioning it based on partition keys. Currently, dynamic
1871
- * partitioning is only supported for Amazon S3 destinations. For more information, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/dynamic-partitioning.html">https://docs.aws.amazon.com/firehose/latest/dev/dynamic-partitioning.html</a>
2247
+ * partitioning is only supported for Amazon S3 destinations.
1872
2248
  * </p>
1873
2249
  */
1874
2250
  DynamicPartitioningConfiguration?: DynamicPartitioningConfiguration;
@@ -1943,9 +2319,9 @@ export interface HttpEndpointDestinationDescription {
1943
2319
  */
1944
2320
  export interface RedshiftDestinationDescription {
1945
2321
  /**
1946
- * <p>The Amazon Resource Name (ARN) of the AWS credentials. For more information, see
1947
- * <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
1948
- * Resource Names (ARNs) and AWS Service Namespaces</a>.</p>
2322
+ * <p>The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more
2323
+ * information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
2324
+ * Amazon Web Services Service Namespaces</a>.</p>
1949
2325
  */
1950
2326
  RoleARN: string | undefined;
1951
2327
  /**
@@ -2061,6 +2437,9 @@ export interface DestinationDescription {
2061
2437
  * <p>The destination in Amazon ES.</p>
2062
2438
  */
2063
2439
  ElasticsearchDestinationDescription?: ElasticsearchDestinationDescription;
2440
+ /**
2441
+ * <p>The destination in Amazon OpenSearch Service.</p>
2442
+ */
2064
2443
  AmazonopensearchserviceDestinationDescription?: AmazonopensearchserviceDestinationDescription;
2065
2444
  /**
2066
2445
  * <p>The destination in Splunk.</p>
@@ -2070,6 +2449,10 @@ export interface DestinationDescription {
2070
2449
  * <p>Describes the specified HTTP endpoint destination.</p>
2071
2450
  */
2072
2451
  HttpEndpointDestinationDescription?: HttpEndpointDestinationDescription;
2452
+ /**
2453
+ * <p>The destination in the Serverless offering for Amazon OpenSearch Service.</p>
2454
+ */
2455
+ AmazonOpenSearchServerlessDestinationDescription?: AmazonOpenSearchServerlessDestinationDescription;
2073
2456
  }
2074
2457
  /**
2075
2458
  * <p>Details about a Kinesis data stream used as the source for a Kinesis Data Firehose
@@ -2084,8 +2467,8 @@ export interface KinesisStreamSourceDescription {
2084
2467
  KinesisStreamARN?: string;
2085
2468
  /**
2086
2469
  * <p>The ARN of the role used by the source Kinesis data stream. For more information, see
2087
- * <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">AWS Identity and
2088
- * Access Management (IAM) ARN Format</a>.</p>
2470
+ * <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">Amazon Web Services
2471
+ * Identity and Access Management (IAM) ARN Format</a>.</p>
2089
2472
  */
2090
2473
  RoleARN?: string;
2091
2474
  /**
@@ -2116,7 +2499,7 @@ export interface DeliveryStreamDescription {
2116
2499
  /**
2117
2500
  * <p>The Amazon Resource Name (ARN) of the delivery stream. For more information, see
2118
2501
  * <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
2119
- * Resource Names (ARNs) and AWS Service Namespaces</a>.</p>
2502
+ * Resource Names (ARNs) and Amazon Web Services Service Namespaces</a>.</p>
2120
2503
  */
2121
2504
  DeliveryStreamARN: string | undefined;
2122
2505
  /**
@@ -2212,15 +2595,15 @@ export interface ElasticsearchDestinationUpdate {
2212
2595
  * for calling the Amazon ES Configuration API and for indexing documents. For more
2213
2596
  * information, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3">Grant Kinesis Data
2214
2597
  * Firehose Access to an Amazon S3 Destination</a> and <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
2215
- * AWS Service Namespaces</a>.</p>
2598
+ * Amazon Web Services Service Namespaces</a>.</p>
2216
2599
  */
2217
2600
  RoleARN?: string;
2218
2601
  /**
2219
2602
  * <p>The ARN of the Amazon ES domain. The IAM role must have permissions
2220
- * for <code>DescribeElasticsearchDomain</code>, <code>DescribeElasticsearchDomains</code>,
2221
- * and <code>DescribeElasticsearchDomainConfig</code> after assuming the IAM role specified in
2603
+ * for <code>DescribeDomain</code>, <code>DescribeDomains</code>, and
2604
+ * <code>DescribeDomainConfig</code> after assuming the IAM role specified in
2222
2605
  * <code>RoleARN</code>. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
2223
- * AWS Service Namespaces</a>.</p>
2606
+ * Amazon Web Services Service Namespaces</a>.</p>
2224
2607
  *
2225
2608
  * <p>Specify either <code>ClusterEndpoint</code> or <code>DomainARN</code>.</p>
2226
2609
  */
@@ -2280,14 +2663,14 @@ export interface ElasticsearchDestinationUpdate {
2280
2663
  */
2281
2664
  export interface ExtendedS3DestinationUpdate {
2282
2665
  /**
2283
- * <p>The Amazon Resource Name (ARN) of the AWS credentials. For more information, see
2284
- * <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
2285
- * Resource Names (ARNs) and AWS Service Namespaces</a>.</p>
2666
+ * <p>The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more
2667
+ * information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
2668
+ * Amazon Web Services Service Namespaces</a>.</p>
2286
2669
  */
2287
2670
  RoleARN?: string;
2288
2671
  /**
2289
2672
  * <p>The ARN of the S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
2290
- * AWS Service Namespaces</a>.</p>
2673
+ * Amazon Web Services Service Namespaces</a>.</p>
2291
2674
  */
2292
2675
  BucketARN?: string;
2293
2676
  /**
@@ -2342,7 +2725,7 @@ export interface ExtendedS3DestinationUpdate {
2342
2725
  /**
2343
2726
  * <p>The configuration of the dynamic partitioning mechanism that creates smaller data sets
2344
2727
  * from the streaming data by partitioning it based on partition keys. Currently, dynamic
2345
- * partitioning is only supported for Amazon S3 destinations. For more information, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/dynamic-partitioning.html">https://docs.aws.amazon.com/firehose/latest/dev/dynamic-partitioning.html</a>
2728
+ * partitioning is only supported for Amazon S3 destinations.
2346
2729
  * </p>
2347
2730
  */
2348
2731
  DynamicPartitioningConfiguration?: DynamicPartitioningConfiguration;
@@ -2618,9 +3001,9 @@ export interface HttpEndpointDestinationUpdate {
2618
3001
  */
2619
3002
  export interface RedshiftDestinationUpdate {
2620
3003
  /**
2621
- * <p>The Amazon Resource Name (ARN) of the AWS credentials. For more information, see
2622
- * <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
2623
- * Resource Names (ARNs) and AWS Service Namespaces</a>.</p>
3004
+ * <p>The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more
3005
+ * information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
3006
+ * Amazon Web Services Service Namespaces</a>.</p>
2624
3007
  */
2625
3008
  RoleARN?: string;
2626
3009
  /**
@@ -2759,6 +3142,9 @@ export interface UpdateDestinationInput {
2759
3142
  * <p>Describes an update for a destination in Amazon ES.</p>
2760
3143
  */
2761
3144
  ElasticsearchDestinationUpdate?: ElasticsearchDestinationUpdate;
3145
+ /**
3146
+ * <p>Describes an update for a destination in Amazon OpenSearch Service.</p>
3147
+ */
2762
3148
  AmazonopensearchserviceDestinationUpdate?: AmazonopensearchserviceDestinationUpdate;
2763
3149
  /**
2764
3150
  * <p>Describes an update for a destination in Splunk.</p>
@@ -2768,13 +3154,18 @@ export interface UpdateDestinationInput {
2768
3154
  * <p>Describes an update to the specified HTTP endpoint destination.</p>
2769
3155
  */
2770
3156
  HttpEndpointDestinationUpdate?: HttpEndpointDestinationUpdate;
3157
+ /**
3158
+ * <p>Describes an update for a destination in the Serverless offering for Amazon OpenSearch
3159
+ * Service.</p>
3160
+ */
3161
+ AmazonOpenSearchServerlessDestinationUpdate?: AmazonOpenSearchServerlessDestinationUpdate;
2771
3162
  }
2772
3163
  export interface UpdateDestinationOutput {
2773
3164
  }
2774
3165
  /**
2775
3166
  * @internal
2776
3167
  */
2777
- export declare const AmazonopensearchserviceBufferingHintsFilterSensitiveLog: (obj: AmazonopensearchserviceBufferingHints) => any;
3168
+ export declare const AmazonOpenSearchServerlessBufferingHintsFilterSensitiveLog: (obj: AmazonOpenSearchServerlessBufferingHints) => any;
2778
3169
  /**
2779
3170
  * @internal
2780
3171
  */
@@ -2794,7 +3185,7 @@ export declare const ProcessingConfigurationFilterSensitiveLog: (obj: Processing
2794
3185
  /**
2795
3186
  * @internal
2796
3187
  */
2797
- export declare const AmazonopensearchserviceRetryOptionsFilterSensitiveLog: (obj: AmazonopensearchserviceRetryOptions) => any;
3188
+ export declare const AmazonOpenSearchServerlessRetryOptionsFilterSensitiveLog: (obj: AmazonOpenSearchServerlessRetryOptions) => any;
2798
3189
  /**
2799
3190
  * @internal
2800
3191
  */
@@ -2818,7 +3209,7 @@ export declare const VpcConfigurationFilterSensitiveLog: (obj: VpcConfiguration)
2818
3209
  /**
2819
3210
  * @internal
2820
3211
  */
2821
- export declare const AmazonopensearchserviceDestinationConfigurationFilterSensitiveLog: (obj: AmazonopensearchserviceDestinationConfiguration) => any;
3212
+ export declare const AmazonOpenSearchServerlessDestinationConfigurationFilterSensitiveLog: (obj: AmazonOpenSearchServerlessDestinationConfiguration) => any;
2822
3213
  /**
2823
3214
  * @internal
2824
3215
  */
@@ -2830,11 +3221,31 @@ export declare const VpcConfigurationDescriptionFilterSensitiveLog: (obj: VpcCon
2830
3221
  /**
2831
3222
  * @internal
2832
3223
  */
2833
- export declare const AmazonopensearchserviceDestinationDescriptionFilterSensitiveLog: (obj: AmazonopensearchserviceDestinationDescription) => any;
3224
+ export declare const AmazonOpenSearchServerlessDestinationDescriptionFilterSensitiveLog: (obj: AmazonOpenSearchServerlessDestinationDescription) => any;
2834
3225
  /**
2835
3226
  * @internal
2836
3227
  */
2837
3228
  export declare const S3DestinationUpdateFilterSensitiveLog: (obj: S3DestinationUpdate) => any;
3229
+ /**
3230
+ * @internal
3231
+ */
3232
+ export declare const AmazonOpenSearchServerlessDestinationUpdateFilterSensitiveLog: (obj: AmazonOpenSearchServerlessDestinationUpdate) => any;
3233
+ /**
3234
+ * @internal
3235
+ */
3236
+ export declare const AmazonopensearchserviceBufferingHintsFilterSensitiveLog: (obj: AmazonopensearchserviceBufferingHints) => any;
3237
+ /**
3238
+ * @internal
3239
+ */
3240
+ export declare const AmazonopensearchserviceRetryOptionsFilterSensitiveLog: (obj: AmazonopensearchserviceRetryOptions) => any;
3241
+ /**
3242
+ * @internal
3243
+ */
3244
+ export declare const AmazonopensearchserviceDestinationConfigurationFilterSensitiveLog: (obj: AmazonopensearchserviceDestinationConfiguration) => any;
3245
+ /**
3246
+ * @internal
3247
+ */
3248
+ export declare const AmazonopensearchserviceDestinationDescriptionFilterSensitiveLog: (obj: AmazonopensearchserviceDestinationDescription) => any;
2838
3249
  /**
2839
3250
  * @internal
2840
3251
  */