@aws-sdk/client-firehose 3.295.0 → 3.297.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,7 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { FirehoseServiceException as __BaseException } from "./FirehoseServiceException";
3
3
  /**
4
+ * @public
4
5
  * <p>Describes the buffering to perform before delivering data to the Serverless offering for
5
6
  * Amazon OpenSearch Service destination.</p>
6
7
  */
@@ -20,6 +21,7 @@ export interface AmazonOpenSearchServerlessBufferingHints {
20
21
  SizeInMBs?: number;
21
22
  }
22
23
  /**
24
+ * @public
23
25
  * <p>Describes the Amazon CloudWatch logging options for your delivery stream.</p>
24
26
  */
25
27
  export interface CloudWatchLoggingOptions {
@@ -38,6 +40,9 @@ export interface CloudWatchLoggingOptions {
38
40
  */
39
41
  LogStreamName?: string;
40
42
  }
43
+ /**
44
+ * @public
45
+ */
41
46
  export declare enum ProcessorParameterName {
42
47
  BUFFER_INTERVAL_IN_SECONDS = "BufferIntervalInSeconds",
43
48
  BUFFER_SIZE_IN_MB = "BufferSizeInMBs",
@@ -50,6 +55,7 @@ export declare enum ProcessorParameterName {
50
55
  SUB_RECORD_TYPE = "SubRecordType"
51
56
  }
52
57
  /**
58
+ * @public
53
59
  * <p>Describes the processor parameter. </p>
54
60
  */
55
61
  export interface ProcessorParameter {
@@ -66,6 +72,9 @@ export interface ProcessorParameter {
66
72
  */
67
73
  ParameterValue: string | undefined;
68
74
  }
75
+ /**
76
+ * @public
77
+ */
69
78
  export declare enum ProcessorType {
70
79
  AppendDelimiterToRecord = "AppendDelimiterToRecord",
71
80
  Lambda = "Lambda",
@@ -73,6 +82,7 @@ export declare enum ProcessorType {
73
82
  RecordDeAggregation = "RecordDeAggregation"
74
83
  }
75
84
  /**
85
+ * @public
76
86
  * <p>Describes a data processor.</p>
77
87
  */
78
88
  export interface Processor {
@@ -86,6 +96,7 @@ export interface Processor {
86
96
  Parameters?: ProcessorParameter[];
87
97
  }
88
98
  /**
99
+ * @public
89
100
  * <p>Describes a data processing configuration.</p>
90
101
  */
91
102
  export interface ProcessingConfiguration {
@@ -99,6 +110,7 @@ export interface ProcessingConfiguration {
99
110
  Processors?: Processor[];
100
111
  }
101
112
  /**
113
+ * @public
102
114
  * <p>Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents
103
115
  * to the Serverless offering for Amazon OpenSearch Service.</p>
104
116
  */
@@ -112,11 +124,15 @@ export interface AmazonOpenSearchServerlessRetryOptions {
112
124
  */
113
125
  DurationInSeconds?: number;
114
126
  }
127
+ /**
128
+ * @public
129
+ */
115
130
  export declare enum AmazonOpenSearchServerlessS3BackupMode {
116
131
  AllDocuments = "AllDocuments",
117
132
  FailedDocumentsOnly = "FailedDocumentsOnly"
118
133
  }
119
134
  /**
135
+ * @public
120
136
  * <p>Describes hints for the buffering to perform before delivering data to the
121
137
  * destination. These options are treated as hints, and therefore Kinesis Data Firehose might
122
138
  * choose to use different values when it is optimal. The <code>SizeInMBs</code> and
@@ -142,6 +158,9 @@ export interface BufferingHints {
142
158
  */
143
159
  IntervalInSeconds?: number;
144
160
  }
161
+ /**
162
+ * @public
163
+ */
145
164
  export declare enum CompressionFormat {
146
165
  GZIP = "GZIP",
147
166
  HADOOP_SNAPPY = "HADOOP_SNAPPY",
@@ -150,6 +169,7 @@ export declare enum CompressionFormat {
150
169
  ZIP = "ZIP"
151
170
  }
152
171
  /**
172
+ * @public
153
173
  * <p>Describes an encryption key for a destination in Amazon S3.</p>
154
174
  */
155
175
  export interface KMSEncryptionConfig {
@@ -159,10 +179,14 @@ export interface KMSEncryptionConfig {
159
179
  */
160
180
  AWSKMSKeyARN: string | undefined;
161
181
  }
182
+ /**
183
+ * @public
184
+ */
162
185
  export declare enum NoEncryptionConfig {
163
186
  NoEncryption = "NoEncryption"
164
187
  }
165
188
  /**
189
+ * @public
166
190
  * <p>Describes the encryption for a destination in Amazon S3.</p>
167
191
  */
168
192
  export interface EncryptionConfiguration {
@@ -177,6 +201,7 @@ export interface EncryptionConfiguration {
177
201
  KMSEncryptionConfig?: KMSEncryptionConfig;
178
202
  }
179
203
  /**
204
+ * @public
180
205
  * <p>Describes the configuration of a destination in Amazon S3.</p>
181
206
  */
182
207
  export interface S3DestinationConfiguration {
@@ -228,6 +253,7 @@ export interface S3DestinationConfiguration {
228
253
  CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
229
254
  }
230
255
  /**
256
+ * @public
231
257
  * <p>The details of the VPC of the Amazon ES destination.</p>
232
258
  */
233
259
  export interface VpcConfiguration {
@@ -313,6 +339,7 @@ export interface VpcConfiguration {
313
339
  SecurityGroupIds: string[] | undefined;
314
340
  }
315
341
  /**
342
+ * @public
316
343
  * <p>Describes the configuration of a destination in the Serverless offering for Amazon
317
344
  * OpenSearch Service.</p>
318
345
  */
@@ -370,6 +397,7 @@ export interface AmazonOpenSearchServerlessDestinationConfiguration {
370
397
  VpcConfiguration?: VpcConfiguration;
371
398
  }
372
399
  /**
400
+ * @public
373
401
  * <p>Describes a destination in Amazon S3.</p>
374
402
  */
375
403
  export interface S3DestinationDescription {
@@ -418,6 +446,7 @@ export interface S3DestinationDescription {
418
446
  CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
419
447
  }
420
448
  /**
449
+ * @public
421
450
  * <p>The details of the VPC of the Amazon ES destination.</p>
422
451
  */
423
452
  export interface VpcConfigurationDescription {
@@ -506,6 +535,7 @@ export interface VpcConfigurationDescription {
506
535
  VpcId: string | undefined;
507
536
  }
508
537
  /**
538
+ * @public
509
539
  * <p>The destination description in the Serverless offering for Amazon OpenSearch
510
540
  * Service.</p>
511
541
  */
@@ -553,6 +583,7 @@ export interface AmazonOpenSearchServerlessDestinationDescription {
553
583
  VpcConfigurationDescription?: VpcConfigurationDescription;
554
584
  }
555
585
  /**
586
+ * @public
556
587
  * <p>Describes an update for a destination in Amazon S3.</p>
557
588
  */
558
589
  export interface S3DestinationUpdate {
@@ -604,6 +635,7 @@ export interface S3DestinationUpdate {
604
635
  CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
605
636
  }
606
637
  /**
638
+ * @public
607
639
  * <p>Describes an update for a destination in the Serverless offering for Amazon OpenSearch
608
640
  * Service.</p>
609
641
  */
@@ -648,6 +680,7 @@ export interface AmazonOpenSearchServerlessDestinationUpdate {
648
680
  CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
649
681
  }
650
682
  /**
683
+ * @public
651
684
  * <p>Describes the buffering to perform before delivering data to the Amazon OpenSearch
652
685
  * Service destination. </p>
653
686
  */
@@ -666,6 +699,9 @@ export interface AmazonopensearchserviceBufferingHints {
666
699
  */
667
700
  SizeInMBs?: number;
668
701
  }
702
+ /**
703
+ * @public
704
+ */
669
705
  export declare enum AmazonopensearchserviceIndexRotationPeriod {
670
706
  NoRotation = "NoRotation",
671
707
  OneDay = "OneDay",
@@ -674,6 +710,7 @@ export declare enum AmazonopensearchserviceIndexRotationPeriod {
674
710
  OneWeek = "OneWeek"
675
711
  }
676
712
  /**
713
+ * @public
677
714
  * <p>Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents
678
715
  * to Amazon OpenSearch Service. </p>
679
716
  */
@@ -686,11 +723,15 @@ export interface AmazonopensearchserviceRetryOptions {
686
723
  */
687
724
  DurationInSeconds?: number;
688
725
  }
726
+ /**
727
+ * @public
728
+ */
689
729
  export declare enum AmazonopensearchserviceS3BackupMode {
690
730
  AllDocuments = "AllDocuments",
691
731
  FailedDocumentsOnly = "FailedDocumentsOnly"
692
732
  }
693
733
  /**
734
+ * @public
694
735
  * <p>Describes the configuration of a destination in Amazon OpenSearch Service</p>
695
736
  */
696
737
  export interface AmazonopensearchserviceDestinationConfiguration {
@@ -763,6 +804,7 @@ export interface AmazonopensearchserviceDestinationConfiguration {
763
804
  VpcConfiguration?: VpcConfiguration;
764
805
  }
765
806
  /**
807
+ * @public
766
808
  * <p>The destination description in Amazon OpenSearch Service.</p>
767
809
  */
768
810
  export interface AmazonopensearchserviceDestinationDescription {
@@ -823,6 +865,7 @@ export interface AmazonopensearchserviceDestinationDescription {
823
865
  VpcConfigurationDescription?: VpcConfigurationDescription;
824
866
  }
825
867
  /**
868
+ * @public
826
869
  * <p>Describes an update for a destination in Amazon OpenSearch Service.</p>
827
870
  */
828
871
  export interface AmazonopensearchserviceDestinationUpdate {
@@ -886,6 +929,7 @@ export interface AmazonopensearchserviceDestinationUpdate {
886
929
  CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
887
930
  }
888
931
  /**
932
+ * @public
889
933
  * <p>Another modification has already happened. Fetch <code>VersionId</code> again and use
890
934
  * it to update the destination.</p>
891
935
  */
@@ -897,11 +941,15 @@ export declare class ConcurrentModificationException extends __BaseException {
897
941
  */
898
942
  constructor(opts: __ExceptionOptionType<ConcurrentModificationException, __BaseException>);
899
943
  }
944
+ /**
945
+ * @public
946
+ */
900
947
  export declare enum ContentEncoding {
901
948
  GZIP = "GZIP",
902
949
  NONE = "NONE"
903
950
  }
904
951
  /**
952
+ * @public
905
953
  * <p>Describes a <code>COPY</code> command for Amazon Redshift.</p>
906
954
  */
907
955
  export interface CopyCommand {
@@ -937,11 +985,15 @@ export interface CopyCommand {
937
985
  */
938
986
  CopyOptions?: string;
939
987
  }
988
+ /**
989
+ * @public
990
+ */
940
991
  export declare enum KeyType {
941
992
  AWS_OWNED_CMK = "AWS_OWNED_CMK",
942
993
  CUSTOMER_MANAGED_CMK = "CUSTOMER_MANAGED_CMK"
943
994
  }
944
995
  /**
996
+ * @public
945
997
  * <p>Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side
946
998
  * Encryption (SSE). </p>
947
999
  */
@@ -975,11 +1027,15 @@ export interface DeliveryStreamEncryptionConfigurationInput {
975
1027
  */
976
1028
  KeyType: KeyType | string | undefined;
977
1029
  }
1030
+ /**
1031
+ * @public
1032
+ */
978
1033
  export declare enum DeliveryStreamType {
979
1034
  DirectPut = "DirectPut",
980
1035
  KinesisStreamAsSource = "KinesisStreamAsSource"
981
1036
  }
982
1037
  /**
1038
+ * @public
983
1039
  * <p>Describes the buffering to perform before delivering data to the Amazon ES
984
1040
  * destination.</p>
985
1041
  */
@@ -998,6 +1054,9 @@ export interface ElasticsearchBufferingHints {
998
1054
  */
999
1055
  SizeInMBs?: number;
1000
1056
  }
1057
+ /**
1058
+ * @public
1059
+ */
1001
1060
  export declare enum ElasticsearchIndexRotationPeriod {
1002
1061
  NoRotation = "NoRotation",
1003
1062
  OneDay = "OneDay",
@@ -1006,6 +1065,7 @@ export declare enum ElasticsearchIndexRotationPeriod {
1006
1065
  OneWeek = "OneWeek"
1007
1066
  }
1008
1067
  /**
1068
+ * @public
1009
1069
  * <p>Configures retry behavior in case Kinesis Data Firehose is unable to deliver
1010
1070
  * documents to Amazon ES.</p>
1011
1071
  */
@@ -1018,11 +1078,15 @@ export interface ElasticsearchRetryOptions {
1018
1078
  */
1019
1079
  DurationInSeconds?: number;
1020
1080
  }
1081
+ /**
1082
+ * @public
1083
+ */
1021
1084
  export declare enum ElasticsearchS3BackupMode {
1022
1085
  AllDocuments = "AllDocuments",
1023
1086
  FailedDocumentsOnly = "FailedDocumentsOnly"
1024
1087
  }
1025
1088
  /**
1089
+ * @public
1026
1090
  * <p>Describes the configuration of a destination in Amazon ES.</p>
1027
1091
  */
1028
1092
  export interface ElasticsearchDestinationConfiguration {
@@ -1108,6 +1172,7 @@ export interface ElasticsearchDestinationConfiguration {
1108
1172
  VpcConfiguration?: VpcConfiguration;
1109
1173
  }
1110
1174
  /**
1175
+ * @public
1111
1176
  * <p>The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for deserializing
1112
1177
  * data, which means converting it from the JSON format in preparation for serializing it to
1113
1178
  * the Parquet or ORC format. This is one of two deserializers you can choose, depending on
@@ -1124,6 +1189,7 @@ export interface HiveJsonSerDe {
1124
1189
  TimestampFormats?: string[];
1125
1190
  }
1126
1191
  /**
1192
+ * @public
1127
1193
  * <p>The OpenX SerDe. Used by Kinesis Data Firehose for deserializing data, which means
1128
1194
  * converting it from the JSON format in preparation for serializing it to the Parquet or ORC
1129
1195
  * format. This is one of two deserializers you can choose, depending on which one offers the
@@ -1148,12 +1214,13 @@ export interface OpenXJsonSerDe {
1148
1214
  * <p>Maps column names to JSON keys that aren't identical to the column names. This is
1149
1215
  * useful when the JSON contains keys that are Hive keywords. For example,
1150
1216
  * <code>timestamp</code> is a Hive keyword. If you have a JSON key named
1151
- * <code>timestamp</code>, set this parameter to <code>{"ts": "timestamp"}</code> to map
1217
+ * <code>timestamp</code>, set this parameter to <code>\{"ts": "timestamp"\}</code> to map
1152
1218
  * this key to a column named <code>ts</code>.</p>
1153
1219
  */
1154
1220
  ColumnToJsonKeyMappings?: Record<string, string>;
1155
1221
  }
1156
1222
  /**
1223
+ * @public
1157
1224
  * <p>The deserializer you want Kinesis Data Firehose to use for converting the input data
1158
1225
  * from JSON. Kinesis Data Firehose then serializes the data to its final format using the
1159
1226
  * <a>Serializer</a>. Kinesis Data Firehose supports two types of deserializers:
@@ -1176,6 +1243,7 @@ export interface Deserializer {
1176
1243
  HiveJsonSerDe?: HiveJsonSerDe;
1177
1244
  }
1178
1245
  /**
1246
+ * @public
1179
1247
  * <p>Specifies the deserializer you want to use to convert the format of the input data.
1180
1248
  * This parameter is required if <code>Enabled</code> is set to true.</p>
1181
1249
  */
@@ -1186,16 +1254,23 @@ export interface InputFormatConfiguration {
1186
1254
  */
1187
1255
  Deserializer?: Deserializer;
1188
1256
  }
1257
+ /**
1258
+ * @public
1259
+ */
1189
1260
  export declare enum OrcCompression {
1190
1261
  NONE = "NONE",
1191
1262
  SNAPPY = "SNAPPY",
1192
1263
  ZLIB = "ZLIB"
1193
1264
  }
1265
+ /**
1266
+ * @public
1267
+ */
1194
1268
  export declare enum OrcFormatVersion {
1195
1269
  V0_11 = "V0_11",
1196
1270
  V0_12 = "V0_12"
1197
1271
  }
1198
1272
  /**
1273
+ * @public
1199
1274
  * <p>A serializer to use for converting data to the ORC format before storing it in Amazon
1200
1275
  * S3. For more information, see <a href="https://orc.apache.org/docs/">Apache
1201
1276
  * ORC</a>.</p>
@@ -1261,16 +1336,23 @@ export interface OrcSerDe {
1261
1336
  */
1262
1337
  FormatVersion?: OrcFormatVersion | string;
1263
1338
  }
1339
+ /**
1340
+ * @public
1341
+ */
1264
1342
  export declare enum ParquetCompression {
1265
1343
  GZIP = "GZIP",
1266
1344
  SNAPPY = "SNAPPY",
1267
1345
  UNCOMPRESSED = "UNCOMPRESSED"
1268
1346
  }
1347
+ /**
1348
+ * @public
1349
+ */
1269
1350
  export declare enum ParquetWriterVersion {
1270
1351
  V1 = "V1",
1271
1352
  V2 = "V2"
1272
1353
  }
1273
1354
  /**
1355
+ * @public
1274
1356
  * <p>A serializer to use for converting data to the Parquet format before storing it in
1275
1357
  * Amazon S3. For more information, see <a href="https://parquet.apache.org/documentation/latest/">Apache Parquet</a>.</p>
1276
1358
  */
@@ -1310,6 +1392,7 @@ export interface ParquetSerDe {
1310
1392
  WriterVersion?: ParquetWriterVersion | string;
1311
1393
  }
1312
1394
  /**
1395
+ * @public
1313
1396
  * <p>The serializer that you want Kinesis Data Firehose to use to convert data to the target
1314
1397
  * format before writing it to Amazon S3. Kinesis Data Firehose supports two types of
1315
1398
  * serializers: the <a href="https://hive.apache.org/javadocs/r1.2.2/api/org/apache/hadoop/hive/ql/io/orc/OrcSerde.html">ORC SerDe</a> and the <a href="https://hive.apache.org/javadocs/r1.2.2/api/org/apache/hadoop/hive/ql/io/parquet/serde/ParquetHiveSerDe.html">Parquet SerDe</a>.</p>
@@ -1328,6 +1411,7 @@ export interface Serializer {
1328
1411
  OrcSerDe?: OrcSerDe;
1329
1412
  }
1330
1413
  /**
1414
+ * @public
1331
1415
  * <p>Specifies the serializer that you want Kinesis Data Firehose to use to convert the
1332
1416
  * format of your data before it writes it to Amazon S3. This parameter is required if
1333
1417
  * <code>Enabled</code> is set to true.</p>
@@ -1340,6 +1424,7 @@ export interface OutputFormatConfiguration {
1340
1424
  Serializer?: Serializer;
1341
1425
  }
1342
1426
  /**
1427
+ * @public
1343
1428
  * <p>Specifies the schema to which you want Kinesis Data Firehose to configure your data
1344
1429
  * before it writes it to Amazon S3. This parameter is required if <code>Enabled</code> is set
1345
1430
  * to true.</p>
@@ -1395,6 +1480,7 @@ export interface SchemaConfiguration {
1395
1480
  VersionId?: string;
1396
1481
  }
1397
1482
  /**
1483
+ * @public
1398
1484
  * <p>Specifies that you want Kinesis Data Firehose to convert data from the JSON format to
1399
1485
  * the Parquet or ORC format before writing it to Amazon S3. Kinesis Data Firehose uses the
1400
1486
  * serializer and deserializer that you specify, in addition to the column information from
@@ -1427,6 +1513,7 @@ export interface DataFormatConversionConfiguration {
1427
1513
  Enabled?: boolean;
1428
1514
  }
1429
1515
  /**
1516
+ * @public
1430
1517
  * <p> The retry behavior in case Kinesis Data Firehose is unable to deliver data to an Amazon
1431
1518
  * S3 prefix.</p>
1432
1519
  */
@@ -1438,6 +1525,7 @@ export interface RetryOptions {
1438
1525
  DurationInSeconds?: number;
1439
1526
  }
1440
1527
  /**
1528
+ * @public
1441
1529
  * <p>The configuration of the dynamic partitioning mechanism that creates smaller data sets
1442
1530
  * from the streaming data by partitioning it based on partition keys. Currently, dynamic
1443
1531
  * partitioning is only supported for Amazon S3 destinations.
@@ -1455,11 +1543,15 @@ export interface DynamicPartitioningConfiguration {
1455
1543
  */
1456
1544
  Enabled?: boolean;
1457
1545
  }
1546
+ /**
1547
+ * @public
1548
+ */
1458
1549
  export declare enum S3BackupMode {
1459
1550
  Disabled = "Disabled",
1460
1551
  Enabled = "Enabled"
1461
1552
  }
1462
1553
  /**
1554
+ * @public
1463
1555
  * <p>Describes the configuration of a destination in Amazon S3.</p>
1464
1556
  */
1465
1557
  export interface ExtendedS3DestinationConfiguration {
@@ -1533,6 +1625,7 @@ export interface ExtendedS3DestinationConfiguration {
1533
1625
  DynamicPartitioningConfiguration?: DynamicPartitioningConfiguration;
1534
1626
  }
1535
1627
  /**
1628
+ * @public
1536
1629
  * <p>Describes the buffering options that can be applied before data is delivered to the HTTP
1537
1630
  * endpoint destination. Kinesis Data Firehose treats these options as hints, and it might
1538
1631
  * choose to use more optimal values. The <code>SizeInMBs</code> and
@@ -1555,6 +1648,7 @@ export interface HttpEndpointBufferingHints {
1555
1648
  IntervalInSeconds?: number;
1556
1649
  }
1557
1650
  /**
1651
+ * @public
1558
1652
  * <p>Describes the configuration of the HTTP endpoint to which Kinesis Firehose delivers
1559
1653
  * data.</p>
1560
1654
  */
@@ -1579,6 +1673,7 @@ export interface HttpEndpointConfiguration {
1579
1673
  AccessKey?: string;
1580
1674
  }
1581
1675
  /**
1676
+ * @public
1582
1677
  * <p>Describes the metadata that's delivered to the specified HTTP endpoint
1583
1678
  * destination.</p>
1584
1679
  */
@@ -1593,6 +1688,7 @@ export interface HttpEndpointCommonAttribute {
1593
1688
  AttributeValue: string | undefined;
1594
1689
  }
1595
1690
  /**
1691
+ * @public
1596
1692
  * <p>The configuration of the HTTP endpoint request.</p>
1597
1693
  */
1598
1694
  export interface HttpEndpointRequestConfiguration {
@@ -1607,6 +1703,7 @@ export interface HttpEndpointRequestConfiguration {
1607
1703
  CommonAttributes?: HttpEndpointCommonAttribute[];
1608
1704
  }
1609
1705
  /**
1706
+ * @public
1610
1707
  * <p>Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to
1611
1708
  * the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of
1612
1709
  * receipt from the specified HTTP endpoint destination.</p>
@@ -1620,11 +1717,15 @@ export interface HttpEndpointRetryOptions {
1620
1717
  */
1621
1718
  DurationInSeconds?: number;
1622
1719
  }
1720
+ /**
1721
+ * @public
1722
+ */
1623
1723
  export declare enum HttpEndpointS3BackupMode {
1624
1724
  AllData = "AllData",
1625
1725
  FailedDataOnly = "FailedDataOnly"
1626
1726
  }
1627
1727
  /**
1728
+ * @public
1628
1729
  * <p>Describes the configuration of the HTTP endpoint destination.</p>
1629
1730
  */
1630
1731
  export interface HttpEndpointDestinationConfiguration {
@@ -1677,6 +1778,7 @@ export interface HttpEndpointDestinationConfiguration {
1677
1778
  S3Configuration: S3DestinationConfiguration | undefined;
1678
1779
  }
1679
1780
  /**
1781
+ * @public
1680
1782
  * <p>The stream and role Amazon Resource Names (ARNs) for a Kinesis data stream used as
1681
1783
  * the source for a delivery stream.</p>
1682
1784
  */
@@ -1694,6 +1796,7 @@ export interface KinesisStreamSourceConfiguration {
1694
1796
  RoleARN: string | undefined;
1695
1797
  }
1696
1798
  /**
1799
+ * @public
1697
1800
  * <p>Configures retry behavior in case Kinesis Data Firehose is unable to deliver
1698
1801
  * documents to Amazon Redshift.</p>
1699
1802
  */
@@ -1707,11 +1810,15 @@ export interface RedshiftRetryOptions {
1707
1810
  */
1708
1811
  DurationInSeconds?: number;
1709
1812
  }
1813
+ /**
1814
+ * @public
1815
+ */
1710
1816
  export declare enum RedshiftS3BackupMode {
1711
1817
  Disabled = "Disabled",
1712
1818
  Enabled = "Enabled"
1713
1819
  }
1714
1820
  /**
1821
+ * @public
1715
1822
  * <p>Describes the configuration of a destination in Amazon Redshift.</p>
1716
1823
  */
1717
1824
  export interface RedshiftDestinationConfiguration {
@@ -1770,11 +1877,15 @@ export interface RedshiftDestinationConfiguration {
1770
1877
  */
1771
1878
  CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
1772
1879
  }
1880
+ /**
1881
+ * @public
1882
+ */
1773
1883
  export declare enum HECEndpointType {
1774
1884
  Event = "Event",
1775
1885
  Raw = "Raw"
1776
1886
  }
1777
1887
  /**
1888
+ * @public
1778
1889
  * <p>Configures retry behavior in case Kinesis Data Firehose is unable to deliver
1779
1890
  * documents to Splunk, or if it doesn't receive an acknowledgment from Splunk.</p>
1780
1891
  */
@@ -1787,11 +1898,15 @@ export interface SplunkRetryOptions {
1787
1898
  */
1788
1899
  DurationInSeconds?: number;
1789
1900
  }
1901
+ /**
1902
+ * @public
1903
+ */
1790
1904
  export declare enum SplunkS3BackupMode {
1791
1905
  AllEvents = "AllEvents",
1792
1906
  FailedEventsOnly = "FailedEventsOnly"
1793
1907
  }
1794
1908
  /**
1909
+ * @public
1795
1910
  * <p>Describes the configuration of a destination in Splunk.</p>
1796
1911
  */
1797
1912
  export interface SplunkDestinationConfiguration {
@@ -1846,6 +1961,7 @@ export interface SplunkDestinationConfiguration {
1846
1961
  CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
1847
1962
  }
1848
1963
  /**
1964
+ * @public
1849
1965
  * <p>Metadata that you can assign to a delivery stream, consisting of a key-value
1850
1966
  * pair.</p>
1851
1967
  */
@@ -1862,6 +1978,9 @@ export interface Tag {
1862
1978
  */
1863
1979
  Value?: string;
1864
1980
  }
1981
+ /**
1982
+ * @public
1983
+ */
1865
1984
  export interface CreateDeliveryStreamInput {
1866
1985
  /**
1867
1986
  * <p>The name of the delivery stream. This name must be unique per Amazon Web Services
@@ -1947,6 +2066,9 @@ export interface CreateDeliveryStreamInput {
1947
2066
  */
1948
2067
  AmazonOpenSearchServerlessDestinationConfiguration?: AmazonOpenSearchServerlessDestinationConfiguration;
1949
2068
  }
2069
+ /**
2070
+ * @public
2071
+ */
1950
2072
  export interface CreateDeliveryStreamOutput {
1951
2073
  /**
1952
2074
  * <p>The ARN of the delivery stream.</p>
@@ -1954,6 +2076,7 @@ export interface CreateDeliveryStreamOutput {
1954
2076
  DeliveryStreamARN?: string;
1955
2077
  }
1956
2078
  /**
2079
+ * @public
1957
2080
  * <p>The specified input parameter has a value that is not valid.</p>
1958
2081
  */
1959
2082
  export declare class InvalidArgumentException extends __BaseException {
@@ -1965,6 +2088,7 @@ export declare class InvalidArgumentException extends __BaseException {
1965
2088
  constructor(opts: __ExceptionOptionType<InvalidArgumentException, __BaseException>);
1966
2089
  }
1967
2090
  /**
2091
+ * @public
1968
2092
  * <p>Kinesis Data Firehose throws this exception when an attempt to put records or to start
1969
2093
  * or stop delivery stream encryption fails. This happens when the KMS service throws one of
1970
2094
  * the following exception types: <code>AccessDeniedException</code>,
@@ -1981,6 +2105,7 @@ export declare class InvalidKMSResourceException extends __BaseException {
1981
2105
  constructor(opts: __ExceptionOptionType<InvalidKMSResourceException, __BaseException>);
1982
2106
  }
1983
2107
  /**
2108
+ * @public
1984
2109
  * <p>You have already reached the limit for a requested resource.</p>
1985
2110
  */
1986
2111
  export declare class LimitExceededException extends __BaseException {
@@ -1992,6 +2117,7 @@ export declare class LimitExceededException extends __BaseException {
1992
2117
  constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
1993
2118
  }
1994
2119
  /**
2120
+ * @public
1995
2121
  * <p>The resource is already in use and not available for this operation.</p>
1996
2122
  */
1997
2123
  export declare class ResourceInUseException extends __BaseException {
@@ -2002,6 +2128,9 @@ export declare class ResourceInUseException extends __BaseException {
2002
2128
  */
2003
2129
  constructor(opts: __ExceptionOptionType<ResourceInUseException, __BaseException>);
2004
2130
  }
2131
+ /**
2132
+ * @public
2133
+ */
2005
2134
  export interface DeleteDeliveryStreamInput {
2006
2135
  /**
2007
2136
  * <p>The name of the delivery stream.</p>
@@ -2019,9 +2148,13 @@ export interface DeleteDeliveryStreamInput {
2019
2148
  */
2020
2149
  AllowForceDelete?: boolean;
2021
2150
  }
2151
+ /**
2152
+ * @public
2153
+ */
2022
2154
  export interface DeleteDeliveryStreamOutput {
2023
2155
  }
2024
2156
  /**
2157
+ * @public
2025
2158
  * <p>The specified resource could not be found.</p>
2026
2159
  */
2027
2160
  export declare class ResourceNotFoundException extends __BaseException {
@@ -2032,6 +2165,9 @@ export declare class ResourceNotFoundException extends __BaseException {
2032
2165
  */
2033
2166
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
2034
2167
  }
2168
+ /**
2169
+ * @public
2170
+ */
2035
2171
  export declare enum DeliveryStreamFailureType {
2036
2172
  CREATE_ENI_FAILED = "CREATE_ENI_FAILED",
2037
2173
  CREATE_KMS_GRANT_FAILED = "CREATE_KMS_GRANT_FAILED",
@@ -2050,6 +2186,7 @@ export declare enum DeliveryStreamFailureType {
2050
2186
  UNKNOWN_ERROR = "UNKNOWN_ERROR"
2051
2187
  }
2052
2188
  /**
2189
+ * @public
2053
2190
  * <p>Provides details in case one of the following operations fails due to an error related
2054
2191
  * to KMS: <a>CreateDeliveryStream</a>, <a>DeleteDeliveryStream</a>,
2055
2192
  * <a>StartDeliveryStreamEncryption</a>, <a>StopDeliveryStreamEncryption</a>.</p>
@@ -2064,6 +2201,9 @@ export interface FailureDescription {
2064
2201
  */
2065
2202
  Details: string | undefined;
2066
2203
  }
2204
+ /**
2205
+ * @public
2206
+ */
2067
2207
  export declare enum DeliveryStreamEncryptionStatus {
2068
2208
  DISABLED = "DISABLED",
2069
2209
  DISABLING = "DISABLING",
@@ -2073,6 +2213,7 @@ export declare enum DeliveryStreamEncryptionStatus {
2073
2213
  ENABLING_FAILED = "ENABLING_FAILED"
2074
2214
  }
2075
2215
  /**
2216
+ * @public
2076
2217
  * <p>Contains information about the server-side encryption (SSE) status for the delivery
2077
2218
  * stream, the type customer master key (CMK) in use, if any, and the ARN of the CMK. You can
2078
2219
  * get <code>DeliveryStreamEncryptionConfiguration</code> by invoking the <a>DescribeDeliveryStream</a> operation. </p>
@@ -2104,6 +2245,9 @@ export interface DeliveryStreamEncryptionConfiguration {
2104
2245
  */
2105
2246
  FailureDescription?: FailureDescription;
2106
2247
  }
2248
+ /**
2249
+ * @public
2250
+ */
2107
2251
  export declare enum DeliveryStreamStatus {
2108
2252
  ACTIVE = "ACTIVE",
2109
2253
  CREATING = "CREATING",
@@ -2112,6 +2256,7 @@ export declare enum DeliveryStreamStatus {
2112
2256
  DELETING_FAILED = "DELETING_FAILED"
2113
2257
  }
2114
2258
  /**
2259
+ * @public
2115
2260
  * <p>The destination description in Amazon ES.</p>
2116
2261
  */
2117
2262
  export interface ElasticsearchDestinationDescription {
@@ -2179,6 +2324,7 @@ export interface ElasticsearchDestinationDescription {
2179
2324
  VpcConfigurationDescription?: VpcConfigurationDescription;
2180
2325
  }
2181
2326
  /**
2327
+ * @public
2182
2328
  * <p>Describes a destination in Amazon S3.</p>
2183
2329
  */
2184
2330
  export interface ExtendedS3DestinationDescription {
@@ -2250,6 +2396,7 @@ export interface ExtendedS3DestinationDescription {
2250
2396
  DynamicPartitioningConfiguration?: DynamicPartitioningConfiguration;
2251
2397
  }
2252
2398
  /**
2399
+ * @public
2253
2400
  * <p>Describes the HTTP endpoint selected as the destination. </p>
2254
2401
  */
2255
2402
  export interface HttpEndpointDescription {
@@ -2263,6 +2410,7 @@ export interface HttpEndpointDescription {
2263
2410
  Name?: string;
2264
2411
  }
2265
2412
  /**
2413
+ * @public
2266
2414
  * <p>Describes the HTTP endpoint destination.</p>
2267
2415
  */
2268
2416
  export interface HttpEndpointDestinationDescription {
@@ -2315,6 +2463,7 @@ export interface HttpEndpointDestinationDescription {
2315
2463
  S3DestinationDescription?: S3DestinationDescription;
2316
2464
  }
2317
2465
  /**
2466
+ * @public
2318
2467
  * <p>Describes a destination in Amazon Redshift.</p>
2319
2468
  */
2320
2469
  export interface RedshiftDestinationDescription {
@@ -2363,6 +2512,7 @@ export interface RedshiftDestinationDescription {
2363
2512
  CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
2364
2513
  }
2365
2514
  /**
2515
+ * @public
2366
2516
  * <p>Describes a destination in Splunk.</p>
2367
2517
  */
2368
2518
  export interface SplunkDestinationDescription {
@@ -2414,6 +2564,7 @@ export interface SplunkDestinationDescription {
2414
2564
  CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
2415
2565
  }
2416
2566
  /**
2567
+ * @public
2417
2568
  * <p>Describes the destination for a delivery stream.</p>
2418
2569
  */
2419
2570
  export interface DestinationDescription {
@@ -2455,6 +2606,7 @@ export interface DestinationDescription {
2455
2606
  AmazonOpenSearchServerlessDestinationDescription?: AmazonOpenSearchServerlessDestinationDescription;
2456
2607
  }
2457
2608
  /**
2609
+ * @public
2458
2610
  * <p>Details about a Kinesis data stream used as the source for a Kinesis Data Firehose
2459
2611
  * delivery stream.</p>
2460
2612
  */
@@ -2478,6 +2630,7 @@ export interface KinesisStreamSourceDescription {
2478
2630
  DeliveryStartTimestamp?: Date;
2479
2631
  }
2480
2632
  /**
2633
+ * @public
2481
2634
  * <p>Details about a Kinesis data stream used as the source for a Kinesis Data Firehose
2482
2635
  * delivery stream.</p>
2483
2636
  */
@@ -2489,6 +2642,7 @@ export interface SourceDescription {
2489
2642
  KinesisStreamSourceDescription?: KinesisStreamSourceDescription;
2490
2643
  }
2491
2644
  /**
2645
+ * @public
2492
2646
  * <p>Contains information about a delivery stream.</p>
2493
2647
  */
2494
2648
  export interface DeliveryStreamDescription {
@@ -2564,6 +2718,9 @@ export interface DeliveryStreamDescription {
2564
2718
  */
2565
2719
  HasMoreDestinations: boolean | undefined;
2566
2720
  }
2721
+ /**
2722
+ * @public
2723
+ */
2567
2724
  export interface DescribeDeliveryStreamInput {
2568
2725
  /**
2569
2726
  * <p>The name of the delivery stream.</p>
@@ -2580,6 +2737,9 @@ export interface DescribeDeliveryStreamInput {
2580
2737
  */
2581
2738
  ExclusiveStartDestinationId?: string;
2582
2739
  }
2740
+ /**
2741
+ * @public
2742
+ */
2583
2743
  export interface DescribeDeliveryStreamOutput {
2584
2744
  /**
2585
2745
  * <p>Information about the delivery stream.</p>
@@ -2587,6 +2747,7 @@ export interface DescribeDeliveryStreamOutput {
2587
2747
  DeliveryStreamDescription: DeliveryStreamDescription | undefined;
2588
2748
  }
2589
2749
  /**
2750
+ * @public
2590
2751
  * <p>Describes an update for a destination in Amazon ES.</p>
2591
2752
  */
2592
2753
  export interface ElasticsearchDestinationUpdate {
@@ -2659,6 +2820,7 @@ export interface ElasticsearchDestinationUpdate {
2659
2820
  CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
2660
2821
  }
2661
2822
  /**
2823
+ * @public
2662
2824
  * <p>Describes an update for a destination in Amazon S3.</p>
2663
2825
  */
2664
2826
  export interface ExtendedS3DestinationUpdate {
@@ -2730,6 +2892,9 @@ export interface ExtendedS3DestinationUpdate {
2730
2892
  */
2731
2893
  DynamicPartitioningConfiguration?: DynamicPartitioningConfiguration;
2732
2894
  }
2895
+ /**
2896
+ * @public
2897
+ */
2733
2898
  export interface ListDeliveryStreamsInput {
2734
2899
  /**
2735
2900
  * <p>The maximum number of delivery streams to list. The default value is 10.</p>
@@ -2761,6 +2926,9 @@ export interface ListDeliveryStreamsInput {
2761
2926
  */
2762
2927
  ExclusiveStartDeliveryStreamName?: string;
2763
2928
  }
2929
+ /**
2930
+ * @public
2931
+ */
2764
2932
  export interface ListDeliveryStreamsOutput {
2765
2933
  /**
2766
2934
  * <p>The names of the delivery streams.</p>
@@ -2771,6 +2939,9 @@ export interface ListDeliveryStreamsOutput {
2771
2939
  */
2772
2940
  HasMoreDeliveryStreams: boolean | undefined;
2773
2941
  }
2942
+ /**
2943
+ * @public
2944
+ */
2774
2945
  export interface ListTagsForDeliveryStreamInput {
2775
2946
  /**
2776
2947
  * <p>The name of the delivery stream whose tags you want to list.</p>
@@ -2790,6 +2961,9 @@ export interface ListTagsForDeliveryStreamInput {
2790
2961
  */
2791
2962
  Limit?: number;
2792
2963
  }
2964
+ /**
2965
+ * @public
2966
+ */
2793
2967
  export interface ListTagsForDeliveryStreamOutput {
2794
2968
  /**
2795
2969
  * <p>A list of tags associated with <code>DeliveryStreamName</code>, starting with the
@@ -2805,6 +2979,7 @@ export interface ListTagsForDeliveryStreamOutput {
2805
2979
  HasMoreTags: boolean | undefined;
2806
2980
  }
2807
2981
  /**
2982
+ * @public
2808
2983
  * <p>The unit of data in a delivery stream.</p>
2809
2984
  */
2810
2985
  export interface _Record {
@@ -2814,6 +2989,9 @@ export interface _Record {
2814
2989
  */
2815
2990
  Data: Uint8Array | undefined;
2816
2991
  }
2992
+ /**
2993
+ * @public
2994
+ */
2817
2995
  export interface PutRecordInput {
2818
2996
  /**
2819
2997
  * <p>The name of the delivery stream.</p>
@@ -2824,6 +3002,9 @@ export interface PutRecordInput {
2824
3002
  */
2825
3003
  Record: _Record | undefined;
2826
3004
  }
3005
+ /**
3006
+ * @public
3007
+ */
2827
3008
  export interface PutRecordOutput {
2828
3009
  /**
2829
3010
  * <p>The ID of the record.</p>
@@ -2835,6 +3016,7 @@ export interface PutRecordOutput {
2835
3016
  Encrypted?: boolean;
2836
3017
  }
2837
3018
  /**
3019
+ * @public
2838
3020
  * <p>The service is unavailable. Back off and retry the operation. If you continue to see
2839
3021
  * the exception, throughput limits for the delivery stream may have been exceeded. For more
2840
3022
  * information about limits and how to request an increase, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/limits.html">Amazon Kinesis Data Firehose
@@ -2848,6 +3030,9 @@ export declare class ServiceUnavailableException extends __BaseException {
2848
3030
  */
2849
3031
  constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
2850
3032
  }
3033
+ /**
3034
+ * @public
3035
+ */
2851
3036
  export interface PutRecordBatchInput {
2852
3037
  /**
2853
3038
  * <p>The name of the delivery stream.</p>
@@ -2859,6 +3044,7 @@ export interface PutRecordBatchInput {
2859
3044
  Records: _Record[] | undefined;
2860
3045
  }
2861
3046
  /**
3047
+ * @public
2862
3048
  * <p>Contains the result for an individual record from a <a>PutRecordBatch</a>
2863
3049
  * request. If the record is successfully added to your delivery stream, it receives a record
2864
3050
  * ID. If the record fails to be added to your delivery stream, the result includes an error
@@ -2878,6 +3064,9 @@ export interface PutRecordBatchResponseEntry {
2878
3064
  */
2879
3065
  ErrorMessage?: string;
2880
3066
  }
3067
+ /**
3068
+ * @public
3069
+ */
2881
3070
  export interface PutRecordBatchOutput {
2882
3071
  /**
2883
3072
  * <p>The number of records that might have failed processing. This number might be greater
@@ -2896,6 +3085,9 @@ export interface PutRecordBatchOutput {
2896
3085
  */
2897
3086
  RequestResponses: PutRecordBatchResponseEntry[] | undefined;
2898
3087
  }
3088
+ /**
3089
+ * @public
3090
+ */
2899
3091
  export interface StartDeliveryStreamEncryptionInput {
2900
3092
  /**
2901
3093
  * <p>The name of the delivery stream for which you want to enable server-side encryption
@@ -2908,8 +3100,14 @@ export interface StartDeliveryStreamEncryptionInput {
2908
3100
  */
2909
3101
  DeliveryStreamEncryptionConfigurationInput?: DeliveryStreamEncryptionConfigurationInput;
2910
3102
  }
3103
+ /**
3104
+ * @public
3105
+ */
2911
3106
  export interface StartDeliveryStreamEncryptionOutput {
2912
3107
  }
3108
+ /**
3109
+ * @public
3110
+ */
2913
3111
  export interface StopDeliveryStreamEncryptionInput {
2914
3112
  /**
2915
3113
  * <p>The name of the delivery stream for which you want to disable server-side encryption
@@ -2917,8 +3115,14 @@ export interface StopDeliveryStreamEncryptionInput {
2917
3115
  */
2918
3116
  DeliveryStreamName: string | undefined;
2919
3117
  }
3118
+ /**
3119
+ * @public
3120
+ */
2920
3121
  export interface StopDeliveryStreamEncryptionOutput {
2921
3122
  }
3123
+ /**
3124
+ * @public
3125
+ */
2922
3126
  export interface TagDeliveryStreamInput {
2923
3127
  /**
2924
3128
  * <p>The name of the delivery stream to which you want to add the tags.</p>
@@ -2929,8 +3133,14 @@ export interface TagDeliveryStreamInput {
2929
3133
  */
2930
3134
  Tags: Tag[] | undefined;
2931
3135
  }
3136
+ /**
3137
+ * @public
3138
+ */
2932
3139
  export interface TagDeliveryStreamOutput {
2933
3140
  }
3141
+ /**
3142
+ * @public
3143
+ */
2934
3144
  export interface UntagDeliveryStreamInput {
2935
3145
  /**
2936
3146
  * <p>The name of the delivery stream.</p>
@@ -2942,9 +3152,13 @@ export interface UntagDeliveryStreamInput {
2942
3152
  */
2943
3153
  TagKeys: string[] | undefined;
2944
3154
  }
3155
+ /**
3156
+ * @public
3157
+ */
2945
3158
  export interface UntagDeliveryStreamOutput {
2946
3159
  }
2947
3160
  /**
3161
+ * @public
2948
3162
  * <p>Updates the specified HTTP endpoint destination.</p>
2949
3163
  */
2950
3164
  export interface HttpEndpointDestinationUpdate {
@@ -2997,6 +3211,7 @@ export interface HttpEndpointDestinationUpdate {
2997
3211
  S3Update?: S3DestinationUpdate;
2998
3212
  }
2999
3213
  /**
3214
+ * @public
3000
3215
  * <p>Describes an update for a destination in Amazon Redshift.</p>
3001
3216
  */
3002
3217
  export interface RedshiftDestinationUpdate {
@@ -3054,6 +3269,7 @@ export interface RedshiftDestinationUpdate {
3054
3269
  CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
3055
3270
  }
3056
3271
  /**
3272
+ * @public
3057
3273
  * <p>Describes an update for a destination in Splunk.</p>
3058
3274
  */
3059
3275
  export interface SplunkDestinationUpdate {
@@ -3107,6 +3323,9 @@ export interface SplunkDestinationUpdate {
3107
3323
  */
3108
3324
  CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
3109
3325
  }
3326
+ /**
3327
+ * @public
3328
+ */
3110
3329
  export interface UpdateDestinationInput {
3111
3330
  /**
3112
3331
  * <p>The name of the delivery stream.</p>
@@ -3160,6 +3379,9 @@ export interface UpdateDestinationInput {
3160
3379
  */
3161
3380
  AmazonOpenSearchServerlessDestinationUpdate?: AmazonOpenSearchServerlessDestinationUpdate;
3162
3381
  }
3382
+ /**
3383
+ * @public
3384
+ */
3163
3385
  export interface UpdateDestinationOutput {
3164
3386
  }
3165
3387
  /**