aws-sdk 2.237.1 → 2.238.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -12,19 +12,19 @@ declare class Firehose extends Service {
12
12
  constructor(options?: Firehose.Types.ClientConfiguration)
13
13
  config: Config & Firehose.Types.ClientConfiguration;
14
14
  /**
15
- * Creates a delivery stream. By default, you can create up to 50 delivery streams per AWS Region. This is an asynchronous operation that immediately returns. The initial status of the delivery stream is CREATING. After the delivery stream is created, its status is ACTIVE and it now accepts data. Attempts to send data to a delivery stream that is not in the ACTIVE state cause an exception. To check the state of a delivery stream, use DescribeDeliveryStream. A Kinesis Data Firehose delivery stream can be configured to receive records directly from providers using PutRecord or PutRecordBatch, or it can be configured to use an existing Kinesis data stream as its source. To specify a Kinesis data stream as input, set the DeliveryStreamType parameter to KinesisStreamAsSource, and provide the Kinesis data stream Amazon Resource Name (ARN) and role ARN in the KinesisStreamSourceConfiguration parameter. A delivery stream is configured with a single destination: Amazon S3, Amazon ES, Amazon Redshift, or Splunk. Specify only one of the following destination configuration parameters: ExtendedS3DestinationConfiguration, S3DestinationConfiguration, ElasticsearchDestinationConfiguration, RedshiftDestinationConfiguration, or SplunkDestinationConfiguration. When you specify S3DestinationConfiguration, you can also provide the following optional values: BufferingHints, EncryptionConfiguration, and CompressionFormat. By default, if no BufferingHints value is provided, Kinesis Data Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. BufferingHints is a hint, so there are some cases where the service cannot adhere to these conditions strictly. For example, record boundaries are such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3. A few notes about Amazon Redshift as a destination: An Amazon Redshift destination requires an S3 bucket as intermediate location. This is because Kinesis Data Firehose first delivers data to Amazon S3 and then uses COPY syntax to load data into an Amazon Redshift table. This is specified in the RedshiftDestinationConfiguration.S3Configuration parameter. The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats. We strongly recommend that you use the user name and password that you provide exclusively with Kinesis Data Firehose. In addition, the permissions for the account should be restricted for Amazon Redshift INSERT permissions. Kinesis Data Firehose assumes the IAM role that is configured as part of the destination. The role should allow the Kinesis Data Firehose principal to assume the role, and the role should have permissions that allow the service to deliver the data. For more information, see Grant Kinesis Firehose Access to an Amazon S3 Destination in the Amazon Kinesis Data Firehose Developer Guide.
15
+ * Creates a Kinesis Data Firehose delivery stream. By default, you can create up to 50 delivery streams per AWS Region. This is an asynchronous operation that immediately returns. The initial status of the delivery stream is CREATING. After the delivery stream is created, its status is ACTIVE and it now accepts data. Attempts to send data to a delivery stream that is not in the ACTIVE state cause an exception. To check the state of a delivery stream, use DescribeDeliveryStream. A Kinesis Data Firehose delivery stream can be configured to receive records directly from providers using PutRecord or PutRecordBatch, or it can be configured to use an existing Kinesis stream as its source. To specify a Kinesis data stream as input, set the DeliveryStreamType parameter to KinesisStreamAsSource, and provide the Kinesis stream Amazon Resource Name (ARN) and role ARN in the KinesisStreamSourceConfiguration parameter. A delivery stream is configured with a single destination: Amazon S3, Amazon ES, Amazon Redshift, or Splunk. You must specify only one of the following destination configuration parameters: ExtendedS3DestinationConfiguration, S3DestinationConfiguration, ElasticsearchDestinationConfiguration, RedshiftDestinationConfiguration, or SplunkDestinationConfiguration. When you specify S3DestinationConfiguration, you can also provide the following optional values: BufferingHints, EncryptionConfiguration, and CompressionFormat. By default, if no BufferingHints value is provided, Kinesis Data Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. BufferingHints is a hint, so there are some cases where the service cannot adhere to these conditions strictly. For example, record boundaries might be such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3. A few notes about Amazon Redshift as a destination: An Amazon Redshift destination requires an S3 bucket as intermediate location. Kinesis Data Firehose first delivers data to Amazon S3 and then uses COPY syntax to load data into an Amazon Redshift table. This is specified in the RedshiftDestinationConfiguration.S3Configuration parameter. The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats. We strongly recommend that you use the user name and password you provide exclusively with Kinesis Data Firehose, and that the permissions for the account are restricted for Amazon Redshift INSERT permissions. Kinesis Data Firehose assumes the IAM role that is configured as part of the destination. The role should allow the Kinesis Data Firehose principal to assume the role, and the role should have permissions that allow the service to deliver the data. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination in the Amazon Kinesis Data Firehose Developer Guide.
16
16
  */
17
17
  createDeliveryStream(params: Firehose.Types.CreateDeliveryStreamInput, callback?: (err: AWSError, data: Firehose.Types.CreateDeliveryStreamOutput) => void): Request<Firehose.Types.CreateDeliveryStreamOutput, AWSError>;
18
18
  /**
19
- * Creates a delivery stream. By default, you can create up to 50 delivery streams per AWS Region. This is an asynchronous operation that immediately returns. The initial status of the delivery stream is CREATING. After the delivery stream is created, its status is ACTIVE and it now accepts data. Attempts to send data to a delivery stream that is not in the ACTIVE state cause an exception. To check the state of a delivery stream, use DescribeDeliveryStream. A Kinesis Data Firehose delivery stream can be configured to receive records directly from providers using PutRecord or PutRecordBatch, or it can be configured to use an existing Kinesis data stream as its source. To specify a Kinesis data stream as input, set the DeliveryStreamType parameter to KinesisStreamAsSource, and provide the Kinesis data stream Amazon Resource Name (ARN) and role ARN in the KinesisStreamSourceConfiguration parameter. A delivery stream is configured with a single destination: Amazon S3, Amazon ES, Amazon Redshift, or Splunk. Specify only one of the following destination configuration parameters: ExtendedS3DestinationConfiguration, S3DestinationConfiguration, ElasticsearchDestinationConfiguration, RedshiftDestinationConfiguration, or SplunkDestinationConfiguration. When you specify S3DestinationConfiguration, you can also provide the following optional values: BufferingHints, EncryptionConfiguration, and CompressionFormat. By default, if no BufferingHints value is provided, Kinesis Data Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. BufferingHints is a hint, so there are some cases where the service cannot adhere to these conditions strictly. For example, record boundaries are such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3. A few notes about Amazon Redshift as a destination: An Amazon Redshift destination requires an S3 bucket as intermediate location. This is because Kinesis Data Firehose first delivers data to Amazon S3 and then uses COPY syntax to load data into an Amazon Redshift table. This is specified in the RedshiftDestinationConfiguration.S3Configuration parameter. The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats. We strongly recommend that you use the user name and password that you provide exclusively with Kinesis Data Firehose. In addition, the permissions for the account should be restricted for Amazon Redshift INSERT permissions. Kinesis Data Firehose assumes the IAM role that is configured as part of the destination. The role should allow the Kinesis Data Firehose principal to assume the role, and the role should have permissions that allow the service to deliver the data. For more information, see Grant Kinesis Firehose Access to an Amazon S3 Destination in the Amazon Kinesis Data Firehose Developer Guide.
19
+ * Creates a Kinesis Data Firehose delivery stream. By default, you can create up to 50 delivery streams per AWS Region. This is an asynchronous operation that immediately returns. The initial status of the delivery stream is CREATING. After the delivery stream is created, its status is ACTIVE and it now accepts data. Attempts to send data to a delivery stream that is not in the ACTIVE state cause an exception. To check the state of a delivery stream, use DescribeDeliveryStream. A Kinesis Data Firehose delivery stream can be configured to receive records directly from providers using PutRecord or PutRecordBatch, or it can be configured to use an existing Kinesis stream as its source. To specify a Kinesis data stream as input, set the DeliveryStreamType parameter to KinesisStreamAsSource, and provide the Kinesis stream Amazon Resource Name (ARN) and role ARN in the KinesisStreamSourceConfiguration parameter. A delivery stream is configured with a single destination: Amazon S3, Amazon ES, Amazon Redshift, or Splunk. You must specify only one of the following destination configuration parameters: ExtendedS3DestinationConfiguration, S3DestinationConfiguration, ElasticsearchDestinationConfiguration, RedshiftDestinationConfiguration, or SplunkDestinationConfiguration. When you specify S3DestinationConfiguration, you can also provide the following optional values: BufferingHints, EncryptionConfiguration, and CompressionFormat. By default, if no BufferingHints value is provided, Kinesis Data Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. BufferingHints is a hint, so there are some cases where the service cannot adhere to these conditions strictly. For example, record boundaries might be such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3. A few notes about Amazon Redshift as a destination: An Amazon Redshift destination requires an S3 bucket as intermediate location. Kinesis Data Firehose first delivers data to Amazon S3 and then uses COPY syntax to load data into an Amazon Redshift table. This is specified in the RedshiftDestinationConfiguration.S3Configuration parameter. The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats. We strongly recommend that you use the user name and password you provide exclusively with Kinesis Data Firehose, and that the permissions for the account are restricted for Amazon Redshift INSERT permissions. Kinesis Data Firehose assumes the IAM role that is configured as part of the destination. The role should allow the Kinesis Data Firehose principal to assume the role, and the role should have permissions that allow the service to deliver the data. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination in the Amazon Kinesis Data Firehose Developer Guide.
20
20
  */
21
21
  createDeliveryStream(callback?: (err: AWSError, data: Firehose.Types.CreateDeliveryStreamOutput) => void): Request<Firehose.Types.CreateDeliveryStreamOutput, AWSError>;
22
22
  /**
23
- * Deletes a delivery stream and its data. You can delete a delivery stream only if it is in ACTIVE or DELETING state, and not in the CREATING state. While the deletion request is in process, the delivery stream is in the DELETING state. To check the state of a delivery stream, use DescribeDeliveryStream. While the delivery stream is DELETING state, the service may continue to accept the records, but the service doesn't make any guarantees with respect to delivering the data. Therefore, as a best practice, you should first stop any applications that are sending records before deleting a delivery stream.
23
+ * Deletes a delivery stream and its data. You can delete a delivery stream only if it is in ACTIVE or DELETING state, and not in the CREATING state. While the deletion request is in process, the delivery stream is in the DELETING state. To check the state of a delivery stream, use DescribeDeliveryStream. While the delivery stream is DELETING state, the service might continue to accept the records, but it doesn't make any guarantees with respect to delivering the data. Therefore, as a best practice, you should first stop any applications that are sending records before deleting a delivery stream.
24
24
  */
25
25
  deleteDeliveryStream(params: Firehose.Types.DeleteDeliveryStreamInput, callback?: (err: AWSError, data: Firehose.Types.DeleteDeliveryStreamOutput) => void): Request<Firehose.Types.DeleteDeliveryStreamOutput, AWSError>;
26
26
  /**
27
- * Deletes a delivery stream and its data. You can delete a delivery stream only if it is in ACTIVE or DELETING state, and not in the CREATING state. While the deletion request is in process, the delivery stream is in the DELETING state. To check the state of a delivery stream, use DescribeDeliveryStream. While the delivery stream is DELETING state, the service may continue to accept the records, but the service doesn't make any guarantees with respect to delivering the data. Therefore, as a best practice, you should first stop any applications that are sending records before deleting a delivery stream.
27
+ * Deletes a delivery stream and its data. You can delete a delivery stream only if it is in ACTIVE or DELETING state, and not in the CREATING state. While the deletion request is in process, the delivery stream is in the DELETING state. To check the state of a delivery stream, use DescribeDeliveryStream. While the delivery stream is DELETING state, the service might continue to accept the records, but it doesn't make any guarantees with respect to delivering the data. Therefore, as a best practice, you should first stop any applications that are sending records before deleting a delivery stream.
28
28
  */
29
29
  deleteDeliveryStream(callback?: (err: AWSError, data: Firehose.Types.DeleteDeliveryStreamOutput) => void): Request<Firehose.Types.DeleteDeliveryStreamOutput, AWSError>;
30
30
  /**
@@ -52,19 +52,19 @@ declare class Firehose extends Service {
52
52
  */
53
53
  listTagsForDeliveryStream(callback?: (err: AWSError, data: Firehose.Types.ListTagsForDeliveryStreamOutput) => void): Request<Firehose.Types.ListTagsForDeliveryStreamOutput, AWSError>;
54
54
  /**
55
- * Writes a single data record into an Amazon Kinesis Data Firehose delivery stream. To write multiple data records into a delivery stream, use PutRecordBatch. Applications using these operations are referred to as producers. By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. Note that if you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each delivery stream. For more information about limits and how to request an increase, see Amazon Kinesis Data Firehose Limits. You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KB in size and any kind of data. For example, it can be a segment from a log file, geographic location data, website clickstream data, and so on. Kinesis Data Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\n) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination. The PutRecord operation returns a RecordId, which is a unique string assigned to each record. Producer applications can use this ID for purposes such as auditability and investigation. If the PutRecord operation throws a ServiceUnavailableException, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream. Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.
55
+ * Writes a single data record into an Amazon Kinesis Data Firehose delivery stream. To write multiple data records into a delivery stream, use PutRecordBatch. Applications using these operations are referred to as producers. By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. If you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each delivery stream. For more information about limits and how to request an increase, see Amazon Kinesis Data Firehose Limits. You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data. For example, it can be a segment from a log file, geographic location data, website clickstream data, and so on. Kinesis Data Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\n) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination. The PutRecord operation returns a RecordId, which is a unique string assigned to each record. Producer applications can use this ID for purposes such as auditability and investigation. If the PutRecord operation throws a ServiceUnavailableException, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream. Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they are added to a delivery stream as it tries to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.
56
56
  */
57
57
  putRecord(params: Firehose.Types.PutRecordInput, callback?: (err: AWSError, data: Firehose.Types.PutRecordOutput) => void): Request<Firehose.Types.PutRecordOutput, AWSError>;
58
58
  /**
59
- * Writes a single data record into an Amazon Kinesis Data Firehose delivery stream. To write multiple data records into a delivery stream, use PutRecordBatch. Applications using these operations are referred to as producers. By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. Note that if you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each delivery stream. For more information about limits and how to request an increase, see Amazon Kinesis Data Firehose Limits. You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KB in size and any kind of data. For example, it can be a segment from a log file, geographic location data, website clickstream data, and so on. Kinesis Data Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\n) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination. The PutRecord operation returns a RecordId, which is a unique string assigned to each record. Producer applications can use this ID for purposes such as auditability and investigation. If the PutRecord operation throws a ServiceUnavailableException, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream. Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.
59
+ * Writes a single data record into an Amazon Kinesis Data Firehose delivery stream. To write multiple data records into a delivery stream, use PutRecordBatch. Applications using these operations are referred to as producers. By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. If you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each delivery stream. For more information about limits and how to request an increase, see Amazon Kinesis Data Firehose Limits. You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data. For example, it can be a segment from a log file, geographic location data, website clickstream data, and so on. Kinesis Data Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\n) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination. The PutRecord operation returns a RecordId, which is a unique string assigned to each record. Producer applications can use this ID for purposes such as auditability and investigation. If the PutRecord operation throws a ServiceUnavailableException, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream. Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they are added to a delivery stream as it tries to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.
60
60
  */
61
61
  putRecord(callback?: (err: AWSError, data: Firehose.Types.PutRecordOutput) => void): Request<Firehose.Types.PutRecordOutput, AWSError>;
62
62
  /**
63
- * Writes multiple data records into a delivery stream in a single call, which can achieve higher throughput per producer than when writing single records. To write single data records into a delivery stream, use PutRecord. Applications using these operations are referred to as producers. By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. If you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each delivery stream. For more information about limits, see Amazon Kinesis Data Firehose Limits. Each PutRecordBatch request supports up to 500 records. Each record in the request can be as large as 1,000 KB (before 64-bit encoding), up to a limit of 4 MB for the entire request. These limits cannot be changed. You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KB in size and any kind of data. For example, it could be a segment from a log file, geographic location data, website clickstream data, and so on. Kinesis Data Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\n) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination. The PutRecordBatch response includes a count of failed records, FailedPutCount, and an array of responses, RequestResponses. Each entry in the RequestResponses array provides additional information about the processed record. It directly correlates with a record in the request array using the same ordering, from the top to the bottom. The response array always includes the same number of records as the request array. RequestResponses includes both successfully and unsuccessfully processed records. Kinesis Data Firehose attempts to process all records in each PutRecordBatch request. A single record failure does not stop the processing of subsequent records. A successfully processed record includes a RecordId value, which is unique for the record. An unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error, and is one of the following values: ServiceUnavailable or InternalFailure. ErrorMessage provides more detailed information about the error. If there is an internal server error or a timeout, the write might have completed or it might have failed. If FailedPutCount is greater than 0, retry the request, resending only those records that might have failed processing. This minimizes the possible duplicate records and also reduces the total bytes sent (and corresponding charges). We recommend that you handle any duplicates at the destination. If PutRecordBatch throws ServiceUnavailableException, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream. Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.
63
+ * Writes multiple data records into a delivery stream in a single call, which can achieve higher throughput per producer than when writing single records. To write single data records into a delivery stream, use PutRecord. Applications using these operations are referred to as producers. By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. If you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each delivery stream. For more information about limits, see Amazon Kinesis Data Firehose Limits. Each PutRecordBatch request supports up to 500 records. Each record in the request can be as large as 1,000 KB (before 64-bit encoding), up to a limit of 4 MB for the entire request. These limits cannot be changed. You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data. For example, it could be a segment from a log file, geographic location data, website clickstream data, and so on. Kinesis Data Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\n) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination. The PutRecordBatch response includes a count of failed records, FailedPutCount, and an array of responses, RequestResponses. Each entry in the RequestResponses array provides additional information about the processed record. It directly correlates with a record in the request array using the same ordering, from the top to the bottom. The response array always includes the same number of records as the request array. RequestResponses includes both successfully and unsuccessfully processed records. Kinesis Data Firehose tries to process all records in each PutRecordBatch request. A single record failure does not stop the processing of subsequent records. A successfully processed record includes a RecordId value, which is unique for the record. An unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error, and is one of the following values: ServiceUnavailable or InternalFailure. ErrorMessage provides more detailed information about the error. If there is an internal server error or a timeout, the write might have completed or it might have failed. If FailedPutCount is greater than 0, retry the request, resending only those records that might have failed processing. This minimizes the possible duplicate records and also reduces the total bytes sent (and corresponding charges). We recommend that you handle any duplicates at the destination. If PutRecordBatch throws ServiceUnavailableException, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream. Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.
64
64
  */
65
65
  putRecordBatch(params: Firehose.Types.PutRecordBatchInput, callback?: (err: AWSError, data: Firehose.Types.PutRecordBatchOutput) => void): Request<Firehose.Types.PutRecordBatchOutput, AWSError>;
66
66
  /**
67
- * Writes multiple data records into a delivery stream in a single call, which can achieve higher throughput per producer than when writing single records. To write single data records into a delivery stream, use PutRecord. Applications using these operations are referred to as producers. By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. If you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each delivery stream. For more information about limits, see Amazon Kinesis Data Firehose Limits. Each PutRecordBatch request supports up to 500 records. Each record in the request can be as large as 1,000 KB (before 64-bit encoding), up to a limit of 4 MB for the entire request. These limits cannot be changed. You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KB in size and any kind of data. For example, it could be a segment from a log file, geographic location data, website clickstream data, and so on. Kinesis Data Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\n) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination. The PutRecordBatch response includes a count of failed records, FailedPutCount, and an array of responses, RequestResponses. Each entry in the RequestResponses array provides additional information about the processed record. It directly correlates with a record in the request array using the same ordering, from the top to the bottom. The response array always includes the same number of records as the request array. RequestResponses includes both successfully and unsuccessfully processed records. Kinesis Data Firehose attempts to process all records in each PutRecordBatch request. A single record failure does not stop the processing of subsequent records. A successfully processed record includes a RecordId value, which is unique for the record. An unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error, and is one of the following values: ServiceUnavailable or InternalFailure. ErrorMessage provides more detailed information about the error. If there is an internal server error or a timeout, the write might have completed or it might have failed. If FailedPutCount is greater than 0, retry the request, resending only those records that might have failed processing. This minimizes the possible duplicate records and also reduces the total bytes sent (and corresponding charges). We recommend that you handle any duplicates at the destination. If PutRecordBatch throws ServiceUnavailableException, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream. Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.
67
+ * Writes multiple data records into a delivery stream in a single call, which can achieve higher throughput per producer than when writing single records. To write single data records into a delivery stream, use PutRecord. Applications using these operations are referred to as producers. By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. If you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each delivery stream. For more information about limits, see Amazon Kinesis Data Firehose Limits. Each PutRecordBatch request supports up to 500 records. Each record in the request can be as large as 1,000 KB (before 64-bit encoding), up to a limit of 4 MB for the entire request. These limits cannot be changed. You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data. For example, it could be a segment from a log file, geographic location data, website clickstream data, and so on. Kinesis Data Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\n) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination. The PutRecordBatch response includes a count of failed records, FailedPutCount, and an array of responses, RequestResponses. Each entry in the RequestResponses array provides additional information about the processed record. It directly correlates with a record in the request array using the same ordering, from the top to the bottom. The response array always includes the same number of records as the request array. RequestResponses includes both successfully and unsuccessfully processed records. Kinesis Data Firehose tries to process all records in each PutRecordBatch request. A single record failure does not stop the processing of subsequent records. A successfully processed record includes a RecordId value, which is unique for the record. An unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error, and is one of the following values: ServiceUnavailable or InternalFailure. ErrorMessage provides more detailed information about the error. If there is an internal server error or a timeout, the write might have completed or it might have failed. If FailedPutCount is greater than 0, retry the request, resending only those records that might have failed processing. This minimizes the possible duplicate records and also reduces the total bytes sent (and corresponding charges). We recommend that you handle any duplicates at the destination. If PutRecordBatch throws ServiceUnavailableException, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream. Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.
68
68
  */
69
69
  putRecordBatch(callback?: (err: AWSError, data: Firehose.Types.PutRecordBatchOutput) => void): Request<Firehose.Types.PutRecordBatchOutput, AWSError>;
70
70
  /**
@@ -84,16 +84,17 @@ declare class Firehose extends Service {
84
84
  */
85
85
  untagDeliveryStream(callback?: (err: AWSError, data: Firehose.Types.UntagDeliveryStreamOutput) => void): Request<Firehose.Types.UntagDeliveryStreamOutput, AWSError>;
86
86
  /**
87
- * Updates the specified destination of the specified delivery stream. Use this operation to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a destination (for example, to change the bucket name of the Amazon S3 destination). The update might not occur immediately. The target delivery stream remains active while the configurations are updated, so data writes to the delivery stream can continue during this process. The updated configurations are usually effective within a few minutes. Switching between Amazon ES and other services is not supported. For an Amazon ES destination, you can only update to another Amazon ES destination. If the destination type is the same, Kinesis Data Firehose merges the configuration parameters specified with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the call, the existing values are retained. For example, in the Amazon S3 destination, if EncryptionConfiguration is not specified, then the existing EncryptionConfiguration is maintained on the destination. If the destination type is not the same, for example, changing the destination from Amazon S3 to Amazon Redshift, Kinesis Data Firehose does not merge any parameters. In this case, all parameters must be specified. Kinesis Data Firehose uses CurrentDeliveryStreamVersionId to avoid race conditions and conflicting merges. This is a required field, and the service updates the configuration only if the existing configuration has a version ID that matches. After the update is applied successfully, the version ID is updated, and you can retrieve it using DescribeDeliveryStream. Use the new version ID to set CurrentDeliveryStreamVersionId in the next call.
87
+ * Updates the specified destination of the specified delivery stream. Use this operation to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a destination (for example, to change the bucket name of the Amazon S3 destination). The update might not occur immediately. The target delivery stream remains active while the configurations are updated, so data writes to the delivery stream can continue during this process. The updated configurations are usually effective within a few minutes. Switching between Amazon ES and other services is not supported. For an Amazon ES destination, you can only update to another Amazon ES destination. If the destination type is the same, Kinesis Data Firehose merges the configuration parameters specified with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the call, the existing values are retained. For example, in the Amazon S3 destination, if EncryptionConfiguration is not specified, then the existing EncryptionConfiguration is maintained on the destination. If the destination type is not the same, for example, changing the destination from Amazon S3 to Amazon Redshift, Kinesis Data Firehose does not merge any parameters. In this case, all parameters must be specified. Kinesis Data Firehose uses CurrentDeliveryStreamVersionId to avoid race conditions and conflicting merges. This is a required field, and the service updates the configuration only if the existing configuration has a version ID that matches. After the update is applied successfully, the version ID is updated, and can be retrieved using DescribeDeliveryStream. Use the new version ID to set CurrentDeliveryStreamVersionId in the next call.
88
88
  */
89
89
  updateDestination(params: Firehose.Types.UpdateDestinationInput, callback?: (err: AWSError, data: Firehose.Types.UpdateDestinationOutput) => void): Request<Firehose.Types.UpdateDestinationOutput, AWSError>;
90
90
  /**
91
- * Updates the specified destination of the specified delivery stream. Use this operation to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a destination (for example, to change the bucket name of the Amazon S3 destination). The update might not occur immediately. The target delivery stream remains active while the configurations are updated, so data writes to the delivery stream can continue during this process. The updated configurations are usually effective within a few minutes. Switching between Amazon ES and other services is not supported. For an Amazon ES destination, you can only update to another Amazon ES destination. If the destination type is the same, Kinesis Data Firehose merges the configuration parameters specified with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the call, the existing values are retained. For example, in the Amazon S3 destination, if EncryptionConfiguration is not specified, then the existing EncryptionConfiguration is maintained on the destination. If the destination type is not the same, for example, changing the destination from Amazon S3 to Amazon Redshift, Kinesis Data Firehose does not merge any parameters. In this case, all parameters must be specified. Kinesis Data Firehose uses CurrentDeliveryStreamVersionId to avoid race conditions and conflicting merges. This is a required field, and the service updates the configuration only if the existing configuration has a version ID that matches. After the update is applied successfully, the version ID is updated, and you can retrieve it using DescribeDeliveryStream. Use the new version ID to set CurrentDeliveryStreamVersionId in the next call.
91
+ * Updates the specified destination of the specified delivery stream. Use this operation to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a destination (for example, to change the bucket name of the Amazon S3 destination). The update might not occur immediately. The target delivery stream remains active while the configurations are updated, so data writes to the delivery stream can continue during this process. The updated configurations are usually effective within a few minutes. Switching between Amazon ES and other services is not supported. For an Amazon ES destination, you can only update to another Amazon ES destination. If the destination type is the same, Kinesis Data Firehose merges the configuration parameters specified with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the call, the existing values are retained. For example, in the Amazon S3 destination, if EncryptionConfiguration is not specified, then the existing EncryptionConfiguration is maintained on the destination. If the destination type is not the same, for example, changing the destination from Amazon S3 to Amazon Redshift, Kinesis Data Firehose does not merge any parameters. In this case, all parameters must be specified. Kinesis Data Firehose uses CurrentDeliveryStreamVersionId to avoid race conditions and conflicting merges. This is a required field, and the service updates the configuration only if the existing configuration has a version ID that matches. After the update is applied successfully, the version ID is updated, and can be retrieved using DescribeDeliveryStream. Use the new version ID to set CurrentDeliveryStreamVersionId in the next call.
92
92
  */
93
93
  updateDestination(callback?: (err: AWSError, data: Firehose.Types.UpdateDestinationOutput) => void): Request<Firehose.Types.UpdateDestinationOutput, AWSError>;
94
94
  }
