cdk-lambda-subminute 2.0.376 → 2.0.378
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +3 -3
- package/lib/cdk-lambda-subminute.js +3 -3
- package/node_modules/aws-sdk/README.md +1 -1
- package/node_modules/aws-sdk/apis/artifact-2018-05-10.examples.json +5 -0
- package/node_modules/aws-sdk/apis/artifact-2018-05-10.min.json +258 -0
- package/node_modules/aws-sdk/apis/artifact-2018-05-10.paginators.json +10 -0
- package/node_modules/aws-sdk/apis/codepipeline-2015-07-09.min.json +76 -73
- package/node_modules/aws-sdk/apis/elasticmapreduce-2009-03-31.min.json +26 -0
- package/node_modules/aws-sdk/apis/firehose-2015-08-04.min.json +260 -171
- package/node_modules/aws-sdk/apis/guardduty-2017-11-28.min.json +73 -59
- package/node_modules/aws-sdk/apis/healthlake-2017-07-01.min.json +29 -0
- package/node_modules/aws-sdk/apis/metadata.json +3 -0
- package/node_modules/aws-sdk/apis/sagemaker-2017-07-24.min.json +24 -4
- package/node_modules/aws-sdk/apis/sns-2010-03-31.min.json +35 -9
- package/node_modules/aws-sdk/clients/all.d.ts +1 -0
- package/node_modules/aws-sdk/clients/all.js +2 -1
- package/node_modules/aws-sdk/clients/artifact.d.ts +333 -0
- package/node_modules/aws-sdk/clients/artifact.js +18 -0
- package/node_modules/aws-sdk/clients/codepipeline.d.ts +5 -0
- package/node_modules/aws-sdk/clients/connectparticipant.d.ts +7 -7
- package/node_modules/aws-sdk/clients/detective.d.ts +49 -49
- package/node_modules/aws-sdk/clients/emr.d.ts +32 -2
- package/node_modules/aws-sdk/clients/firehose.d.ts +195 -118
- package/node_modules/aws-sdk/clients/guardduty.d.ts +11 -10
- package/node_modules/aws-sdk/clients/healthlake.d.ts +42 -2
- package/node_modules/aws-sdk/clients/lambda.d.ts +15 -15
- package/node_modules/aws-sdk/clients/opensearch.d.ts +19 -19
- package/node_modules/aws-sdk/clients/polly.d.ts +1 -1
- package/node_modules/aws-sdk/clients/rds.d.ts +2 -2
- package/node_modules/aws-sdk/clients/sagemaker.d.ts +22 -2
- package/node_modules/aws-sdk/clients/secretsmanager.d.ts +3 -3
- package/node_modules/aws-sdk/clients/sns.d.ts +20 -20
- package/node_modules/aws-sdk/dist/aws-sdk-core-react-native.js +2 -2
- package/node_modules/aws-sdk/dist/aws-sdk-react-native.js +48 -11
- package/node_modules/aws-sdk/dist/aws-sdk.js +403 -256
- package/node_modules/aws-sdk/dist/aws-sdk.min.js +72 -72
- package/node_modules/aws-sdk/lib/config_service_placeholders.d.ts +2 -0
- package/node_modules/aws-sdk/lib/core.js +1 -1
- package/node_modules/aws-sdk/package.json +1 -1
- package/package.json +3 -3
@@ -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
|
15
|
+
* Creates a Firehose delivery stream. By default, you can create up to 50 delivery streams per Amazon Web Services 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. If the delivery stream creation fails, the status transitions to CREATING_FAILED. 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. If the status of a delivery stream is CREATING_FAILED, this status doesn't change, and you can't invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it. A 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. To create a delivery stream with server-side encryption (SSE) enabled, include DeliveryStreamEncryptionConfigurationInput in your request. This is optional. You can also invoke StartDeliveryStreamEncryption to turn on SSE for an existing delivery stream that doesn't have SSE enabled. A delivery stream is configured with a single destination, such as Amazon Simple Storage Service (Amazon S3), Amazon Redshift, Amazon OpenSearch Service, Amazon OpenSearch Serverless, Splunk, and any custom HTTP endpoint or HTTP endpoints owned by or supported by third-party service providers, including Datadog, Dynatrace, LogicMonitor, MongoDB, New Relic, and Sumo Logic. 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, 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. 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 Firehose, and that the permissions for the account are restricted for Amazon Redshift INSERT permissions. Firehose assumes the IAM role that is configured as part of the destination. The role should allow the 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 Firehose Access to an Amazon S3 Destination in the Amazon 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
|
19
|
+
* Creates a Firehose delivery stream. By default, you can create up to 50 delivery streams per Amazon Web Services 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. If the delivery stream creation fails, the status transitions to CREATING_FAILED. 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. If the status of a delivery stream is CREATING_FAILED, this status doesn't change, and you can't invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it. A 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. To create a delivery stream with server-side encryption (SSE) enabled, include DeliveryStreamEncryptionConfigurationInput in your request. This is optional. You can also invoke StartDeliveryStreamEncryption to turn on SSE for an existing delivery stream that doesn't have SSE enabled. A delivery stream is configured with a single destination, such as Amazon Simple Storage Service (Amazon S3), Amazon Redshift, Amazon OpenSearch Service, Amazon OpenSearch Serverless, Splunk, and any custom HTTP endpoint or HTTP endpoints owned by or supported by third-party service providers, including Datadog, Dynatrace, LogicMonitor, MongoDB, New Relic, and Sumo Logic. 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, 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. 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 Firehose, and that the permissions for the account are restricted for Amazon Redshift INSERT permissions. Firehose assumes the IAM role that is configured as part of the destination. The role should allow the 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 Firehose Access to an Amazon S3 Destination in the Amazon 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.
|
23
|
+
* Deletes a delivery stream and its data. You can delete a delivery stream only if it is in one of the following states: ACTIVE, DELETING, CREATING_FAILED, or DELETING_FAILED. You can't delete a delivery stream that is in the CREATING state. To check the state of a delivery stream, use DescribeDeliveryStream. DeleteDeliveryStream is an asynchronous API. When an API request to DeleteDeliveryStream succeeds, the delivery stream is marked for deletion, and it goes into the DELETING state.While the delivery stream is in the DELETING state, the service might continue to accept records, but it doesn't make any guarantees with respect to delivering the data. Therefore, as a best practice, first stop any applications that are sending records before you delete a delivery stream. Removal of a delivery stream that is in the DELETING state is a low priority operation for the service. A stream may remain in the DELETING state for several minutes. Therefore, as a best practice, applications should not wait for streams in the DELETING state to be removed.
|
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.
|
27
|
+
* Deletes a delivery stream and its data. You can delete a delivery stream only if it is in one of the following states: ACTIVE, DELETING, CREATING_FAILED, or DELETING_FAILED. You can't delete a delivery stream that is in the CREATING state. To check the state of a delivery stream, use DescribeDeliveryStream. DeleteDeliveryStream is an asynchronous API. When an API request to DeleteDeliveryStream succeeds, the delivery stream is marked for deletion, and it goes into the DELETING state.While the delivery stream is in the DELETING state, the service might continue to accept records, but it doesn't make any guarantees with respect to delivering the data. Therefore, as a best practice, first stop any applications that are sending records before you delete a delivery stream. Removal of a delivery stream that is in the DELETING state is a low priority operation for the service. A stream may remain in the DELETING state for several minutes. Therefore, as a best practice, applications should not wait for streams in the DELETING state to be removed.
|
28
28
|
*/
|
29
29
|
deleteDeliveryStream(callback?: (err: AWSError, data: Firehose.Types.DeleteDeliveryStreamOutput) => void): Request<Firehose.Types.DeleteDeliveryStreamOutput, AWSError>;
|
30
30
|
/**
|
@@ -35,6 +35,14 @@ declare class Firehose extends Service {
|
|
35
35
|
* Describes the specified delivery stream and its status. For example, after your delivery stream is created, call DescribeDeliveryStream to see whether the delivery stream is ACTIVE and therefore ready for data to be sent to it. If the status of a delivery stream is CREATING_FAILED, this status doesn't change, and you can't invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it. If the status is DELETING_FAILED, you can force deletion by invoking DeleteDeliveryStream again but with DeleteDeliveryStreamInput$AllowForceDelete set to true.
|
36
36
|
*/
|
37
37
|
describeDeliveryStream(callback?: (err: AWSError, data: Firehose.Types.DescribeDeliveryStreamOutput) => void): Request<Firehose.Types.DescribeDeliveryStreamOutput, AWSError>;
|
38
|
+
/**
|
39
|
+
*
|
40
|
+
*/
|
41
|
+
getKinesisStream(params: Firehose.Types.GetKinesisStreamInput, callback?: (err: AWSError, data: Firehose.Types.GetKinesisStreamOutput) => void): Request<Firehose.Types.GetKinesisStreamOutput, AWSError>;
|
42
|
+
/**
|
43
|
+
*
|
44
|
+
*/
|
45
|
+
getKinesisStream(callback?: (err: AWSError, data: Firehose.Types.GetKinesisStreamOutput) => void): Request<Firehose.Types.GetKinesisStreamOutput, AWSError>;
|
38
46
|
/**
|
39
47
|
* Lists your delivery streams in alphabetical order of their names. The number of delivery streams might be too large to return using a single call to ListDeliveryStreams. You can limit the number of delivery streams returned, using the Limit parameter. To determine whether there are more delivery streams to list, check the value of HasMoreDeliveryStreams in the output. If there are more delivery streams to list, you can request them by calling this operation again and setting the ExclusiveStartDeliveryStreamName parameter to the name of the last delivery stream returned in the last call.
|
40
48
|
*/
|
@@ -52,35 +60,35 @@ declare class Firehose extends Service {
|
|
52
60
|
*/
|
53
61
|
listTagsForDeliveryStream(callback?: (err: AWSError, data: Firehose.Types.ListTagsForDeliveryStreamOutput) => void): Request<Firehose.Types.ListTagsForDeliveryStreamOutput, AWSError>;
|
54
62
|
/**
|
55
|
-
* Writes a single data record into an Amazon
|
63
|
+
* Writes a single data record into an Amazon 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 Firehose Limits. Firehose accumulates and publishes a particular metric for a customer account in one minute intervals. It is possible that the bursts of incoming bytes/records ingested to a delivery stream last only for a few seconds. Due to this, the actual spikes in the traffic might not be fully visible in the customer's 1 minute CloudWatch metrics. 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 KiB 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. 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, the API is automatically reinvoked (retried) 3 times. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream. Re-invoking the Put API operations (for example, PutRecord and PutRecordBatch) can result in data duplicates. For larger data assets, allow for a longer time out before retrying Put API operations. Data records sent to 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. Don't concatenate two or more base64 strings to form the data fields of your records. Instead, concatenate the raw data, then perform base64 encoding.
|
56
64
|
*/
|
57
65
|
putRecord(params: Firehose.Types.PutRecordInput, callback?: (err: AWSError, data: Firehose.Types.PutRecordOutput) => void): Request<Firehose.Types.PutRecordOutput, AWSError>;
|
58
66
|
/**
|
59
|
-
* Writes a single data record into an Amazon
|
67
|
+
* Writes a single data record into an Amazon 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 Firehose Limits. Firehose accumulates and publishes a particular metric for a customer account in one minute intervals. It is possible that the bursts of incoming bytes/records ingested to a delivery stream last only for a few seconds. Due to this, the actual spikes in the traffic might not be fully visible in the customer's 1 minute CloudWatch metrics. 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 KiB 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. 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, the API is automatically reinvoked (retried) 3 times. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream. Re-invoking the Put API operations (for example, PutRecord and PutRecordBatch) can result in data duplicates. For larger data assets, allow for a longer time out before retrying Put API operations. Data records sent to 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. Don't concatenate two or more base64 strings to form the data fields of your records. Instead, concatenate the raw data, then perform base64 encoding.
|
60
68
|
*/
|
61
69
|
putRecord(callback?: (err: AWSError, data: Firehose.Types.PutRecordOutput) => void): Request<Firehose.Types.PutRecordOutput, AWSError>;
|
62
70
|
/**
|
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.
|
71
|
+
* 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. Firehose accumulates and publishes a particular metric for a customer account in one minute intervals. It is possible that the bursts of incoming bytes/records ingested to a delivery stream last only for a few seconds. Due to this, the actual spikes in the traffic might not be fully visible in the customer's 1 minute CloudWatch metrics. For information about service quota, see Amazon Firehose Quota. Each PutRecordBatch request supports up to 500 records. Each record in the request can be as large as 1,000 KB (before base64 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. 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. Even if the PutRecordBatch call succeeds, the value of FailedPutCount may be greater than 0, indicating that there are records for which the operation didn't succeed. 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. 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: ServiceUnavailableException 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, the API is automatically reinvoked (retried) 3 times. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream. Re-invoking the Put API operations (for example, PutRecord and PutRecordBatch) can result in data duplicates. For larger data assets, allow for a longer time out before retrying Put API operations. Data records sent to 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. Don't concatenate two or more base64 strings to form the data fields of your records. Instead, concatenate the raw data, then perform base64 encoding.
|
64
72
|
*/
|
65
73
|
putRecordBatch(params: Firehose.Types.PutRecordBatchInput, callback?: (err: AWSError, data: Firehose.Types.PutRecordBatchOutput) => void): Request<Firehose.Types.PutRecordBatchOutput, AWSError>;
|
66
74
|
/**
|
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.
|
75
|
+
* 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. Firehose accumulates and publishes a particular metric for a customer account in one minute intervals. It is possible that the bursts of incoming bytes/records ingested to a delivery stream last only for a few seconds. Due to this, the actual spikes in the traffic might not be fully visible in the customer's 1 minute CloudWatch metrics. For information about service quota, see Amazon Firehose Quota. Each PutRecordBatch request supports up to 500 records. Each record in the request can be as large as 1,000 KB (before base64 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. 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. Even if the PutRecordBatch call succeeds, the value of FailedPutCount may be greater than 0, indicating that there are records for which the operation didn't succeed. 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. 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: ServiceUnavailableException 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, the API is automatically reinvoked (retried) 3 times. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream. Re-invoking the Put API operations (for example, PutRecord and PutRecordBatch) can result in data duplicates. For larger data assets, allow for a longer time out before retrying Put API operations. Data records sent to 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. Don't concatenate two or more base64 strings to form the data fields of your records. Instead, concatenate the raw data, then perform base64 encoding.
|
68
76
|
*/
|
69
77
|
putRecordBatch(callback?: (err: AWSError, data: Firehose.Types.PutRecordBatchOutput) => void): Request<Firehose.Types.PutRecordBatchOutput, AWSError>;
|
70
78
|
/**
|
71
|
-
* Enables server-side encryption (SSE) for the delivery stream. This operation is asynchronous. It returns immediately. When you invoke it,
|
79
|
+
* Enables server-side encryption (SSE) for the delivery stream. This operation is asynchronous. It returns immediately. When you invoke it, Firehose first sets the encryption status of the stream to ENABLING, and then to ENABLED. The encryption status of a delivery stream is the Status property in DeliveryStreamEncryptionConfiguration. If the operation fails, the encryption status changes to ENABLING_FAILED. You can continue to read and write data to your delivery stream while the encryption status is ENABLING, but the data is not encrypted. It can take up to 5 seconds after the encryption status changes to ENABLED before all records written to the delivery stream are encrypted. To find out whether a record or a batch of records was encrypted, check the response elements PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted, respectively. To check the encryption status of a delivery stream, use DescribeDeliveryStream. Even if encryption is currently enabled for a delivery stream, you can still invoke this operation on it to change the ARN of the CMK or both its type and ARN. If you invoke this method to change the CMK, and the old CMK is of type CUSTOMER_MANAGED_CMK, Firehose schedules the grant it had on the old CMK for retirement. If the new CMK is of type CUSTOMER_MANAGED_CMK, Firehose creates a grant that enables it to use the new CMK to encrypt and decrypt data and to manage the grant. For the KMS grant creation to be successful, Firehose APIs StartDeliveryStreamEncryption and CreateDeliveryStream should not be called with session credentials that are more than 6 hours old. If a delivery stream already has encryption enabled and then you invoke this operation to change the ARN of the CMK or both its type and ARN and you get ENABLING_FAILED, this only means that the attempt to change the CMK failed. In this case, encryption remains enabled with the old CMK. If the encryption status of your delivery stream is ENABLING_FAILED, you can invoke this operation again with a valid CMK. The CMK must be enabled and the key policy mustn't explicitly deny the permission for Firehose to invoke KMS encrypt and decrypt operations. You can enable SSE for a delivery stream only if it's a delivery stream that uses DirectPut as its source. The StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have a combined limit of 25 calls per delivery stream per 24 hours. For example, you reach the limit if you call StartDeliveryStreamEncryption 13 times and StopDeliveryStreamEncryption 12 times for the same delivery stream in a 24-hour period.
|
72
80
|
*/
|
73
81
|
startDeliveryStreamEncryption(params: Firehose.Types.StartDeliveryStreamEncryptionInput, callback?: (err: AWSError, data: Firehose.Types.StartDeliveryStreamEncryptionOutput) => void): Request<Firehose.Types.StartDeliveryStreamEncryptionOutput, AWSError>;
|
74
82
|
/**
|
75
|
-
* Enables server-side encryption (SSE) for the delivery stream. This operation is asynchronous. It returns immediately. When you invoke it,
|
83
|
+
* Enables server-side encryption (SSE) for the delivery stream. This operation is asynchronous. It returns immediately. When you invoke it, Firehose first sets the encryption status of the stream to ENABLING, and then to ENABLED. The encryption status of a delivery stream is the Status property in DeliveryStreamEncryptionConfiguration. If the operation fails, the encryption status changes to ENABLING_FAILED. You can continue to read and write data to your delivery stream while the encryption status is ENABLING, but the data is not encrypted. It can take up to 5 seconds after the encryption status changes to ENABLED before all records written to the delivery stream are encrypted. To find out whether a record or a batch of records was encrypted, check the response elements PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted, respectively. To check the encryption status of a delivery stream, use DescribeDeliveryStream. Even if encryption is currently enabled for a delivery stream, you can still invoke this operation on it to change the ARN of the CMK or both its type and ARN. If you invoke this method to change the CMK, and the old CMK is of type CUSTOMER_MANAGED_CMK, Firehose schedules the grant it had on the old CMK for retirement. If the new CMK is of type CUSTOMER_MANAGED_CMK, Firehose creates a grant that enables it to use the new CMK to encrypt and decrypt data and to manage the grant. For the KMS grant creation to be successful, Firehose APIs StartDeliveryStreamEncryption and CreateDeliveryStream should not be called with session credentials that are more than 6 hours old. If a delivery stream already has encryption enabled and then you invoke this operation to change the ARN of the CMK or both its type and ARN and you get ENABLING_FAILED, this only means that the attempt to change the CMK failed. In this case, encryption remains enabled with the old CMK. If the encryption status of your delivery stream is ENABLING_FAILED, you can invoke this operation again with a valid CMK. The CMK must be enabled and the key policy mustn't explicitly deny the permission for Firehose to invoke KMS encrypt and decrypt operations. You can enable SSE for a delivery stream only if it's a delivery stream that uses DirectPut as its source. The StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have a combined limit of 25 calls per delivery stream per 24 hours. For example, you reach the limit if you call StartDeliveryStreamEncryption 13 times and StopDeliveryStreamEncryption 12 times for the same delivery stream in a 24-hour period.
|
76
84
|
*/
|
77
85
|
startDeliveryStreamEncryption(callback?: (err: AWSError, data: Firehose.Types.StartDeliveryStreamEncryptionOutput) => void): Request<Firehose.Types.StartDeliveryStreamEncryptionOutput, AWSError>;
|
78
86
|
/**
|
79
|
-
* Disables server-side encryption (SSE) for the delivery stream. This operation is asynchronous. It returns immediately. When you invoke it,
|
87
|
+
* Disables server-side encryption (SSE) for the delivery stream. This operation is asynchronous. It returns immediately. When you invoke it, Firehose first sets the encryption status of the stream to DISABLING, and then to DISABLED. You can continue to read and write data to your stream while its status is DISABLING. It can take up to 5 seconds after the encryption status changes to DISABLED before all records written to the delivery stream are no longer subject to encryption. To find out whether a record or a batch of records was encrypted, check the response elements PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted, respectively. To check the encryption state of a delivery stream, use DescribeDeliveryStream. If SSE is enabled using a customer managed CMK and then you invoke StopDeliveryStreamEncryption, Firehose schedules the related KMS grant for retirement and then retires it after it ensures that it is finished delivering records to the destination. The StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have a combined limit of 25 calls per delivery stream per 24 hours. For example, you reach the limit if you call StartDeliveryStreamEncryption 13 times and StopDeliveryStreamEncryption 12 times for the same delivery stream in a 24-hour period.
|
80
88
|
*/
|
81
89
|
stopDeliveryStreamEncryption(params: Firehose.Types.StopDeliveryStreamEncryptionInput, callback?: (err: AWSError, data: Firehose.Types.StopDeliveryStreamEncryptionOutput) => void): Request<Firehose.Types.StopDeliveryStreamEncryptionOutput, AWSError>;
|
82
90
|
/**
|
83
|
-
* Disables server-side encryption (SSE) for the delivery stream. This operation is asynchronous. It returns immediately. When you invoke it,
|
91
|
+
* Disables server-side encryption (SSE) for the delivery stream. This operation is asynchronous. It returns immediately. When you invoke it, Firehose first sets the encryption status of the stream to DISABLING, and then to DISABLED. You can continue to read and write data to your stream while its status is DISABLING. It can take up to 5 seconds after the encryption status changes to DISABLED before all records written to the delivery stream are no longer subject to encryption. To find out whether a record or a batch of records was encrypted, check the response elements PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted, respectively. To check the encryption state of a delivery stream, use DescribeDeliveryStream. If SSE is enabled using a customer managed CMK and then you invoke StopDeliveryStreamEncryption, Firehose schedules the related KMS grant for retirement and then retires it after it ensures that it is finished delivering records to the destination. The StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have a combined limit of 25 calls per delivery stream per 24 hours. For example, you reach the limit if you call StartDeliveryStreamEncryption 13 times and StopDeliveryStreamEncryption 12 times for the same delivery stream in a 24-hour period.
|
84
92
|
*/
|
85
93
|
stopDeliveryStreamEncryption(callback?: (err: AWSError, data: Firehose.Types.StopDeliveryStreamEncryptionOutput) => void): Request<Firehose.Types.StopDeliveryStreamEncryptionOutput, AWSError>;
|
86
94
|
/**
|
@@ -100,16 +108,25 @@ declare class Firehose extends Service {
|
|
100
108
|
*/
|
101
109
|
untagDeliveryStream(callback?: (err: AWSError, data: Firehose.Types.UntagDeliveryStreamOutput) => void): Request<Firehose.Types.UntagDeliveryStreamOutput, AWSError>;
|
102
110
|
/**
|
103
|
-
* 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 OpenSearch Service and other services is not supported. For an Amazon OpenSearch Service destination, you can only update to another Amazon OpenSearch Service destination. If the destination type is the same,
|
111
|
+
* 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 OpenSearch Service and other services is not supported. For an Amazon OpenSearch Service destination, you can only update to another Amazon OpenSearch Service destination. If the destination type is the same, 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, Firehose does not merge any parameters. In this case, all parameters must be specified. 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.
|
104
112
|
*/
|
105
113
|
updateDestination(params: Firehose.Types.UpdateDestinationInput, callback?: (err: AWSError, data: Firehose.Types.UpdateDestinationOutput) => void): Request<Firehose.Types.UpdateDestinationOutput, AWSError>;
|
106
114
|
/**
|
107
|
-
* 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 OpenSearch Service and other services is not supported. For an Amazon OpenSearch Service destination, you can only update to another Amazon OpenSearch Service destination. If the destination type is the same,
|
115
|
+
* 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 OpenSearch Service and other services is not supported. For an Amazon OpenSearch Service destination, you can only update to another Amazon OpenSearch Service destination. If the destination type is the same, 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, Firehose does not merge any parameters. In this case, all parameters must be specified. 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.
|
108
116
|
*/
|
109
117
|
updateDestination(callback?: (err: AWSError, data: Firehose.Types.UpdateDestinationOutput) => void): Request<Firehose.Types.UpdateDestinationOutput, AWSError>;
|
118
|
+
/**
|
119
|
+
*
|
120
|
+
*/
|
121
|
+
verifyResourcesExistForTagris(params: Firehose.Types.TagrisVerifyResourcesExistInput, callback?: (err: AWSError, data: Firehose.Types.TagrisVerifyResourcesExistOutput) => void): Request<Firehose.Types.TagrisVerifyResourcesExistOutput, AWSError>;
|
122
|
+
/**
|
123
|
+
*
|
124
|
+
*/
|
125
|
+
verifyResourcesExistForTagris(callback?: (err: AWSError, data: Firehose.Types.TagrisVerifyResourcesExistOutput) => void): Request<Firehose.Types.TagrisVerifyResourcesExistOutput, AWSError>;
|
110
126
|
}
|
111
127
|
declare namespace Firehose {
|
112
128
|
export type AWSKMSKeyARN = string;
|
129
|
+
export type AccessKeyId = string;
|
113
130
|
export interface AmazonOpenSearchServerlessBufferingHints {
|
114
131
|
/**
|
115
132
|
* Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).
|
@@ -125,7 +142,7 @@ declare namespace Firehose {
|
|
125
142
|
export type AmazonOpenSearchServerlessCollectionEndpoint = string;
|
126
143
|
export interface AmazonOpenSearchServerlessDestinationConfiguration {
|
127
144
|
/**
|
128
|
-
* The Amazon Resource Name (ARN) of the IAM role to be assumed by
|
145
|
+
* The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.
|
129
146
|
*/
|
130
147
|
RoleARN: RoleARN;
|
131
148
|
/**
|
@@ -141,11 +158,11 @@ declare namespace Firehose {
|
|
141
158
|
*/
|
142
159
|
BufferingHints?: AmazonOpenSearchServerlessBufferingHints;
|
143
160
|
/**
|
144
|
-
* The retry behavior in case
|
161
|
+
* The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).
|
145
162
|
*/
|
146
163
|
RetryOptions?: AmazonOpenSearchServerlessRetryOptions;
|
147
164
|
/**
|
148
|
-
* Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly,
|
165
|
+
* Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
|
149
166
|
*/
|
150
167
|
S3BackupMode?: AmazonOpenSearchServerlessS3BackupMode;
|
151
168
|
S3Configuration: S3DestinationConfiguration;
|
@@ -185,7 +202,7 @@ declare namespace Firehose {
|
|
185
202
|
}
|
186
203
|
export interface AmazonOpenSearchServerlessDestinationUpdate {
|
187
204
|
/**
|
188
|
-
* The Amazon Resource Name (ARN) of the IAM role to be assumed by
|
205
|
+
* The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.
|
189
206
|
*/
|
190
207
|
RoleARN?: RoleARN;
|
191
208
|
/**
|
@@ -201,7 +218,7 @@ declare namespace Firehose {
|
|
201
218
|
*/
|
202
219
|
BufferingHints?: AmazonOpenSearchServerlessBufferingHints;
|
203
220
|
/**
|
204
|
-
* The retry behavior in case
|
221
|
+
* The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).
|
205
222
|
*/
|
206
223
|
RetryOptions?: AmazonOpenSearchServerlessRetryOptions;
|
207
224
|
S3Update?: S3DestinationUpdate;
|
@@ -212,7 +229,7 @@ declare namespace Firehose {
|
|
212
229
|
export type AmazonOpenSearchServerlessRetryDurationInSeconds = number;
|
213
230
|
export interface AmazonOpenSearchServerlessRetryOptions {
|
214
231
|
/**
|
215
|
-
* After an initial failure to deliver to the Serverless offering for Amazon OpenSearch Service, the total amount of time during which
|
232
|
+
* After an initial failure to deliver to the Serverless offering for 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.
|
216
233
|
*/
|
217
234
|
DurationInSeconds?: AmazonOpenSearchServerlessRetryDurationInSeconds;
|
218
235
|
}
|
@@ -232,7 +249,7 @@ declare namespace Firehose {
|
|
232
249
|
export type AmazonopensearchserviceClusterEndpoint = string;
|
233
250
|
export interface AmazonopensearchserviceDestinationConfiguration {
|
234
251
|
/**
|
235
|
-
* The Amazon Resource Name (ARN) of the IAM role to be assumed by
|
252
|
+
* The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
|
236
253
|
*/
|
237
254
|
RoleARN: RoleARN;
|
238
255
|
/**
|
@@ -248,7 +265,7 @@ declare namespace Firehose {
|
|
248
265
|
*/
|
249
266
|
IndexName: AmazonopensearchserviceIndexName;
|
250
267
|
/**
|
251
|
-
* The Amazon OpenSearch Service 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,
|
268
|
+
* The Amazon OpenSearch Service 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, Firehose returns an error during run time.
|
252
269
|
*/
|
253
270
|
TypeName?: AmazonopensearchserviceTypeName;
|
254
271
|
/**
|
@@ -260,11 +277,11 @@ declare namespace Firehose {
|
|
260
277
|
*/
|
261
278
|
BufferingHints?: AmazonopensearchserviceBufferingHints;
|
262
279
|
/**
|
263
|
-
* The retry behavior in case
|
280
|
+
* The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).
|
264
281
|
*/
|
265
282
|
RetryOptions?: AmazonopensearchserviceRetryOptions;
|
266
283
|
/**
|
267
|
-
* Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly,
|
284
|
+
* Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
|
268
285
|
*/
|
269
286
|
S3BackupMode?: AmazonopensearchserviceS3BackupMode;
|
270
287
|
S3Configuration: S3DestinationConfiguration;
|
@@ -272,7 +289,7 @@ declare namespace Firehose {
|
|
272
289
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
273
290
|
VpcConfiguration?: VpcConfiguration;
|
274
291
|
/**
|
275
|
-
* Indicates the method for setting up document ID. The supported methods are
|
292
|
+
* Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
|
276
293
|
*/
|
277
294
|
DocumentIdOptions?: DocumentIdOptions;
|
278
295
|
}
|
@@ -286,7 +303,7 @@ declare namespace Firehose {
|
|
286
303
|
*/
|
287
304
|
DomainARN?: AmazonopensearchserviceDomainARN;
|
288
305
|
/**
|
289
|
-
* The endpoint to use when communicating with the cluster.
|
306
|
+
* The endpoint to use when communicating with the cluster. Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch Service.
|
290
307
|
*/
|
291
308
|
ClusterEndpoint?: AmazonopensearchserviceClusterEndpoint;
|
292
309
|
/**
|
@@ -318,13 +335,13 @@ declare namespace Firehose {
|
|
318
335
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
319
336
|
VpcConfigurationDescription?: VpcConfigurationDescription;
|
320
337
|
/**
|
321
|
-
* Indicates the method for setting up document ID. The supported methods are
|
338
|
+
* Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
|
322
339
|
*/
|
323
340
|
DocumentIdOptions?: DocumentIdOptions;
|
324
341
|
}
|
325
342
|
export interface AmazonopensearchserviceDestinationUpdate {
|
326
343
|
/**
|
327
|
-
* The Amazon Resource Name (ARN) of the IAM role to be assumed by
|
344
|
+
* The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
|
328
345
|
*/
|
329
346
|
RoleARN?: RoleARN;
|
330
347
|
/**
|
@@ -340,7 +357,7 @@ declare namespace Firehose {
|
|
340
357
|
*/
|
341
358
|
IndexName?: AmazonopensearchserviceIndexName;
|
342
359
|
/**
|
343
|
-
* The Amazon OpenSearch Service 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,
|
360
|
+
* The Amazon OpenSearch Service 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, Firehose returns an error during runtime. If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.
|
344
361
|
*/
|
345
362
|
TypeName?: AmazonopensearchserviceTypeName;
|
346
363
|
/**
|
@@ -352,14 +369,14 @@ declare namespace Firehose {
|
|
352
369
|
*/
|
353
370
|
BufferingHints?: AmazonopensearchserviceBufferingHints;
|
354
371
|
/**
|
355
|
-
* The retry behavior in case
|
372
|
+
* The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).
|
356
373
|
*/
|
357
374
|
RetryOptions?: AmazonopensearchserviceRetryOptions;
|
358
375
|
S3Update?: S3DestinationUpdate;
|
359
376
|
ProcessingConfiguration?: ProcessingConfiguration;
|
360
377
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
361
378
|
/**
|
362
|
-
* Indicates the method for setting up document ID. The supported methods are
|
379
|
+
* Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
|
363
380
|
*/
|
364
381
|
DocumentIdOptions?: DocumentIdOptions;
|
365
382
|
}
|
@@ -369,7 +386,7 @@ declare namespace Firehose {
|
|
369
386
|
export type AmazonopensearchserviceRetryDurationInSeconds = number;
|
370
387
|
export interface AmazonopensearchserviceRetryOptions {
|
371
388
|
/**
|
372
|
-
* After an initial failure to deliver to Amazon OpenSearch Service, the total amount of time during which
|
389
|
+
* 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.
|
373
390
|
*/
|
374
391
|
DurationInSeconds?: AmazonopensearchserviceRetryDurationInSeconds;
|
375
392
|
}
|
@@ -427,7 +444,7 @@ declare namespace Firehose {
|
|
427
444
|
*/
|
428
445
|
DataTableColumns?: DataTableColumns;
|
429
446
|
/**
|
430
|
-
* Optional parameters to use with the Amazon Redshift COPY command. For more information, see the "Optional Parameters" section of Amazon Redshift COPY command. Some possible examples that would apply to
|
447
|
+
* Optional parameters to use with the Amazon Redshift COPY command. For more information, see the "Optional Parameters" section of Amazon Redshift COPY command. Some possible examples that would apply to Firehose are as follows: delimiter '\t' lzop; - fields are delimited with "\t" (TAB character) and compressed using lzop. delimiter '|' - fields are delimited with "|" (this is the default delimiter). delimiter '|' escape - the delimiter should be escaped. fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6' - fields are fixed width in the source, with each width specified after every column in the table. JSON 's3://mybucket/jsonpaths.txt' - data is in JSON format, and the path specified is the format of the data. For more examples, see Amazon Redshift COPY command examples.
|
431
448
|
*/
|
432
449
|
CopyOptions?: CopyOptions;
|
433
450
|
}
|
@@ -497,6 +514,7 @@ declare namespace Firehose {
|
|
497
514
|
*/
|
498
515
|
DeliveryStreamARN?: DeliveryStreamARN;
|
499
516
|
}
|
517
|
+
export type CustomTimeZone = string;
|
500
518
|
export type Data = Buffer|Uint8Array|Blob|string;
|
501
519
|
export interface DataFormatConversionConfiguration {
|
502
520
|
/**
|
@@ -504,11 +522,11 @@ declare namespace Firehose {
|
|
504
522
|
*/
|
505
523
|
SchemaConfiguration?: SchemaConfiguration;
|
506
524
|
/**
|
507
|
-
* Specifies the deserializer that you want
|
525
|
+
* Specifies the deserializer that you want Firehose to use to convert the format of your data from JSON. This parameter is required if Enabled is set to true.
|
508
526
|
*/
|
509
527
|
InputFormatConfiguration?: InputFormatConfiguration;
|
510
528
|
/**
|
511
|
-
* Specifies the serializer that you want
|
529
|
+
* Specifies the serializer that you want Firehose to use to convert the format of your data to the Parquet or ORC format. This parameter is required if Enabled is set to true.
|
512
530
|
*/
|
513
531
|
OutputFormatConfiguration?: OutputFormatConfiguration;
|
514
532
|
/**
|
@@ -525,7 +543,7 @@ declare namespace Firehose {
|
|
525
543
|
*/
|
526
544
|
DeliveryStreamName: DeliveryStreamName;
|
527
545
|
/**
|
528
|
-
* Set this to true if you want to delete the delivery stream even if
|
546
|
+
* Set this to true if you want to delete the delivery stream even if Firehose is unable to retire the grant for the CMK. Firehose might be unable to retire the grant due to a customer error, such as when the CMK or the grant are in an invalid state. If you force deletion, you can then use the RevokeGrant operation to revoke the grant you gave to Firehose. If a failure to retire the grant happens due to an Amazon Web Services KMS issue, Firehose keeps retrying the delete operation. The default value is false.
|
529
547
|
*/
|
530
548
|
AllowForceDelete?: BooleanObject;
|
531
549
|
}
|
@@ -603,11 +621,11 @@ declare namespace Firehose {
|
|
603
621
|
}
|
604
622
|
export interface DeliveryStreamEncryptionConfigurationInput {
|
605
623
|
/**
|
606
|
-
* If you set KeyType to CUSTOMER_MANAGED_CMK, you must specify the Amazon Resource Name (ARN) of the CMK. If you set KeyType to Amazon Web Services_OWNED_CMK,
|
624
|
+
* If you set KeyType to CUSTOMER_MANAGED_CMK, you must specify the Amazon Resource Name (ARN) of the CMK. If you set KeyType to Amazon Web Services_OWNED_CMK, Firehose uses a service-account CMK.
|
607
625
|
*/
|
608
626
|
KeyARN?: AWSKMSKeyARN;
|
609
627
|
/**
|
610
|
-
* Indicates the type of customer master key (CMK) to use for encryption. The default setting is Amazon Web Services_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs). When you invoke CreateDeliveryStream or StartDeliveryStreamEncryption with KeyType set to CUSTOMER_MANAGED_CMK,
|
628
|
+
* Indicates the type of customer master key (CMK) to use for encryption. The default setting is Amazon Web Services_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs). When you invoke CreateDeliveryStream or StartDeliveryStreamEncryption with KeyType set to CUSTOMER_MANAGED_CMK, Firehose invokes the Amazon KMS operation CreateGrant to create a grant that allows the Firehose service to use the customer managed CMK to perform encryption and decryption. Firehose manages that grant. When you invoke StartDeliveryStreamEncryption to change the CMK for a delivery stream that is encrypted with a customer managed CMK, Firehose schedules the grant it had on the old CMK for retirement. You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 delivery streams. If a CreateDeliveryStream or StartDeliveryStreamEncryption operation exceeds this limit, Firehose throws a LimitExceededException. To encrypt your delivery stream, use symmetric CMKs. Firehose doesn't support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see About Symmetric and Asymmetric CMKs in the Amazon Web Services Key Management Service developer guide.
|
611
629
|
*/
|
612
630
|
KeyType: KeyType;
|
613
631
|
}
|
@@ -628,7 +646,7 @@ declare namespace Firehose {
|
|
628
646
|
*/
|
629
647
|
Limit?: DescribeDeliveryStreamInputLimit;
|
630
648
|
/**
|
631
|
-
* The ID of the destination to start returning the destination information.
|
649
|
+
* The ID of the destination to start returning the destination information. Firehose supports one destination per delivery stream.
|
632
650
|
*/
|
633
651
|
ExclusiveStartDestinationId?: DestinationId;
|
634
652
|
}
|
@@ -641,11 +659,11 @@ declare namespace Firehose {
|
|
641
659
|
}
|
642
660
|
export interface Deserializer {
|
643
661
|
/**
|
644
|
-
* The OpenX SerDe. Used by
|
662
|
+
* The OpenX SerDe. Used by 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.
|
645
663
|
*/
|
646
664
|
OpenXJsonSerDe?: OpenXJsonSerDe;
|
647
665
|
/**
|
648
|
-
* The native Hive / HCatalog JsonSerDe. Used by
|
666
|
+
* The native Hive / HCatalog JsonSerDe. Used by 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.
|
649
667
|
*/
|
650
668
|
HiveJsonSerDe?: HiveJsonSerDe;
|
651
669
|
}
|
@@ -695,17 +713,17 @@ declare namespace Firehose {
|
|
695
713
|
export type DestinationId = string;
|
696
714
|
export interface DocumentIdOptions {
|
697
715
|
/**
|
698
|
-
* When the FIREHOSE_DEFAULT option is chosen,
|
716
|
+
* When the FIREHOSE_DEFAULT option is chosen, Firehose generates a unique document ID for each record based on a unique internal identifier. The generated document ID is stable across multiple delivery attempts, which helps prevent the same record from being indexed multiple times with different document IDs. When the NO_DOCUMENT_ID option is chosen, Firehose does not include any document IDs in the requests it sends to the Amazon OpenSearch Service. This causes the Amazon OpenSearch Service domain to generate document IDs. In case of multiple delivery attempts, this may cause the same record to be indexed more than once with different document IDs. This option enables write-heavy operations, such as the ingestion of logs and observability data, to consume less resources in the Amazon OpenSearch Service domain, resulting in improved performance.
|
699
717
|
*/
|
700
718
|
DefaultDocumentIdFormat: DefaultDocumentIdFormat;
|
701
719
|
}
|
702
720
|
export interface DynamicPartitioningConfiguration {
|
703
721
|
/**
|
704
|
-
* The retry behavior in case
|
722
|
+
* The retry behavior in case Firehose is unable to deliver data to an Amazon S3 prefix.
|
705
723
|
*/
|
706
724
|
RetryOptions?: RetryOptions;
|
707
725
|
/**
|
708
|
-
* Specifies that the dynamic partitioning is enabled for this
|
726
|
+
* Specifies that the dynamic partitioning is enabled for this Firehose delivery stream.
|
709
727
|
*/
|
710
728
|
Enabled?: BooleanObject;
|
711
729
|
}
|
@@ -724,7 +742,7 @@ declare namespace Firehose {
|
|
724
742
|
export type ElasticsearchClusterEndpoint = string;
|
725
743
|
export interface ElasticsearchDestinationConfiguration {
|
726
744
|
/**
|
727
|
-
* The Amazon Resource Name (ARN) of the IAM role to be assumed by
|
745
|
+
* 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 information, see Grant Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
|
728
746
|
*/
|
729
747
|
RoleARN: RoleARN;
|
730
748
|
/**
|
@@ -740,7 +758,7 @@ declare namespace Firehose {
|
|
740
758
|
*/
|
741
759
|
IndexName: ElasticsearchIndexName;
|
742
760
|
/**
|
743
|
-
* 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,
|
761
|
+
* 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, Firehose returns an error during run time. For Elasticsearch 7.x, don't specify a TypeName.
|
744
762
|
*/
|
745
763
|
TypeName?: ElasticsearchTypeName;
|
746
764
|
/**
|
@@ -752,11 +770,11 @@ declare namespace Firehose {
|
|
752
770
|
*/
|
753
771
|
BufferingHints?: ElasticsearchBufferingHints;
|
754
772
|
/**
|
755
|
-
* The retry behavior in case
|
773
|
+
* The retry behavior in case Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
|
756
774
|
*/
|
757
775
|
RetryOptions?: ElasticsearchRetryOptions;
|
758
776
|
/**
|
759
|
-
* Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly,
|
777
|
+
* Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to 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 FailedDocumentsOnly. You can't change this backup mode after you create the delivery stream.
|
760
778
|
*/
|
761
779
|
S3BackupMode?: ElasticsearchS3BackupMode;
|
762
780
|
/**
|
@@ -776,7 +794,7 @@ declare namespace Firehose {
|
|
776
794
|
*/
|
777
795
|
VpcConfiguration?: VpcConfiguration;
|
778
796
|
/**
|
779
|
-
* Indicates the method for setting up document ID. The supported methods are
|
797
|
+
* Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
|
780
798
|
*/
|
781
799
|
DocumentIdOptions?: DocumentIdOptions;
|
782
800
|
}
|
@@ -786,11 +804,11 @@ declare namespace Firehose {
|
|
786
804
|
*/
|
787
805
|
RoleARN?: RoleARN;
|
788
806
|
/**
|
789
|
-
* The ARN of the Amazon ES domain. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
|
807
|
+
* The ARN of the Amazon ES 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.
|
790
808
|
*/
|
791
809
|
DomainARN?: ElasticsearchDomainARN;
|
792
810
|
/**
|
793
|
-
* The endpoint to use when communicating with the cluster.
|
811
|
+
* The endpoint to use when communicating with the cluster. Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon ES.
|
794
812
|
*/
|
795
813
|
ClusterEndpoint?: ElasticsearchClusterEndpoint;
|
796
814
|
/**
|
@@ -834,13 +852,13 @@ declare namespace Firehose {
|
|
834
852
|
*/
|
835
853
|
VpcConfigurationDescription?: VpcConfigurationDescription;
|
836
854
|
/**
|
837
|
-
* Indicates the method for setting up document ID. The supported methods are
|
855
|
+
* Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
|
838
856
|
*/
|
839
857
|
DocumentIdOptions?: DocumentIdOptions;
|
840
858
|
}
|
841
859
|
export interface ElasticsearchDestinationUpdate {
|
842
860
|
/**
|
843
|
-
* The Amazon Resource Name (ARN) of the IAM role to be assumed by
|
861
|
+
* 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 information, see Grant Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
|
844
862
|
*/
|
845
863
|
RoleARN?: RoleARN;
|
846
864
|
/**
|
@@ -856,7 +874,7 @@ declare namespace Firehose {
|
|
856
874
|
*/
|
857
875
|
IndexName?: ElasticsearchIndexName;
|
858
876
|
/**
|
859
|
-
* 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,
|
877
|
+
* 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, Firehose returns an error during runtime. If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.
|
860
878
|
*/
|
861
879
|
TypeName?: ElasticsearchTypeName;
|
862
880
|
/**
|
@@ -868,7 +886,7 @@ declare namespace Firehose {
|
|
868
886
|
*/
|
869
887
|
BufferingHints?: ElasticsearchBufferingHints;
|
870
888
|
/**
|
871
|
-
* The retry behavior in case
|
889
|
+
* The retry behavior in case Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
|
872
890
|
*/
|
873
891
|
RetryOptions?: ElasticsearchRetryOptions;
|
874
892
|
/**
|
@@ -884,7 +902,7 @@ declare namespace Firehose {
|
|
884
902
|
*/
|
885
903
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
886
904
|
/**
|
887
|
-
* Indicates the method for setting up document ID. The supported methods are
|
905
|
+
* Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
|
888
906
|
*/
|
889
907
|
DocumentIdOptions?: DocumentIdOptions;
|
890
908
|
}
|
@@ -894,7 +912,7 @@ declare namespace Firehose {
|
|
894
912
|
export type ElasticsearchRetryDurationInSeconds = number;
|
895
913
|
export interface ElasticsearchRetryOptions {
|
896
914
|
/**
|
897
|
-
* After an initial failure to deliver to Amazon ES, the total amount of time during which
|
915
|
+
* After an initial failure to deliver to Amazon ES, 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.
|
898
916
|
*/
|
899
917
|
DurationInSeconds?: ElasticsearchRetryDurationInSeconds;
|
900
918
|
}
|
@@ -927,7 +945,7 @@ declare namespace Firehose {
|
|
927
945
|
*/
|
928
946
|
Prefix?: Prefix;
|
929
947
|
/**
|
930
|
-
* A prefix that
|
948
|
+
* A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.
|
931
949
|
*/
|
932
950
|
ErrorOutputPrefix?: ErrorOutputPrefix;
|
933
951
|
/**
|
@@ -966,6 +984,14 @@ declare namespace Firehose {
|
|
966
984
|
* The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations.
|
967
985
|
*/
|
968
986
|
DynamicPartitioningConfiguration?: DynamicPartitioningConfiguration;
|
987
|
+
/**
|
988
|
+
* Specify a file extension. It will override the default file extension
|
989
|
+
*/
|
990
|
+
FileExtension?: FileExtension;
|
991
|
+
/**
|
992
|
+
* The time zone you prefer. UTC is the default.
|
993
|
+
*/
|
994
|
+
CustomTimeZone?: CustomTimeZone;
|
969
995
|
}
|
970
996
|
export interface ExtendedS3DestinationDescription {
|
971
997
|
/**
|
@@ -981,7 +1007,7 @@ declare namespace Firehose {
|
|
981
1007
|
*/
|
982
1008
|
Prefix?: Prefix;
|
983
1009
|
/**
|
984
|
-
* A prefix that
|
1010
|
+
* A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.
|
985
1011
|
*/
|
986
1012
|
ErrorOutputPrefix?: ErrorOutputPrefix;
|
987
1013
|
/**
|
@@ -1020,6 +1046,14 @@ declare namespace Firehose {
|
|
1020
1046
|
* The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations.
|
1021
1047
|
*/
|
1022
1048
|
DynamicPartitioningConfiguration?: DynamicPartitioningConfiguration;
|
1049
|
+
/**
|
1050
|
+
* Specify a file extension. It will override the default file extension
|
1051
|
+
*/
|
1052
|
+
FileExtension?: FileExtension;
|
1053
|
+
/**
|
1054
|
+
* The time zone you prefer. UTC is the default.
|
1055
|
+
*/
|
1056
|
+
CustomTimeZone?: CustomTimeZone;
|
1023
1057
|
}
|
1024
1058
|
export interface ExtendedS3DestinationUpdate {
|
1025
1059
|
/**
|
@@ -1035,7 +1069,7 @@ declare namespace Firehose {
|
|
1035
1069
|
*/
|
1036
1070
|
Prefix?: Prefix;
|
1037
1071
|
/**
|
1038
|
-
* A prefix that
|
1072
|
+
* A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.
|
1039
1073
|
*/
|
1040
1074
|
ErrorOutputPrefix?: ErrorOutputPrefix;
|
1041
1075
|
/**
|
@@ -1074,6 +1108,14 @@ declare namespace Firehose {
|
|
1074
1108
|
* The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations.
|
1075
1109
|
*/
|
1076
1110
|
DynamicPartitioningConfiguration?: DynamicPartitioningConfiguration;
|
1111
|
+
/**
|
1112
|
+
* Specify a file extension. It will override the default file extension
|
1113
|
+
*/
|
1114
|
+
FileExtension?: FileExtension;
|
1115
|
+
/**
|
1116
|
+
* The time zone you prefer. UTC is the default.
|
1117
|
+
*/
|
1118
|
+
CustomTimeZone?: CustomTimeZone;
|
1077
1119
|
}
|
1078
1120
|
export interface FailureDescription {
|
1079
1121
|
/**
|
@@ -1085,13 +1127,21 @@ declare namespace Firehose {
|
|
1085
1127
|
*/
|
1086
1128
|
Details: NonEmptyString;
|
1087
1129
|
}
|
1130
|
+
export type FileExtension = string;
|
1131
|
+
export interface GetKinesisStreamInput {
|
1132
|
+
DeliveryStreamARN: DeliveryStreamARN;
|
1133
|
+
}
|
1134
|
+
export interface GetKinesisStreamOutput {
|
1135
|
+
KinesisStreamARN?: KinesisStreamARN;
|
1136
|
+
CredentialsForReadingKinesisStream?: SessionCredentials;
|
1137
|
+
}
|
1088
1138
|
export type HECAcknowledgmentTimeoutInSeconds = number;
|
1089
1139
|
export type HECEndpoint = string;
|
1090
1140
|
export type HECEndpointType = "Raw"|"Event"|string;
|
1091
1141
|
export type HECToken = string;
|
1092
1142
|
export interface HiveJsonSerDe {
|
1093
1143
|
/**
|
1094
|
-
* Indicates how you want
|
1144
|
+
* Indicates how you want Firehose to parse the date and timestamps 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 timestamps in epoch milliseconds. If you don't specify a format, Firehose uses java.sql.Timestamp::valueOf by default.
|
1095
1145
|
*/
|
1096
1146
|
TimestampFormats?: ListOfNonEmptyStrings;
|
1097
1147
|
}
|
@@ -1151,7 +1201,7 @@ declare namespace Firehose {
|
|
1151
1201
|
*/
|
1152
1202
|
EndpointConfiguration: HttpEndpointConfiguration;
|
1153
1203
|
/**
|
1154
|
-
* The buffering options that can be used before data is delivered to the specified destination.
|
1204
|
+
* The buffering options that can be used before data is delivered to the specified destination. Firehose treats these options as hints, and it might choose to use more optimal values. The SizeInMBs and IntervalInSeconds parameters are optional. However, if you specify a value for one of them, you must also provide a value for the other.
|
1155
1205
|
*/
|
1156
1206
|
BufferingHints?: HttpEndpointBufferingHints;
|
1157
1207
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
@@ -1161,15 +1211,15 @@ declare namespace Firehose {
|
|
1161
1211
|
RequestConfiguration?: HttpEndpointRequestConfiguration;
|
1162
1212
|
ProcessingConfiguration?: ProcessingConfiguration;
|
1163
1213
|
/**
|
1164
|
-
*
|
1214
|
+
* Firehose uses this IAM role for all the permissions that the delivery stream needs.
|
1165
1215
|
*/
|
1166
1216
|
RoleARN?: RoleARN;
|
1167
1217
|
/**
|
1168
|
-
* Describes the retry behavior in case
|
1218
|
+
* Describes the retry behavior in case Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.
|
1169
1219
|
*/
|
1170
1220
|
RetryOptions?: HttpEndpointRetryOptions;
|
1171
1221
|
/**
|
1172
|
-
* Describes the S3 bucket backup options for the data that
|
1222
|
+
* Describes the S3 bucket backup options for the data that Firehose delivers to the HTTP endpoint destination. You can back up all documents (AllData) or only the documents that Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly).
|
1173
1223
|
*/
|
1174
1224
|
S3BackupMode?: HttpEndpointS3BackupMode;
|
1175
1225
|
S3Configuration: S3DestinationConfiguration;
|
@@ -1180,7 +1230,7 @@ declare namespace Firehose {
|
|
1180
1230
|
*/
|
1181
1231
|
EndpointConfiguration?: HttpEndpointDescription;
|
1182
1232
|
/**
|
1183
|
-
* Describes buffering options that can be applied to the data before it is delivered to the HTTPS endpoint destination.
|
1233
|
+
* Describes buffering options that can be applied to the data before it is delivered to the HTTPS endpoint destination. Firehose teats these options as hints, and it might choose to use more optimal values. The SizeInMBs and IntervalInSeconds parameters are optional. However, if specify a value for one of them, you must also provide a value for the other.
|
1184
1234
|
*/
|
1185
1235
|
BufferingHints?: HttpEndpointBufferingHints;
|
1186
1236
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
@@ -1190,15 +1240,15 @@ declare namespace Firehose {
|
|
1190
1240
|
RequestConfiguration?: HttpEndpointRequestConfiguration;
|
1191
1241
|
ProcessingConfiguration?: ProcessingConfiguration;
|
1192
1242
|
/**
|
1193
|
-
*
|
1243
|
+
* Firehose uses this IAM role for all the permissions that the delivery stream needs.
|
1194
1244
|
*/
|
1195
1245
|
RoleARN?: RoleARN;
|
1196
1246
|
/**
|
1197
|
-
* Describes the retry behavior in case
|
1247
|
+
* Describes the retry behavior in case Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.
|
1198
1248
|
*/
|
1199
1249
|
RetryOptions?: HttpEndpointRetryOptions;
|
1200
1250
|
/**
|
1201
|
-
* Describes the S3 bucket backup options for the data that Kinesis Firehose delivers to the HTTP endpoint destination. You can back up all documents (AllData) or only the documents that
|
1251
|
+
* Describes the S3 bucket backup options for the data that Kinesis Firehose delivers to the HTTP endpoint destination. You can back up all documents (AllData) or only the documents that Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly).
|
1202
1252
|
*/
|
1203
1253
|
S3BackupMode?: HttpEndpointS3BackupMode;
|
1204
1254
|
S3DestinationDescription?: S3DestinationDescription;
|
@@ -1209,7 +1259,7 @@ declare namespace Firehose {
|
|
1209
1259
|
*/
|
1210
1260
|
EndpointConfiguration?: HttpEndpointConfiguration;
|
1211
1261
|
/**
|
1212
|
-
* Describes buffering options that can be applied to the data before it is delivered to the HTTPS endpoint destination.
|
1262
|
+
* Describes buffering options that can be applied to the data before it is delivered to the HTTPS endpoint destination. Firehose teats these options as hints, and it might choose to use more optimal values. The SizeInMBs and IntervalInSeconds parameters are optional. However, if specify a value for one of them, you must also provide a value for the other.
|
1213
1263
|
*/
|
1214
1264
|
BufferingHints?: HttpEndpointBufferingHints;
|
1215
1265
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
@@ -1219,15 +1269,15 @@ declare namespace Firehose {
|
|
1219
1269
|
RequestConfiguration?: HttpEndpointRequestConfiguration;
|
1220
1270
|
ProcessingConfiguration?: ProcessingConfiguration;
|
1221
1271
|
/**
|
1222
|
-
*
|
1272
|
+
* Firehose uses this IAM role for all the permissions that the delivery stream needs.
|
1223
1273
|
*/
|
1224
1274
|
RoleARN?: RoleARN;
|
1225
1275
|
/**
|
1226
|
-
* Describes the retry behavior in case
|
1276
|
+
* Describes the retry behavior in case Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.
|
1227
1277
|
*/
|
1228
1278
|
RetryOptions?: HttpEndpointRetryOptions;
|
1229
1279
|
/**
|
1230
|
-
* Describes the S3 bucket backup options for the data that Kinesis Firehose delivers to the HTTP endpoint destination. You can back up all documents (AllData) or only the documents that
|
1280
|
+
* Describes the S3 bucket backup options for the data that Kinesis Firehose delivers to the HTTP endpoint destination. You can back up all documents (AllData) or only the documents that Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly).
|
1231
1281
|
*/
|
1232
1282
|
S3BackupMode?: HttpEndpointS3BackupMode;
|
1233
1283
|
S3Update?: S3DestinationUpdate;
|
@@ -1235,7 +1285,7 @@ declare namespace Firehose {
|
|
1235
1285
|
export type HttpEndpointName = string;
|
1236
1286
|
export interface HttpEndpointRequestConfiguration {
|
1237
1287
|
/**
|
1238
|
-
*
|
1288
|
+
* Firehose uses the content encoding to compress the body of a request before sending the request to the destination. For more information, see Content-Encoding in MDN Web Docs, the official Mozilla documentation.
|
1239
1289
|
*/
|
1240
1290
|
ContentEncoding?: ContentEncoding;
|
1241
1291
|
/**
|
@@ -1246,7 +1296,7 @@ declare namespace Firehose {
|
|
1246
1296
|
export type HttpEndpointRetryDurationInSeconds = number;
|
1247
1297
|
export interface HttpEndpointRetryOptions {
|
1248
1298
|
/**
|
1249
|
-
* The total amount of time that
|
1299
|
+
* The total amount of time that Firehose spends on retries. This duration starts after the initial attempt to send data to the custom destination via HTTPS endpoint fails. It doesn't include the periods during which Firehose waits for acknowledgment from the specified destination after each attempt.
|
1250
1300
|
*/
|
1251
1301
|
DurationInSeconds?: HttpEndpointRetryDurationInSeconds;
|
1252
1302
|
}
|
@@ -1287,7 +1337,7 @@ declare namespace Firehose {
|
|
1287
1337
|
*/
|
1288
1338
|
RoleARN?: RoleARN;
|
1289
1339
|
/**
|
1290
|
-
*
|
1340
|
+
* Firehose starts retrieving records from the Kinesis data stream starting with this timestamp.
|
1291
1341
|
*/
|
1292
1342
|
DeliveryStartTimestamp?: DeliveryStartTimestamp;
|
1293
1343
|
}
|
@@ -1375,7 +1425,7 @@ declare namespace Firehose {
|
|
1375
1425
|
*/
|
1376
1426
|
AuthenticationConfiguration?: AuthenticationConfiguration;
|
1377
1427
|
/**
|
1378
|
-
*
|
1428
|
+
* Firehose starts retrieving records from the topic within the Amazon MSK cluster starting with this timestamp.
|
1379
1429
|
*/
|
1380
1430
|
DeliveryStartTimestamp?: DeliveryStartTimestamp;
|
1381
1431
|
}
|
@@ -1385,11 +1435,11 @@ declare namespace Firehose {
|
|
1385
1435
|
export type NonNegativeIntegerObject = number;
|
1386
1436
|
export interface OpenXJsonSerDe {
|
1387
1437
|
/**
|
1388
|
-
* When set to true, specifies that the names of the keys include dots and that you want
|
1438
|
+
* When set to true, specifies that the names of the keys include dots and that you want 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.
|
1389
1439
|
*/
|
1390
1440
|
ConvertDotsInJsonKeysToUnderscores?: BooleanObject;
|
1391
1441
|
/**
|
1392
|
-
* When set to true, which is the default,
|
1442
|
+
* When set to true, which is the default, Firehose converts JSON keys to lowercase before deserializing them.
|
1393
1443
|
*/
|
1394
1444
|
CaseInsensitive?: BooleanObject;
|
1395
1445
|
/**
|
@@ -1406,7 +1456,7 @@ declare namespace Firehose {
|
|
1406
1456
|
*/
|
1407
1457
|
StripeSizeBytes?: OrcStripeSizeBytes;
|
1408
1458
|
/**
|
1409
|
-
* 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.
|
1459
|
+
* 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. Firehose uses this value for padding calculations.
|
1410
1460
|
*/
|
1411
1461
|
BlockSizeBytes?: BlockSizeBytes;
|
1412
1462
|
/**
|
@@ -1418,7 +1468,7 @@ declare namespace Firehose {
|
|
1418
1468
|
*/
|
1419
1469
|
EnablePadding?: BooleanObject;
|
1420
1470
|
/**
|
1421
|
-
* 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.
|
1471
|
+
* 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. Firehose ignores this parameter when OrcSerDe$EnablePadding is false.
|
1422
1472
|
*/
|
1423
1473
|
PaddingTolerance?: Proportion;
|
1424
1474
|
/**
|
@@ -1426,7 +1476,7 @@ declare namespace Firehose {
|
|
1426
1476
|
*/
|
1427
1477
|
Compression?: OrcCompression;
|
1428
1478
|
/**
|
1429
|
-
* The column names for which you want
|
1479
|
+
* The column names for which you want Firehose to create bloom filters. The default is null.
|
1430
1480
|
*/
|
1431
1481
|
BloomFilterColumns?: ListOfNonEmptyStringsWithoutWhitespace;
|
1432
1482
|
/**
|
@@ -1453,7 +1503,7 @@ declare namespace Firehose {
|
|
1453
1503
|
export type ParquetPageSizeBytes = number;
|
1454
1504
|
export interface ParquetSerDe {
|
1455
1505
|
/**
|
1456
|
-
* 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.
|
1506
|
+
* 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. Firehose uses this value for padding calculations.
|
1457
1507
|
*/
|
1458
1508
|
BlockSizeBytes?: BlockSizeBytes;
|
1459
1509
|
/**
|
@@ -1512,9 +1562,9 @@ declare namespace Firehose {
|
|
1512
1562
|
ParameterValue: ProcessorParameterValue;
|
1513
1563
|
}
|
1514
1564
|
export type ProcessorParameterList = ProcessorParameter[];
|
1515
|
-
export type ProcessorParameterName = "LambdaArn"|"NumberOfRetries"|"MetadataExtractionQuery"|"JsonParsingEngine"|"RoleArn"|"BufferSizeInMBs"|"BufferIntervalInSeconds"|"SubRecordType"|"Delimiter"|"CompressionFormat"|string;
|
1565
|
+
export type ProcessorParameterName = "LambdaArn"|"NumberOfRetries"|"MetadataExtractionQuery"|"JsonParsingEngine"|"RoleArn"|"BufferSizeInMBs"|"BufferIntervalInSeconds"|"SubRecordType"|"Delimiter"|"CompressionFormat"|"DataMessageExtraction"|string;
|
1516
1566
|
export type ProcessorParameterValue = string;
|
1517
|
-
export type ProcessorType = "RecordDeAggregation"|"Decompression"|"Lambda"|"MetadataExtraction"|"AppendDelimiterToRecord"|string;
|
1567
|
+
export type ProcessorType = "RecordDeAggregation"|"Decompression"|"CloudWatchLogProcessing"|"Lambda"|"MetadataExtraction"|"AppendDelimiterToRecord"|string;
|
1518
1568
|
export type Proportion = number;
|
1519
1569
|
export interface PutRecordBatchInput {
|
1520
1570
|
/**
|
@@ -1605,7 +1655,7 @@ declare namespace Firehose {
|
|
1605
1655
|
*/
|
1606
1656
|
Password: Password;
|
1607
1657
|
/**
|
1608
|
-
* The retry behavior in case
|
1658
|
+
* The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).
|
1609
1659
|
*/
|
1610
1660
|
RetryOptions?: RedshiftRetryOptions;
|
1611
1661
|
/**
|
@@ -1647,7 +1697,7 @@ declare namespace Firehose {
|
|
1647
1697
|
*/
|
1648
1698
|
Username: Username;
|
1649
1699
|
/**
|
1650
|
-
* The retry behavior in case
|
1700
|
+
* The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).
|
1651
1701
|
*/
|
1652
1702
|
RetryOptions?: RedshiftRetryOptions;
|
1653
1703
|
/**
|
@@ -1693,7 +1743,7 @@ declare namespace Firehose {
|
|
1693
1743
|
*/
|
1694
1744
|
Password?: Password;
|
1695
1745
|
/**
|
1696
|
-
* The retry behavior in case
|
1746
|
+
* The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).
|
1697
1747
|
*/
|
1698
1748
|
RetryOptions?: RedshiftRetryOptions;
|
1699
1749
|
/**
|
@@ -1720,7 +1770,7 @@ declare namespace Firehose {
|
|
1720
1770
|
export type RedshiftRetryDurationInSeconds = number;
|
1721
1771
|
export interface RedshiftRetryOptions {
|
1722
1772
|
/**
|
1723
|
-
* The length of time during which
|
1773
|
+
* The length of time during which Firehose retries delivery after a failure, starting from the initial request and including the first attempt. The default value is 3600 seconds (60 minutes). Firehose does not retry if the value of DurationInSeconds is 0 (zero) or if the first delivery attempt takes longer than the current value.
|
1724
1774
|
*/
|
1725
1775
|
DurationInSeconds?: RedshiftRetryDurationInSeconds;
|
1726
1776
|
}
|
@@ -1728,7 +1778,7 @@ declare namespace Firehose {
|
|
1728
1778
|
export type RetryDurationInSeconds = number;
|
1729
1779
|
export interface RetryOptions {
|
1730
1780
|
/**
|
1731
|
-
* The period of time during which
|
1781
|
+
* The period of time during which Firehose retries to deliver data to the specified Amazon S3 prefix.
|
1732
1782
|
*/
|
1733
1783
|
DurationInSeconds?: RetryDurationInSeconds;
|
1734
1784
|
}
|
@@ -1748,7 +1798,7 @@ declare namespace Firehose {
|
|
1748
1798
|
*/
|
1749
1799
|
Prefix?: Prefix;
|
1750
1800
|
/**
|
1751
|
-
* A prefix that
|
1801
|
+
* A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.
|
1752
1802
|
*/
|
1753
1803
|
ErrorOutputPrefix?: ErrorOutputPrefix;
|
1754
1804
|
/**
|
@@ -1782,7 +1832,7 @@ declare namespace Firehose {
|
|
1782
1832
|
*/
|
1783
1833
|
Prefix?: Prefix;
|
1784
1834
|
/**
|
1785
|
-
* A prefix that
|
1835
|
+
* A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.
|
1786
1836
|
*/
|
1787
1837
|
ErrorOutputPrefix?: ErrorOutputPrefix;
|
1788
1838
|
/**
|
@@ -1816,7 +1866,7 @@ declare namespace Firehose {
|
|
1816
1866
|
*/
|
1817
1867
|
Prefix?: Prefix;
|
1818
1868
|
/**
|
1819
|
-
* A prefix that
|
1869
|
+
* A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.
|
1820
1870
|
*/
|
1821
1871
|
ErrorOutputPrefix?: ErrorOutputPrefix;
|
1822
1872
|
/**
|
@@ -1838,7 +1888,7 @@ declare namespace Firehose {
|
|
1838
1888
|
}
|
1839
1889
|
export interface SchemaConfiguration {
|
1840
1890
|
/**
|
1841
|
-
* The role that
|
1891
|
+
* The role that Firehose can use to access Amazon Web Services Glue. This role must be in the same account you use for Firehose. Cross-account roles aren't allowed. If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the RoleARN property is required and its value must be specified.
|
1842
1892
|
*/
|
1843
1893
|
RoleARN?: NonEmptyStringWithoutWhitespace;
|
1844
1894
|
/**
|
@@ -1858,10 +1908,11 @@ declare namespace Firehose {
|
|
1858
1908
|
*/
|
1859
1909
|
Region?: NonEmptyStringWithoutWhitespace;
|
1860
1910
|
/**
|
1861
|
-
* Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to LATEST,
|
1911
|
+
* Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to LATEST, Firehose uses the most recent version. This means that any updates to the table are automatically picked up.
|
1862
1912
|
*/
|
1863
1913
|
VersionId?: NonEmptyStringWithoutWhitespace;
|
1864
1914
|
}
|
1915
|
+
export type SecretAccessKey = string;
|
1865
1916
|
export type SecurityGroupIdList = NonEmptyStringWithoutWhitespace[];
|
1866
1917
|
export interface Serializer {
|
1867
1918
|
/**
|
@@ -1873,6 +1924,13 @@ declare namespace Firehose {
|
|
1873
1924
|
*/
|
1874
1925
|
OrcSerDe?: OrcSerDe;
|
1875
1926
|
}
|
1927
|
+
export interface SessionCredentials {
|
1928
|
+
AccessKeyId: AccessKeyId;
|
1929
|
+
SecretAccessKey: SecretAccessKey;
|
1930
|
+
SessionToken: SessionToken;
|
1931
|
+
Expiration: Timestamp;
|
1932
|
+
}
|
1933
|
+
export type SessionToken = string;
|
1876
1934
|
export type SizeInMBs = number;
|
1877
1935
|
export type SnowflakeAccountUrl = string;
|
1878
1936
|
export type SnowflakeContentColumnName = string;
|
@@ -1934,7 +1992,7 @@ declare namespace Firehose {
|
|
1934
1992
|
*/
|
1935
1993
|
RoleARN: RoleARN;
|
1936
1994
|
/**
|
1937
|
-
* The time period where
|
1995
|
+
* The time period where Firehose will retry sending data to the chosen HTTP endpoint.
|
1938
1996
|
*/
|
1939
1997
|
RetryOptions?: SnowflakeRetryOptions;
|
1940
1998
|
/**
|
@@ -1991,7 +2049,7 @@ declare namespace Firehose {
|
|
1991
2049
|
*/
|
1992
2050
|
RoleARN?: RoleARN;
|
1993
2051
|
/**
|
1994
|
-
* The time period where
|
2052
|
+
* The time period where Firehose will retry sending data to the chosen HTTP endpoint.
|
1995
2053
|
*/
|
1996
2054
|
RetryOptions?: SnowflakeRetryOptions;
|
1997
2055
|
/**
|
@@ -2052,7 +2110,7 @@ declare namespace Firehose {
|
|
2052
2110
|
*/
|
2053
2111
|
RoleARN?: RoleARN;
|
2054
2112
|
/**
|
2055
|
-
* Specify how long
|
2113
|
+
* Specify how long Firehose retries sending data to the New Relic HTTP endpoint. After sending data, Firehose first waits for an acknowledgment from the HTTP endpoint. If an error occurs or the acknowledgment doesn’t arrive within the acknowledgment timeout period, Firehose starts the retry duration counter. It keeps retrying until the retry duration expires. After that, Firehose considers it a data delivery failure and backs up the data to your Amazon S3 bucket. Every time that Firehose sends data to the HTTP endpoint (either the initial attempt or a retry), it restarts the acknowledgement timeout counter and waits for an acknowledgement from the HTTP endpoint. Even if the retry duration expires, Firehose still waits for the acknowledgment until it receives it or the acknowledgement timeout period is reached. If the acknowledgment times out, Firehose determines whether there's time left in the retry counter. If there is time left, it retries again and repeats the logic until it receives an acknowledgment or determines that the retry time has expired. If you don't want Firehose to retry sending data, set this value to 0.
|
2056
2114
|
*/
|
2057
2115
|
RetryOptions?: SnowflakeRetryOptions;
|
2058
2116
|
/**
|
@@ -2068,7 +2126,7 @@ declare namespace Firehose {
|
|
2068
2126
|
export type SnowflakeRetryDurationInSeconds = number;
|
2069
2127
|
export interface SnowflakeRetryOptions {
|
2070
2128
|
/**
|
2071
|
-
* the time period where
|
2129
|
+
* the time period where Firehose will retry sending data to the chosen HTTP endpoint.
|
2072
2130
|
*/
|
2073
2131
|
DurationInSeconds?: SnowflakeRetryDurationInSeconds;
|
2074
2132
|
}
|
@@ -2117,7 +2175,7 @@ declare namespace Firehose {
|
|
2117
2175
|
export type SplunkBufferingSizeInMBs = number;
|
2118
2176
|
export interface SplunkDestinationConfiguration {
|
2119
2177
|
/**
|
2120
|
-
* The HTTP Event Collector (HEC) endpoint to which
|
2178
|
+
* The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.
|
2121
2179
|
*/
|
2122
2180
|
HECEndpoint: HECEndpoint;
|
2123
2181
|
/**
|
@@ -2129,15 +2187,15 @@ declare namespace Firehose {
|
|
2129
2187
|
*/
|
2130
2188
|
HECToken: HECToken;
|
2131
2189
|
/**
|
2132
|
-
* The amount of time that
|
2190
|
+
* The amount of time that Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Firehose either tries to send the data again or considers it an error, based on your retry settings.
|
2133
2191
|
*/
|
2134
2192
|
HECAcknowledgmentTimeoutInSeconds?: HECAcknowledgmentTimeoutInSeconds;
|
2135
2193
|
/**
|
2136
|
-
* The retry behavior in case
|
2194
|
+
* The retry behavior in case Firehose is unable to deliver data to Splunk, or if it doesn't receive an acknowledgment of receipt from Splunk.
|
2137
2195
|
*/
|
2138
2196
|
RetryOptions?: SplunkRetryOptions;
|
2139
2197
|
/**
|
2140
|
-
* Defines how documents should be delivered to Amazon S3. When set to FailedEventsOnly,
|
2198
|
+
* Defines how documents should be delivered to Amazon S3. When set to FailedEventsOnly, Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllEvents, Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. The default value is FailedEventsOnly. You can update this backup mode from FailedEventsOnly to AllEvents. You can't update it from AllEvents to FailedEventsOnly.
|
2141
2199
|
*/
|
2142
2200
|
S3BackupMode?: SplunkS3BackupMode;
|
2143
2201
|
/**
|
@@ -2159,7 +2217,7 @@ declare namespace Firehose {
|
|
2159
2217
|
}
|
2160
2218
|
export interface SplunkDestinationDescription {
|
2161
2219
|
/**
|
2162
|
-
* The HTTP Event Collector (HEC) endpoint to which
|
2220
|
+
* The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.
|
2163
2221
|
*/
|
2164
2222
|
HECEndpoint?: HECEndpoint;
|
2165
2223
|
/**
|
@@ -2171,15 +2229,15 @@ declare namespace Firehose {
|
|
2171
2229
|
*/
|
2172
2230
|
HECToken?: HECToken;
|
2173
2231
|
/**
|
2174
|
-
* The amount of time that
|
2232
|
+
* The amount of time that Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Firehose either tries to send the data again or considers it an error, based on your retry settings.
|
2175
2233
|
*/
|
2176
2234
|
HECAcknowledgmentTimeoutInSeconds?: HECAcknowledgmentTimeoutInSeconds;
|
2177
2235
|
/**
|
2178
|
-
* The retry behavior in case
|
2236
|
+
* The retry behavior in case Firehose is unable to deliver data to Splunk or if it doesn't receive an acknowledgment of receipt from Splunk.
|
2179
2237
|
*/
|
2180
2238
|
RetryOptions?: SplunkRetryOptions;
|
2181
2239
|
/**
|
2182
|
-
* Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly,
|
2240
|
+
* Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is FailedDocumentsOnly.
|
2183
2241
|
*/
|
2184
2242
|
S3BackupMode?: SplunkS3BackupMode;
|
2185
2243
|
/**
|
@@ -2201,7 +2259,7 @@ declare namespace Firehose {
|
|
2201
2259
|
}
|
2202
2260
|
export interface SplunkDestinationUpdate {
|
2203
2261
|
/**
|
2204
|
-
* The HTTP Event Collector (HEC) endpoint to which
|
2262
|
+
* The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.
|
2205
2263
|
*/
|
2206
2264
|
HECEndpoint?: HECEndpoint;
|
2207
2265
|
/**
|
@@ -2213,15 +2271,15 @@ declare namespace Firehose {
|
|
2213
2271
|
*/
|
2214
2272
|
HECToken?: HECToken;
|
2215
2273
|
/**
|
2216
|
-
* The amount of time that
|
2274
|
+
* The amount of time that Firehose waits to receive an acknowledgment from Splunk after it sends data. At the end of the timeout period, Firehose either tries to send the data again or considers it an error, based on your retry settings.
|
2217
2275
|
*/
|
2218
2276
|
HECAcknowledgmentTimeoutInSeconds?: HECAcknowledgmentTimeoutInSeconds;
|
2219
2277
|
/**
|
2220
|
-
* The retry behavior in case
|
2278
|
+
* The retry behavior in case Firehose is unable to deliver data to Splunk or if it doesn't receive an acknowledgment of receipt from Splunk.
|
2221
2279
|
*/
|
2222
2280
|
RetryOptions?: SplunkRetryOptions;
|
2223
2281
|
/**
|
2224
|
-
* Specifies how you want
|
2282
|
+
* Specifies how you want Firehose to back up documents to Amazon S3. When set to FailedDocumentsOnly, Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllEvents, Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. The default value is FailedEventsOnly. You can update this backup mode from FailedEventsOnly to AllEvents. You can't update it from AllEvents to FailedEventsOnly.
|
2225
2283
|
*/
|
2226
2284
|
S3BackupMode?: SplunkS3BackupMode;
|
2227
2285
|
/**
|
@@ -2244,7 +2302,7 @@ declare namespace Firehose {
|
|
2244
2302
|
export type SplunkRetryDurationInSeconds = number;
|
2245
2303
|
export interface SplunkRetryOptions {
|
2246
2304
|
/**
|
2247
|
-
* The total amount of time that
|
2305
|
+
* The total amount of time that Firehose spends on retries. This duration starts after the initial attempt to send data to Splunk fails. It doesn't include the periods during which Firehose waits for acknowledgment from Splunk after each attempt.
|
2248
2306
|
*/
|
2249
2307
|
DurationInSeconds?: SplunkRetryDurationInSeconds;
|
2250
2308
|
}
|
@@ -2296,6 +2354,25 @@ declare namespace Firehose {
|
|
2296
2354
|
export type TagKey = string;
|
2297
2355
|
export type TagKeyList = TagKey[];
|
2298
2356
|
export type TagValue = string;
|
2357
|
+
export type TagrisAccountId = string;
|
2358
|
+
export type TagrisAmazonResourceName = string;
|
2359
|
+
export type TagrisInternalId = string;
|
2360
|
+
export type TagrisStatus = "ACTIVE"|"NOT_ACTIVE"|string;
|
2361
|
+
export type TagrisSweepList = TagrisSweepListItem[];
|
2362
|
+
export interface TagrisSweepListItem {
|
2363
|
+
TagrisAccountId?: TagrisAccountId;
|
2364
|
+
TagrisAmazonResourceName?: TagrisAmazonResourceName;
|
2365
|
+
TagrisInternalId?: TagrisInternalId;
|
2366
|
+
TagrisVersion?: TagrisVersion;
|
2367
|
+
}
|
2368
|
+
export type TagrisSweepListResult = {[key: string]: TagrisStatus};
|
2369
|
+
export interface TagrisVerifyResourcesExistInput {
|
2370
|
+
TagrisSweepList: TagrisSweepList;
|
2371
|
+
}
|
2372
|
+
export interface TagrisVerifyResourcesExistOutput {
|
2373
|
+
TagrisSweepListResult: TagrisSweepListResult;
|
2374
|
+
}
|
2375
|
+
export type TagrisVersion = number;
|
2299
2376
|
export type Timestamp = Date;
|
2300
2377
|
export type TopicName = string;
|
2301
2378
|
export interface UntagDeliveryStreamInput {
|
@@ -2365,29 +2442,29 @@ declare namespace Firehose {
|
|
2365
2442
|
export type Username = string;
|
2366
2443
|
export interface VpcConfiguration {
|
2367
2444
|
/**
|
2368
|
-
* The IDs of the subnets that you want
|
2445
|
+
* 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 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 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 scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Firehose can create up to three ENIs for this delivery stream for each of the subnets specified here. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.
|
2369
2446
|
*/
|
2370
2447
|
SubnetIds: SubnetIdList;
|
2371
2448
|
/**
|
2372
|
-
* The ARN of the IAM role that you want the delivery stream to use to create endpoints in the destination VPC. You can use your existing
|
2449
|
+
* The ARN of the IAM role that you want the delivery stream to use to create endpoints in the destination VPC. You can use your existing Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Firehose service principal and that it grants the following permissions: ec2:DescribeVpcs ec2:DescribeVpcAttribute ec2:DescribeSubnets ec2:DescribeSecurityGroups ec2:DescribeNetworkInterfaces ec2:CreateNetworkInterface ec2:CreateNetworkInterfacePermission ec2:DeleteNetworkInterface When you specify subnets for delivering data to the destination in a private VPC, make sure you have enough number of free IP addresses in chosen subnets. If there is no available free IP address in a specified subnet, Firehose cannot create or add ENIs for the data delivery in the private VPC, and the delivery will be degraded or fail.
|
2373
2450
|
*/
|
2374
2451
|
RoleARN: RoleARN;
|
2375
2452
|
/**
|
2376
|
-
* The IDs of the security groups that you want
|
2453
|
+
* 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 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 traffic. For more information about security group rules, see Security group rules in the Amazon VPC documentation.
|
2377
2454
|
*/
|
2378
2455
|
SecurityGroupIds: SecurityGroupIdList;
|
2379
2456
|
}
|
2380
2457
|
export interface VpcConfigurationDescription {
|
2381
2458
|
/**
|
2382
|
-
* The IDs of the subnets that
|
2459
|
+
* 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 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 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 scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Firehose can create up to three ENIs for this delivery stream for each of the subnets specified here. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.
|
2383
2460
|
*/
|
2384
2461
|
SubnetIds: SubnetIdList;
|
2385
2462
|
/**
|
2386
|
-
* The ARN of the IAM role that the delivery stream uses to create endpoints in the destination VPC. You can use your existing
|
2463
|
+
* The ARN of the IAM role that the delivery stream uses to create endpoints in the destination VPC. You can use your existing Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Firehose service principal and that it grants the following permissions: ec2:DescribeVpcs ec2:DescribeVpcAttribute ec2:DescribeSubnets ec2:DescribeSecurityGroups ec2:DescribeNetworkInterfaces ec2:CreateNetworkInterface ec2:CreateNetworkInterfacePermission ec2:DeleteNetworkInterface If you revoke these permissions after you create the delivery stream, Firehose can't scale out by creating more ENIs when necessary. You might therefore see a degradation in performance.
|
2387
2464
|
*/
|
2388
2465
|
RoleARN: RoleARN;
|
2389
2466
|
/**
|
2390
|
-
* The IDs of the security groups that
|
2467
|
+
* 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 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 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 traffic. For more information about security group rules, see Security group rules in the Amazon VPC documentation.
|
2391
2468
|
*/
|
2392
2469
|
SecurityGroupIds: SecurityGroupIdList;
|
2393
2470
|
/**
|