@aws-sdk/client-firehose 3.734.0 → 3.737.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.
package/dist-cjs/index.js CHANGED
@@ -1127,6 +1127,7 @@ var se_CreateDeliveryStreamInput = /* @__PURE__ */ __name((input, context) => {
1127
1127
  DeliveryStreamEncryptionConfigurationInput: import_smithy_client._json,
1128
1128
  DeliveryStreamName: [],
1129
1129
  DeliveryStreamType: [],
1130
+ DirectPutSourceConfiguration: import_smithy_client._json,
1130
1131
  ElasticsearchDestinationConfiguration: import_smithy_client._json,
1131
1132
  ExtendedS3DestinationConfiguration: (_) => se_ExtendedS3DestinationConfiguration(_, context),
1132
1133
  HttpEndpointDestinationConfiguration: import_smithy_client._json,
@@ -1403,6 +1404,7 @@ var de_Serializer = /* @__PURE__ */ __name((output, context) => {
1403
1404
  var de_SourceDescription = /* @__PURE__ */ __name((output, context) => {
1404
1405
  return (0, import_smithy_client.take)(output, {
1405
1406
  DatabaseSourceDescription: (_) => de_DatabaseSourceDescription(_, context),
1407
+ DirectPutSourceDescription: import_smithy_client._json,
1406
1408
  KinesisStreamSourceDescription: (_) => de_KinesisStreamSourceDescription(_, context),
1407
1409
  MSKSourceDescription: (_) => de_MSKSourceDescription(_, context)
1408
1410
  });
@@ -351,6 +351,7 @@ const se_CreateDeliveryStreamInput = (input, context) => {
351
351
  DeliveryStreamEncryptionConfigurationInput: _json,
352
352
  DeliveryStreamName: [],
353
353
  DeliveryStreamType: [],
354
+ DirectPutSourceConfiguration: _json,
354
355
  ElasticsearchDestinationConfiguration: _json,
355
356
  ExtendedS3DestinationConfiguration: (_) => se_ExtendedS3DestinationConfiguration(_, context),
356
357
  HttpEndpointDestinationConfiguration: _json,
@@ -633,6 +634,7 @@ const de_Serializer = (output, context) => {
633
634
  const de_SourceDescription = (output, context) => {
634
635
  return take(output, {
635
636
  DatabaseSourceDescription: (_) => de_DatabaseSourceDescription(_, context),
637
+ DirectPutSourceDescription: _json,
636
638
  KinesisStreamSourceDescription: (_) => de_KinesisStreamSourceDescription(_, context),
637
639
  MSKSourceDescription: (_) => de_MSKSourceDescription(_, context),
638
640
  });
@@ -103,6 +103,9 @@ declare const CreateDeliveryStreamCommand_base: {
103
103
  * const input = { // CreateDeliveryStreamInput
104
104
  * DeliveryStreamName: "STRING_VALUE", // required
105
105
  * DeliveryStreamType: "DirectPut" || "KinesisStreamAsSource" || "MSKAsSource" || "DatabaseAsSource",
106
+ * DirectPutSourceConfiguration: { // DirectPutSourceConfiguration
107
+ * ThroughputHintInMBs: Number("int"), // required
108
+ * },
106
109
  * KinesisStreamSourceConfiguration: { // KinesisStreamSourceConfiguration
107
110
  * KinesisStreamARN: "STRING_VALUE", // required
108
111
  * RoleARN: "STRING_VALUE", // required
@@ -605,6 +608,7 @@ declare const CreateDeliveryStreamCommand_base: {
605
608
  * DurationInSeconds: Number("int"),
606
609
  * },
607
610
  * RoleARN: "STRING_VALUE", // required
611
+ * AppendOnly: true || false,
608
612
  * CatalogConfiguration: { // CatalogConfiguration
609
613
  * CatalogARN: "STRING_VALUE",
610
614
  * WarehouseLocation: "STRING_VALUE",
@@ -70,6 +70,9 @@ declare const DescribeDeliveryStreamCommand_base: {
70
70
  * // CreateTimestamp: new Date("TIMESTAMP"),
71
71
  * // LastUpdateTimestamp: new Date("TIMESTAMP"),
72
72
  * // Source: { // SourceDescription
73
+ * // DirectPutSourceDescription: { // DirectPutSourceDescription
74
+ * // ThroughputHintInMBs: Number("int"),
75
+ * // },
73
76
  * // KinesisStreamSourceDescription: { // KinesisStreamSourceDescription
74
77
  * // KinesisStreamARN: "STRING_VALUE",
75
78
  * // RoleARN: "STRING_VALUE",
@@ -621,6 +624,7 @@ declare const DescribeDeliveryStreamCommand_base: {
621
624
  * // DurationInSeconds: Number("int"),
622
625
  * // },
623
626
  * // RoleARN: "STRING_VALUE",
627
+ * // AppendOnly: true || false,
624
628
  * // CatalogConfiguration: { // CatalogConfiguration
625
629
  * // CatalogARN: "STRING_VALUE",
626
630
  * // WarehouseLocation: "STRING_VALUE",
@@ -506,6 +506,7 @@ declare const UpdateDestinationCommand_base: {
506
506
  * DurationInSeconds: Number("int"),
507
507
  * },
508
508
  * RoleARN: "STRING_VALUE",
509
+ * AppendOnly: true || false,
509
510
  * CatalogConfiguration: { // CatalogConfiguration
510
511
  * CatalogARN: "STRING_VALUE",
511
512
  * WarehouseLocation: "STRING_VALUE",
@@ -317,9 +317,9 @@ export interface S3DestinationConfiguration {
317
317
  export interface VpcConfiguration {
318
318
  /**
319
319
  * <p>The IDs of the subnets that you want Firehose to use to create ENIs in the
320
- * VPC of the Amazon ES destination. Make sure that the routing tables and inbound and
320
+ * VPC of the Amazon OpenSearch Service destination. Make sure that the routing tables and inbound and
321
321
  * outbound rules allow traffic to flow from the subnets whose IDs are specified here to the
322
- * subnets that have the destination Amazon ES endpoints. Firehose creates at
322
+ * subnets that have the destination Amazon OpenSearch Service endpoints. Firehose creates at
323
323
  * least one ENI in each of the subnets that are specified here. Do not delete or modify these
324
324
  * ENIs.</p>
325
325
  * <p>The number of ENIs that Firehose creates in the subnets specified here
@@ -386,12 +386,12 @@ export interface VpcConfiguration {
386
386
  RoleARN: string | undefined;
387
387
  /**
388
388
  * <p>The IDs of the security groups that you want Firehose to use when it
389
- * creates ENIs in the VPC of the Amazon ES destination. You can use the same security group
390
- * that the Amazon ES domain uses or different ones. If you specify different security groups
391
- * here, ensure that they allow outbound HTTPS traffic to the Amazon ES domain's security
392
- * group. Also ensure that the Amazon ES domain's security group allows HTTPS traffic from the
389
+ * creates ENIs in the VPC of the Amazon OpenSearch Service destination. You can use the same security group
390
+ * that the Amazon OpenSearch Service domain uses or different ones. If you specify different security groups
391
+ * here, ensure that they allow outbound HTTPS traffic to the Amazon OpenSearch Service domain's security
392
+ * group. Also ensure that the Amazon OpenSearch Service domain's security group allows HTTPS traffic from the
393
393
  * security groups specified here. If you use the same security group for both your delivery
394
- * stream and the Amazon ES domain, make sure the security group inbound rule allows HTTPS
394
+ * stream and the Amazon OpenSearch Service domain, make sure the security group inbound rule allows HTTPS
395
395
  * traffic. For more information about security group rules, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html#SecurityGroupRules">Security group
396
396
  * rules</a> in the Amazon VPC documentation.</p>
397
397
  * @public
@@ -525,15 +525,15 @@ export interface S3DestinationDescription {
525
525
  CloudWatchLoggingOptions?: CloudWatchLoggingOptions | undefined;
526
526
  }
527
527
  /**
528
- * <p>The details of the VPC of the Amazon ES destination.</p>
528
+ * <p>The details of the VPC of the Amazon OpenSearch Service destination.</p>
529
529
  * @public
530
530
  */
531
531
  export interface VpcConfigurationDescription {
532
532
  /**
533
533
  * <p>The IDs of the subnets that Firehose uses to create ENIs in the VPC of the
534
- * Amazon ES destination. Make sure that the routing tables and inbound and outbound rules
534
+ * Amazon OpenSearch Service destination. Make sure that the routing tables and inbound and outbound rules
535
535
  * allow traffic to flow from the subnets whose IDs are specified here to the subnets that
536
- * have the destination Amazon ES endpoints. Firehose creates at least one ENI in
536
+ * have the destination Amazon OpenSearch Service endpoints. Firehose creates at least one ENI in
537
537
  * each of the subnets that are specified here. Do not delete or modify these ENIs.</p>
538
538
  * <p>The number of ENIs that Firehose creates in the subnets specified here
539
539
  * scales up and down automatically based on throughput. To enable Firehose to
@@ -598,19 +598,19 @@ export interface VpcConfigurationDescription {
598
598
  RoleARN: string | undefined;
599
599
  /**
600
600
  * <p>The IDs of the security groups that Firehose uses when it creates ENIs in
601
- * the VPC of the Amazon ES destination. You can use the same security group that the Amazon
601
+ * the VPC of the Amazon OpenSearch Service destination. You can use the same security group that the Amazon
602
602
  * ES domain uses or different ones. If you specify different security groups, ensure that
603
- * they allow outbound HTTPS traffic to the Amazon ES domain's security group. Also ensure
604
- * that the Amazon ES domain's security group allows HTTPS traffic from the security groups
603
+ * they allow outbound HTTPS traffic to the Amazon OpenSearch Service domain's security group. Also ensure
604
+ * that the Amazon OpenSearch Service domain's security group allows HTTPS traffic from the security groups
605
605
  * specified here. If you use the same security group for both your Firehose stream and the
606
- * Amazon ES domain, make sure the security group inbound rule allows HTTPS traffic. For more
606
+ * Amazon OpenSearch Service domain, make sure the security group inbound rule allows HTTPS traffic. For more
607
607
  * information about security group rules, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html#SecurityGroupRules">Security group
608
608
  * rules</a> in the Amazon VPC documentation.</p>
609
609
  * @public
610
610
  */
611
611
  SecurityGroupIds: string[] | undefined;
612
612
  /**
613
- * <p>The ID of the Amazon ES destination's VPC.</p>
613
+ * <p>The ID of the Amazon OpenSearch Service destination's VPC.</p>
614
614
  * @public
615
615
  */
616
616
  VpcId: string | undefined;
@@ -668,7 +668,7 @@ export interface AmazonOpenSearchServerlessDestinationDescription {
668
668
  */
669
669
  CloudWatchLoggingOptions?: CloudWatchLoggingOptions | undefined;
670
670
  /**
671
- * <p>The details of the VPC of the Amazon ES destination.</p>
671
+ * <p>The details of the VPC of the Amazon OpenSearch Service destination.</p>
672
672
  * @public
673
673
  */
674
674
  VpcConfigurationDescription?: VpcConfigurationDescription | undefined;
@@ -1045,7 +1045,7 @@ export interface AmazonopensearchserviceDestinationDescription {
1045
1045
  */
1046
1046
  CloudWatchLoggingOptions?: CloudWatchLoggingOptions | undefined;
1047
1047
  /**
1048
- * <p>The details of the VPC of the Amazon ES destination.</p>
1048
+ * <p>The details of the VPC of the Amazon OpenSearch Service destination.</p>
1049
1049
  * @public
1050
1050
  */
1051
1051
  VpcConfigurationDescription?: VpcConfigurationDescription | undefined;
@@ -1178,8 +1178,8 @@ export interface CatalogConfiguration {
1178
1178
  */
1179
1179
  CatalogARN?: string | undefined;
1180
1180
  /**
1181
- * <p>
1182
- * </p>
1181
+ * <p>The warehouse location for Apache Iceberg tables. You must configure this when schema
1182
+ * evolution and table creation is enabled.</p>
1183
1183
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
1184
1184
  * @public
1185
1185
  */
@@ -1251,14 +1251,15 @@ export interface CopyCommand {
1251
1251
  CopyOptions?: string | undefined;
1252
1252
  }
1253
1253
  /**
1254
- * <p>
1255
- * </p>
1254
+ * <p>The structure used to configure the list of column patterns in source database
1255
+ * endpoint for Firehose to read from. </p>
1256
1256
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
1257
1257
  * @public
1258
1258
  */
1259
1259
  export interface DatabaseColumnList {
1260
1260
  /**
1261
1261
  * <p>
1262
+ * The list of column patterns in source database to be included for Firehose to read from.
1262
1263
  * </p>
1263
1264
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
1264
1265
  * @public
@@ -1266,6 +1267,7 @@ export interface DatabaseColumnList {
1266
1267
  Include?: string[] | undefined;
1267
1268
  /**
1268
1269
  * <p>
1270
+ * The list of column patterns in source database to be excluded for Firehose to read from.
1269
1271
  * </p>
1270
1272
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
1271
1273
  * @public
@@ -1273,22 +1275,22 @@ export interface DatabaseColumnList {
1273
1275
  Exclude?: string[] | undefined;
1274
1276
  }
1275
1277
  /**
1276
- * <p>
1277
- * </p>
1278
+ * <p>The structure used to configure the list of database patterns in source database
1279
+ * endpoint for Firehose to read from. </p>
1278
1280
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
1279
1281
  * @public
1280
1282
  */
1281
1283
  export interface DatabaseList {
1282
1284
  /**
1283
- * <p>
1284
- * </p>
1285
+ * <p>The list of database patterns in source database endpoint to be included for Firehose
1286
+ * to read from. </p>
1285
1287
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
1286
1288
  * @public
1287
1289
  */
1288
1290
  Include?: string[] | undefined;
1289
1291
  /**
1290
- * <p>
1291
- * </p>
1292
+ * <p>The list of database patterns in source database endpoint to be excluded for Firehose
1293
+ * to read from. </p>
1292
1294
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
1293
1295
  * @public
1294
1296
  */
@@ -1323,6 +1325,7 @@ export interface SecretsManagerConfiguration {
1323
1325
  }
1324
1326
  /**
1325
1327
  * <p>
1328
+ * The structure to configure the authentication methods for Firehose to connect to source database endpoint.
1326
1329
  * </p>
1327
1330
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
1328
1331
  * @public
@@ -1336,6 +1339,7 @@ export interface DatabaseSourceAuthenticationConfiguration {
1336
1339
  }
1337
1340
  /**
1338
1341
  * <p>
1342
+ * The structure for details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database.
1339
1343
  * </p>
1340
1344
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
1341
1345
  * @public
@@ -1343,6 +1347,7 @@ export interface DatabaseSourceAuthenticationConfiguration {
1343
1347
  export interface DatabaseSourceVPCConfiguration {
1344
1348
  /**
1345
1349
  * <p>
1350
+ * The VPC endpoint service name which Firehose uses to create a PrivateLink to the database. The endpoint service must have the Firehose service principle <code>firehose.amazonaws.com</code> as an allowed principal on the VPC endpoint service. The VPC endpoint service name is a string that looks like <code>com.amazonaws.vpce.<region>.<vpc-endpoint-service-id></code>.
1346
1351
  * </p>
1347
1352
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
1348
1353
  * @public
@@ -1362,22 +1367,22 @@ export declare const SSLMode: {
1362
1367
  */
1363
1368
  export type SSLMode = (typeof SSLMode)[keyof typeof SSLMode];
1364
1369
  /**
1365
- * <p>
1366
- * </p>
1370
+ * <p>The structure used to configure the list of table patterns in source database endpoint
1371
+ * for Firehose to read from. </p>
1367
1372
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
1368
1373
  * @public
1369
1374
  */
1370
1375
  export interface DatabaseTableList {
1371
1376
  /**
1372
- * <p>
1373
- * </p>
1377
+ * <p>The list of table patterns in source database endpoint to be included for Firehose to
1378
+ * read from. </p>
1374
1379
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
1375
1380
  * @public
1376
1381
  */
1377
1382
  Include?: string[] | undefined;
1378
1383
  /**
1379
- * <p>
1380
- * </p>
1384
+ * <p>The list of table patterns in source database endpoint to be excluded for Firehose to
1385
+ * read from. </p>
1381
1386
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
1382
1387
  * @public
1383
1388
  */
@@ -1397,34 +1402,51 @@ export declare const DatabaseType: {
1397
1402
  export type DatabaseType = (typeof DatabaseType)[keyof typeof DatabaseType];
1398
1403
  /**
1399
1404
  * <p>
1405
+ * The top level object for configuring streams with database as a source.
1400
1406
  * </p>
1401
1407
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
1402
1408
  * @public
1403
1409
  */
1404
1410
  export interface DatabaseSourceConfiguration {
1405
1411
  /**
1406
- * <p>
1407
- * </p>
1412
+ * <p>The type of database engine. This can be one of the following values. </p>
1413
+ * <ul>
1414
+ * <li>
1415
+ * <p>MySQL</p>
1416
+ * </li>
1417
+ * <li>
1418
+ * <p>PostgreSQL</p>
1419
+ * </li>
1420
+ * </ul>
1408
1421
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
1409
1422
  * @public
1410
1423
  */
1411
1424
  Type: DatabaseType | undefined;
1412
1425
  /**
1413
1426
  * <p>
1427
+ * The endpoint of the database server.
1414
1428
  * </p>
1415
1429
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
1416
1430
  * @public
1417
1431
  */
1418
1432
  Endpoint: string | undefined;
1419
1433
  /**
1420
- * <p>
1421
- * </p>
1434
+ * <p>The port of the database. This can be one of the following values.</p>
1435
+ * <ul>
1436
+ * <li>
1437
+ * <p>3306 for MySQL database type</p>
1438
+ * </li>
1439
+ * <li>
1440
+ * <p>5432 for PostgreSQL database type</p>
1441
+ * </li>
1442
+ * </ul>
1422
1443
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
1423
1444
  * @public
1424
1445
  */
1425
1446
  Port: number | undefined;
1426
1447
  /**
1427
1448
  * <p>
1449
+ * The mode to enable or disable SSL when Firehose connects to the database endpoint.
1428
1450
  * </p>
1429
1451
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
1430
1452
  * @public
@@ -1432,6 +1454,7 @@ export interface DatabaseSourceConfiguration {
1432
1454
  SSLMode?: SSLMode | undefined;
1433
1455
  /**
1434
1456
  * <p>
1457
+ * The list of database patterns in source database endpoint for Firehose to read from.
1435
1458
  * </p>
1436
1459
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
1437
1460
  * @public
@@ -1439,6 +1462,7 @@ export interface DatabaseSourceConfiguration {
1439
1462
  Databases: DatabaseList | undefined;
1440
1463
  /**
1441
1464
  * <p>
1465
+ * The list of table patterns in source database endpoint for Firehose to read from.
1442
1466
  * </p>
1443
1467
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
1444
1468
  * @public
@@ -1446,6 +1470,7 @@ export interface DatabaseSourceConfiguration {
1446
1470
  Tables: DatabaseTableList | undefined;
1447
1471
  /**
1448
1472
  * <p>
1473
+ * The list of column patterns in source database endpoint for Firehose to read from.
1449
1474
  * </p>
1450
1475
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
1451
1476
  * @public
@@ -1453,6 +1478,7 @@ export interface DatabaseSourceConfiguration {
1453
1478
  Columns?: DatabaseColumnList | undefined;
1454
1479
  /**
1455
1480
  * <p>
1481
+ * The optional list of table and column names used as unique key columns when taking snapshot if the tables don’t have primary keys configured.
1456
1482
  * </p>
1457
1483
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
1458
1484
  * @public
@@ -1460,6 +1486,7 @@ export interface DatabaseSourceConfiguration {
1460
1486
  SurrogateKeys?: string[] | undefined;
1461
1487
  /**
1462
1488
  * <p>
1489
+ * The fully qualified name of the table in source database endpoint that Firehose uses to track snapshot progress.
1463
1490
  * </p>
1464
1491
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
1465
1492
  * @public
@@ -1467,6 +1494,7 @@ export interface DatabaseSourceConfiguration {
1467
1494
  SnapshotWatermarkTable: string | undefined;
1468
1495
  /**
1469
1496
  * <p>
1497
+ * The structure to configure the authentication methods for Firehose to connect to source database endpoint.
1470
1498
  * </p>
1471
1499
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
1472
1500
  * @public
@@ -1474,6 +1502,7 @@ export interface DatabaseSourceConfiguration {
1474
1502
  DatabaseSourceAuthenticationConfiguration: DatabaseSourceAuthenticationConfiguration | undefined;
1475
1503
  /**
1476
1504
  * <p>
1505
+ * The details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database.
1477
1506
  * </p>
1478
1507
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
1479
1508
  * @public
@@ -1544,7 +1573,20 @@ export declare const DeliveryStreamType: {
1544
1573
  */
1545
1574
  export type DeliveryStreamType = (typeof DeliveryStreamType)[keyof typeof DeliveryStreamType];
1546
1575
  /**
1547
- * <p>Describes the buffering to perform before delivering data to the Amazon ES
1576
+ * <p>The structure that configures parameters such as <code>ThroughputHintInMBs</code> for a stream configured with
1577
+ * Direct PUT as a source. </p>
1578
+ * @public
1579
+ */
1580
+ export interface DirectPutSourceConfiguration {
1581
+ /**
1582
+ * <p> The value that you configure for this parameter is for information purpose only and
1583
+ * does not affect Firehose delivery throughput limit. You can use the <a href="https://support.console.aws.amazon.com/support/home#/case/create%3FissueType=service-limit-increase%26limitType=kinesis-firehose-limits">Firehose Limits form</a> to request a throughput limit increase. </p>
1584
+ * @public
1585
+ */
1586
+ ThroughputHintInMBs: number | undefined;
1587
+ }
1588
+ /**
1589
+ * <p>Describes the buffering to perform before delivering data to the Amazon OpenSearch Service
1548
1590
  * destination.</p>
1549
1591
  * @public
1550
1592
  */
@@ -1582,12 +1624,12 @@ export declare const ElasticsearchIndexRotationPeriod: {
1582
1624
  export type ElasticsearchIndexRotationPeriod = (typeof ElasticsearchIndexRotationPeriod)[keyof typeof ElasticsearchIndexRotationPeriod];
1583
1625
  /**
1584
1626
  * <p>Configures retry behavior in case Firehose is unable to deliver
1585
- * documents to Amazon ES.</p>
1627
+ * documents to Amazon OpenSearch Service.</p>
1586
1628
  * @public
1587
1629
  */
1588
1630
  export interface ElasticsearchRetryOptions {
1589
1631
  /**
1590
- * <p>After an initial failure to deliver to Amazon ES, the total amount of time during
1632
+ * <p>After an initial failure to deliver to Amazon OpenSearch Service, the total amount of time during
1591
1633
  * which Firehose retries delivery (including the first attempt). After this time
1592
1634
  * has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5
1593
1635
  * minutes). A value of 0 (zero) results in no retries.</p>
@@ -1608,20 +1650,20 @@ export declare const ElasticsearchS3BackupMode: {
1608
1650
  */
1609
1651
  export type ElasticsearchS3BackupMode = (typeof ElasticsearchS3BackupMode)[keyof typeof ElasticsearchS3BackupMode];
1610
1652
  /**
1611
- * <p>Describes the configuration of a destination in Amazon ES.</p>
1653
+ * <p>Describes the configuration of a destination in Amazon OpenSearch Service.</p>
1612
1654
  * @public
1613
1655
  */
1614
1656
  export interface ElasticsearchDestinationConfiguration {
1615
1657
  /**
1616
1658
  * <p>The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose
1617
- * for calling the Amazon ES Configuration API and for indexing documents. For more
1659
+ * for calling the Amazon OpenSearch Service Configuration API and for indexing documents. For more
1618
1660
  * information, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3">Grant 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
1619
1661
  * Amazon Web Services Service Namespaces</a>.</p>
1620
1662
  * @public
1621
1663
  */
1622
1664
  RoleARN: string | undefined;
1623
1665
  /**
1624
- * <p>The ARN of the Amazon ES domain. The IAM role must have permissions
1666
+ * <p>The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions
1625
1667
  * for <code>DescribeDomain</code>, <code>DescribeDomains</code>, and
1626
1668
  * <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
1627
1669
  * Amazon Web Services Service Namespaces</a>.</p>
@@ -1652,7 +1694,7 @@ export interface ElasticsearchDestinationConfiguration {
1652
1694
  * <p>The Elasticsearch index rotation period. Index rotation appends a timestamp to the
1653
1695
  * <code>IndexName</code> to facilitate the expiration of old data. For more information,
1654
1696
  * see <a href="https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation">Index Rotation for the
1655
- * Amazon ES Destination</a>. The default value is <code>OneDay</code>.</p>
1697
+ * Amazon OpenSearch Service Destination</a>. The default value is <code>OneDay</code>.</p>
1656
1698
  * @public
1657
1699
  */
1658
1700
  IndexRotationPeriod?: ElasticsearchIndexRotationPeriod | undefined;
@@ -1664,7 +1706,7 @@ export interface ElasticsearchDestinationConfiguration {
1664
1706
  BufferingHints?: ElasticsearchBufferingHints | undefined;
1665
1707
  /**
1666
1708
  * <p>The retry behavior in case Firehose is unable to deliver documents to
1667
- * Amazon ES. The default value is 300 (5 minutes).</p>
1709
+ * Amazon OpenSearch Service. The default value is 300 (5 minutes).</p>
1668
1710
  * @public
1669
1711
  */
1670
1712
  RetryOptions?: ElasticsearchRetryOptions | undefined;
@@ -1676,7 +1718,7 @@ export interface ElasticsearchDestinationConfiguration {
1676
1718
  * <code>AllDocuments</code>, Firehose delivers all incoming records to Amazon
1677
1719
  * S3, and also writes failed documents with <code>AmazonOpenSearchService-failed/</code>
1678
1720
  * 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
1679
- * Amazon ES Destination</a>. Default value is
1721
+ * Amazon OpenSearch Service Destination</a>. Default value is
1680
1722
  * <code>FailedDocumentsOnly</code>.</p>
1681
1723
  * <p>You can't change this backup mode after you create the Firehose stream. </p>
1682
1724
  * @public
@@ -1973,13 +2015,13 @@ export interface ParquetSerDe {
1973
2015
  /**
1974
2016
  * <p>The serializer that you want Firehose to use to convert data to the target
1975
2017
  * format before writing it to Amazon S3. Firehose supports two types of
1976
- * 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>
2018
+ * serializers: the ORC SerDe and the Parquet SerDe.</p>
1977
2019
  * @public
1978
2020
  */
1979
2021
  export interface Serializer {
1980
2022
  /**
1981
2023
  * <p>A serializer to use for converting data to the Parquet format before storing it in
1982
- * Amazon S3. For more information, see <a href="https://parquet.apache.org/documentation/latest/">Apache Parquet</a>.</p>
2024
+ * Amazon S3. For more information, see <a href="https://parquet.apache.org/docs/contribution-guidelines/">Apache Parquet</a>.</p>
1983
2025
  * @public
1984
2026
  */
1985
2027
  ParquetSerDe?: ParquetSerDe | undefined;
@@ -2130,8 +2172,7 @@ export interface DynamicPartitioningConfiguration {
2130
2172
  */
2131
2173
  RetryOptions?: RetryOptions | undefined;
2132
2174
  /**
2133
- * <p>Specifies that the dynamic partitioning is enabled for this Firehose
2134
- * Firehose stream.</p>
2175
+ * <p>Specifies that the dynamic partitioning is enabled for this Firehose stream.</p>
2135
2176
  * @public
2136
2177
  */
2137
2178
  Enabled?: boolean | undefined;
@@ -2430,14 +2471,14 @@ export interface HttpEndpointDestinationConfiguration {
2430
2471
  SecretsManagerConfiguration?: SecretsManagerConfiguration | undefined;
2431
2472
  }
2432
2473
  /**
2433
- * <p>
2434
- * </p>
2474
+ * <p>Represents a single field in a <code>PartitionSpec</code>. </p>
2435
2475
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
2436
2476
  * @public
2437
2477
  */
2438
2478
  export interface PartitionField {
2439
2479
  /**
2440
2480
  * <p>
2481
+ * The column name to be configured in partition spec.
2441
2482
  * </p>
2442
2483
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
2443
2484
  * @public
@@ -2445,15 +2486,21 @@ export interface PartitionField {
2445
2486
  SourceName: string | undefined;
2446
2487
  }
2447
2488
  /**
2448
- * <p>
2449
- * </p>
2489
+ * <p>Represents how to produce partition data for a table. Partition data is produced by
2490
+ * transforming columns in a table. Each column transform is represented by a named
2491
+ * <code>PartitionField</code>. </p>
2492
+ * <p>Here is an example of the schema in JSON. </p>
2493
+ * <p>
2494
+ * <code>"partitionSpec": \{ "identity": [ \{"sourceName": "column1"\}, \{"sourceName":
2495
+ * "column2"\}, \{"sourceName": "column3"\} ] \}</code>
2496
+ * </p>
2450
2497
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
2451
2498
  * @public
2452
2499
  */
2453
2500
  export interface PartitionSpec {
2454
2501
  /**
2455
- * <p>
2456
- * </p>
2502
+ * <p> List of identity <a href="https://iceberg.apache.org/spec/#partition-transforms">transforms</a> that performs an identity transformation. The transform takes the
2503
+ * source value, and does not modify it. Result type is the source type.</p>
2457
2504
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
2458
2505
  * @public
2459
2506
  */
@@ -2489,8 +2536,8 @@ export interface DestinationTableConfiguration {
2489
2536
  */
2490
2537
  UniqueKeys?: string[] | undefined;
2491
2538
  /**
2492
- * <p>
2493
- * </p>
2539
+ * <p>The partition spec configuration for a table that is used by automatic table
2540
+ * creation.</p>
2494
2541
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
2495
2542
  * @public
2496
2543
  */
@@ -2516,14 +2563,14 @@ export declare const IcebergS3BackupMode: {
2516
2563
  */
2517
2564
  export type IcebergS3BackupMode = (typeof IcebergS3BackupMode)[keyof typeof IcebergS3BackupMode];
2518
2565
  /**
2519
- * <p>
2520
- * </p>
2566
+ * <p>The configuration to enable schema evolution.</p>
2521
2567
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
2522
2568
  * @public
2523
2569
  */
2524
2570
  export interface SchemaEvolutionConfiguration {
2525
2571
  /**
2526
2572
  * <p>
2573
+ * Specify whether you want to enable schema evolution.
2527
2574
  * </p>
2528
2575
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
2529
2576
  * @public
@@ -2531,14 +2578,14 @@ export interface SchemaEvolutionConfiguration {
2531
2578
  Enabled: boolean | undefined;
2532
2579
  }
2533
2580
  /**
2534
- * <p>
2535
- * </p>
2581
+ * <p>The configuration to enable automatic table creation.</p>
2536
2582
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
2537
2583
  * @public
2538
2584
  */
2539
2585
  export interface TableCreationConfiguration {
2540
2586
  /**
2541
2587
  * <p>
2588
+ * Specify whether you want to enable automatic table creation.
2542
2589
  * </p>
2543
2590
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
2544
2591
  * @public
@@ -2559,15 +2606,13 @@ export interface IcebergDestinationConfiguration {
2559
2606
  */
2560
2607
  DestinationTableConfigurationList?: DestinationTableConfiguration[] | undefined;
2561
2608
  /**
2562
- * <p>
2563
- * </p>
2609
+ * <p>The configuration to enable automatic schema evolution.</p>
2564
2610
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
2565
2611
  * @public
2566
2612
  */
2567
2613
  SchemaEvolutionConfiguration?: SchemaEvolutionConfiguration | undefined;
2568
2614
  /**
2569
- * <p>
2570
- * </p>
2615
+ * <p>The configuration to enable automatic table creation.</p>
2571
2616
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
2572
2617
  * @public
2573
2618
  */
@@ -2609,6 +2654,17 @@ export interface IcebergDestinationConfiguration {
2609
2654
  * @public
2610
2655
  */
2611
2656
  RoleARN: string | undefined;
2657
+ /**
2658
+ * <p> Describes whether all incoming data for this delivery stream will be append only
2659
+ * (inserts only and not for updates and deletes) for Iceberg delivery. This feature is only
2660
+ * applicable for Apache Iceberg Tables.</p>
2661
+ * <p>The default value is false. If you set this value to true, Firehose automatically
2662
+ * increases the throughput limit of a stream based on the throttling levels of the stream. If
2663
+ * you set this parameter to true for a stream with updates and deletes, you will see out of
2664
+ * order delivery. </p>
2665
+ * @public
2666
+ */
2667
+ AppendOnly?: boolean | undefined;
2612
2668
  /**
2613
2669
  * <p>
2614
2670
  * Configuration describing where the destination Apache Iceberg Tables are persisted.
@@ -2925,12 +2981,25 @@ export interface SnowflakeDestinationConfiguration {
2925
2981
  */
2926
2982
  DataLoadingOption?: SnowflakeDataLoadingOption | undefined;
2927
2983
  /**
2928
- * <p>The name of the record metadata column</p>
2984
+ * <p>Specify a column name in the table, where the metadata information has to be loaded.
2985
+ * When you enable this field, you will see the following column in the snowflake table, which
2986
+ * differs based on the source type.</p>
2987
+ * <p>For Direct PUT as source </p>
2988
+ * <p>
2989
+ * <code>\{ "firehoseDeliveryStreamName" : "streamname", "IngestionTime" : "timestamp"
2990
+ * \}</code>
2991
+ * </p>
2992
+ * <p>For Kinesis Data Stream as source </p>
2993
+ * <p>
2994
+ * <code> "kinesisStreamName" : "streamname", "kinesisShardId" : "Id",
2995
+ * "kinesisPartitionKey" : "key", "kinesisSequenceNumber" : "1234", "subsequenceNumber" :
2996
+ * "2334", "IngestionTime" : "timestamp" \}</code>
2997
+ * </p>
2929
2998
  * @public
2930
2999
  */
2931
3000
  MetaDataColumnName?: string | undefined;
2932
3001
  /**
2933
- * <p>The name of the record content column</p>
3002
+ * <p>The name of the record content column.</p>
2934
3003
  * @public
2935
3004
  */
2936
3005
  ContentColumnName?: string | undefined;
@@ -3169,6 +3238,12 @@ export interface CreateDeliveryStreamInput {
3169
3238
  * @public
3170
3239
  */
3171
3240
  DeliveryStreamType?: DeliveryStreamType | undefined;
3241
+ /**
3242
+ * <p>The structure that configures parameters such as <code>ThroughputHintInMBs</code> for a
3243
+ * stream configured with Direct PUT as a source. </p>
3244
+ * @public
3245
+ */
3246
+ DirectPutSourceConfiguration?: DirectPutSourceConfiguration | undefined;
3172
3247
  /**
3173
3248
  * <p>When a Kinesis data stream is used as the source for the Firehose stream, a <a>KinesisStreamSourceConfiguration</a> containing the Kinesis data stream Amazon
3174
3249
  * Resource Name (ARN) and the role ARN for the source stream.</p>
@@ -3200,7 +3275,7 @@ export interface CreateDeliveryStreamInput {
3200
3275
  */
3201
3276
  RedshiftDestinationConfiguration?: RedshiftDestinationConfiguration | undefined;
3202
3277
  /**
3203
- * <p>The destination in Amazon ES. You can specify only one destination.</p>
3278
+ * <p>The destination in Amazon OpenSearch Service. You can specify only one destination.</p>
3204
3279
  * @public
3205
3280
  */
3206
3281
  ElasticsearchDestinationConfiguration?: ElasticsearchDestinationConfiguration | undefined;
@@ -3232,9 +3307,9 @@ export interface CreateDeliveryStreamInput {
3232
3307
  * <p>If you specify tags in the <code>CreateDeliveryStream</code> action, Amazon Data
3233
3308
  * Firehose performs an additional authorization on the
3234
3309
  * <code>firehose:TagDeliveryStream</code> action to verify if users have permissions to
3235
- * create tags. If you do not provide this permission, requests to create new Firehose
3236
- * Firehose streams with IAM resource tags will fail with an
3237
- * <code>AccessDeniedException</code> such as following.</p>
3310
+ * create tags. If you do not provide this permission, requests to create new Firehose streams
3311
+ * with IAM resource tags will fail with an <code>AccessDeniedException</code> such as
3312
+ * following.</p>
3238
3313
  * <p>
3239
3314
  * <b>AccessDeniedException</b>
3240
3315
  * </p>
@@ -3270,6 +3345,7 @@ export interface CreateDeliveryStreamInput {
3270
3345
  IcebergDestinationConfiguration?: IcebergDestinationConfiguration | undefined;
3271
3346
  /**
3272
3347
  * <p>
3348
+ * The top level object for configuring streams with database as a source.
3273
3349
  * </p>
3274
3350
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
3275
3351
  * @public
@@ -3411,6 +3487,7 @@ export declare const SnapshotStatus: {
3411
3487
  export type SnapshotStatus = (typeof SnapshotStatus)[keyof typeof SnapshotStatus];
3412
3488
  /**
3413
3489
  * <p>
3490
+ * The structure that describes the snapshot information of a table in source database endpoint that Firehose reads.
3414
3491
  * </p>
3415
3492
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
3416
3493
  * @public
@@ -3418,6 +3495,7 @@ export type SnapshotStatus = (typeof SnapshotStatus)[keyof typeof SnapshotStatus
3418
3495
  export interface DatabaseSnapshotInfo {
3419
3496
  /**
3420
3497
  * <p>
3498
+ * The identifier of the current snapshot of the table in source database endpoint.
3421
3499
  * </p>
3422
3500
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
3423
3501
  * @public
@@ -3425,6 +3503,7 @@ export interface DatabaseSnapshotInfo {
3425
3503
  Id: string | undefined;
3426
3504
  /**
3427
3505
  * <p>
3506
+ * The fully qualified name of the table in source database endpoint that Firehose reads.
3428
3507
  * </p>
3429
3508
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
3430
3509
  * @public
@@ -3432,6 +3511,7 @@ export interface DatabaseSnapshotInfo {
3432
3511
  Table: string | undefined;
3433
3512
  /**
3434
3513
  * <p>
3514
+ * The timestamp when the current snapshot is taken on the table.
3435
3515
  * </p>
3436
3516
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
3437
3517
  * @public
@@ -3439,6 +3519,7 @@ export interface DatabaseSnapshotInfo {
3439
3519
  RequestTimestamp: Date | undefined;
3440
3520
  /**
3441
3521
  * <p>
3522
+ * The principal that sent the request to take the current snapshot on the table.
3442
3523
  * </p>
3443
3524
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
3444
3525
  * @public
@@ -3446,6 +3527,7 @@ export interface DatabaseSnapshotInfo {
3446
3527
  RequestedBy: SnapshotRequestedBy | undefined;
3447
3528
  /**
3448
3529
  * <p>
3530
+ * The status of the current snapshot of the table.
3449
3531
  * </p>
3450
3532
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
3451
3533
  * @public
@@ -3461,34 +3543,51 @@ export interface DatabaseSnapshotInfo {
3461
3543
  }
3462
3544
  /**
3463
3545
  * <p>
3546
+ * The top level object for database source description.
3464
3547
  * </p>
3465
3548
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
3466
3549
  * @public
3467
3550
  */
3468
3551
  export interface DatabaseSourceDescription {
3469
3552
  /**
3470
- * <p>
3471
- * </p>
3553
+ * <p>The type of database engine. This can be one of the following values. </p>
3554
+ * <ul>
3555
+ * <li>
3556
+ * <p>MySQL</p>
3557
+ * </li>
3558
+ * <li>
3559
+ * <p>PostgreSQL</p>
3560
+ * </li>
3561
+ * </ul>
3472
3562
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
3473
3563
  * @public
3474
3564
  */
3475
3565
  Type?: DatabaseType | undefined;
3476
3566
  /**
3477
3567
  * <p>
3568
+ * The endpoint of the database server.
3478
3569
  * </p>
3479
3570
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
3480
3571
  * @public
3481
3572
  */
3482
3573
  Endpoint?: string | undefined;
3483
3574
  /**
3484
- * <p>
3485
- * </p>
3575
+ * <p>The port of the database. This can be one of the following values.</p>
3576
+ * <ul>
3577
+ * <li>
3578
+ * <p>3306 for MySQL database type</p>
3579
+ * </li>
3580
+ * <li>
3581
+ * <p>5432 for PostgreSQL database type</p>
3582
+ * </li>
3583
+ * </ul>
3486
3584
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
3487
3585
  * @public
3488
3586
  */
3489
3587
  Port?: number | undefined;
3490
3588
  /**
3491
3589
  * <p>
3590
+ * The mode to enable or disable SSL when Firehose connects to the database endpoint.
3492
3591
  * </p>
3493
3592
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
3494
3593
  * @public
@@ -3496,6 +3595,7 @@ export interface DatabaseSourceDescription {
3496
3595
  SSLMode?: SSLMode | undefined;
3497
3596
  /**
3498
3597
  * <p>
3598
+ * The list of database patterns in source database endpoint for Firehose to read from.
3499
3599
  * </p>
3500
3600
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
3501
3601
  * @public
@@ -3503,6 +3603,7 @@ export interface DatabaseSourceDescription {
3503
3603
  Databases?: DatabaseList | undefined;
3504
3604
  /**
3505
3605
  * <p>
3606
+ * The list of table patterns in source database endpoint for Firehose to read from.
3506
3607
  * </p>
3507
3608
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
3508
3609
  * @public
@@ -3510,6 +3611,7 @@ export interface DatabaseSourceDescription {
3510
3611
  Tables?: DatabaseTableList | undefined;
3511
3612
  /**
3512
3613
  * <p>
3614
+ * The list of column patterns in source database endpoint for Firehose to read from.
3513
3615
  * </p>
3514
3616
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
3515
3617
  * @public
@@ -3517,6 +3619,7 @@ export interface DatabaseSourceDescription {
3517
3619
  Columns?: DatabaseColumnList | undefined;
3518
3620
  /**
3519
3621
  * <p>
3622
+ * The optional list of table and column names used as unique key columns when taking snapshot if the tables don’t have primary keys configured.
3520
3623
  * </p>
3521
3624
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
3522
3625
  * @public
@@ -3524,6 +3627,7 @@ export interface DatabaseSourceDescription {
3524
3627
  SurrogateKeys?: string[] | undefined;
3525
3628
  /**
3526
3629
  * <p>
3630
+ * The fully qualified name of the table in source database endpoint that Firehose uses to track snapshot progress.
3527
3631
  * </p>
3528
3632
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
3529
3633
  * @public
@@ -3531,6 +3635,7 @@ export interface DatabaseSourceDescription {
3531
3635
  SnapshotWatermarkTable?: string | undefined;
3532
3636
  /**
3533
3637
  * <p>
3638
+ * The structure that describes the snapshot information of a table in source database endpoint that Firehose reads.
3534
3639
  * </p>
3535
3640
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
3536
3641
  * @public
@@ -3538,6 +3643,7 @@ export interface DatabaseSourceDescription {
3538
3643
  SnapshotInfo?: DatabaseSnapshotInfo[] | undefined;
3539
3644
  /**
3540
3645
  * <p>
3646
+ * The structure to configure the authentication methods for Firehose to connect to source database endpoint.
3541
3647
  * </p>
3542
3648
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
3543
3649
  * @public
@@ -3545,6 +3651,7 @@ export interface DatabaseSourceDescription {
3545
3651
  DatabaseSourceAuthenticationConfiguration?: DatabaseSourceAuthenticationConfiguration | undefined;
3546
3652
  /**
3547
3653
  * <p>
3654
+ * The details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database.
3548
3655
  * </p>
3549
3656
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
3550
3657
  * @public
@@ -3659,7 +3766,7 @@ export declare const DeliveryStreamStatus: {
3659
3766
  */
3660
3767
  export type DeliveryStreamStatus = (typeof DeliveryStreamStatus)[keyof typeof DeliveryStreamStatus];
3661
3768
  /**
3662
- * <p>The destination description in Amazon ES.</p>
3769
+ * <p>The destination description in Amazon OpenSearch Service.</p>
3663
3770
  * @public
3664
3771
  */
3665
3772
  export interface ElasticsearchDestinationDescription {
@@ -3671,17 +3778,17 @@ export interface ElasticsearchDestinationDescription {
3671
3778
  */
3672
3779
  RoleARN?: string | undefined;
3673
3780
  /**
3674
- * <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
3781
+ * <p>The ARN of the Amazon OpenSearch Service domain. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
3675
3782
  * Resource Names (ARNs) and Amazon Web Services Service Namespaces</a>.</p>
3676
3783
  * <p>Firehose uses either <code>ClusterEndpoint</code> or <code>DomainARN</code>
3677
- * to send data to Amazon ES.</p>
3784
+ * to send data to Amazon OpenSearch Service.</p>
3678
3785
  * @public
3679
3786
  */
3680
3787
  DomainARN?: string | undefined;
3681
3788
  /**
3682
3789
  * <p>The endpoint to use when communicating with the cluster. Firehose uses
3683
3790
  * either this <code>ClusterEndpoint</code> or the <code>DomainARN</code> field to send data
3684
- * to Amazon ES.</p>
3791
+ * to Amazon OpenSearch Service.</p>
3685
3792
  * @public
3686
3793
  */
3687
3794
  ClusterEndpoint?: string | undefined;
@@ -3708,7 +3815,7 @@ export interface ElasticsearchDestinationDescription {
3708
3815
  */
3709
3816
  BufferingHints?: ElasticsearchBufferingHints | undefined;
3710
3817
  /**
3711
- * <p>The Amazon ES retry options.</p>
3818
+ * <p>The Amazon OpenSearch Service retry options.</p>
3712
3819
  * @public
3713
3820
  */
3714
3821
  RetryOptions?: ElasticsearchRetryOptions | undefined;
@@ -3938,14 +4045,14 @@ export interface IcebergDestinationDescription {
3938
4045
  */
3939
4046
  DestinationTableConfigurationList?: DestinationTableConfiguration[] | undefined;
3940
4047
  /**
3941
- * <p>
3942
- * </p>
4048
+ * <p>The description of automatic schema evolution configuration.</p>
3943
4049
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
3944
4050
  * @public
3945
4051
  */
3946
4052
  SchemaEvolutionConfiguration?: SchemaEvolutionConfiguration | undefined;
3947
4053
  /**
3948
4054
  * <p>
4055
+ * The description of table creation configuration.
3949
4056
  * </p>
3950
4057
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
3951
4058
  * @public
@@ -3988,6 +4095,18 @@ export interface IcebergDestinationDescription {
3988
4095
  * @public
3989
4096
  */
3990
4097
  RoleARN?: string | undefined;
4098
+ /**
4099
+ * <p> Describes whether all incoming data for this delivery stream will be append only
4100
+ * (inserts only and not for updates and deletes) for Iceberg delivery. This feature is only
4101
+ * applicable for Apache Iceberg Tables.</p>
4102
+ * <p>The default value is false. If you set this value to true, Firehose automatically
4103
+ * increases the throughput limit of a stream based on the throttling levels of the stream. If
4104
+ * you set this parameter to true for a stream with updates and deletes, you will see out of
4105
+ * order delivery.</p>
4106
+ * <p> </p>
4107
+ * @public
4108
+ */
4109
+ AppendOnly?: boolean | undefined;
3991
4110
  /**
3992
4111
  * <p>
3993
4112
  * Configuration describing where the destination Iceberg tables are persisted.
@@ -4269,7 +4388,7 @@ export interface DestinationDescription {
4269
4388
  */
4270
4389
  RedshiftDestinationDescription?: RedshiftDestinationDescription | undefined;
4271
4390
  /**
4272
- * <p>The destination in Amazon ES.</p>
4391
+ * <p>The destination in Amazon OpenSearch Service.</p>
4273
4392
  * @public
4274
4393
  */
4275
4394
  ElasticsearchDestinationDescription?: ElasticsearchDestinationDescription | undefined;
@@ -4306,9 +4425,22 @@ export interface DestinationDescription {
4306
4425
  */
4307
4426
  IcebergDestinationDescription?: IcebergDestinationDescription | undefined;
4308
4427
  }
4428
+ /**
4429
+ * <p>The structure that configures parameters such as <code>ThroughputHintInMBs</code> for a stream configured with
4430
+ * Direct PUT as a source. </p>
4431
+ * @public
4432
+ */
4433
+ export interface DirectPutSourceDescription {
4434
+ /**
4435
+ * <p> The value that you configure for this parameter is for information purpose only and
4436
+ * does not affect Firehose delivery throughput limit. You can use the <a href="https://support.console.aws.amazon.com/support/home#/case/create%3FissueType=service-limit-increase%26limitType=kinesis-firehose-limits">Firehose Limits form</a> to request a throughput limit increase. </p>
4437
+ * @public
4438
+ */
4439
+ ThroughputHintInMBs?: number | undefined;
4440
+ }
4309
4441
  /**
4310
4442
  * <p>Details about a Kinesis data stream used as the source for a Firehose
4311
- * Firehose stream.</p>
4443
+ * stream.</p>
4312
4444
  * @public
4313
4445
  */
4314
4446
  export interface KinesisStreamSourceDescription {
@@ -4334,8 +4466,7 @@ export interface KinesisStreamSourceDescription {
4334
4466
  DeliveryStartTimestamp?: Date | undefined;
4335
4467
  }
4336
4468
  /**
4337
- * <p>Details about the Amazon MSK cluster used as the source for a Firehose
4338
- * Firehose stream.</p>
4469
+ * <p>Details about the Amazon MSK cluster used as the source for a Firehose stream.</p>
4339
4470
  * @public
4340
4471
  */
4341
4472
  export interface MSKSourceDescription {
@@ -4372,10 +4503,16 @@ export interface MSKSourceDescription {
4372
4503
  }
4373
4504
  /**
4374
4505
  * <p>Details about a Kinesis data stream used as the source for a Firehose
4375
- * Firehose stream.</p>
4506
+ * stream.</p>
4376
4507
  * @public
4377
4508
  */
4378
4509
  export interface SourceDescription {
4510
+ /**
4511
+ * <p>Details about Direct PUT used as the source for a Firehose stream.
4512
+ * </p>
4513
+ * @public
4514
+ */
4515
+ DirectPutSourceDescription?: DirectPutSourceDescription | undefined;
4379
4516
  /**
4380
4517
  * <p>The <a>KinesisStreamSourceDescription</a> value for the source Kinesis
4381
4518
  * data stream.</p>
@@ -4389,8 +4526,7 @@ export interface SourceDescription {
4389
4526
  */
4390
4527
  MSKSourceDescription?: MSKSourceDescription | undefined;
4391
4528
  /**
4392
- * <p>
4393
- * </p>
4529
+ * <p>Details about a database used as the source for a Firehose stream.</p>
4394
4530
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
4395
4531
  * @public
4396
4532
  */
@@ -4517,20 +4653,20 @@ export interface DescribeDeliveryStreamOutput {
4517
4653
  DeliveryStreamDescription: DeliveryStreamDescription | undefined;
4518
4654
  }
4519
4655
  /**
4520
- * <p>Describes an update for a destination in Amazon ES.</p>
4656
+ * <p>Describes an update for a destination in Amazon OpenSearch Service.</p>
4521
4657
  * @public
4522
4658
  */
4523
4659
  export interface ElasticsearchDestinationUpdate {
4524
4660
  /**
4525
4661
  * <p>The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose
4526
- * for calling the Amazon ES Configuration API and for indexing documents. For more
4662
+ * for calling the Amazon OpenSearch Service Configuration API and for indexing documents. For more
4527
4663
  * information, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3">Grant 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
4528
4664
  * Amazon Web Services Service Namespaces</a>.</p>
4529
4665
  * @public
4530
4666
  */
4531
4667
  RoleARN?: string | undefined;
4532
4668
  /**
4533
- * <p>The ARN of the Amazon ES domain. The IAM role must have permissions
4669
+ * <p>The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions
4534
4670
  * for <code>DescribeDomain</code>, <code>DescribeDomains</code>, and
4535
4671
  * <code>DescribeDomainConfig</code> after assuming the IAM role specified in
4536
4672
  * <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
@@ -4565,7 +4701,7 @@ export interface ElasticsearchDestinationUpdate {
4565
4701
  * <p>The Elasticsearch index rotation period. Index rotation appends a timestamp to
4566
4702
  * <code>IndexName</code> to facilitate the expiration of old data. For more information,
4567
4703
  * see <a href="https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation">Index Rotation for the
4568
- * Amazon ES Destination</a>. Default value is <code>OneDay</code>.</p>
4704
+ * Amazon OpenSearch Service Destination</a>. Default value is <code>OneDay</code>.</p>
4569
4705
  * @public
4570
4706
  */
4571
4707
  IndexRotationPeriod?: ElasticsearchIndexRotationPeriod | undefined;
@@ -4577,7 +4713,7 @@ export interface ElasticsearchDestinationUpdate {
4577
4713
  BufferingHints?: ElasticsearchBufferingHints | undefined;
4578
4714
  /**
4579
4715
  * <p>The retry behavior in case Firehose is unable to deliver documents to
4580
- * Amazon ES. The default value is 300 (5 minutes).</p>
4716
+ * Amazon OpenSearch Service. The default value is 300 (5 minutes).</p>
4581
4717
  * @public
4582
4718
  */
4583
4719
  RetryOptions?: ElasticsearchRetryOptions | undefined;
@@ -5090,6 +5226,7 @@ export interface IcebergDestinationUpdate {
5090
5226
  DestinationTableConfigurationList?: DestinationTableConfiguration[] | undefined;
5091
5227
  /**
5092
5228
  * <p>
5229
+ * The configuration to enable automatic schema evolution.
5093
5230
  * </p>
5094
5231
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
5095
5232
  * @public
@@ -5097,6 +5234,7 @@ export interface IcebergDestinationUpdate {
5097
5234
  SchemaEvolutionConfiguration?: SchemaEvolutionConfiguration | undefined;
5098
5235
  /**
5099
5236
  * <p>
5237
+ * The configuration to enable automatic table creation.
5100
5238
  * </p>
5101
5239
  * <p>Amazon Data Firehose is in preview release and is subject to change.</p>
5102
5240
  * @public
@@ -5139,6 +5277,17 @@ export interface IcebergDestinationUpdate {
5139
5277
  * @public
5140
5278
  */
5141
5279
  RoleARN?: string | undefined;
5280
+ /**
5281
+ * <p> Describes whether all incoming data for this delivery stream will be append only
5282
+ * (inserts only and not for updates and deletes) for Iceberg delivery. This feature is only
5283
+ * applicable for Apache Iceberg Tables. </p>
5284
+ * <p>The default value is false. If you set this value to true, Firehose automatically
5285
+ * increases the throughput limit of a stream based on the throttling levels of the stream. If
5286
+ * you set this parameter to true for a stream with updates and deletes, you will see out of
5287
+ * order delivery. </p>
5288
+ * @public
5289
+ */
5290
+ AppendOnly?: boolean | undefined;
5142
5291
  /**
5143
5292
  * <p>
5144
5293
  * Configuration describing where the destination Iceberg tables are persisted.
@@ -5460,7 +5609,7 @@ export interface UpdateDestinationInput {
5460
5609
  */
5461
5610
  RedshiftDestinationUpdate?: RedshiftDestinationUpdate | undefined;
5462
5611
  /**
5463
- * <p>Describes an update for a destination in Amazon ES.</p>
5612
+ * <p>Describes an update for a destination in Amazon OpenSearch Service.</p>
5464
5613
  * @public
5465
5614
  */
5466
5615
  ElasticsearchDestinationUpdate?: ElasticsearchDestinationUpdate | undefined;
@@ -330,6 +330,9 @@ export declare const DeliveryStreamType: {
330
330
  };
331
331
  export type DeliveryStreamType =
332
332
  (typeof DeliveryStreamType)[keyof typeof DeliveryStreamType];
333
+ export interface DirectPutSourceConfiguration {
334
+ ThroughputHintInMBs: number | undefined;
335
+ }
333
336
  export interface ElasticsearchBufferingHints {
334
337
  IntervalInSeconds?: number | undefined;
335
338
  SizeInMBs?: number | undefined;
@@ -558,6 +561,7 @@ export interface IcebergDestinationConfiguration {
558
561
  S3BackupMode?: IcebergS3BackupMode | undefined;
559
562
  RetryOptions?: RetryOptions | undefined;
560
563
  RoleARN: string | undefined;
564
+ AppendOnly?: boolean | undefined;
561
565
  CatalogConfiguration: CatalogConfiguration | undefined;
562
566
  S3Configuration: S3DestinationConfiguration | undefined;
563
567
  }
@@ -682,6 +686,7 @@ export interface Tag {
682
686
  export interface CreateDeliveryStreamInput {
683
687
  DeliveryStreamName: string | undefined;
684
688
  DeliveryStreamType?: DeliveryStreamType | undefined;
689
+ DirectPutSourceConfiguration?: DirectPutSourceConfiguration | undefined;
685
690
  KinesisStreamSourceConfiguration?:
686
691
  | KinesisStreamSourceConfiguration
687
692
  | undefined;
@@ -912,6 +917,7 @@ export interface IcebergDestinationDescription {
912
917
  S3BackupMode?: IcebergS3BackupMode | undefined;
913
918
  RetryOptions?: RetryOptions | undefined;
914
919
  RoleARN?: string | undefined;
920
+ AppendOnly?: boolean | undefined;
915
921
  CatalogConfiguration?: CatalogConfiguration | undefined;
916
922
  S3DestinationDescription?: S3DestinationDescription | undefined;
917
923
  }
@@ -984,6 +990,9 @@ export interface DestinationDescription {
984
990
  | undefined;
985
991
  IcebergDestinationDescription?: IcebergDestinationDescription | undefined;
986
992
  }
993
+ export interface DirectPutSourceDescription {
994
+ ThroughputHintInMBs?: number | undefined;
995
+ }
987
996
  export interface KinesisStreamSourceDescription {
988
997
  KinesisStreamARN?: string | undefined;
989
998
  RoleARN?: string | undefined;
@@ -997,6 +1006,7 @@ export interface MSKSourceDescription {
997
1006
  ReadFromTimestamp?: Date | undefined;
998
1007
  }
999
1008
  export interface SourceDescription {
1009
+ DirectPutSourceDescription?: DirectPutSourceDescription | undefined;
1000
1010
  KinesisStreamSourceDescription?: KinesisStreamSourceDescription | undefined;
1001
1011
  MSKSourceDescription?: MSKSourceDescription | undefined;
1002
1012
  DatabaseSourceDescription?: DatabaseSourceDescription | undefined;
@@ -1163,6 +1173,7 @@ export interface IcebergDestinationUpdate {
1163
1173
  S3BackupMode?: IcebergS3BackupMode | undefined;
1164
1174
  RetryOptions?: RetryOptions | undefined;
1165
1175
  RoleARN?: string | undefined;
1176
+ AppendOnly?: boolean | undefined;
1166
1177
  CatalogConfiguration?: CatalogConfiguration | undefined;
1167
1178
  S3Configuration?: S3DestinationConfiguration | undefined;
1168
1179
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-firehose",
3
3
  "description": "AWS SDK for JavaScript Firehose Client for Node.js, Browser and React Native",
4
- "version": "3.734.0",
4
+ "version": "3.737.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-firehose",