95
95
  declare namespace Firehose {
96
96
  export type AWSKMSKeyARN = string;
97
+ export type BlockSizeBytes = number;
97
98
  export type BooleanObject = boolean;
98
99
  export type BucketARN = string;
99
100
  export interface BufferingHints {
@@ -121,6 +122,7 @@ declare namespace Firehose {
121
122
  LogStreamName?: LogStreamName;
122
123
  }
123
124
  export type ClusterJDBCURL = string;
125
+ export type ColumnToJsonKeyMappings = {[key: string]: NonEmptyString};
124
126
  export type CompressionFormat = "UNCOMPRESSED"|"GZIP"|"ZIP"|"Snappy"|string;
125
127
  export interface CopyCommand {
126
128
  /**
@@ -139,7 +141,7 @@ declare namespace Firehose {
139
141
  export type CopyOptions = string;
140
142
  export interface CreateDeliveryStreamInput {
141
143
  /**
142
- * The name of the delivery stream. This name must be unique per AWS account in the same Region. If the delivery streams are in different accounts or different Regions, you can have multiple delivery streams with the same name.
144
+ * The name of the delivery stream. This name must be unique per AWS account in the same AWS Region. If the delivery streams are in different accounts or different Regions, you can have multiple delivery streams with the same name.
143
145
  */
144
146
  DeliveryStreamName: DeliveryStreamName;
145
147
  /**
@@ -178,6 +180,24 @@ declare namespace Firehose {
178
180
  DeliveryStreamARN?: DeliveryStreamARN;
179
181
  }
180
182
  export type Data = Buffer|Uint8Array|Blob|string;
183
+ export interface DataFormatConversionConfiguration {
184
+ /**
185
+ * Specifies the AWS Glue Data Catalog table that contains the column information.
186
+ */
187
+ SchemaConfiguration?: SchemaConfiguration;
188
+ /**
189
+ * Specifies the deserializer that you want Kinesis Data Firehose to use to convert the format of your data from JSON.
190
+ */
191
+ InputFormatConfiguration?: InputFormatConfiguration;
192
+ /**
193
+ * Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data to the Parquet or ORC format.
194
+ */
195
+ OutputFormatConfiguration?: OutputFormatConfiguration;
196
+ /**
197
+ * Defaults to true. Set it to false if you want to disable format conversion while preserving the configuration details.
198
+ */
199
+ Enabled?: BooleanObject;
200
+ }
181
201
  export type DataTableColumns = string;
182
202
  export type DataTableName = string;
183
203
  export interface DeleteDeliveryStreamInput {
@@ -196,7 +216,7 @@ declare namespace Firehose {
196
216
  */
197
217
  DeliveryStreamName: DeliveryStreamName;
198
218
  /**
199
- * The Amazon Resource Name (ARN) of the delivery stream.
219
+ * The Amazon Resource Name (ARN) of the delivery stream. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
200
220
  */
201
221
  DeliveryStreamARN: DeliveryStreamARN;
202
222
  /**
@@ -243,11 +263,11 @@ declare namespace Firehose {
243
263
  */
244
264
  DeliveryStreamName: DeliveryStreamName;
245
265
  /**
246
- * The limit on the number of destinations to return. Currently, you can have one destination per delivery stream.
266
+ * The limit on the number of destinations to return. You can have one destination per delivery stream.
247
267
  */
248
268
  Limit?: DescribeDeliveryStreamInputLimit;
249
269
  /**
250
- * The ID of the destination to start returning the destination information. Currently, Kinesis Data Firehose supports one destination per delivery stream.
270
+ * The ID of the destination to start returning the destination information. Kinesis Data Firehose supports one destination per delivery stream.
251
271
  */
252
272
  ExclusiveStartDestinationId?: DestinationId;
253
273
  }
@@ -258,6 +278,16 @@ declare namespace Firehose {
258
278
  */
259
279
  DeliveryStreamDescription: DeliveryStreamDescription;
260
280
  }
281
+ export interface Deserializer {
282
+ /**
283
+ * The OpenX SerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe.
284
+ */
285
+ OpenXJsonSerDe?: OpenXJsonSerDe;
286
+ /**
287
+ * The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe.
288
+ */
289
+ HiveJsonSerDe?: HiveJsonSerDe;
290
+ }
261
291
  export interface DestinationDescription {
262
292
  /**
263
293
  * The ID of the destination.
@@ -300,11 +330,11 @@ declare namespace Firehose {
300
330
  export type ElasticsearchBufferingSizeInMBs = number;
301
331
  export interface ElasticsearchDestinationConfiguration {
302
332
  /**
303
- * The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon Destination.
333
+ * The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and AWS Service Namespaces.
304
334
  */
305
335
  RoleARN: RoleARN;
306
336
  /**
307
- * The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN.
337
+ * The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
308
338
  */
309
339
  DomainARN: ElasticsearchDomainARN;
310
340
  /**
@@ -312,7 +342,7 @@ declare namespace Firehose {
312
342
  */
313
343
  IndexName: ElasticsearchIndexName;
314
344
  /**
315
- * The Elasticsearch type name.
345
+ * The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during run time.
316
346
  */
317
347
  TypeName: ElasticsearchTypeName;
318
348
  /**
@@ -328,7 +358,7 @@ declare namespace Firehose {
328
358
  */
329
359
  RetryOptions?: ElasticsearchRetryOptions;
330
360
  /**
331
- * Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with elasticsearch-failed/ appended to the key prefix. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with elasticsearch-failed/ appended to the prefix. For more information, see Data Delivery Failure Handling. Default value is FailedDocumentsOnly.
361
+ * Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with elasticsearch-failed/ appended to the key prefix. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with elasticsearch-failed/ appended to the prefix. For more information, see Amazon S3 Backup for the Amazon ES Destination. Default value is FailedDocumentsOnly.
332
362
  */
333
363
  S3BackupMode?: ElasticsearchS3BackupMode;
334
364
  /**
@@ -340,17 +370,17 @@ declare namespace Firehose {
340
370
  */
341
371
  ProcessingConfiguration?: ProcessingConfiguration;
342
372
  /**
343
- * The CloudWatch logging options for your delivery stream.
373
+ * The Amazon CloudWatch logging options for your delivery stream.
344
374
  */
345
375
  CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
346
376
  }
347
377
  export interface ElasticsearchDestinationDescription {
348
378
  /**
349
- * The Amazon Resource Name (ARN) of the AWS credentials.
379
+ * The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
350
380
  */
351
381
  RoleARN?: RoleARN;
352
382
  /**
353
- * The ARN of the Amazon ES domain.
383
+ * The ARN of the Amazon ES domain. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
354
384
  */
355
385
  DomainARN?: ElasticsearchDomainARN;
356
386
  /**
@@ -386,17 +416,17 @@ declare namespace Firehose {
386
416
  */
387
417
  ProcessingConfiguration?: ProcessingConfiguration;
388
418
  /**
389
- * The CloudWatch logging options.
419
+ * The Amazon CloudWatch logging options.
390
420
  */
391
421
  CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
392
422
  }
393
423
  export interface ElasticsearchDestinationUpdate {
394
424
  /**
395
- * The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination.
425
+ * The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and AWS Service Namespaces.
396
426
  */
397
427
  RoleARN?: RoleARN;
398
428
  /**
399
- * The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the IAM role specified in RoleARN.
429
+ * The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the IAM role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
400
430
  */
401
431
  DomainARN?: ElasticsearchDomainARN;
402
432
  /**
@@ -404,7 +434,7 @@ declare namespace Firehose {
404
434
  */
405
435
  IndexName?: ElasticsearchIndexName;
406
436
  /**
407
- * The Elasticsearch type name.
437
+ * The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during runtime.
408
438
  */
409
439
  TypeName?: ElasticsearchTypeName;
410
440
  /**
@@ -438,7 +468,7 @@ declare namespace Firehose {
438
468
  export type ElasticsearchRetryDurationInSeconds = number;
439
469
  export interface ElasticsearchRetryOptions {
440
470
  /**
441
- * After an initial failure to deliver to Amazon ES, the total amount of time during which Kinesis Data Firehose re-attempts 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.
471
+ * After an initial failure to deliver to Amazon ES, the total amount of time during which Kinesis Data 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.
442
472
  */
443
473
  DurationInSeconds?: ElasticsearchRetryDurationInSeconds;
444
474
  }
@@ -458,11 +488,11 @@ declare namespace Firehose {
458
488
  export type ErrorMessage = string;
459
489
  export interface ExtendedS3DestinationConfiguration {
460
490
  /**
461
- * The Amazon Resource Name (ARN) of the AWS credentials.
491
+ * The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
462
492
  */
463
493
  RoleARN: RoleARN;
464
494
  /**
465
- * The ARN of the S3 bucket.
495
+ * The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
466
496
  */
467
497
  BucketARN: BucketARN;
468
498
  /**
@@ -482,7 +512,7 @@ declare namespace Firehose {
482
512
  */
483
513
  EncryptionConfiguration?: EncryptionConfiguration;
484
514
  /**
485
- * The CloudWatch logging options for your delivery stream.
515
+ * The Amazon CloudWatch logging options for your delivery stream.
486
516
  */
487
517
  CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
488
518
  /**
@@ -497,18 +527,22 @@ declare namespace Firehose {
497
527
  * The configuration for backup in Amazon S3.
498
528
  */
499
529
  S3BackupConfiguration?: S3DestinationConfiguration;
530
+ /**
531
+ * The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.
532
+ */
533
+ DataFormatConversionConfiguration?: DataFormatConversionConfiguration;
500
534
  }
501
535
  export interface ExtendedS3DestinationDescription {
502
536
  /**
503
- * The Amazon Resource Name (ARN) of the AWS credentials.
537
+ * The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
504
538
  */
505
539
  RoleARN: RoleARN;
506
540
  /**
507
- * The ARN of the S3 bucket.
541
+ * The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
508
542
  */
509
543
  BucketARN: BucketARN;
510
544
  /**
511
- * The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide.
545
+ * The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide.
512
546
  */
513
547
  Prefix?: Prefix;
514
548
  /**
@@ -524,7 +558,7 @@ declare namespace Firehose {
524
558
  */
525
559
  EncryptionConfiguration: EncryptionConfiguration;
526
560
  /**
527
- * The CloudWatch logging options for your delivery stream.
561
+ * The Amazon CloudWatch logging options for your delivery stream.
528
562
  */
529
563
  CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
530
564
  /**
@@ -539,14 +573,18 @@ declare namespace Firehose {
539
573
  * The configuration for backup in Amazon S3.
540
574
  */
541
575
  S3BackupDescription?: S3DestinationDescription;
576
+ /**
577
+ * The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.
578
+ */
579
+ DataFormatConversionConfiguration?: DataFormatConversionConfiguration;
542
580
  }
543
581
  export interface ExtendedS3DestinationUpdate {
544
582
  /**
545
- * The Amazon Resource Name (ARN) of the AWS credentials.
583
+ * The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
546
584
  */
547
585
  RoleARN?: RoleARN;
548
586
  /**
549
- * The ARN of the S3 bucket.
587
+ * The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
550
588
  */
551
589
  BucketARN?: BucketARN;
552
590
  /**
@@ -566,7 +604,7 @@ declare namespace Firehose {
566
604
  */
567
605
  EncryptionConfiguration?: EncryptionConfiguration;
568
606
  /**
569
- * The CloudWatch logging options for your delivery stream.
607
+ * The Amazon CloudWatch logging options for your delivery stream.
570
608
  */
571
609
  CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
572
610
  /**
@@ -581,36 +619,52 @@ declare namespace Firehose {
581
619
  * The Amazon S3 destination for backup.
582
620
  */
583
621
  S3BackupUpdate?: S3DestinationUpdate;
622
+ /**
623
+ * The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.
624
+ */
625
+ DataFormatConversionConfiguration?: DataFormatConversionConfiguration;
584
626
  }
585
627
  export type HECAcknowledgmentTimeoutInSeconds = number;
586
628
  export type HECEndpoint = string;
587
629
  export type HECEndpointType = "Raw"|"Event"|string;
588
630
  export type HECToken = string;
631
+ export interface HiveJsonSerDe {
632
+ /**
633
+ * Indicates how you want Kinesis Data Firehose to parse the date and time stamps that may be present in your input data JSON. To specify these format strings, follow the pattern syntax of JodaTime's DateTimeFormat format strings. For more information, see Class DateTimeFormat. You can also use the special value millis to parse time stamps in epoch milliseconds. If you don't specify a format, Kinesis Data Firehose uses java.sql.Timestamp::valueOf by default.
634
+ */
635
+ TimestampFormats?: ListOfNonEmptyStrings;
636
+ }
637
+ export interface InputFormatConfiguration {
638
+ /**
639
+ * Specifies which deserializer to use. You can choose either the Apache Hive JSON SerDe or the OpenX JSON SerDe. If both are non-null, the server rejects the request.
640
+ */
641
+ Deserializer?: Deserializer;
642
+ }
589
643
  export type IntervalInSeconds = number;
590
644
  export interface KMSEncryptionConfig {
591
645
  /**
592
- * The Amazon Resource Name (ARN) of the encryption key. Must belong to the same AWS Region as the destination Amazon S3 bucket.
646
+ * The Amazon Resource Name (ARN) of the encryption key. Must belong to the same AWS Region as the destination Amazon S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
593
647
  */
594
648
  AWSKMSKeyARN: AWSKMSKeyARN;
595
649
  }
596
650
  export type KinesisStreamARN = string;
597
651
  export interface KinesisStreamSourceConfiguration {
598
652
  /**
599
- * The ARN of the source Kinesis data stream.
653
+ * The ARN of the source Kinesis data stream. For more information, see Amazon Kinesis Data Streams ARN Format.
600
654
  */
601
655
  KinesisStreamARN: KinesisStreamARN;
602
656
  /**
603
- * The ARN of the role that provides access to the source Kinesis data stream.
657
+ * The ARN of the role that provides access to the source Kinesis data stream. For more information, see AWS Identity and Access Management (IAM) ARN Format.
604
658
  */
605
659
  RoleARN: RoleARN;
606
660
  }
607
661
  export interface KinesisStreamSourceDescription {
608
662
  /**
609
- * The Amazon Resource Name (ARN) of the source Kinesis data stream.
663
+ * The Amazon Resource Name (ARN) of the source Kinesis data stream. For more information, see Amazon Kinesis Data Streams ARN Format.
610
664
  */
611
665
  KinesisStreamARN?: KinesisStreamARN;
612
666
  /**
613
- * The ARN of the role used by the source Kinesis data stream.
667
+ * The ARN of the role used by the source Kinesis data stream. For more information, see AWS Identity and Access Management (IAM) ARN Format.
614
668
  */
615
669
  RoleARN?: RoleARN;
616
670
  /**
@@ -643,6 +697,8 @@ declare namespace Firehose {
643
697
  */
644
698
  HasMoreDeliveryStreams: BooleanObject;
645
699
  }
700
+ export type ListOfNonEmptyStrings = NonEmptyString[];
701
+ export type ListOfNonEmptyStringsWithoutWhitespace = NonEmptyStringWithoutWhitespace[];
646
702
  export interface ListTagsForDeliveryStreamInput {
647
703
  /**
648
704
  * The name of the delivery stream whose tags you want to list.
@@ -672,7 +728,104 @@ declare namespace Firehose {
672
728
  export type LogGroupName = string;
673
729
  export type LogStreamName = string;
674
730
  export type NoEncryptionConfig = "NoEncryption"|string;
731
+ export type NonEmptyString = string;
732
+ export type NonEmptyStringWithoutWhitespace = string;
675
733
  export type NonNegativeIntegerObject = number;
734
+ export interface OpenXJsonSerDe {
735
+ /**
736
+ * When set to true, specifies that the names of the keys include dots and that you want Kinesis Data Firehose to replace them with underscores. This is useful because Apache Hive does not allow dots in column names. For example, if the JSON contains a key whose name is "a.b", you can define the column name to be "a_b" when using this option. The default is false.
737
+ */
738
+ ConvertDotsInJsonKeysToUnderscores?: BooleanObject;
739
+ /**
740
+ * When set to true, which is the default, Kinesis Data Firehose converts JSON keys to lowercase before deserializing them.
741
+ */
742
+ CaseInsensitive?: BooleanObject;
743
+ /**
744
+ * Maps column names to JSON keys that aren't identical to the column names. This is useful when the JSON contains keys that are Hive keywords. For example, timestamp is a Hive keyword. If you have a JSON key named timestamp, set this parameter to {"ts": "timestamp"} to map this key to a column named ts.
745
+ */
746
+ ColumnToJsonKeyMappings?: ColumnToJsonKeyMappings;
747
+ }
748
+ export type OrcCompression = "NONE"|"ZLIB"|"SNAPPY"|string;
749
+ export type OrcFormatVersion = "V0_11"|"V0_12"|string;
750
+ export type OrcRowIndexStride = number;
751
+ export interface OrcSerDe {
752
+ /**
753
+ * The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB.
754
+ */
755
+ StripeSizeBytes?: OrcStripeSizeBytes;
756
+ /**
757
+ * The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations.
758
+ */
759
+ BlockSizeBytes?: BlockSizeBytes;
760
+ /**
761
+ * The number of rows between index entries. The default is 10,000 and the minimum is 1,000.
762
+ */
763
+ RowIndexStride?: OrcRowIndexStride;
764
+ /**
765
+ * Set this to true to indicate that you want stripes to be padded to the HDFS block boundaries. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is false.
766
+ */
767
+ EnablePadding?: BooleanObject;
768
+ /**
769
+ * A number between 0 and 1 that defines the tolerance for block padding as a decimal fraction of stripe size. The default value is 0.05, which means 5 percent of stripe size. For the default values of 64 MiB ORC stripes and 256 MiB HDFS blocks, the default block padding tolerance of 5 percent reserves a maximum of 3.2 MiB for padding within the 256 MiB block. In such a case, if the available size within the block is more than 3.2 MiB, a new, smaller stripe is inserted to fit within that space. This ensures that no stripe crosses block boundaries and causes remote reads within a node-local task. Kinesis Data Firehose ignores this parameter when OrcSerDe$EnablePadding is false.
770
+ */
771
+ PaddingTolerance?: Proportion;
772
+ /**
773
+ * The compression code to use over data blocks. The default is SNAPPY.
774
+ */
775
+ Compression?: OrcCompression;
776
+ /**
777
+ * The column names for which you want Kinesis Data Firehose to create bloom filters. The default is null.
778
+ */
779
+ BloomFilterColumns?: ListOfNonEmptyStringsWithoutWhitespace;
780
+ /**
781
+ * The Bloom filter false positive probability (FPP). The lower the FPP, the bigger the Bloom filter. The default value is 0.05, the minimum is 0, and the maximum is 1.
782
+ */
783
+ BloomFilterFalsePositiveProbability?: Proportion;
784
+ /**
785
+ * Represents the fraction of the total number of non-null rows. To turn off dictionary encoding, set this fraction to a number that is less than the number of distinct keys in a dictionary. To always use dictionary encoding, set this threshold to 1.
786
+ */
787
+ DictionaryKeyThreshold?: Proportion;
788
+ /**
789
+ * The version of the file to write. The possible values are V0_11 and V0_12. The default is V0_12.
790
+ */
791
+ FormatVersion?: OrcFormatVersion;
792
+ }
793
+ export type OrcStripeSizeBytes = number;
794
+ export interface OutputFormatConfiguration {
795
+ /**
796
+ * Specifies which serializer to use. You can choose either the ORC SerDe or the Parquet SerDe. If both are non-null, the server rejects the request.
797
+ */
798
+ Serializer?: Serializer;
799
+ }
800
+ export type ParquetCompression = "UNCOMPRESSED"|"GZIP"|"SNAPPY"|string;
801
+ export type ParquetPageSizeBytes = number;
802
+ export interface ParquetSerDe {
803
+ /**
804
+ * The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations.
805
+ */
806
+ BlockSizeBytes?: BlockSizeBytes;
807
+ /**
808
+ * The Parquet page size. Column chunks are divided into pages. A page is conceptually an indivisible unit (in terms of compression and encoding). The minimum value is 64 KiB and the default is 1 MiB.
809
+ */
810
+ PageSizeBytes?: ParquetPageSizeBytes;
811
+ /**
812
+ * The compression code to use over data blocks. The possible values are UNCOMPRESSED, SNAPPY, and GZIP, with the default being SNAPPY. Use SNAPPY for higher decompression speed. Use GZIP if the compression ration is more important than speed.
813
+ */
814
+ Compression?: ParquetCompression;
815
+ /**
816
+ * Indicates whether to enable dictionary compression.
817
+ */
818
+ EnableDictionaryCompression?: BooleanObject;
819
+ /**
820
+ * The maximum amount of padding to apply. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 0.
821
+ */
822
+ MaxPaddingBytes?: NonNegativeIntegerObject;
823
+ /**
824
+ * Indicates the version of row format to output. The possible values are V1 and V2. The default is V1.
825
+ */
826
+ WriterVersion?: ParquetWriterVersion;
827
+ }
828
+ export type ParquetWriterVersion = "V1"|"V2"|string;
676
829
  export type Password = string;
677
830
  export type Prefix = string;
678
831
  export interface ProcessingConfiguration {
@@ -710,6 +863,7 @@ declare namespace Firehose {
710
863
  export type ProcessorParameterName = "LambdaArn"|"NumberOfRetries"|"RoleArn"|"BufferSizeInMBs"|"BufferIntervalInSeconds"|string;
711
864
  export type ProcessorParameterValue = string;
712
865
  export type ProcessorType = "Lambda"|string;
866
+ export type Proportion = number;
713
867
  export interface PutRecordBatchInput {
714
868
  /**
715
869
  * The name of the delivery stream.
@@ -771,7 +925,7 @@ declare namespace Firehose {
771
925
  }
772
926
  export interface RedshiftDestinationConfiguration {
773
927
  /**
774
- * The Amazon Resource Name (ARN) of the AWS credentials.
928
+ * The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
775
929
  */
776
930
  RoleARN: RoleARN;
777
931
  /**
@@ -817,7 +971,7 @@ declare namespace Firehose {
817
971
  }
818
972
  export interface RedshiftDestinationDescription {
819
973
  /**
820
- * The Amazon Resource Name (ARN) of the AWS credentials.
974
+ * The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
821
975
  */
822
976
  RoleARN: RoleARN;
823
977
  /**
@@ -853,13 +1007,13 @@ declare namespace Firehose {
853
1007
  */
854
1008
  S3BackupDescription?: S3DestinationDescription;
855
1009
  /**
856
- * The CloudWatch logging options for your delivery stream.
1010
+ * The Amazon CloudWatch logging options for your delivery stream.
857
1011
  */
858
1012
  CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
859
1013
  }
860
1014
  export interface RedshiftDestinationUpdate {
861
1015
  /**
862
- * The Amazon Resource Name (ARN) of the AWS credentials.
1016
+ * The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
863
1017
  */
864
1018
  RoleARN?: RoleARN;
865
1019
  /**
@@ -899,7 +1053,7 @@ declare namespace Firehose {
899
1053
  */
900
1054
  S3BackupUpdate?: S3DestinationUpdate;
901
1055
  /**
902
- * The CloudWatch logging options for your delivery stream.
1056
+ * The Amazon CloudWatch logging options for your delivery stream.
903
1057
  */
904
1058
  CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
905
1059
  }
@@ -915,11 +1069,11 @@ declare namespace Firehose {
915
1069
  export type S3BackupMode = "Disabled"|"Enabled"|string;
916
1070
  export interface S3DestinationConfiguration {
917
1071
  /**
918
- * The Amazon Resource Name (ARN) of the AWS credentials.
1072
+ * The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
919
1073
  */
920
1074
  RoleARN: RoleARN;
921
1075
  /**
922
- * The ARN of the S3 bucket.
1076
+ * The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
923
1077
  */
924
1078
  BucketARN: BucketARN;
925
1079
  /**
@@ -945,11 +1099,11 @@ declare namespace Firehose {
945
1099
  }
946
1100
  export interface S3DestinationDescription {
947
1101
  /**
948
- * The Amazon Resource Name (ARN) of the AWS credentials.
1102
+ * The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
949
1103
  */
950
1104
  RoleARN: RoleARN;
951
1105
  /**
952
- * The ARN of the S3 bucket.
1106
+ * The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
953
1107
  */
954
1108
  BucketARN: BucketARN;
955
1109
  /**
@@ -969,17 +1123,17 @@ declare namespace Firehose {
969
1123
  */
970
1124
  EncryptionConfiguration: EncryptionConfiguration;
971
1125
  /**
972
- * The CloudWatch logging options for your delivery stream.
1126
+ * The Amazon CloudWatch logging options for your delivery stream.
973
1127
  */
974
1128
  CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
975
1129
  }
976
1130
  export interface S3DestinationUpdate {
977
1131
  /**
978
- * The Amazon Resource Name (ARN) of the AWS credentials.
1132
+ * The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
979
1133
  */
980
1134
  RoleARN?: RoleARN;
981
1135
  /**
982
- * The ARN of the S3 bucket.
1136
+ * The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
983
1137
  */
984
1138
  BucketARN?: BucketARN;
985
1139
  /**
@@ -1003,6 +1157,42 @@ declare namespace Firehose {
1003
1157
  */
1004
1158
  CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
1005
1159
  }
1160
+ export interface SchemaConfiguration {
1161
+ /**
1162
+ * The role that Kinesis Data Firehose can use to access AWS Glue. This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren't allowed.
1163
+ */
1164
+ RoleARN?: NonEmptyStringWithoutWhitespace;
1165
+ /**
1166
+ * The ID of the AWS Glue Data Catalog. If you don't supply this, the AWS account ID is used by default.
1167
+ */
1168
+ CatalogId?: NonEmptyStringWithoutWhitespace;
1169
+ /**
1170
+ * Specifies the name of the AWS Glue database that contains the schema for the output data.
1171
+ */
1172
+ DatabaseName?: NonEmptyStringWithoutWhitespace;
1173
+ /**
1174
+ * Specifies the AWS Glue table that contains the column information that constitutes your data schema.
1175
+ */
1176
+ TableName?: NonEmptyStringWithoutWhitespace;
1177
+ /**
1178
+ * If you don't specify an AWS Region, the default is the current Region.
1179
+ */
1180
+ Region?: NonEmptyStringWithoutWhitespace;
1181
+ /**
1182
+ * Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to LATEST, Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up.
1183
+ */
1184
+ VersionId?: NonEmptyStringWithoutWhitespace;
1185
+ }
1186
+ export interface Serializer {
1187
+ /**
1188
+ * A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet.
1189
+ */
1190
+ ParquetSerDe?: ParquetSerDe;
1191
+ /**
1192
+ * A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC.
1193
+ */
1194
+ OrcSerDe?: OrcSerDe;
1195
+ }
1006
1196
  export type SizeInMBs = number;
1007
1197
  export interface SourceDescription {
1008
1198
  /**
@@ -1044,7 +1234,7 @@ declare namespace Firehose {
1044
1234
  */
1045
1235
  ProcessingConfiguration?: ProcessingConfiguration;
1046
1236
  /**
1047
- * The CloudWatch logging options for your delivery stream.
1237
+ * The Amazon CloudWatch logging options for your delivery stream.
1048
1238
  */
1049
1239
  CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
1050
1240
  }
@@ -1058,7 +1248,7 @@ declare namespace Firehose {
1058
1248
  */
1059
1249
  HECEndpointType?: HECEndpointType;
1060
1250
  /**
1061
- * This is a GUID you obtain from your Splunk cluster when you create a new HEC endpoint.
1251
+ * A GUID you obtain from your Splunk cluster when you create a new HEC endpoint.
1062
1252
  */
1063
1253
  HECToken?: HECToken;
1064
1254
  /**
@@ -1082,7 +1272,7 @@ declare namespace Firehose {
1082
1272
  */
1083
1273
  ProcessingConfiguration?: ProcessingConfiguration;
1084
1274
  /**
1085
- * The CloudWatch logging options for your delivery stream.
1275
+ * The Amazon CloudWatch logging options for your delivery stream.
1086
1276
  */
1087
1277
  CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
1088
1278
  }
@@ -1120,7 +1310,7 @@ declare namespace Firehose {
1120
1310
  */
1121
1311
  ProcessingConfiguration?: ProcessingConfiguration;
1122
1312
  /**
1123
- * The CloudWatch logging options for your delivery stream.
1313
+ * The Amazon CloudWatch logging options for your delivery stream.
1124
1314
  */
1125
1315
  CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
1126
1316
  }
@@ -1177,7 +1367,7 @@ declare namespace Firehose {
1177
1367
  */
1178
1368
  DeliveryStreamName: DeliveryStreamName;
1179
1369
  /**
1180
- * Obtain this value from the VersionId result of DeliveryStreamDescription. This value is required, and it helps the service perform conditional operations. For example, if there is an interleaving update and this value is null, then the update destination fails. After the update is successful, the VersionId value is updated. The service then performs a merge of the old configuration with the new configuration.
1370
+ * Obtain this value from the VersionId result of DeliveryStreamDescription. This value is required, and helps the service perform conditional operations. For example, if there is an interleaving update and this value is null, then the update destination fails. After the update is successful, the VersionId value is updated. The service then performs a merge of the old configuration with the new configuration.
1181
1371
  */
1182
1372
  CurrentDeliveryStreamVersionId: DeliveryStreamVersionId;
1183
1373
  /**