firehose.d.ts (52102B)
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {ServiceConfigurationOptions} from '../lib/service'; 6 import {ConfigBase as Config} from '../lib/config'; 7 interface Blob {} 8 declare class Firehose extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: Firehose.Types.ClientConfiguration) 13 config: Config & Firehose.Types.ClientConfiguration; 14 /** 15 * Creates a delivery stream. CreateDeliveryStream is an asynchronous operation that immediately returns. The initial status of the delivery stream is CREATING. After the delivery stream is created, its status is ACTIVE and it now accepts data. Attempts to send data to a delivery stream that is not in the ACTIVE state cause an exception. To check the state of a delivery stream, use DescribeDeliveryStream. The name of a delivery stream identifies it. You can't have two delivery streams with the same name in the same region. Two delivery streams in different AWS accounts or different regions in the same AWS account can have the same name. By default, you can create up to 20 delivery streams per region. A delivery stream can only be configured with a single destination, Amazon S3, Amazon Elasticsearch Service, or Amazon Redshift. For correct CreateDeliveryStream request syntax, specify only one destination configuration parameter: either S3DestinationConfiguration, ElasticsearchDestinationConfiguration, or RedshiftDestinationConfiguration. As part of S3DestinationConfiguration, optional values BufferingHints, EncryptionConfiguration, and CompressionFormat can be provided. By default, if no BufferingHints value is provided, Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. Note that BufferingHints is a hint, so there are some cases where the service cannot adhere to these conditions strictly; for example, record boundaries are such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3. A few notes about RedshiftDestinationConfiguration: An Amazon Redshift destination requires an S3 bucket as intermediate location, as Firehose first delivers data to S3 and then uses COPY syntax to load data into an Amazon Redshift table. This is specified in the RedshiftDestinationConfiguration.S3Configuration parameter element. 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 the username and password provided is used exclusively for Firehose purposes, 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 destinations. The IAM role should allow the Firehose principal to assume the role, and the role should have permissions that allows the service to deliver the data. For more information, see Amazon S3 Bucket Access in the Amazon Kinesis Firehose Developer Guide. 16 */ 17 createDeliveryStream(params: Firehose.Types.CreateDeliveryStreamInput, callback?: (err: AWSError, data: Firehose.Types.CreateDeliveryStreamOutput) => void): Request<Firehose.Types.CreateDeliveryStreamOutput, AWSError>; 18 /** 19 * Creates a delivery stream. CreateDeliveryStream is an asynchronous operation that immediately returns. The initial status of the delivery stream is CREATING. After the delivery stream is created, its status is ACTIVE and it now accepts data. Attempts to send data to a delivery stream that is not in the ACTIVE state cause an exception. To check the state of a delivery stream, use DescribeDeliveryStream. The name of a delivery stream identifies it. You can't have two delivery streams with the same name in the same region. Two delivery streams in different AWS accounts or different regions in the same AWS account can have the same name. By default, you can create up to 20 delivery streams per region. A delivery stream can only be configured with a single destination, Amazon S3, Amazon Elasticsearch Service, or Amazon Redshift. For correct CreateDeliveryStream request syntax, specify only one destination configuration parameter: either S3DestinationConfiguration, ElasticsearchDestinationConfiguration, or RedshiftDestinationConfiguration. As part of S3DestinationConfiguration, optional values BufferingHints, EncryptionConfiguration, and CompressionFormat can be provided. By default, if no BufferingHints value is provided, Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. Note that BufferingHints is a hint, so there are some cases where the service cannot adhere to these conditions strictly; for example, record boundaries are such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3. A few notes about RedshiftDestinationConfiguration: An Amazon Redshift destination requires an S3 bucket as intermediate location, as Firehose first delivers data to S3 and then uses COPY syntax to load data into an Amazon Redshift table. This is specified in the RedshiftDestinationConfiguration.S3Configuration parameter element. 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 the username and password provided is used exclusively for Firehose purposes, 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 destinations. The IAM role should allow the Firehose principal to assume the role, and the role should have permissions that allows the service to deliver the data. For more information, see Amazon S3 Bucket Access in the Amazon Kinesis Firehose Developer Guide. 20 */ 21 createDeliveryStream(callback?: (err: AWSError, data: Firehose.Types.CreateDeliveryStreamOutput) => void): Request<Firehose.Types.CreateDeliveryStreamOutput, AWSError>; 22 /** 23 * Deletes a delivery stream and its data. You can delete a delivery stream only if it is in ACTIVE or DELETING state, and not in the CREATING state. While the deletion request is in process, the delivery stream is in the DELETING state. To check the state of a delivery stream, use DescribeDeliveryStream. While the delivery stream is DELETING state, the service may continue to accept the records, but the service doesn't make any guarantees with respect to delivering the data. Therefore, as a best practice, you should first stop any applications that are sending records before deleting a delivery stream. 24 */ 25 deleteDeliveryStream(params: Firehose.Types.DeleteDeliveryStreamInput, callback?: (err: AWSError, data: Firehose.Types.DeleteDeliveryStreamOutput) => void): Request<Firehose.Types.DeleteDeliveryStreamOutput, AWSError>; 26 /** 27 * Deletes a delivery stream and its data. You can delete a delivery stream only if it is in ACTIVE or DELETING state, and not in the CREATING state. While the deletion request is in process, the delivery stream is in the DELETING state. To check the state of a delivery stream, use DescribeDeliveryStream. While the delivery stream is DELETING state, the service may continue to accept the records, but the service doesn't make any guarantees with respect to delivering the data. Therefore, as a best practice, you should first stop any applications that are sending records before deleting a delivery stream. 28 */ 29 deleteDeliveryStream(callback?: (err: AWSError, data: Firehose.Types.DeleteDeliveryStreamOutput) => void): Request<Firehose.Types.DeleteDeliveryStreamOutput, AWSError>; 30 /** 31 * Describes the specified delivery stream and gets the status. For example, after your delivery stream is created, call DescribeDeliveryStream to see if the delivery stream is ACTIVE and therefore ready for data to be sent to it. 32 */ 33 describeDeliveryStream(params: Firehose.Types.DescribeDeliveryStreamInput, callback?: (err: AWSError, data: Firehose.Types.DescribeDeliveryStreamOutput) => void): Request<Firehose.Types.DescribeDeliveryStreamOutput, AWSError>; 34 /** 35 * Describes the specified delivery stream and gets the status. For example, after your delivery stream is created, call DescribeDeliveryStream to see if the delivery stream is ACTIVE and therefore ready for data to be sent to it. 36 */ 37 describeDeliveryStream(callback?: (err: AWSError, data: Firehose.Types.DescribeDeliveryStreamOutput) => void): Request<Firehose.Types.DescribeDeliveryStreamOutput, AWSError>; 38 /** 39 * Lists your delivery streams. 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 specifying the name of the last delivery stream returned in the call in the ExclusiveStartDeliveryStreamName parameter of a subsequent call. 40 */ 41 listDeliveryStreams(params: Firehose.Types.ListDeliveryStreamsInput, callback?: (err: AWSError, data: Firehose.Types.ListDeliveryStreamsOutput) => void): Request<Firehose.Types.ListDeliveryStreamsOutput, AWSError>; 42 /** 43 * Lists your delivery streams. 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 specifying the name of the last delivery stream returned in the call in the ExclusiveStartDeliveryStreamName parameter of a subsequent call. 44 */ 45 listDeliveryStreams(callback?: (err: AWSError, data: Firehose.Types.ListDeliveryStreamsOutput) => void): Request<Firehose.Types.ListDeliveryStreamsOutput, AWSError>; 46 /** 47 * Writes a single data record into an Amazon Kinesis Firehose delivery stream. To write multiple data records into a delivery stream, use PutRecordBatch. Applications using these operations are referred to as producers. By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. Note that if you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each delivery stream. For more information about limits and how to request an increase, see Amazon Kinesis Firehose Limits. You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data, for example, a segment from a log file, geographic location data, web site clickstream data, etc. 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(s) to parse individual data items when reading the data from the destination. The PutRecord operation returns a RecordId, which is a unique string assigned to each record. Producer applications can use this ID for purposes such as auditability and investigation. If the PutRecord operation throws a ServiceUnavailableException, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream. Data records sent to 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. 48 */ 49 putRecord(params: Firehose.Types.PutRecordInput, callback?: (err: AWSError, data: Firehose.Types.PutRecordOutput) => void): Request<Firehose.Types.PutRecordOutput, AWSError>; 50 /** 51 * Writes a single data record into an Amazon Kinesis Firehose delivery stream. To write multiple data records into a delivery stream, use PutRecordBatch. Applications using these operations are referred to as producers. By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. Note that if you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each delivery stream. For more information about limits and how to request an increase, see Amazon Kinesis Firehose Limits. You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data, for example, a segment from a log file, geographic location data, web site clickstream data, etc. 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(s) to parse individual data items when reading the data from the destination. The PutRecord operation returns a RecordId, which is a unique string assigned to each record. Producer applications can use this ID for purposes such as auditability and investigation. If the PutRecord operation throws a ServiceUnavailableException, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream. Data records sent to 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. 52 */ 53 putRecord(callback?: (err: AWSError, data: Firehose.Types.PutRecordOutput) => void): Request<Firehose.Types.PutRecordOutput, AWSError>; 54 /** 55 * 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. Each PutRecordBatch request supports up to 500 records. Each record in the request can be as large as 1,000 KB (before 64-bit encoding), up to a limit of 4 MB for the entire request. By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. Note that if you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each delivery stream. For more information about limits and how to request an increase, see Amazon Kinesis Firehose Limits. You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data, for example, a segment from a log file, geographic location data, web site 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(s) to parse individual data items when reading the data from the destination. The PutRecordBatch response includes a count of any failed records, FailedPutCount, and an array of responses, RequestResponses. The FailedPutCount value is a count of records that failed. Each entry in the RequestResponses array gives additional information of the processed record. Each entry in RequestResponses directly correlates with a record in the request array using the same ordering, from the top to the bottom of the request and response. RequestResponses always includes the same number of records as the request array. RequestResponses both successfully and unsuccessfully processed records. Firehose attempts to process all records in each PutRecordBatch request. A single record failure does not stop the processing of subsequent records. A successfully processed record includes a RecordId value, which is a unique value identified for the record. An unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error and is one of the following values: ServiceUnavailable or InternalFailure. ErrorMessage provides more detailed information about the error. If FailedPutCount is greater than 0 (zero), retry the request. A retry of the entire batch of records is possible; however, we strongly recommend that you inspect the entire response and resend only those records that failed processing. This minimizes duplicate records and also reduces the total bytes sent (and corresponding charges). If the PutRecordBatch operation throws a ServiceUnavailableException, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream. Data records sent to 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. 56 */ 57 putRecordBatch(params: Firehose.Types.PutRecordBatchInput, callback?: (err: AWSError, data: Firehose.Types.PutRecordBatchOutput) => void): Request<Firehose.Types.PutRecordBatchOutput, AWSError>; 58 /** 59 * 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. Each PutRecordBatch request supports up to 500 records. Each record in the request can be as large as 1,000 KB (before 64-bit encoding), up to a limit of 4 MB for the entire request. By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. Note that if you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each delivery stream. For more information about limits and how to request an increase, see Amazon Kinesis Firehose Limits. You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data, for example, a segment from a log file, geographic location data, web site 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(s) to parse individual data items when reading the data from the destination. The PutRecordBatch response includes a count of any failed records, FailedPutCount, and an array of responses, RequestResponses. The FailedPutCount value is a count of records that failed. Each entry in the RequestResponses array gives additional information of the processed record. Each entry in RequestResponses directly correlates with a record in the request array using the same ordering, from the top to the bottom of the request and response. RequestResponses always includes the same number of records as the request array. RequestResponses both successfully and unsuccessfully processed records. Firehose attempts to process all records in each PutRecordBatch request. A single record failure does not stop the processing of subsequent records. A successfully processed record includes a RecordId value, which is a unique value identified for the record. An unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error and is one of the following values: ServiceUnavailable or InternalFailure. ErrorMessage provides more detailed information about the error. If FailedPutCount is greater than 0 (zero), retry the request. A retry of the entire batch of records is possible; however, we strongly recommend that you inspect the entire response and resend only those records that failed processing. This minimizes duplicate records and also reduces the total bytes sent (and corresponding charges). If the PutRecordBatch operation throws a ServiceUnavailableException, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream. Data records sent to 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. 60 */ 61 putRecordBatch(callback?: (err: AWSError, data: Firehose.Types.PutRecordBatchOutput) => void): Request<Firehose.Types.PutRecordBatchOutput, AWSError>; 62 /** 63 * Updates the specified destination of the specified delivery stream. Note: Switching between Elasticsearch and other services is not supported. For Elasticsearch destination, you can only update an existing Elasticsearch destination with this operation. This operation can be used to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a given destination (for example, to change the bucket name of the Amazon S3 destination). The update may 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 normally effective within a few minutes. If the destination type is the same, Firehose merges the configuration parameters specified in the UpdateDestination request with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the update request, then the existing configuration parameters 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 the CurrentDeliveryStreamVersionId to avoid race conditions and conflicting merges. This is a required field in every request and the service only updates the configuration if the existing configuration matches the VersionId. After the update is applied successfully, the VersionId is updated, which can be retrieved with the DescribeDeliveryStream operation. The new VersionId should be uses to set CurrentDeliveryStreamVersionId in the next UpdateDestination operation. 64 */ 65 updateDestination(params: Firehose.Types.UpdateDestinationInput, callback?: (err: AWSError, data: Firehose.Types.UpdateDestinationOutput) => void): Request<Firehose.Types.UpdateDestinationOutput, AWSError>; 66 /** 67 * Updates the specified destination of the specified delivery stream. Note: Switching between Elasticsearch and other services is not supported. For Elasticsearch destination, you can only update an existing Elasticsearch destination with this operation. This operation can be used to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a given destination (for example, to change the bucket name of the Amazon S3 destination). The update may 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 normally effective within a few minutes. If the destination type is the same, Firehose merges the configuration parameters specified in the UpdateDestination request with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the update request, then the existing configuration parameters 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 the CurrentDeliveryStreamVersionId to avoid race conditions and conflicting merges. This is a required field in every request and the service only updates the configuration if the existing configuration matches the VersionId. After the update is applied successfully, the VersionId is updated, which can be retrieved with the DescribeDeliveryStream operation. The new VersionId should be uses to set CurrentDeliveryStreamVersionId in the next UpdateDestination operation. 68 */ 69 updateDestination(callback?: (err: AWSError, data: Firehose.Types.UpdateDestinationOutput) => void): Request<Firehose.Types.UpdateDestinationOutput, AWSError>; 70 } 71 declare namespace Firehose.Types { 72 export type AWSKMSKeyARN = string; 73 export type BooleanObject = boolean; 74 export type BucketARN = string; 75 export interface BufferingHints { 76 /** 77 * Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5. We recommend setting SizeInMBs to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec set SizeInMBs to be 10 MB or higher. 78 */ 79 SizeInMBs?: SizeInMBs; 80 /** 81 * Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300. 82 */ 83 IntervalInSeconds?: IntervalInSeconds; 84 } 85 export interface CloudWatchLoggingOptions { 86 /** 87 * Enables or disables CloudWatch logging. 88 */ 89 Enabled?: BooleanObject; 90 /** 91 * The CloudWatch group name for logging. This value is required if Enabled is true. 92 */ 93 LogGroupName?: LogGroupName; 94 /** 95 * The CloudWatch log stream name for logging. This value is required if Enabled is true. 96 */ 97 LogStreamName?: LogStreamName; 98 } 99 export type ClusterJDBCURL = string; 100 export type CompressionFormat = "UNCOMPRESSED"|"GZIP"|"ZIP"|"Snappy"|string; 101 export interface CopyCommand { 102 /** 103 * The name of the target table. The table must already exist in the database. 104 */ 105 DataTableName: DataTableName; 106 /** 107 * A comma-separated list of column names. 108 */ 109 DataTableColumns?: DataTableColumns; 110 /** 111 * 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. 112 */ 113 CopyOptions?: CopyOptions; 114 } 115 export type CopyOptions = string; 116 export interface CreateDeliveryStreamInput { 117 /** 118 * The name of the delivery stream. 119 */ 120 DeliveryStreamName: DeliveryStreamName; 121 /** 122 * The destination in Amazon S3. This value must be specified if ElasticsearchDestinationConfiguration or RedshiftDestinationConfiguration is specified (see restrictions listed above). 123 */ 124 S3DestinationConfiguration?: S3DestinationConfiguration; 125 /** 126 * The destination in Amazon Redshift. This value cannot be specified if Amazon S3 or Amazon Elasticsearch is the desired destination (see restrictions listed above). 127 */ 128 RedshiftDestinationConfiguration?: RedshiftDestinationConfiguration; 129 /** 130 * The destination in Amazon ES. This value cannot be specified if Amazon S3 or Amazon Redshift is the desired destination (see restrictions listed above). 131 */ 132 ElasticsearchDestinationConfiguration?: ElasticsearchDestinationConfiguration; 133 } 134 export interface CreateDeliveryStreamOutput { 135 /** 136 * The ARN of the delivery stream. 137 */ 138 DeliveryStreamARN?: DeliveryStreamARN; 139 } 140 export type Data = Buffer|Uint8Array|Blob|string; 141 export type DataTableColumns = string; 142 export type DataTableName = string; 143 export interface DeleteDeliveryStreamInput { 144 /** 145 * The name of the delivery stream. 146 */ 147 DeliveryStreamName: DeliveryStreamName; 148 } 149 export interface DeleteDeliveryStreamOutput { 150 } 151 export type DeliveryStreamARN = string; 152 export interface DeliveryStreamDescription { 153 /** 154 * The name of the delivery stream. 155 */ 156 DeliveryStreamName: DeliveryStreamName; 157 /** 158 * The Amazon Resource Name (ARN) of the delivery stream. 159 */ 160 DeliveryStreamARN: DeliveryStreamARN; 161 /** 162 * The status of the delivery stream. 163 */ 164 DeliveryStreamStatus: DeliveryStreamStatus; 165 /** 166 * Used when calling the UpdateDestination operation. Each time the destination is updated for the delivery stream, the VersionId is changed, and the current VersionId is required when updating the destination. This is so that the service knows it is applying the changes to the correct version of the delivery stream. 167 */ 168 VersionId: DeliveryStreamVersionId; 169 /** 170 * The date and time that the delivery stream was created. 171 */ 172 CreateTimestamp?: Timestamp; 173 /** 174 * The date and time that the delivery stream was last updated. 175 */ 176 LastUpdateTimestamp?: Timestamp; 177 /** 178 * The destinations. 179 */ 180 Destinations: DestinationDescriptionList; 181 /** 182 * Indicates whether there are more destinations available to list. 183 */ 184 HasMoreDestinations: BooleanObject; 185 } 186 export type DeliveryStreamName = string; 187 export type DeliveryStreamNameList = DeliveryStreamName[]; 188 export type DeliveryStreamStatus = "CREATING"|"DELETING"|"ACTIVE"|string; 189 export type DeliveryStreamVersionId = string; 190 export interface DescribeDeliveryStreamInput { 191 /** 192 * The name of the delivery stream. 193 */ 194 DeliveryStreamName: DeliveryStreamName; 195 /** 196 * The limit on the number of destinations to return. Currently, you can have one destination per delivery stream. 197 */ 198 Limit?: DescribeDeliveryStreamInputLimit; 199 /** 200 * Specifies the destination ID to start returning the destination information. Currently Firehose supports one destination per delivery stream. 201 */ 202 ExclusiveStartDestinationId?: DestinationId; 203 } 204 export type DescribeDeliveryStreamInputLimit = number; 205 export interface DescribeDeliveryStreamOutput { 206 /** 207 * Information about the delivery stream. 208 */ 209 DeliveryStreamDescription: DeliveryStreamDescription; 210 } 211 export interface DestinationDescription { 212 /** 213 * The ID of the destination. 214 */ 215 DestinationId: DestinationId; 216 /** 217 * The Amazon S3 destination. 218 */ 219 S3DestinationDescription?: S3DestinationDescription; 220 /** 221 * The destination in Amazon Redshift. 222 */ 223 RedshiftDestinationDescription?: RedshiftDestinationDescription; 224 /** 225 * The destination in Amazon ES. 226 */ 227 ElasticsearchDestinationDescription?: ElasticsearchDestinationDescription; 228 } 229 export type DestinationDescriptionList = DestinationDescription[]; 230 export type DestinationId = string; 231 export interface ElasticsearchBufferingHints { 232 /** 233 * Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes). 234 */ 235 IntervalInSeconds?: ElasticsearchBufferingIntervalInSeconds; 236 /** 237 * Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5. We recommend setting SizeInMBs to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, set SizeInMBs to be 10 MB or higher. 238 */ 239 SizeInMBs?: ElasticsearchBufferingSizeInMBs; 240 } 241 export type ElasticsearchBufferingIntervalInSeconds = number; 242 export type ElasticsearchBufferingSizeInMBs = number; 243 export interface ElasticsearchDestinationConfiguration { 244 /** 245 * The 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 Amazon S3 Bucket Access. 246 */ 247 RoleARN: RoleARN; 248 /** 249 * The ARN of the Amazon ES domain. The IAM role must have permission for DescribeElasticsearchDomain, DescribeElasticsearchDomains , and DescribeElasticsearchDomainConfig after assuming RoleARN. 250 */ 251 DomainARN: ElasticsearchDomainARN; 252 /** 253 * The Elasticsearch index name. 254 */ 255 IndexName: ElasticsearchIndexName; 256 /** 257 * The Elasticsearch type name. 258 */ 259 TypeName: ElasticsearchTypeName; 260 /** 261 * The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate expiration of old data. For more information, see Index Rotation for Amazon Elasticsearch Service Destination. Default value is OneDay. 262 */ 263 IndexRotationPeriod?: ElasticsearchIndexRotationPeriod; 264 /** 265 * Buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used. 266 */ 267 BufferingHints?: ElasticsearchBufferingHints; 268 /** 269 * Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon ES. Default value is 300 (5 minutes). 270 */ 271 RetryOptions?: ElasticsearchRetryOptions; 272 /** 273 * Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with elasticsearch-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with elasticsearch-failed/ appended to the prefix. For more information, see Amazon S3 Backup for Amazon Elasticsearch Service Destination. Default value is FailedDocumentsOnly. 274 */ 275 S3BackupMode?: ElasticsearchS3BackupMode; 276 S3Configuration: S3DestinationConfiguration; 277 /** 278 * Describes CloudWatch logging options for your delivery stream. 279 */ 280 CloudWatchLoggingOptions?: CloudWatchLoggingOptions; 281 } 282 export interface ElasticsearchDestinationDescription { 283 /** 284 * The ARN of the AWS credentials. 285 */ 286 RoleARN?: RoleARN; 287 /** 288 * The ARN of the Amazon ES domain. 289 */ 290 DomainARN?: ElasticsearchDomainARN; 291 /** 292 * The Elasticsearch index name. 293 */ 294 IndexName?: ElasticsearchIndexName; 295 /** 296 * The Elasticsearch type name. 297 */ 298 TypeName?: ElasticsearchTypeName; 299 /** 300 * The Elasticsearch index rotation period 301 */ 302 IndexRotationPeriod?: ElasticsearchIndexRotationPeriod; 303 /** 304 * Buffering options. 305 */ 306 BufferingHints?: ElasticsearchBufferingHints; 307 /** 308 * Elasticsearch retry options. 309 */ 310 RetryOptions?: ElasticsearchRetryOptions; 311 /** 312 * Amazon S3 backup mode. 313 */ 314 S3BackupMode?: ElasticsearchS3BackupMode; 315 S3DestinationDescription?: S3DestinationDescription; 316 /** 317 * CloudWatch logging options. 318 */ 319 CloudWatchLoggingOptions?: CloudWatchLoggingOptions; 320 } 321 export interface ElasticsearchDestinationUpdate { 322 /** 323 * The 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 Amazon S3 Bucket Access. 324 */ 325 RoleARN?: RoleARN; 326 /** 327 * The ARN of the Amazon ES domain. The IAM role must have permission for DescribeElasticsearchDomain, DescribeElasticsearchDomains , and DescribeElasticsearchDomainConfig after assuming RoleARN. 328 */ 329 DomainARN?: ElasticsearchDomainARN; 330 /** 331 * The Elasticsearch index name. 332 */ 333 IndexName?: ElasticsearchIndexName; 334 /** 335 * The Elasticsearch type name. 336 */ 337 TypeName?: ElasticsearchTypeName; 338 /** 339 * The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for Amazon Elasticsearch Service Destination. Default value is OneDay. 340 */ 341 IndexRotationPeriod?: ElasticsearchIndexRotationPeriod; 342 /** 343 * Buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used. 344 */ 345 BufferingHints?: ElasticsearchBufferingHints; 346 /** 347 * Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon ES. Default value is 300 (5 minutes). 348 */ 349 RetryOptions?: ElasticsearchRetryOptions; 350 S3Update?: S3DestinationUpdate; 351 /** 352 * Describes CloudWatch logging options for your delivery stream. 353 */ 354 CloudWatchLoggingOptions?: CloudWatchLoggingOptions; 355 } 356 export type ElasticsearchDomainARN = string; 357 export type ElasticsearchIndexName = string; 358 export type ElasticsearchIndexRotationPeriod = "NoRotation"|"OneHour"|"OneDay"|"OneWeek"|"OneMonth"|string; 359 export type ElasticsearchRetryDurationInSeconds = number; 360 export interface ElasticsearchRetryOptions { 361 /** 362 * After an initial failure to deliver to Amazon ES, the total amount of time during which Firehose re-attempts delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries. 363 */ 364 DurationInSeconds?: ElasticsearchRetryDurationInSeconds; 365 } 366 export type ElasticsearchS3BackupMode = "FailedDocumentsOnly"|"AllDocuments"|string; 367 export type ElasticsearchTypeName = string; 368 export interface EncryptionConfiguration { 369 /** 370 * Specifically override existing encryption information to ensure no encryption is used. 371 */ 372 NoEncryptionConfig?: NoEncryptionConfig; 373 /** 374 * The encryption key. 375 */ 376 KMSEncryptionConfig?: KMSEncryptionConfig; 377 } 378 export type ErrorCode = string; 379 export type ErrorMessage = string; 380 export type IntervalInSeconds = number; 381 export interface KMSEncryptionConfig { 382 /** 383 * The ARN of the encryption key. Must belong to the same region as the destination Amazon S3 bucket. 384 */ 385 AWSKMSKeyARN: AWSKMSKeyARN; 386 } 387 export interface ListDeliveryStreamsInput { 388 /** 389 * The maximum number of delivery streams to list. 390 */ 391 Limit?: ListDeliveryStreamsInputLimit; 392 /** 393 * The name of the delivery stream to start the list with. 394 */ 395 ExclusiveStartDeliveryStreamName?: DeliveryStreamName; 396 } 397 export type ListDeliveryStreamsInputLimit = number; 398 export interface ListDeliveryStreamsOutput { 399 /** 400 * The names of the delivery streams. 401 */ 402 DeliveryStreamNames: DeliveryStreamNameList; 403 /** 404 * Indicates whether there are more delivery streams available to list. 405 */ 406 HasMoreDeliveryStreams: BooleanObject; 407 } 408 export type LogGroupName = string; 409 export type LogStreamName = string; 410 export type NoEncryptionConfig = "NoEncryption"|string; 411 export type NonNegativeIntegerObject = number; 412 export type Password = string; 413 export type Prefix = string; 414 export interface PutRecordBatchInput { 415 /** 416 * The name of the delivery stream. 417 */ 418 DeliveryStreamName: DeliveryStreamName; 419 /** 420 * One or more records. 421 */ 422 Records: PutRecordBatchRequestEntryList; 423 } 424 export interface PutRecordBatchOutput { 425 /** 426 * The number of unsuccessfully written records. 427 */ 428 FailedPutCount: NonNegativeIntegerObject; 429 /** 430 * The results for the individual records. The index of each element matches the same index in which records were sent. 431 */ 432 RequestResponses: PutRecordBatchResponseEntryList; 433 } 434 export type PutRecordBatchRequestEntryList = Record[]; 435 export interface PutRecordBatchResponseEntry { 436 /** 437 * The ID of the record. 438 */ 439 RecordId?: PutResponseRecordId; 440 /** 441 * The error code for an individual record result. 442 */ 443 ErrorCode?: ErrorCode; 444 /** 445 * The error message for an individual record result. 446 */ 447 ErrorMessage?: ErrorMessage; 448 } 449 export type PutRecordBatchResponseEntryList = PutRecordBatchResponseEntry[]; 450 export interface PutRecordInput { 451 /** 452 * The name of the delivery stream. 453 */ 454 DeliveryStreamName: DeliveryStreamName; 455 /** 456 * The record. 457 */ 458 Record: Record; 459 } 460 export interface PutRecordOutput { 461 /** 462 * The ID of the record. 463 */ 464 RecordId: PutResponseRecordId; 465 } 466 export type PutResponseRecordId = string; 467 export interface Record { 468 /** 469 * The data blob, which is base64-encoded when the blob is serialized. The maximum size of the data blob, before base64-encoding, is 1,000 KB. 470 */ 471 Data: Data; 472 } 473 export interface RedshiftDestinationConfiguration { 474 /** 475 * The ARN of the AWS credentials. 476 */ 477 RoleARN: RoleARN; 478 /** 479 * The database connection string. 480 */ 481 ClusterJDBCURL: ClusterJDBCURL; 482 /** 483 * The COPY command. 484 */ 485 CopyCommand: CopyCommand; 486 /** 487 * The name of the user. 488 */ 489 Username: Username; 490 /** 491 * The user password. 492 */ 493 Password: Password; 494 /** 495 * Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes). 496 */ 497 RetryOptions?: RedshiftRetryOptions; 498 /** 499 * The S3 configuration for the intermediate location from which Amazon Redshift obtains data. Restrictions are described in the topic for CreateDeliveryStream. 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. 500 */ 501 S3Configuration: S3DestinationConfiguration; 502 /** 503 * Describes CloudWatch logging options for your delivery stream. 504 */ 505 CloudWatchLoggingOptions?: CloudWatchLoggingOptions; 506 } 507 export interface RedshiftDestinationDescription { 508 /** 509 * The ARN of the AWS credentials. 510 */ 511 RoleARN: RoleARN; 512 /** 513 * The database connection string. 514 */ 515 ClusterJDBCURL: ClusterJDBCURL; 516 /** 517 * The COPY command. 518 */ 519 CopyCommand: CopyCommand; 520 /** 521 * The name of the user. 522 */ 523 Username: Username; 524 /** 525 * Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes). 526 */ 527 RetryOptions?: RedshiftRetryOptions; 528 /** 529 * The Amazon S3 destination. 530 */ 531 S3DestinationDescription: S3DestinationDescription; 532 /** 533 * Describes CloudWatch logging options for your delivery stream. 534 */ 535 CloudWatchLoggingOptions?: CloudWatchLoggingOptions; 536 } 537 export interface RedshiftDestinationUpdate { 538 /** 539 * The ARN of the AWS credentials. 540 */ 541 RoleARN?: RoleARN; 542 /** 543 * The database connection string. 544 */ 545 ClusterJDBCURL?: ClusterJDBCURL; 546 /** 547 * The COPY command. 548 */ 549 CopyCommand?: CopyCommand; 550 /** 551 * The name of the user. 552 */ 553 Username?: Username; 554 /** 555 * The user password. 556 */ 557 Password?: Password; 558 /** 559 * Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes). 560 */ 561 RetryOptions?: RedshiftRetryOptions; 562 /** 563 * The Amazon S3 destination. The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationUpdate.S3Update because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats. 564 */ 565 S3Update?: S3DestinationUpdate; 566 /** 567 * Describes CloudWatch logging options for your delivery stream. 568 */ 569 CloudWatchLoggingOptions?: CloudWatchLoggingOptions; 570 } 571 export type RedshiftRetryDurationInSeconds = number; 572 export interface RedshiftRetryOptions { 573 /** 574 * 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. 575 */ 576 DurationInSeconds?: RedshiftRetryDurationInSeconds; 577 } 578 export type RoleARN = string; 579 export interface S3DestinationConfiguration { 580 /** 581 * The ARN of the AWS credentials. 582 */ 583 RoleARN: RoleARN; 584 /** 585 * The ARN of the S3 bucket. 586 */ 587 BucketARN: BucketARN; 588 /** 589 * The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Firehose Developer Guide. 590 */ 591 Prefix?: Prefix; 592 /** 593 * The buffering option. If no value is specified, BufferingHints object default values are used. 594 */ 595 BufferingHints?: BufferingHints; 596 /** 597 * The compression format. If no value is specified, the default is UNCOMPRESSED. The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket. 598 */ 599 CompressionFormat?: CompressionFormat; 600 /** 601 * The encryption configuration. If no value is specified, the default is no encryption. 602 */ 603 EncryptionConfiguration?: EncryptionConfiguration; 604 /** 605 * Describes CloudWatch logging options for your delivery stream. 606 */ 607 CloudWatchLoggingOptions?: CloudWatchLoggingOptions; 608 } 609 export interface S3DestinationDescription { 610 /** 611 * The ARN of the AWS credentials. 612 */ 613 RoleARN: RoleARN; 614 /** 615 * The ARN of the S3 bucket. 616 */ 617 BucketARN: BucketARN; 618 /** 619 * The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Firehose Developer Guide. 620 */ 621 Prefix?: Prefix; 622 /** 623 * The buffering option. If no value is specified, BufferingHints object default values are used. 624 */ 625 BufferingHints: BufferingHints; 626 /** 627 * The compression format. If no value is specified, the default is NOCOMPRESSION. 628 */ 629 CompressionFormat: CompressionFormat; 630 /** 631 * The encryption configuration. If no value is specified, the default is no encryption. 632 */ 633 EncryptionConfiguration: EncryptionConfiguration; 634 /** 635 * Describes CloudWatch logging options for your delivery stream. 636 */ 637 CloudWatchLoggingOptions?: CloudWatchLoggingOptions; 638 } 639 export interface S3DestinationUpdate { 640 /** 641 * The ARN of the AWS credentials. 642 */ 643 RoleARN?: RoleARN; 644 /** 645 * The ARN of the S3 bucket. 646 */ 647 BucketARN?: BucketARN; 648 /** 649 * The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Firehose Developer Guide. 650 */ 651 Prefix?: Prefix; 652 /** 653 * The buffering option. If no value is specified, BufferingHints object default values are used. 654 */ 655 BufferingHints?: BufferingHints; 656 /** 657 * The compression format. If no value is specified, the default is NOCOMPRESSION. The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket. 658 */ 659 CompressionFormat?: CompressionFormat; 660 /** 661 * The encryption configuration. If no value is specified, the default is no encryption. 662 */ 663 EncryptionConfiguration?: EncryptionConfiguration; 664 /** 665 * Describes CloudWatch logging options for your delivery stream. 666 */ 667 CloudWatchLoggingOptions?: CloudWatchLoggingOptions; 668 } 669 export type SizeInMBs = number; 670 export type Timestamp = Date; 671 export interface UpdateDestinationInput { 672 /** 673 * The name of the delivery stream. 674 */ 675 DeliveryStreamName: DeliveryStreamName; 676 /** 677 * Obtain this value from the VersionId result of the DeliveryStreamDescription operation. This value is required, and helps the service to perform conditional operations. For example, if there is a interleaving update and this value is null, then the update destination fails. After the update is successful, the VersionId value is updated. The service then performs a merge of the old configuration with the new configuration. 678 */ 679 CurrentDeliveryStreamVersionId: DeliveryStreamVersionId; 680 /** 681 * The ID of the destination. 682 */ 683 DestinationId: DestinationId; 684 /** 685 * Describes an update for a destination in Amazon S3. 686 */ 687 S3DestinationUpdate?: S3DestinationUpdate; 688 /** 689 * Describes an update for a destination in Amazon Redshift. 690 */ 691 RedshiftDestinationUpdate?: RedshiftDestinationUpdate; 692 /** 693 * Describes an update for a destination in Amazon ES. 694 */ 695 ElasticsearchDestinationUpdate?: ElasticsearchDestinationUpdate; 696 } 697 export interface UpdateDestinationOutput { 698 } 699 export type Username = string; 700 /** 701 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 702 */ 703 export type apiVersion = "2015-08-04"|"latest"|string; 704 export interface ClientApiVersions { 705 /** 706 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 707 */ 708 apiVersion?: apiVersion; 709 } 710 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 711 } 712 export = Firehose;