From 446f685affb6bd97f381b5e6d832a576942916df Mon Sep 17 00:00:00 2001 From: awstools Date: Tue, 28 Jan 2025 19:12:54 +0000 Subject: [PATCH] feat(client-firehose): For AppendOnly streams, Firehose will automatically scale to match your throughput. --- .../commands/CreateDeliveryStreamCommand.ts | 4 + .../commands/DescribeDeliveryStreamCommand.ts | 4 + .../src/commands/UpdateDestinationCommand.ts | 1 + .../client-firehose/src/models/models_0.ts | 348 +++++++++++++----- .../src/protocols/Aws_json1_1.ts | 7 + codegen/sdk-codegen/aws-models/firehose.json | 262 ++++++++----- 6 files changed, 433 insertions(+), 193 deletions(-) diff --git a/clients/client-firehose/src/commands/CreateDeliveryStreamCommand.ts b/clients/client-firehose/src/commands/CreateDeliveryStreamCommand.ts index 26441eabbeb82..b5e5bdadeab82 100644 --- a/clients/client-firehose/src/commands/CreateDeliveryStreamCommand.ts +++ b/clients/client-firehose/src/commands/CreateDeliveryStreamCommand.ts @@ -108,6 +108,9 @@ export interface CreateDeliveryStreamCommandOutput extends CreateDeliveryStreamO * const input = { // CreateDeliveryStreamInput * DeliveryStreamName: "STRING_VALUE", // required * DeliveryStreamType: "DirectPut" || "KinesisStreamAsSource" || "MSKAsSource" || "DatabaseAsSource", + * DirectPutSourceConfiguration: { // DirectPutSourceConfiguration + * ThroughputHintInMBs: Number("int"), // required + * }, * KinesisStreamSourceConfiguration: { // KinesisStreamSourceConfiguration * KinesisStreamARN: "STRING_VALUE", // required * RoleARN: "STRING_VALUE", // required @@ -610,6 +613,7 @@ export interface CreateDeliveryStreamCommandOutput extends CreateDeliveryStreamO * DurationInSeconds: Number("int"), * }, * RoleARN: "STRING_VALUE", // required + * AppendOnly: true || false, * CatalogConfiguration: { // CatalogConfiguration * CatalogARN: "STRING_VALUE", * WarehouseLocation: "STRING_VALUE", diff --git a/clients/client-firehose/src/commands/DescribeDeliveryStreamCommand.ts b/clients/client-firehose/src/commands/DescribeDeliveryStreamCommand.ts index db0ca5f12343a..f500eb0e2cbbb 100644 --- a/clients/client-firehose/src/commands/DescribeDeliveryStreamCommand.ts +++ b/clients/client-firehose/src/commands/DescribeDeliveryStreamCommand.ts @@ -75,6 +75,9 @@ export interface DescribeDeliveryStreamCommandOutput extends DescribeDeliveryStr * // CreateTimestamp: new Date("TIMESTAMP"), * // LastUpdateTimestamp: new Date("TIMESTAMP"), * // Source: { // SourceDescription + * // DirectPutSourceDescription: { // DirectPutSourceDescription + * // ThroughputHintInMBs: Number("int"), + * // }, * // KinesisStreamSourceDescription: { // KinesisStreamSourceDescription * // KinesisStreamARN: "STRING_VALUE", * // RoleARN: "STRING_VALUE", @@ -626,6 +629,7 @@ export interface DescribeDeliveryStreamCommandOutput extends DescribeDeliveryStr * // DurationInSeconds: Number("int"), * // }, * // RoleARN: "STRING_VALUE", + * // AppendOnly: true || false, * // CatalogConfiguration: { // CatalogConfiguration * // CatalogARN: "STRING_VALUE", * // WarehouseLocation: "STRING_VALUE", diff --git a/clients/client-firehose/src/commands/UpdateDestinationCommand.ts b/clients/client-firehose/src/commands/UpdateDestinationCommand.ts index 0ddd92e396f6d..02714c237924a 100644 --- a/clients/client-firehose/src/commands/UpdateDestinationCommand.ts +++ b/clients/client-firehose/src/commands/UpdateDestinationCommand.ts @@ -511,6 +511,7 @@ export interface UpdateDestinationCommandOutput extends UpdateDestinationOutput, * DurationInSeconds: Number("int"), * }, * RoleARN: "STRING_VALUE", + * AppendOnly: true || false, * CatalogConfiguration: { // CatalogConfiguration * CatalogARN: "STRING_VALUE", * WarehouseLocation: "STRING_VALUE", diff --git a/clients/client-firehose/src/models/models_0.ts b/clients/client-firehose/src/models/models_0.ts index 6463d64e6d9e2..ad04219f79b6f 100644 --- a/clients/client-firehose/src/models/models_0.ts +++ b/clients/client-firehose/src/models/models_0.ts @@ -356,9 +356,9 @@ export interface S3DestinationConfiguration { export interface VpcConfiguration { /** *

The IDs of the subnets that you want Firehose to use to create ENIs in the - * VPC of the Amazon ES destination. Make sure that the routing tables and inbound and + * VPC of the Amazon OpenSearch Service destination. Make sure that the routing tables and inbound and * outbound rules allow traffic to flow from the subnets whose IDs are specified here to the - * subnets that have the destination Amazon ES endpoints. Firehose creates at + * subnets that have the destination Amazon OpenSearch Service endpoints. Firehose creates at * least one ENI in each of the subnets that are specified here. Do not delete or modify these * ENIs.

*

The number of ENIs that Firehose creates in the subnets specified here @@ -427,12 +427,12 @@ export interface VpcConfiguration { /** *

The IDs of the security groups that you want Firehose to use when it - * creates ENIs in the VPC of the Amazon ES destination. You can use the same security group - * that the Amazon ES domain uses or different ones. If you specify different security groups - * here, ensure that they allow outbound HTTPS traffic to the Amazon ES domain's security - * group. Also ensure that the Amazon ES domain's security group allows HTTPS traffic from the + * creates ENIs in the VPC of the Amazon OpenSearch Service destination. You can use the same security group + * that the Amazon OpenSearch Service domain uses or different ones. If you specify different security groups + * here, ensure that they allow outbound HTTPS traffic to the Amazon OpenSearch Service domain's security + * group. Also ensure that the Amazon OpenSearch Service domain's security group allows HTTPS traffic from the * security groups specified here. If you use the same security group for both your delivery - * stream and the Amazon ES domain, make sure the security group inbound rule allows HTTPS + * stream and the Amazon OpenSearch Service domain, make sure the security group inbound rule allows HTTPS * traffic. For more information about security group rules, see Security group * rules in the Amazon VPC documentation.

* @public @@ -585,15 +585,15 @@ export interface S3DestinationDescription { } /** - *

The details of the VPC of the Amazon ES destination.

+ *

The details of the VPC of the Amazon OpenSearch Service destination.

* @public */ export interface VpcConfigurationDescription { /** *

The IDs of the subnets that Firehose uses to create ENIs in the VPC of the - * Amazon ES destination. Make sure that the routing tables and inbound and outbound rules + * Amazon OpenSearch Service destination. Make sure that the routing tables and inbound and outbound rules * allow traffic to flow from the subnets whose IDs are specified here to the subnets that - * have the destination Amazon ES endpoints. Firehose creates at least one ENI in + * have the destination Amazon OpenSearch Service endpoints. Firehose creates at least one ENI in * each of the subnets that are specified here. Do not delete or modify these ENIs.

*

The number of ENIs that Firehose creates in the subnets specified here * scales up and down automatically based on throughput. To enable Firehose to @@ -660,12 +660,12 @@ export interface VpcConfigurationDescription { /** *

The IDs of the security groups that Firehose uses when it creates ENIs in - * the VPC of the Amazon ES destination. You can use the same security group that the Amazon + * the VPC of the Amazon OpenSearch Service destination. You can use the same security group that the Amazon * ES domain uses or different ones. If you specify different security groups, ensure that - * they allow outbound HTTPS traffic to the Amazon ES domain's security group. Also ensure - * that the Amazon ES domain's security group allows HTTPS traffic from the security groups + * they allow outbound HTTPS traffic to the Amazon OpenSearch Service domain's security group. Also ensure + * that the Amazon OpenSearch Service domain's security group allows HTTPS traffic from the security groups * specified here. If you use the same security group for both your Firehose stream and the - * Amazon ES domain, make sure the security group inbound rule allows HTTPS traffic. For more + * Amazon OpenSearch Service domain, make sure the security group inbound rule allows HTTPS traffic. For more * information about security group rules, see Security group * rules in the Amazon VPC documentation.

* @public @@ -673,7 +673,7 @@ export interface VpcConfigurationDescription { SecurityGroupIds: string[] | undefined; /** - *

The ID of the Amazon ES destination's VPC.

+ *

The ID of the Amazon OpenSearch Service destination's VPC.

* @public */ VpcId: string | undefined; @@ -741,7 +741,7 @@ export interface AmazonOpenSearchServerlessDestinationDescription { CloudWatchLoggingOptions?: CloudWatchLoggingOptions | undefined; /** - *

The details of the VPC of the Amazon ES destination.

+ *

The details of the VPC of the Amazon OpenSearch Service destination.

* @public */ VpcConfigurationDescription?: VpcConfigurationDescription | undefined; @@ -1173,7 +1173,7 @@ export interface AmazonopensearchserviceDestinationDescription { CloudWatchLoggingOptions?: CloudWatchLoggingOptions | undefined; /** - *

The details of the VPC of the Amazon ES destination.

+ *

The details of the VPC of the Amazon OpenSearch Service destination.

* @public */ VpcConfigurationDescription?: VpcConfigurationDescription | undefined; @@ -1325,8 +1325,8 @@ export interface CatalogConfiguration { CatalogARN?: string | undefined; /** - *

- *

+ *

The warehouse location for Apache Iceberg tables. You must configure this when schema + * evolution and table creation is enabled.

*

Amazon Data Firehose is in preview release and is subject to change.

* @public */ @@ -1412,14 +1412,15 @@ export interface CopyCommand { } /** - *

- *

+ *

The structure used to configure the list of column patterns in source database + * endpoint for Firehose to read from.

*

Amazon Data Firehose is in preview release and is subject to change.

* @public */ export interface DatabaseColumnList { /** *

+ * The list of column patterns in source database to be included for Firehose to read from. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -1428,6 +1429,7 @@ export interface DatabaseColumnList { /** *

+ * The list of column patterns in source database to be excluded for Firehose to read from. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -1436,23 +1438,23 @@ export interface DatabaseColumnList { } /** - *

- *

+ *

The structure used to configure the list of database patterns in source database + * endpoint for Firehose to read from.

*

Amazon Data Firehose is in preview release and is subject to change.

* @public */ export interface DatabaseList { /** - *

- *

+ *

The list of database patterns in source database endpoint to be included for Firehose + * to read from.

*

Amazon Data Firehose is in preview release and is subject to change.

* @public */ Include?: string[] | undefined; /** - *

- *

+ *

The list of database patterns in source database endpoint to be excluded for Firehose + * to read from.

*

Amazon Data Firehose is in preview release and is subject to change.

* @public */ @@ -1491,6 +1493,7 @@ export interface SecretsManagerConfiguration { /** *

+ * The structure to configure the authentication methods for Firehose to connect to source database endpoint. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -1505,6 +1508,7 @@ export interface DatabaseSourceAuthenticationConfiguration { /** *

+ * The structure for details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -1512,6 +1516,7 @@ export interface DatabaseSourceAuthenticationConfiguration { export interface DatabaseSourceVPCConfiguration { /** *

+ * The VPC endpoint service name which Firehose uses to create a PrivateLink to the database. The endpoint service must have the Firehose service principle firehose.amazonaws.com as an allowed principal on the VPC endpoint service. The VPC endpoint service name is a string that looks like com.amazonaws.vpce... *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -1534,23 +1539,23 @@ export const SSLMode = { export type SSLMode = (typeof SSLMode)[keyof typeof SSLMode]; /** - *

- *

+ *

The structure used to configure the list of table patterns in source database endpoint + * for Firehose to read from.

*

Amazon Data Firehose is in preview release and is subject to change.

* @public */ export interface DatabaseTableList { /** - *

- *

+ *

The list of table patterns in source database endpoint to be included for Firehose to + * read from.

*

Amazon Data Firehose is in preview release and is subject to change.

* @public */ Include?: string[] | undefined; /** - *

- *

+ *

The list of table patterns in source database endpoint to be excluded for Firehose to + * read from.

*

Amazon Data Firehose is in preview release and is subject to change.

* @public */ @@ -1573,14 +1578,22 @@ export type DatabaseType = (typeof DatabaseType)[keyof typeof DatabaseType]; /** *

+ * The top level object for configuring streams with database as a source. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public */ export interface DatabaseSourceConfiguration { /** - *

- *

+ *

The type of database engine. This can be one of the following values.

+ * *

Amazon Data Firehose is in preview release and is subject to change.

* @public */ @@ -1588,6 +1601,7 @@ export interface DatabaseSourceConfiguration { /** *

+ * The endpoint of the database server. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -1595,8 +1609,15 @@ export interface DatabaseSourceConfiguration { Endpoint: string | undefined; /** - *

- *

+ *

The port of the database. This can be one of the following values.

+ * *

Amazon Data Firehose is in preview release and is subject to change.

* @public */ @@ -1604,6 +1625,7 @@ export interface DatabaseSourceConfiguration { /** *

+ * The mode to enable or disable SSL when Firehose connects to the database endpoint. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -1612,6 +1634,7 @@ export interface DatabaseSourceConfiguration { /** *

+ * The list of database patterns in source database endpoint for Firehose to read from. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -1620,6 +1643,7 @@ export interface DatabaseSourceConfiguration { /** *

+ * The list of table patterns in source database endpoint for Firehose to read from. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -1628,6 +1652,7 @@ export interface DatabaseSourceConfiguration { /** *

+ * The list of column patterns in source database endpoint for Firehose to read from. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -1636,6 +1661,7 @@ export interface DatabaseSourceConfiguration { /** *

+ * 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. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -1644,6 +1670,7 @@ export interface DatabaseSourceConfiguration { /** *

+ * The fully qualified name of the table in source database endpoint that Firehose uses to track snapshot progress. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -1652,6 +1679,7 @@ export interface DatabaseSourceConfiguration { /** *

+ * The structure to configure the authentication methods for Firehose to connect to source database endpoint. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -1660,6 +1688,7 @@ export interface DatabaseSourceConfiguration { /** *

+ * The details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -1737,7 +1766,21 @@ export const DeliveryStreamType = { export type DeliveryStreamType = (typeof DeliveryStreamType)[keyof typeof DeliveryStreamType]; /** - *

Describes the buffering to perform before delivering data to the Amazon ES + *

The structure that configures parameters such as ThroughputHintInMBs for a stream configured with + * Direct PUT as a source.

+ * @public + */ +export interface DirectPutSourceConfiguration { + /** + *

The value that you configure for this parameter is for information purpose only and + * does not affect Firehose delivery throughput limit. You can use the Firehose Limits form to request a throughput limit increase.

+ * @public + */ + ThroughputHintInMBs: number | undefined; +} + +/** + *

Describes the buffering to perform before delivering data to the Amazon OpenSearch Service * destination.

* @public */ @@ -1780,12 +1823,12 @@ export type ElasticsearchIndexRotationPeriod = /** *

Configures retry behavior in case Firehose is unable to deliver - * documents to Amazon ES.

+ * documents to Amazon OpenSearch Service.

* @public */ export interface ElasticsearchRetryOptions { /** - *

After an initial failure to deliver to Amazon ES, the total amount of time during + *

After an initial failure to deliver to Amazon OpenSearch Service, the total amount of time during * which Firehose retries delivery (including the first attempt). After this time * has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 * minutes). A value of 0 (zero) results in no retries.

@@ -1809,13 +1852,13 @@ export const ElasticsearchS3BackupMode = { export type ElasticsearchS3BackupMode = (typeof ElasticsearchS3BackupMode)[keyof typeof ElasticsearchS3BackupMode]; /** - *

Describes the configuration of a destination in Amazon ES.

+ *

Describes the configuration of a destination in Amazon OpenSearch Service.

* @public */ export interface ElasticsearchDestinationConfiguration { /** *

The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose - * for calling the Amazon ES Configuration API and for indexing documents. For more + * for calling the Amazon OpenSearch Service Configuration API and for indexing documents. For more * information, see Grant Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and * Amazon Web Services Service Namespaces.

* @public @@ -1823,7 +1866,7 @@ export interface ElasticsearchDestinationConfiguration { RoleARN: string | undefined; /** - *

The ARN of the Amazon ES domain. The IAM role must have permissions + *

The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions * for DescribeDomain, DescribeDomains, and * DescribeDomainConfig after assuming the role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and * Amazon Web Services Service Namespaces.

@@ -1858,7 +1901,7 @@ export interface ElasticsearchDestinationConfiguration { *

The Elasticsearch index rotation period. Index rotation appends a timestamp to the * IndexName to facilitate the expiration of old data. For more information, * see Index Rotation for the - * Amazon ES Destination. The default value is OneDay.

+ * Amazon OpenSearch Service Destination. The default value is OneDay.

* @public */ IndexRotationPeriod?: ElasticsearchIndexRotationPeriod | undefined; @@ -1872,7 +1915,7 @@ export interface ElasticsearchDestinationConfiguration { /** *

The retry behavior in case Firehose is unable to deliver documents to - * Amazon ES. The default value is 300 (5 minutes).

+ * Amazon OpenSearch Service. The default value is 300 (5 minutes).

* @public */ RetryOptions?: ElasticsearchRetryOptions | undefined; @@ -1885,7 +1928,7 @@ export interface ElasticsearchDestinationConfiguration { * AllDocuments, Firehose delivers all incoming records to Amazon * S3, and also writes failed documents with AmazonOpenSearchService-failed/ * appended to the prefix. For more information, see Amazon S3 Backup for the - * Amazon ES Destination. Default value is + * Amazon OpenSearch Service Destination. Default value is * FailedDocumentsOnly.

*

You can't change this backup mode after you create the Firehose stream.

* @public @@ -2219,13 +2262,13 @@ export interface ParquetSerDe { /** *

The serializer that you want Firehose to use to convert data to the target * format before writing it to Amazon S3. Firehose supports two types of - * serializers: the ORC SerDe and the Parquet SerDe.

+ * serializers: the ORC SerDe and the Parquet SerDe.

* @public */ export interface Serializer { /** *

A serializer to use for converting data to the Parquet format before storing it in - * Amazon S3. For more information, see Apache Parquet.

+ * Amazon S3. For more information, see Apache Parquet.

* @public */ ParquetSerDe?: ParquetSerDe | undefined; @@ -2391,8 +2434,7 @@ export interface DynamicPartitioningConfiguration { RetryOptions?: RetryOptions | undefined; /** - *

Specifies that the dynamic partitioning is enabled for this Firehose - * Firehose stream.

+ *

Specifies that the dynamic partitioning is enabled for this Firehose stream.

* @public */ Enabled?: boolean | undefined; @@ -2731,14 +2773,14 @@ export interface HttpEndpointDestinationConfiguration { } /** - *

- *

+ *

Represents a single field in a PartitionSpec.

*

Amazon Data Firehose is in preview release and is subject to change.

* @public */ export interface PartitionField { /** *

+ * The column name to be configured in partition spec. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -2747,15 +2789,21 @@ export interface PartitionField { } /** - *

- *

+ *

Represents how to produce partition data for a table. Partition data is produced by + * transforming columns in a table. Each column transform is represented by a named + * PartitionField.

+ *

Here is an example of the schema in JSON.

+ *

+ * "partitionSpec": \{ "identity": [ \{"sourceName": "column1"\}, \{"sourceName": + * "column2"\}, \{"sourceName": "column3"\} ] \} + *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public */ export interface PartitionSpec { /** - *

- *

+ *

List of identity transforms that performs an identity transformation. The transform takes the + * source value, and does not modify it. Result type is the source type.

*

Amazon Data Firehose is in preview release and is subject to change.

* @public */ @@ -2795,8 +2843,8 @@ export interface DestinationTableConfiguration { UniqueKeys?: string[] | undefined; /** - *

- *

+ *

The partition spec configuration for a table that is used by automatic table + * creation.

*

Amazon Data Firehose is in preview release and is subject to change.

* @public */ @@ -2826,14 +2874,14 @@ export const IcebergS3BackupMode = { export type IcebergS3BackupMode = (typeof IcebergS3BackupMode)[keyof typeof IcebergS3BackupMode]; /** - *

- *

+ *

The configuration to enable schema evolution.

*

Amazon Data Firehose is in preview release and is subject to change.

* @public */ export interface SchemaEvolutionConfiguration { /** *

+ * Specify whether you want to enable schema evolution. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -2842,14 +2890,14 @@ export interface SchemaEvolutionConfiguration { } /** - *

- *

+ *

The configuration to enable automatic table creation.

*

Amazon Data Firehose is in preview release and is subject to change.

* @public */ export interface TableCreationConfiguration { /** *

+ * Specify whether you want to enable automatic table creation. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -2872,16 +2920,14 @@ export interface IcebergDestinationConfiguration { DestinationTableConfigurationList?: DestinationTableConfiguration[] | undefined; /** - *

- *

+ *

The configuration to enable automatic schema evolution.

*

Amazon Data Firehose is in preview release and is subject to change.

* @public */ SchemaEvolutionConfiguration?: SchemaEvolutionConfiguration | undefined; /** - *

- *

+ *

The configuration to enable automatic table creation.

*

Amazon Data Firehose is in preview release and is subject to change.

* @public */ @@ -2930,6 +2976,18 @@ export interface IcebergDestinationConfiguration { */ RoleARN: string | undefined; + /** + *

Describes whether all incoming data for this delivery stream will be append only + * (inserts only and not for updates and deletes) for Iceberg delivery. This feature is only + * applicable for Apache Iceberg Tables.

+ *

The default value is false. If you set this value to true, Firehose automatically + * increases the throughput limit of a stream based on the throttling levels of the stream. If + * you set this parameter to true for a stream with updates and deletes, you will see out of + * order delivery.

+ * @public + */ + AppendOnly?: boolean | undefined; + /** *

* Configuration describing where the destination Apache Iceberg Tables are persisted. @@ -3288,13 +3346,26 @@ export interface SnowflakeDestinationConfiguration { DataLoadingOption?: SnowflakeDataLoadingOption | undefined; /** - *

The name of the record metadata column

+ *

Specify a column name in the table, where the metadata information has to be loaded. + * When you enable this field, you will see the following column in the snowflake table, which + * differs based on the source type.

+ *

For Direct PUT as source

+ *

+ * \{ "firehoseDeliveryStreamName" : "streamname", "IngestionTime" : "timestamp" + * \} + *

+ *

For Kinesis Data Stream as source

+ *

+ * "kinesisStreamName" : "streamname", "kinesisShardId" : "Id", + * "kinesisPartitionKey" : "key", "kinesisSequenceNumber" : "1234", "subsequenceNumber" : + * "2334", "IngestionTime" : "timestamp" \} + *

* @public */ MetaDataColumnName?: string | undefined; /** - *

The name of the record content column

+ *

The name of the record content column.

* @public */ ContentColumnName?: string | undefined; @@ -3565,6 +3636,13 @@ export interface CreateDeliveryStreamInput { */ DeliveryStreamType?: DeliveryStreamType | undefined; + /** + *

The structure that configures parameters such as ThroughputHintInMBs for a + * stream configured with Direct PUT as a source.

+ * @public + */ + DirectPutSourceConfiguration?: DirectPutSourceConfiguration | undefined; + /** *

When a Kinesis data stream is used as the source for the Firehose stream, a KinesisStreamSourceConfiguration containing the Kinesis data stream Amazon * Resource Name (ARN) and the role ARN for the source stream.

@@ -3601,7 +3679,7 @@ export interface CreateDeliveryStreamInput { RedshiftDestinationConfiguration?: RedshiftDestinationConfiguration | undefined; /** - *

The destination in Amazon ES. You can specify only one destination.

+ *

The destination in Amazon OpenSearch Service. You can specify only one destination.

* @public */ ElasticsearchDestinationConfiguration?: ElasticsearchDestinationConfiguration | undefined; @@ -3637,9 +3715,9 @@ export interface CreateDeliveryStreamInput { *

If you specify tags in the CreateDeliveryStream action, Amazon Data * Firehose performs an additional authorization on the * firehose:TagDeliveryStream action to verify if users have permissions to - * create tags. If you do not provide this permission, requests to create new Firehose - * Firehose streams with IAM resource tags will fail with an - * AccessDeniedException such as following.

+ * create tags. If you do not provide this permission, requests to create new Firehose streams + * with IAM resource tags will fail with an AccessDeniedException such as + * following.

*

* AccessDeniedException *

@@ -3680,6 +3758,7 @@ export interface CreateDeliveryStreamInput { /** *

+ * The top level object for configuring streams with database as a source. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -3864,6 +3943,7 @@ export type SnapshotStatus = (typeof SnapshotStatus)[keyof typeof SnapshotStatus /** *

+ * The structure that describes the snapshot information of a table in source database endpoint that Firehose reads. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -3871,6 +3951,7 @@ export type SnapshotStatus = (typeof SnapshotStatus)[keyof typeof SnapshotStatus export interface DatabaseSnapshotInfo { /** *

+ * The identifier of the current snapshot of the table in source database endpoint. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -3879,6 +3960,7 @@ export interface DatabaseSnapshotInfo { /** *

+ * The fully qualified name of the table in source database endpoint that Firehose reads. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -3887,6 +3969,7 @@ export interface DatabaseSnapshotInfo { /** *

+ * The timestamp when the current snapshot is taken on the table. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -3895,6 +3978,7 @@ export interface DatabaseSnapshotInfo { /** *

+ * The principal that sent the request to take the current snapshot on the table. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -3903,6 +3987,7 @@ export interface DatabaseSnapshotInfo { /** *

+ * The status of the current snapshot of the table. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -3920,14 +4005,22 @@ export interface DatabaseSnapshotInfo { /** *

+ * The top level object for database source description. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public */ export interface DatabaseSourceDescription { /** - *

- *

+ *

The type of database engine. This can be one of the following values.

+ * *

Amazon Data Firehose is in preview release and is subject to change.

* @public */ @@ -3935,6 +4028,7 @@ export interface DatabaseSourceDescription { /** *

+ * The endpoint of the database server. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -3942,8 +4036,15 @@ export interface DatabaseSourceDescription { Endpoint?: string | undefined; /** - *

- *

+ *

The port of the database. This can be one of the following values.

+ * *

Amazon Data Firehose is in preview release and is subject to change.

* @public */ @@ -3951,6 +4052,7 @@ export interface DatabaseSourceDescription { /** *

+ * The mode to enable or disable SSL when Firehose connects to the database endpoint. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -3959,6 +4061,7 @@ export interface DatabaseSourceDescription { /** *

+ * The list of database patterns in source database endpoint for Firehose to read from. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -3967,6 +4070,7 @@ export interface DatabaseSourceDescription { /** *

+ * The list of table patterns in source database endpoint for Firehose to read from. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -3975,6 +4079,7 @@ export interface DatabaseSourceDescription { /** *

+ * The list of column patterns in source database endpoint for Firehose to read from. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -3983,6 +4088,7 @@ export interface DatabaseSourceDescription { /** *

+ * 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. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -3991,6 +4097,7 @@ export interface DatabaseSourceDescription { /** *

+ * The fully qualified name of the table in source database endpoint that Firehose uses to track snapshot progress. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -3999,6 +4106,7 @@ export interface DatabaseSourceDescription { /** *

+ * The structure that describes the snapshot information of a table in source database endpoint that Firehose reads. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -4007,6 +4115,7 @@ export interface DatabaseSourceDescription { /** *

+ * The structure to configure the authentication methods for Firehose to connect to source database endpoint. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -4015,6 +4124,7 @@ export interface DatabaseSourceDescription { /** *

+ * The details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -4149,7 +4259,7 @@ export const DeliveryStreamStatus = { export type DeliveryStreamStatus = (typeof DeliveryStreamStatus)[keyof typeof DeliveryStreamStatus]; /** - *

The destination description in Amazon ES.

+ *

The destination description in Amazon OpenSearch Service.

* @public */ export interface ElasticsearchDestinationDescription { @@ -4162,10 +4272,10 @@ export interface ElasticsearchDestinationDescription { RoleARN?: string | undefined; /** - *

The ARN of the Amazon ES domain. For more information, see Amazon + *

The ARN of the Amazon OpenSearch Service domain. For more information, see Amazon * Resource Names (ARNs) and Amazon Web Services Service Namespaces.

*

Firehose uses either ClusterEndpoint or DomainARN - * to send data to Amazon ES.

+ * to send data to Amazon OpenSearch Service.

* @public */ DomainARN?: string | undefined; @@ -4173,7 +4283,7 @@ export interface ElasticsearchDestinationDescription { /** *

The endpoint to use when communicating with the cluster. Firehose uses * either this ClusterEndpoint or the DomainARN field to send data - * to Amazon ES.

+ * to Amazon OpenSearch Service.

* @public */ ClusterEndpoint?: string | undefined; @@ -4205,7 +4315,7 @@ export interface ElasticsearchDestinationDescription { BufferingHints?: ElasticsearchBufferingHints | undefined; /** - *

The Amazon ES retry options.

+ *

The Amazon OpenSearch Service retry options.

* @public */ RetryOptions?: ElasticsearchRetryOptions | undefined; @@ -4470,8 +4580,7 @@ export interface IcebergDestinationDescription { DestinationTableConfigurationList?: DestinationTableConfiguration[] | undefined; /** - *

- *

+ *

The description of automatic schema evolution configuration.

*

Amazon Data Firehose is in preview release and is subject to change.

* @public */ @@ -4479,6 +4588,7 @@ export interface IcebergDestinationDescription { /** *

+ * The description of table creation configuration. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -4528,6 +4638,19 @@ export interface IcebergDestinationDescription { */ RoleARN?: string | undefined; + /** + *

Describes whether all incoming data for this delivery stream will be append only + * (inserts only and not for updates and deletes) for Iceberg delivery. This feature is only + * applicable for Apache Iceberg Tables.

+ *

The default value is false. If you set this value to true, Firehose automatically + * increases the throughput limit of a stream based on the throttling levels of the stream. If + * you set this parameter to true for a stream with updates and deletes, you will see out of + * order delivery.

+ *

+ * @public + */ + AppendOnly?: boolean | undefined; + /** *

* Configuration describing where the destination Iceberg tables are persisted. @@ -4855,7 +4978,7 @@ export interface DestinationDescription { RedshiftDestinationDescription?: RedshiftDestinationDescription | undefined; /** - *

The destination in Amazon ES.

+ *

The destination in Amazon OpenSearch Service.

* @public */ ElasticsearchDestinationDescription?: ElasticsearchDestinationDescription | undefined; @@ -4899,9 +5022,23 @@ export interface DestinationDescription { IcebergDestinationDescription?: IcebergDestinationDescription | undefined; } +/** + *

The structure that configures parameters such as ThroughputHintInMBs for a stream configured with + * Direct PUT as a source.

+ * @public + */ +export interface DirectPutSourceDescription { + /** + *

The value that you configure for this parameter is for information purpose only and + * does not affect Firehose delivery throughput limit. You can use the Firehose Limits form to request a throughput limit increase.

+ * @public + */ + ThroughputHintInMBs?: number | undefined; +} + /** *

Details about a Kinesis data stream used as the source for a Firehose - * Firehose stream.

+ * stream.

* @public */ export interface KinesisStreamSourceDescription { @@ -4930,8 +5067,7 @@ export interface KinesisStreamSourceDescription { } /** - *

Details about the Amazon MSK cluster used as the source for a Firehose - * Firehose stream.

+ *

Details about the Amazon MSK cluster used as the source for a Firehose stream.

* @public */ export interface MSKSourceDescription { @@ -4973,10 +5109,17 @@ export interface MSKSourceDescription { /** *

Details about a Kinesis data stream used as the source for a Firehose - * Firehose stream.

+ * stream.

* @public */ export interface SourceDescription { + /** + *

Details about Direct PUT used as the source for a Firehose stream. + *

+ * @public + */ + DirectPutSourceDescription?: DirectPutSourceDescription | undefined; + /** *

The KinesisStreamSourceDescription value for the source Kinesis * data stream.

@@ -4992,8 +5135,7 @@ export interface SourceDescription { MSKSourceDescription?: MSKSourceDescription | undefined; /** - *

- *

+ *

Details about a database used as the source for a Firehose stream.

*

Amazon Data Firehose is in preview release and is subject to change.

* @public */ @@ -5137,13 +5279,13 @@ export interface DescribeDeliveryStreamOutput { } /** - *

Describes an update for a destination in Amazon ES.

+ *

Describes an update for a destination in Amazon OpenSearch Service.

* @public */ export interface ElasticsearchDestinationUpdate { /** *

The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose - * for calling the Amazon ES Configuration API and for indexing documents. For more + * for calling the Amazon OpenSearch Service Configuration API and for indexing documents. For more * information, see Grant Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and * Amazon Web Services Service Namespaces.

* @public @@ -5151,7 +5293,7 @@ export interface ElasticsearchDestinationUpdate { RoleARN?: string | undefined; /** - *

The ARN of the Amazon ES domain. The IAM role must have permissions + *

The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions * for DescribeDomain, DescribeDomains, and * DescribeDomainConfig after assuming the IAM role specified in * RoleARN. For more information, see Amazon Resource Names (ARNs) and @@ -5190,7 +5332,7 @@ export interface ElasticsearchDestinationUpdate { *

The Elasticsearch index rotation period. Index rotation appends a timestamp to * IndexName to facilitate the expiration of old data. For more information, * see Index Rotation for the - * Amazon ES Destination. Default value is OneDay.

+ * Amazon OpenSearch Service Destination. Default value is OneDay.

* @public */ IndexRotationPeriod?: ElasticsearchIndexRotationPeriod | undefined; @@ -5204,7 +5346,7 @@ export interface ElasticsearchDestinationUpdate { /** *

The retry behavior in case Firehose is unable to deliver documents to - * Amazon ES. The default value is 300 (5 minutes).

+ * Amazon OpenSearch Service. The default value is 300 (5 minutes).

* @public */ RetryOptions?: ElasticsearchRetryOptions | undefined; @@ -5795,6 +5937,7 @@ export interface IcebergDestinationUpdate { /** *

+ * The configuration to enable automatic schema evolution. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -5803,6 +5946,7 @@ export interface IcebergDestinationUpdate { /** *

+ * The configuration to enable automatic table creation. *

*

Amazon Data Firehose is in preview release and is subject to change.

* @public @@ -5852,6 +5996,18 @@ export interface IcebergDestinationUpdate { */ RoleARN?: string | undefined; + /** + *

Describes whether all incoming data for this delivery stream will be append only + * (inserts only and not for updates and deletes) for Iceberg delivery. This feature is only + * applicable for Apache Iceberg Tables.

+ *

The default value is false. If you set this value to true, Firehose automatically + * increases the throughput limit of a stream based on the throttling levels of the stream. If + * you set this parameter to true for a stream with updates and deletes, you will see out of + * order delivery.

+ * @public + */ + AppendOnly?: boolean | undefined; + /** *

* Configuration describing where the destination Iceberg tables are persisted. @@ -6223,7 +6379,7 @@ export interface UpdateDestinationInput { RedshiftDestinationUpdate?: RedshiftDestinationUpdate | undefined; /** - *

Describes an update for a destination in Amazon ES.

+ *

Describes an update for a destination in Amazon OpenSearch Service.

* @public */ ElasticsearchDestinationUpdate?: ElasticsearchDestinationUpdate | undefined; diff --git a/clients/client-firehose/src/protocols/Aws_json1_1.ts b/clients/client-firehose/src/protocols/Aws_json1_1.ts index e1c5cfd114091..f43290edafc1b 100644 --- a/clients/client-firehose/src/protocols/Aws_json1_1.ts +++ b/clients/client-firehose/src/protocols/Aws_json1_1.ts @@ -94,6 +94,7 @@ import { Deserializer, DestinationDescription, DestinationTableConfiguration, + DirectPutSourceConfiguration, DocumentIdOptions, DynamicPartitioningConfiguration, ElasticsearchBufferingHints, @@ -778,6 +779,7 @@ const se_CreateDeliveryStreamInput = (input: CreateDeliveryStreamInput, context: DeliveryStreamEncryptionConfigurationInput: _json, DeliveryStreamName: [], DeliveryStreamType: [], + DirectPutSourceConfiguration: _json, ElasticsearchDestinationConfiguration: _json, ExtendedS3DestinationConfiguration: (_) => se_ExtendedS3DestinationConfiguration(_, context), HttpEndpointDestinationConfiguration: _json, @@ -839,6 +841,8 @@ const se_DataFormatConversionConfiguration = ( // se_DestinationTableConfigurationList omitted. +// se_DirectPutSourceConfiguration omitted. + // se_DocumentIdOptions omitted. // se_DynamicPartitioningConfiguration omitted. @@ -1305,6 +1309,8 @@ const de_DestinationDescriptionList = (output: any, context: __SerdeContext): De // de_DestinationTableConfigurationList omitted. +// de_DirectPutSourceDescription omitted. + // de_DocumentIdOptions omitted. // de_DynamicPartitioningConfiguration omitted. @@ -1512,6 +1518,7 @@ const de_Serializer = (output: any, context: __SerdeContext): Serializer => { const de_SourceDescription = (output: any, context: __SerdeContext): SourceDescription => { return take(output, { DatabaseSourceDescription: (_: any) => de_DatabaseSourceDescription(_, context), + DirectPutSourceDescription: _json, KinesisStreamSourceDescription: (_: any) => de_KinesisStreamSourceDescription(_, context), MSKSourceDescription: (_: any) => de_MSKSourceDescription(_, context), }) as any; diff --git a/codegen/sdk-codegen/aws-models/firehose.json b/codegen/sdk-codegen/aws-models/firehose.json index f9047c401c067..4c1fd55fa8ee1 100644 --- a/codegen/sdk-codegen/aws-models/firehose.json +++ b/codegen/sdk-codegen/aws-models/firehose.json @@ -765,7 +765,7 @@ "WarehouseLocation": { "target": "com.amazonaws.firehose#WarehouseLocation", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

The warehouse location for Apache Iceberg tables. You must configure this when schema\n evolution and table creation is enabled.

\n

Amazon Data Firehose is in preview release and is subject to change.

" } } }, @@ -981,6 +981,12 @@ "smithy.api#documentation": "

The Firehose stream type. This parameter can be one of the following\n values:

\n " } }, + "DirectPutSourceConfiguration": { + "target": "com.amazonaws.firehose#DirectPutSourceConfiguration", + "traits": { + "smithy.api#documentation": "

The structure that configures parameters such as ThroughputHintInMBs for a\n stream configured with Direct PUT as a source.

" + } + }, "KinesisStreamSourceConfiguration": { "target": "com.amazonaws.firehose#KinesisStreamSourceConfiguration", "traits": { @@ -1015,7 +1021,7 @@ "ElasticsearchDestinationConfiguration": { "target": "com.amazonaws.firehose#ElasticsearchDestinationConfiguration", "traits": { - "smithy.api#documentation": "

The destination in Amazon ES. You can specify only one destination.

" + "smithy.api#documentation": "

The destination in Amazon OpenSearch Service. You can specify only one destination.

" } }, "AmazonopensearchserviceDestinationConfiguration": { @@ -1039,7 +1045,7 @@ "Tags": { "target": "com.amazonaws.firehose#TagDeliveryStreamInputTagList", "traits": { - "smithy.api#documentation": "

A set of tags to assign to the Firehose stream. A tag is a key-value pair that you can\n define and assign to Amazon Web Services resources. Tags are metadata. For example, you can\n add friendly names and descriptions or other types of information that can help you\n distinguish the Firehose stream. For more information about tags, see Using\n Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User\n Guide.

\n

You can specify up to 50 tags when creating a Firehose stream.

\n

If you specify tags in the CreateDeliveryStream action, Amazon Data\n Firehose performs an additional authorization on the\n firehose:TagDeliveryStream action to verify if users have permissions to\n create tags. If you do not provide this permission, requests to create new Firehose\n Firehose streams with IAM resource tags will fail with an\n AccessDeniedException such as following.

\n

\n AccessDeniedException\n

\n

User: arn:aws:sts::x:assumed-role/x/x is not authorized to perform: firehose:TagDeliveryStream on resource: arn:aws:firehose:us-east-1:x:deliverystream/x with an explicit deny in an identity-based policy.

\n

For an example IAM policy, see Tag example.\n

" + "smithy.api#documentation": "

A set of tags to assign to the Firehose stream. A tag is a key-value pair that you can\n define and assign to Amazon Web Services resources. Tags are metadata. For example, you can\n add friendly names and descriptions or other types of information that can help you\n distinguish the Firehose stream. For more information about tags, see Using\n Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User\n Guide.

\n

You can specify up to 50 tags when creating a Firehose stream.

\n

If you specify tags in the CreateDeliveryStream action, Amazon Data\n Firehose performs an additional authorization on the\n firehose:TagDeliveryStream action to verify if users have permissions to\n create tags. If you do not provide this permission, requests to create new Firehose streams\n with IAM resource tags will fail with an AccessDeniedException such as\n following.

\n

\n AccessDeniedException\n

\n

User: arn:aws:sts::x:assumed-role/x/x is not authorized to perform: firehose:TagDeliveryStream on resource: arn:aws:firehose:us-east-1:x:deliverystream/x with an explicit deny in an identity-based policy.

\n

For an example IAM policy, see Tag example.\n

" } }, "AmazonOpenSearchServerlessDestinationConfiguration": { @@ -1066,7 +1072,7 @@ "DatabaseSourceConfiguration": { "target": "com.amazonaws.firehose#DatabaseSourceConfiguration", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

\n The top level object for configuring streams with database as a source. \n

\n

Amazon Data Firehose is in preview release and is subject to change.

" } } }, @@ -1171,18 +1177,18 @@ "Include": { "target": "com.amazonaws.firehose#DatabaseColumnIncludeOrExcludeList", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

\n The list of column patterns in source database to be included for Firehose to read from.\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "Exclude": { "target": "com.amazonaws.firehose#DatabaseColumnIncludeOrExcludeList", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

\n The list of column patterns in source database to be excluded for Firehose to read from.\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" } } }, "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

The structure used to configure the list of column patterns in source database\n endpoint for Firehose to read from.

\n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "com.amazonaws.firehose#DatabaseColumnName": { @@ -1217,18 +1223,18 @@ "Include": { "target": "com.amazonaws.firehose#DatabaseIncludeOrExcludeList", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

The list of database patterns in source database endpoint to be included for Firehose\n to read from.

\n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "Exclude": { "target": "com.amazonaws.firehose#DatabaseIncludeOrExcludeList", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

The list of database patterns in source database endpoint to be excluded for Firehose\n to read from.

\n

Amazon Data Firehose is in preview release and is subject to change.

" } } }, "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

The structure used to configure the list of database patterns in source database\n endpoint for Firehose to read from.

\n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "com.amazonaws.firehose#DatabaseName": { @@ -1256,35 +1262,35 @@ "Id": { "target": "com.amazonaws.firehose#NonEmptyStringWithoutWhitespace", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

", + "smithy.api#documentation": "

\n The identifier of the current snapshot of the table in source database endpoint.\n

\n

Amazon Data Firehose is in preview release and is subject to change.

", "smithy.api#required": {} } }, "Table": { "target": "com.amazonaws.firehose#DatabaseTableName", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

", + "smithy.api#documentation": "

\n The fully qualified name of the table in source database endpoint that Firehose reads.\n

\n

Amazon Data Firehose is in preview release and is subject to change.

", "smithy.api#required": {} } }, "RequestTimestamp": { "target": "com.amazonaws.firehose#Timestamp", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

", + "smithy.api#documentation": "

\n The timestamp when the current snapshot is taken on the table.\n

\n

Amazon Data Firehose is in preview release and is subject to change.

", "smithy.api#required": {} } }, "RequestedBy": { "target": "com.amazonaws.firehose#SnapshotRequestedBy", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

", + "smithy.api#documentation": "

\n The principal that sent the request to take the current snapshot on the table.\n

\n

Amazon Data Firehose is in preview release and is subject to change.

", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.firehose#SnapshotStatus", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

", + "smithy.api#documentation": "

\n The status of the current snapshot of the table.\n

\n

Amazon Data Firehose is in preview release and is subject to change.

", "smithy.api#required": {} } }, @@ -1293,7 +1299,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

\n The structure that describes the snapshot information of a table in source database endpoint that Firehose reads. \n

\n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "com.amazonaws.firehose#DatabaseSnapshotInfoList": { @@ -1313,7 +1319,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

\n The structure to configure the authentication methods for Firehose to connect to source database endpoint.\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "com.amazonaws.firehose#DatabaseSourceConfiguration": { @@ -1322,80 +1328,80 @@ "Type": { "target": "com.amazonaws.firehose#DatabaseType", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

", + "smithy.api#documentation": "

The type of database engine. This can be one of the following values.

\n \n

Amazon Data Firehose is in preview release and is subject to change.

", "smithy.api#required": {} } }, "Endpoint": { "target": "com.amazonaws.firehose#DatabaseEndpoint", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

", + "smithy.api#documentation": "

\n The endpoint of the database server.\n

\n

Amazon Data Firehose is in preview release and is subject to change.

", "smithy.api#required": {} } }, "Port": { "target": "com.amazonaws.firehose#DatabasePort", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

", + "smithy.api#documentation": "

The port of the database. This can be one of the following values.

\n \n

Amazon Data Firehose is in preview release and is subject to change.

", "smithy.api#required": {} } }, "SSLMode": { "target": "com.amazonaws.firehose#SSLMode", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

\n The mode to enable or disable SSL when Firehose connects to the database endpoint.\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "Databases": { "target": "com.amazonaws.firehose#DatabaseList", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

", + "smithy.api#documentation": "

\n The list of database patterns in source database endpoint for Firehose to read from.\n

\n

Amazon Data Firehose is in preview release and is subject to change.

", "smithy.api#required": {} } }, "Tables": { "target": "com.amazonaws.firehose#DatabaseTableList", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

", + "smithy.api#documentation": "

\n The list of table patterns in source database endpoint for Firehose to read from.\n

\n

Amazon Data Firehose is in preview release and is subject to change.

", "smithy.api#required": {} } }, "Columns": { "target": "com.amazonaws.firehose#DatabaseColumnList", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

\n The list of column patterns in source database endpoint for Firehose to read from. \n

\n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "SurrogateKeys": { "target": "com.amazonaws.firehose#DatabaseSurrogateKeyList", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

\n 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.\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "SnapshotWatermarkTable": { "target": "com.amazonaws.firehose#DatabaseTableName", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

", + "smithy.api#documentation": "

\n The fully qualified name of the table in source database endpoint that Firehose uses to track snapshot progress.\n

\n

Amazon Data Firehose is in preview release and is subject to change.

", "smithy.api#required": {} } }, "DatabaseSourceAuthenticationConfiguration": { "target": "com.amazonaws.firehose#DatabaseSourceAuthenticationConfiguration", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

", + "smithy.api#documentation": "

\n The structure to configure the authentication methods for Firehose to connect to source database endpoint.\n

\n

Amazon Data Firehose is in preview release and is subject to change.

", "smithy.api#required": {} } }, "DatabaseSourceVPCConfiguration": { "target": "com.amazonaws.firehose#DatabaseSourceVPCConfiguration", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

", + "smithy.api#documentation": "

\n The details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database.\n

\n

Amazon Data Firehose is in preview release and is subject to change.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

\n The top level object for configuring streams with database as a source. \n

\n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "com.amazonaws.firehose#DatabaseSourceDescription": { @@ -1404,78 +1410,78 @@ "Type": { "target": "com.amazonaws.firehose#DatabaseType", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

The type of database engine. This can be one of the following values.

\n \n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "Endpoint": { "target": "com.amazonaws.firehose#DatabaseEndpoint", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

\n The endpoint of the database server.\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "Port": { "target": "com.amazonaws.firehose#DatabasePort", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

The port of the database. This can be one of the following values.

\n \n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "SSLMode": { "target": "com.amazonaws.firehose#SSLMode", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

\n The mode to enable or disable SSL when Firehose connects to the database endpoint.\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "Databases": { "target": "com.amazonaws.firehose#DatabaseList", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

\n The list of database patterns in source database endpoint for Firehose to read from.\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "Tables": { "target": "com.amazonaws.firehose#DatabaseTableList", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

\n The list of table patterns in source database endpoint for Firehose to read from.\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "Columns": { "target": "com.amazonaws.firehose#DatabaseColumnList", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

\n The list of column patterns in source database endpoint for Firehose to read from. \n

\n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "SurrogateKeys": { "target": "com.amazonaws.firehose#DatabaseColumnIncludeOrExcludeList", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

\n 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.\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "SnapshotWatermarkTable": { "target": "com.amazonaws.firehose#DatabaseTableName", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

\n The fully qualified name of the table in source database endpoint that Firehose uses to track snapshot progress.\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "SnapshotInfo": { "target": "com.amazonaws.firehose#DatabaseSnapshotInfoList", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

\n The structure that describes the snapshot information of a table in source database endpoint that Firehose reads. \n

\n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "DatabaseSourceAuthenticationConfiguration": { "target": "com.amazonaws.firehose#DatabaseSourceAuthenticationConfiguration", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

\n The structure to configure the authentication methods for Firehose to connect to source database endpoint.\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "DatabaseSourceVPCConfiguration": { "target": "com.amazonaws.firehose#DatabaseSourceVPCConfiguration", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

\n The details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database.\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" } } }, "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

\n The top level object for database source description.\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "com.amazonaws.firehose#DatabaseSourceVPCConfiguration": { @@ -1484,13 +1490,13 @@ "VpcEndpointServiceName": { "target": "com.amazonaws.firehose#VpcEndpointServiceName", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

", + "smithy.api#documentation": "

\n The VPC endpoint service name which Firehose uses to create a PrivateLink to the database. The endpoint service must have the Firehose service principle firehose.amazonaws.com as an allowed principal on the VPC endpoint service. The VPC endpoint service name is a string that looks like com.amazonaws.vpce... \n

\n

Amazon Data Firehose is in preview release and is subject to change.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

\n The structure for details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database.\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "com.amazonaws.firehose#DatabaseSurrogateKeyList": { @@ -1511,18 +1517,18 @@ "Include": { "target": "com.amazonaws.firehose#DatabaseTableIncludeOrExcludeList", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

The list of table patterns in source database endpoint to be included for Firehose to\n read from.

\n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "Exclude": { "target": "com.amazonaws.firehose#DatabaseTableIncludeOrExcludeList", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

The list of table patterns in source database endpoint to be excluded for Firehose to\n read from.

\n

Amazon Data Firehose is in preview release and is subject to change.

" } } }, "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

The structure used to configure the list of table patterns in source database endpoint\n for Firehose to read from.

\n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "com.amazonaws.firehose#DatabaseTableName": { @@ -2127,7 +2133,7 @@ "ElasticsearchDestinationDescription": { "target": "com.amazonaws.firehose#ElasticsearchDestinationDescription", "traits": { - "smithy.api#documentation": "

The destination in Amazon ES.

" + "smithy.api#documentation": "

The destination in Amazon OpenSearch Service.

" } }, "AmazonopensearchserviceDestinationDescription": { @@ -2213,7 +2219,7 @@ "PartitionSpec": { "target": "com.amazonaws.firehose#PartitionSpec", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

The partition spec configuration for a table that is used by automatic table\n creation.

\n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "S3ErrorOutputPrefix": { @@ -2233,6 +2239,35 @@ "target": "com.amazonaws.firehose#DestinationTableConfiguration" } }, + "com.amazonaws.firehose#DirectPutSourceConfiguration": { + "type": "structure", + "members": { + "ThroughputHintInMBs": { + "target": "com.amazonaws.firehose#ThroughputHintInMBs", + "traits": { + "smithy.api#documentation": "

The value that you configure for this parameter is for information purpose only and\n does not affect Firehose delivery throughput limit. You can use the Firehose Limits form to request a throughput limit increase.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The structure that configures parameters such as ThroughputHintInMBs for a stream configured with\n Direct PUT as a source.

" + } + }, + "com.amazonaws.firehose#DirectPutSourceDescription": { + "type": "structure", + "members": { + "ThroughputHintInMBs": { + "target": "com.amazonaws.firehose#ThroughputHintInMBs", + "traits": { + "smithy.api#documentation": "

The value that you configure for this parameter is for information purpose only and\n does not affect Firehose delivery throughput limit. You can use the Firehose Limits form to request a throughput limit increase.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The structure that configures parameters such as ThroughputHintInMBs for a stream configured with\n Direct PUT as a source.

" + } + }, "com.amazonaws.firehose#DocumentIdOptions": { "type": "structure", "members": { @@ -2260,7 +2295,7 @@ "Enabled": { "target": "com.amazonaws.firehose#BooleanObject", "traits": { - "smithy.api#documentation": "

Specifies that the dynamic partitioning is enabled for this Firehose\n Firehose stream.

" + "smithy.api#documentation": "

Specifies that the dynamic partitioning is enabled for this Firehose stream.

" } } }, @@ -2285,7 +2320,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the buffering to perform before delivering data to the Amazon ES\n destination.

" + "smithy.api#documentation": "

Describes the buffering to perform before delivering data to the Amazon OpenSearch Service\n destination.

" } }, "com.amazonaws.firehose#ElasticsearchBufferingIntervalInSeconds": { @@ -2322,14 +2357,14 @@ "RoleARN": { "target": "com.amazonaws.firehose#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose\n for calling the Amazon ES Configuration API and for indexing documents. For more\n information, see Grant Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and\n Amazon Web Services Service Namespaces.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose\n for calling the Amazon OpenSearch Service Configuration API and for indexing documents. For more\n information, see Grant Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and\n Amazon Web Services Service Namespaces.

", "smithy.api#required": {} } }, "DomainARN": { "target": "com.amazonaws.firehose#ElasticsearchDomainARN", "traits": { - "smithy.api#documentation": "

The ARN of the Amazon ES domain. The IAM role must have permissions\n for DescribeDomain, DescribeDomains, and\n DescribeDomainConfig after assuming the role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and\n Amazon Web Services Service Namespaces.

\n

Specify either ClusterEndpoint or DomainARN.

" + "smithy.api#documentation": "

The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions\n for DescribeDomain, DescribeDomains, and\n DescribeDomainConfig after assuming the role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and\n Amazon Web Services Service Namespaces.

\n

Specify either ClusterEndpoint or DomainARN.

" } }, "ClusterEndpoint": { @@ -2354,7 +2389,7 @@ "IndexRotationPeriod": { "target": "com.amazonaws.firehose#ElasticsearchIndexRotationPeriod", "traits": { - "smithy.api#documentation": "

The Elasticsearch index rotation period. Index rotation appends a timestamp to the\n IndexName to facilitate the expiration of old data. For more information,\n see Index Rotation for the\n Amazon ES Destination. The default value is OneDay.

" + "smithy.api#documentation": "

The Elasticsearch index rotation period. Index rotation appends a timestamp to the\n IndexName to facilitate the expiration of old data. For more information,\n see Index Rotation for the\n Amazon OpenSearch Service Destination. The default value is OneDay.

" } }, "BufferingHints": { @@ -2366,13 +2401,13 @@ "RetryOptions": { "target": "com.amazonaws.firehose#ElasticsearchRetryOptions", "traits": { - "smithy.api#documentation": "

The retry behavior in case Firehose is unable to deliver documents to\n Amazon ES. The default value is 300 (5 minutes).

" + "smithy.api#documentation": "

The retry behavior in case Firehose is unable to deliver documents to\n Amazon OpenSearch Service. The default value is 300 (5 minutes).

" } }, "S3BackupMode": { "target": "com.amazonaws.firehose#ElasticsearchS3BackupMode", "traits": { - "smithy.api#documentation": "

Defines how documents should be delivered to Amazon S3. When it is set to\n FailedDocumentsOnly, Firehose writes any documents that could\n not be indexed to the configured Amazon S3 destination, with\n AmazonOpenSearchService-failed/ appended to the key prefix. When set to\n AllDocuments, Firehose delivers all incoming records to Amazon\n S3, and also writes failed documents with AmazonOpenSearchService-failed/\n appended to the prefix. For more information, see Amazon S3 Backup for the\n Amazon ES Destination. Default value is\n FailedDocumentsOnly.

\n

You can't change this backup mode after you create the Firehose stream.

" + "smithy.api#documentation": "

Defines how documents should be delivered to Amazon S3. When it is set to\n FailedDocumentsOnly, Firehose writes any documents that could\n not be indexed to the configured Amazon S3 destination, with\n AmazonOpenSearchService-failed/ appended to the key prefix. When set to\n AllDocuments, Firehose delivers all incoming records to Amazon\n S3, and also writes failed documents with AmazonOpenSearchService-failed/\n appended to the prefix. For more information, see Amazon S3 Backup for the\n Amazon OpenSearch Service Destination. Default value is\n FailedDocumentsOnly.

\n

You can't change this backup mode after you create the Firehose stream.

" } }, "S3Configuration": { @@ -2408,7 +2443,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the configuration of a destination in Amazon ES.

" + "smithy.api#documentation": "

Describes the configuration of a destination in Amazon OpenSearch Service.

" } }, "com.amazonaws.firehose#ElasticsearchDestinationDescription": { @@ -2423,13 +2458,13 @@ "DomainARN": { "target": "com.amazonaws.firehose#ElasticsearchDomainARN", "traits": { - "smithy.api#documentation": "

The ARN of the Amazon ES domain. For more information, see Amazon\n Resource Names (ARNs) and Amazon Web Services Service Namespaces.

\n

Firehose uses either ClusterEndpoint or DomainARN\n to send data to Amazon ES.

" + "smithy.api#documentation": "

The ARN of the Amazon OpenSearch Service domain. For more information, see Amazon\n Resource Names (ARNs) and Amazon Web Services Service Namespaces.

\n

Firehose uses either ClusterEndpoint or DomainARN\n to send data to Amazon OpenSearch Service.

" } }, "ClusterEndpoint": { "target": "com.amazonaws.firehose#ElasticsearchClusterEndpoint", "traits": { - "smithy.api#documentation": "

The endpoint to use when communicating with the cluster. Firehose uses\n either this ClusterEndpoint or the DomainARN field to send data\n to Amazon ES.

" + "smithy.api#documentation": "

The endpoint to use when communicating with the cluster. Firehose uses\n either this ClusterEndpoint or the DomainARN field to send data\n to Amazon OpenSearch Service.

" } }, "IndexName": { @@ -2459,7 +2494,7 @@ "RetryOptions": { "target": "com.amazonaws.firehose#ElasticsearchRetryOptions", "traits": { - "smithy.api#documentation": "

The Amazon ES retry options.

" + "smithy.api#documentation": "

The Amazon OpenSearch Service retry options.

" } }, "S3BackupMode": { @@ -2500,7 +2535,7 @@ } }, "traits": { - "smithy.api#documentation": "

The destination description in Amazon ES.

" + "smithy.api#documentation": "

The destination description in Amazon OpenSearch Service.

" } }, "com.amazonaws.firehose#ElasticsearchDestinationUpdate": { @@ -2509,13 +2544,13 @@ "RoleARN": { "target": "com.amazonaws.firehose#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose\n for calling the Amazon ES Configuration API and for indexing documents. For more\n information, see Grant Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and\n Amazon Web Services Service Namespaces.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose\n for calling the Amazon OpenSearch Service Configuration API and for indexing documents. For more\n information, see Grant Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and\n Amazon Web Services Service Namespaces.

" } }, "DomainARN": { "target": "com.amazonaws.firehose#ElasticsearchDomainARN", "traits": { - "smithy.api#documentation": "

The ARN of the Amazon ES domain. The IAM role must have permissions\n for DescribeDomain, DescribeDomains, and\n DescribeDomainConfig after assuming the IAM role specified in\n RoleARN. For more information, see Amazon Resource Names (ARNs) and\n Amazon Web Services Service Namespaces.

\n

Specify either ClusterEndpoint or DomainARN.

" + "smithy.api#documentation": "

The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions\n for DescribeDomain, DescribeDomains, and\n DescribeDomainConfig after assuming the IAM role specified in\n RoleARN. For more information, see Amazon Resource Names (ARNs) and\n Amazon Web Services Service Namespaces.

\n

Specify either ClusterEndpoint or DomainARN.

" } }, "ClusterEndpoint": { @@ -2539,7 +2574,7 @@ "IndexRotationPeriod": { "target": "com.amazonaws.firehose#ElasticsearchIndexRotationPeriod", "traits": { - "smithy.api#documentation": "

The Elasticsearch index rotation period. Index rotation appends a timestamp to\n IndexName to facilitate the expiration of old data. For more information,\n see Index Rotation for the\n Amazon ES Destination. Default value is OneDay.

" + "smithy.api#documentation": "

The Elasticsearch index rotation period. Index rotation appends a timestamp to\n IndexName to facilitate the expiration of old data. For more information,\n see Index Rotation for the\n Amazon OpenSearch Service Destination. Default value is OneDay.

" } }, "BufferingHints": { @@ -2551,7 +2586,7 @@ "RetryOptions": { "target": "com.amazonaws.firehose#ElasticsearchRetryOptions", "traits": { - "smithy.api#documentation": "

The retry behavior in case Firehose is unable to deliver documents to\n Amazon ES. The default value is 300 (5 minutes).

" + "smithy.api#documentation": "

The retry behavior in case Firehose is unable to deliver documents to\n Amazon OpenSearch Service. The default value is 300 (5 minutes).

" } }, "S3Update": { @@ -2580,7 +2615,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes an update for a destination in Amazon ES.

" + "smithy.api#documentation": "

Describes an update for a destination in Amazon OpenSearch Service.

" } }, "com.amazonaws.firehose#ElasticsearchDomainARN": { @@ -2653,12 +2688,12 @@ "DurationInSeconds": { "target": "com.amazonaws.firehose#ElasticsearchRetryDurationInSeconds", "traits": { - "smithy.api#documentation": "

After an initial failure to deliver to Amazon ES, the total amount of time during\n which Firehose retries delivery (including the first attempt). After this time\n has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5\n minutes). A value of 0 (zero) results in no retries.

" + "smithy.api#documentation": "

After an initial failure to deliver to Amazon OpenSearch Service, the total amount of time during\n which Firehose retries delivery (including the first attempt). After this time\n has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5\n minutes). A value of 0 (zero) results in no retries.

" } } }, "traits": { - "smithy.api#documentation": "

Configures retry behavior in case Firehose is unable to deliver\n documents to Amazon ES.

" + "smithy.api#documentation": "

Configures retry behavior in case Firehose is unable to deliver\n documents to Amazon OpenSearch Service.

" } }, "com.amazonaws.firehose#ElasticsearchS3BackupMode": { @@ -4592,13 +4627,13 @@ "SchemaEvolutionConfiguration": { "target": "com.amazonaws.firehose#SchemaEvolutionConfiguration", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

The configuration to enable automatic schema evolution.

\n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "TableCreationConfiguration": { "target": "com.amazonaws.firehose#TableCreationConfiguration", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

The configuration to enable automatic table creation.

\n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "BufferingHints": { @@ -4626,6 +4661,12 @@ "smithy.api#required": {} } }, + "AppendOnly": { + "target": "com.amazonaws.firehose#BooleanObject", + "traits": { + "smithy.api#documentation": "

Describes whether all incoming data for this delivery stream will be append only\n (inserts only and not for updates and deletes) for Iceberg delivery. This feature is only\n applicable for Apache Iceberg Tables.

\n

The default value is false. If you set this value to true, Firehose automatically\n increases the throughput limit of a stream based on the throttling levels of the stream. If\n you set this parameter to true for a stream with updates and deletes, you will see out of\n order delivery.

" + } + }, "CatalogConfiguration": { "target": "com.amazonaws.firehose#CatalogConfiguration", "traits": { @@ -4656,13 +4697,13 @@ "SchemaEvolutionConfiguration": { "target": "com.amazonaws.firehose#SchemaEvolutionConfiguration", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

The description of automatic schema evolution configuration.

\n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "TableCreationConfiguration": { "target": "com.amazonaws.firehose#TableCreationConfiguration", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

\n The description of table creation configuration.\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "BufferingHints": { @@ -4689,6 +4730,12 @@ "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling Apache Iceberg Tables.\n

" } }, + "AppendOnly": { + "target": "com.amazonaws.firehose#BooleanObject", + "traits": { + "smithy.api#documentation": "

Describes whether all incoming data for this delivery stream will be append only\n (inserts only and not for updates and deletes) for Iceberg delivery. This feature is only\n applicable for Apache Iceberg Tables.

\n

The default value is false. If you set this value to true, Firehose automatically\n increases the throughput limit of a stream based on the throttling levels of the stream. If\n you set this parameter to true for a stream with updates and deletes, you will see out of\n order delivery.

\n

" + } + }, "CatalogConfiguration": { "target": "com.amazonaws.firehose#CatalogConfiguration", "traits": { @@ -4715,13 +4762,13 @@ "SchemaEvolutionConfiguration": { "target": "com.amazonaws.firehose#SchemaEvolutionConfiguration", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

\n The configuration to enable automatic schema evolution.\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "TableCreationConfiguration": { "target": "com.amazonaws.firehose#TableCreationConfiguration", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

\n The configuration to enable automatic table creation.\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "BufferingHints": { @@ -4748,6 +4795,12 @@ "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling Apache Iceberg Tables.\n

" } }, + "AppendOnly": { + "target": "com.amazonaws.firehose#BooleanObject", + "traits": { + "smithy.api#documentation": "

Describes whether all incoming data for this delivery stream will be append only\n (inserts only and not for updates and deletes) for Iceberg delivery. This feature is only\n applicable for Apache Iceberg Tables.

\n

The default value is false. If you set this value to true, Firehose automatically\n increases the throughput limit of a stream based on the throttling levels of the stream. If\n you set this parameter to true for a stream with updates and deletes, you will see out of\n order delivery.

" + } + }, "CatalogConfiguration": { "target": "com.amazonaws.firehose#CatalogConfiguration", "traits": { @@ -4934,7 +4987,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details about a Kinesis data stream used as the source for a Firehose\n Firehose stream.

" + "smithy.api#documentation": "

Details about a Kinesis data stream used as the source for a Firehose\n stream.

" } }, "com.amazonaws.firehose#LimitExceededException": { @@ -5226,7 +5279,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details about the Amazon MSK cluster used as the source for a Firehose\n Firehose stream.

" + "smithy.api#documentation": "

Details about the Amazon MSK cluster used as the source for a Firehose stream.

" } }, "com.amazonaws.firehose#NoEncryptionConfig": { @@ -5530,13 +5583,13 @@ "SourceName": { "target": "com.amazonaws.firehose#NonEmptyStringWithoutWhitespace", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

", + "smithy.api#documentation": "

\n The column name to be configured in partition spec.\n

\n

Amazon Data Firehose is in preview release and is subject to change.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

Represents a single field in a PartitionSpec.

\n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "com.amazonaws.firehose#PartitionFields": { @@ -5551,12 +5604,12 @@ "Identity": { "target": "com.amazonaws.firehose#PartitionFields", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

List of identity transforms that performs an identity transformation. The transform takes the\n source value, and does not modify it. Result type is the source type.

\n

Amazon Data Firehose is in preview release and is subject to change.

" } } }, "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

Represents how to produce partition data for a table. Partition data is produced by\n transforming columns in a table. Each column transform is represented by a named\n PartitionField.

\n

Here is an example of the schema in JSON.

\n

\n \"partitionSpec\": { \"identity\": [ {\"sourceName\": \"column1\"}, {\"sourceName\":\n \"column2\"}, {\"sourceName\": \"column3\"} ] }\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "com.amazonaws.firehose#Password": { @@ -6617,13 +6670,13 @@ "Enabled": { "target": "com.amazonaws.firehose#BooleanObject", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

", + "smithy.api#documentation": "

\n Specify whether you want to enable schema evolution.\n

\n

Amazon Data Firehose is in preview release and is subject to change.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

The configuration to enable schema evolution.

\n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "com.amazonaws.firehose#SecretARN": { @@ -6681,7 +6734,7 @@ "ParquetSerDe": { "target": "com.amazonaws.firehose#ParquetSerDe", "traits": { - "smithy.api#documentation": "

A serializer to use for converting data to the Parquet format before storing it in\n Amazon S3. For more information, see Apache Parquet.

" + "smithy.api#documentation": "

A serializer to use for converting data to the Parquet format before storing it in\n Amazon S3. For more information, see Apache Parquet.

" } }, "OrcSerDe": { @@ -6692,7 +6745,7 @@ } }, "traits": { - "smithy.api#documentation": "

The serializer that you want Firehose to use to convert data to the target\n format before writing it to Amazon S3. Firehose supports two types of\n serializers: the ORC SerDe and the Parquet SerDe.

" + "smithy.api#documentation": "

The serializer that you want Firehose to use to convert data to the target\n format before writing it to Amazon S3. Firehose supports two types of\n serializers: the ORC SerDe and the Parquet SerDe.

" } }, "com.amazonaws.firehose#ServiceUnavailableException": { @@ -6916,13 +6969,13 @@ "MetaDataColumnName": { "target": "com.amazonaws.firehose#SnowflakeMetaDataColumnName", "traits": { - "smithy.api#documentation": "

The name of the record metadata column

" + "smithy.api#documentation": "

Specify a column name in the table, where the metadata information has to be loaded.\n When you enable this field, you will see the following column in the snowflake table, which\n differs based on the source type.

\n

For Direct PUT as source

\n

\n { \"firehoseDeliveryStreamName\" : \"streamname\", \"IngestionTime\" : \"timestamp\"\n }\n

\n

For Kinesis Data Stream as source

\n

\n \"kinesisStreamName\" : \"streamname\", \"kinesisShardId\" : \"Id\",\n \"kinesisPartitionKey\" : \"key\", \"kinesisSequenceNumber\" : \"1234\", \"subsequenceNumber\" :\n \"2334\", \"IngestionTime\" : \"timestamp\" }\n

" } }, "ContentColumnName": { "target": "com.amazonaws.firehose#SnowflakeContentColumnName", "traits": { - "smithy.api#documentation": "

The name of the record content column

" + "smithy.api#documentation": "

The name of the record content column.

" } }, "SnowflakeVpcConfiguration": { @@ -7359,6 +7412,12 @@ "com.amazonaws.firehose#SourceDescription": { "type": "structure", "members": { + "DirectPutSourceDescription": { + "target": "com.amazonaws.firehose#DirectPutSourceDescription", + "traits": { + "smithy.api#documentation": "

Details about Direct PUT used as the source for a Firehose stream.\n

" + } + }, "KinesisStreamSourceDescription": { "target": "com.amazonaws.firehose#KinesisStreamSourceDescription", "traits": { @@ -7374,12 +7433,12 @@ "DatabaseSourceDescription": { "target": "com.amazonaws.firehose#DatabaseSourceDescription", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

Details about a database used as the source for a Firehose stream.

\n

Amazon Data Firehose is in preview release and is subject to change.

" } } }, "traits": { - "smithy.api#documentation": "

Details about a Kinesis data stream used as the source for a Firehose\n Firehose stream.

" + "smithy.api#documentation": "

Details about a Kinesis data stream used as the source for a Firehose\n stream.

" } }, "com.amazonaws.firehose#SplunkBufferingHints": { @@ -7818,13 +7877,13 @@ "Enabled": { "target": "com.amazonaws.firehose#BooleanObject", "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

", + "smithy.api#documentation": "

\n Specify whether you want to enable automatic table creation.\n

\n

Amazon Data Firehose is in preview release and is subject to change.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

\n

\n

Amazon Data Firehose is in preview release and is subject to change.

" + "smithy.api#documentation": "

The configuration to enable automatic table creation.

\n

Amazon Data Firehose is in preview release and is subject to change.

" } }, "com.amazonaws.firehose#Tag": { @@ -7947,6 +8006,15 @@ "smithy.api#pattern": "^[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@%]*$" } }, + "com.amazonaws.firehose#ThroughputHintInMBs": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, "com.amazonaws.firehose#Timestamp": { "type": "timestamp" }, @@ -8087,7 +8155,7 @@ "ElasticsearchDestinationUpdate": { "target": "com.amazonaws.firehose#ElasticsearchDestinationUpdate", "traits": { - "smithy.api#documentation": "

Describes an update for a destination in Amazon ES.

" + "smithy.api#documentation": "

Describes an update for a destination in Amazon OpenSearch Service.

" } }, "AmazonopensearchserviceDestinationUpdate": { @@ -8155,7 +8223,7 @@ "SubnetIds": { "target": "com.amazonaws.firehose#SubnetIdList", "traits": { - "smithy.api#documentation": "

The IDs of the subnets that you want Firehose to use to create ENIs in the\n VPC of the Amazon ES destination. Make sure that the routing tables and inbound and\n outbound rules allow traffic to flow from the subnets whose IDs are specified here to the\n subnets that have the destination Amazon ES endpoints. Firehose creates at\n least one ENI in each of the subnets that are specified here. Do not delete or modify these\n ENIs.

\n

The number of ENIs that Firehose creates in the subnets specified here\n scales up and down automatically based on throughput. To enable Firehose to\n scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To\n help you calculate the quota you need, assume that Firehose can create up to\n three ENIs for this Firehose stream for each of the subnets specified here. For more\n information about ENI quota, see Network Interfaces\n in the Amazon VPC Quotas topic.

", + "smithy.api#documentation": "

The IDs of the subnets that you want Firehose to use to create ENIs in the\n VPC of the Amazon OpenSearch Service destination. Make sure that the routing tables and inbound and\n outbound rules allow traffic to flow from the subnets whose IDs are specified here to the\n subnets that have the destination Amazon OpenSearch Service endpoints. Firehose creates at\n least one ENI in each of the subnets that are specified here. Do not delete or modify these\n ENIs.

\n

The number of ENIs that Firehose creates in the subnets specified here\n scales up and down automatically based on throughput. To enable Firehose to\n scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To\n help you calculate the quota you need, assume that Firehose can create up to\n three ENIs for this Firehose stream for each of the subnets specified here. For more\n information about ENI quota, see Network Interfaces\n in the Amazon VPC Quotas topic.

", "smithy.api#required": {} } }, @@ -8169,7 +8237,7 @@ "SecurityGroupIds": { "target": "com.amazonaws.firehose#SecurityGroupIdList", "traits": { - "smithy.api#documentation": "

The IDs of the security groups that you want Firehose to use when it\n creates ENIs in the VPC of the Amazon ES destination. You can use the same security group\n that the Amazon ES domain uses or different ones. If you specify different security groups\n here, ensure that they allow outbound HTTPS traffic to the Amazon ES domain's security\n group. Also ensure that the Amazon ES domain's security group allows HTTPS traffic from the\n security groups specified here. If you use the same security group for both your delivery\n stream and the Amazon ES domain, make sure the security group inbound rule allows HTTPS\n traffic. For more information about security group rules, see Security group\n rules in the Amazon VPC documentation.

", + "smithy.api#documentation": "

The IDs of the security groups that you want Firehose to use when it\n creates ENIs in the VPC of the Amazon OpenSearch Service destination. You can use the same security group\n that the Amazon OpenSearch Service domain uses or different ones. If you specify different security groups\n here, ensure that they allow outbound HTTPS traffic to the Amazon OpenSearch Service domain's security\n group. Also ensure that the Amazon OpenSearch Service domain's security group allows HTTPS traffic from the\n security groups specified here. If you use the same security group for both your delivery\n stream and the Amazon OpenSearch Service domain, make sure the security group inbound rule allows HTTPS\n traffic. For more information about security group rules, see Security group\n rules in the Amazon VPC documentation.

", "smithy.api#required": {} } } @@ -8184,7 +8252,7 @@ "SubnetIds": { "target": "com.amazonaws.firehose#SubnetIdList", "traits": { - "smithy.api#documentation": "

The IDs of the subnets that Firehose uses to create ENIs in the VPC of the\n Amazon ES destination. Make sure that the routing tables and inbound and outbound rules\n allow traffic to flow from the subnets whose IDs are specified here to the subnets that\n have the destination Amazon ES endpoints. Firehose creates at least one ENI in\n each of the subnets that are specified here. Do not delete or modify these ENIs.

\n

The number of ENIs that Firehose creates in the subnets specified here\n scales up and down automatically based on throughput. To enable Firehose to\n scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To\n help you calculate the quota you need, assume that Firehose can create up to\n three ENIs for this Firehose stream for each of the subnets specified here. For more\n information about ENI quota, see Network Interfaces\n in the Amazon VPC Quotas topic.

", + "smithy.api#documentation": "

The IDs of the subnets that Firehose uses to create ENIs in the VPC of the\n Amazon OpenSearch Service destination. Make sure that the routing tables and inbound and outbound rules\n allow traffic to flow from the subnets whose IDs are specified here to the subnets that\n have the destination Amazon OpenSearch Service endpoints. Firehose creates at least one ENI in\n each of the subnets that are specified here. Do not delete or modify these ENIs.

\n

The number of ENIs that Firehose creates in the subnets specified here\n scales up and down automatically based on throughput. To enable Firehose to\n scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To\n help you calculate the quota you need, assume that Firehose can create up to\n three ENIs for this Firehose stream for each of the subnets specified here. For more\n information about ENI quota, see Network Interfaces\n in the Amazon VPC Quotas topic.

", "smithy.api#required": {} } }, @@ -8198,20 +8266,20 @@ "SecurityGroupIds": { "target": "com.amazonaws.firehose#SecurityGroupIdList", "traits": { - "smithy.api#documentation": "

The IDs of the security groups that Firehose uses when it creates ENIs in\n the VPC of the Amazon ES destination. You can use the same security group that the Amazon\n ES domain uses or different ones. If you specify different security groups, ensure that\n they allow outbound HTTPS traffic to the Amazon ES domain's security group. Also ensure\n that the Amazon ES domain's security group allows HTTPS traffic from the security groups\n specified here. If you use the same security group for both your Firehose stream and the\n Amazon ES domain, make sure the security group inbound rule allows HTTPS traffic. For more\n information about security group rules, see Security group\n rules in the Amazon VPC documentation.

", + "smithy.api#documentation": "

The IDs of the security groups that Firehose uses when it creates ENIs in\n the VPC of the Amazon OpenSearch Service destination. You can use the same security group that the Amazon\n ES domain uses or different ones. If you specify different security groups, ensure that\n they allow outbound HTTPS traffic to the Amazon OpenSearch Service domain's security group. Also ensure\n that the Amazon OpenSearch Service domain's security group allows HTTPS traffic from the security groups\n specified here. If you use the same security group for both your Firehose stream and the\n Amazon OpenSearch Service domain, make sure the security group inbound rule allows HTTPS traffic. For more\n information about security group rules, see Security group\n rules in the Amazon VPC documentation.

", "smithy.api#required": {} } }, "VpcId": { "target": "com.amazonaws.firehose#NonEmptyStringWithoutWhitespace", "traits": { - "smithy.api#documentation": "

The ID of the Amazon ES destination's VPC.

", + "smithy.api#documentation": "

The ID of the Amazon OpenSearch Service destination's VPC.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The details of the VPC of the Amazon ES destination.

" + "smithy.api#documentation": "

The details of the VPC of the Amazon OpenSearch Service destination.

" } }, "com.amazonaws.firehose#VpcEndpointServiceName": {