@aws-sdk/client-firehose 3.321.1 → 3.326.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -499,6 +499,10 @@ export interface CreateDeliveryStreamCommandOutput extends CreateDeliveryStreamO
499
499
  * };
500
500
  * const command = new CreateDeliveryStreamCommand(input);
501
501
  * const response = await client.send(command);
502
+ * // { // CreateDeliveryStreamOutput
503
+ * // DeliveryStreamARN: "STRING_VALUE",
504
+ * // };
505
+ *
502
506
  * ```
503
507
  *
504
508
  * @param CreateDeliveryStreamCommandInput - {@link CreateDeliveryStreamCommandInput}
@@ -523,6 +527,8 @@ export interface CreateDeliveryStreamCommandOutput extends CreateDeliveryStreamO
523
527
  * @throws {@link ResourceInUseException} (client fault)
524
528
  * <p>The resource is already in use and not available for this operation.</p>
525
529
  *
530
+ * @throws {@link FirehoseServiceException}
531
+ * <p>Base exception class for all service exceptions from Firehose service.</p>
526
532
  *
527
533
  */
528
534
  export declare class CreateDeliveryStreamCommand extends $Command<CreateDeliveryStreamCommandInput, CreateDeliveryStreamCommandOutput, FirehoseClientResolvedConfig> {
@@ -41,6 +41,8 @@ export interface DeleteDeliveryStreamCommandOutput extends DeleteDeliveryStreamO
41
41
  * };
42
42
  * const command = new DeleteDeliveryStreamCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // {};
45
+ *
44
46
  * ```
45
47
  *
46
48
  * @param DeleteDeliveryStreamCommandInput - {@link DeleteDeliveryStreamCommandInput}
@@ -55,6 +57,8 @@ export interface DeleteDeliveryStreamCommandOutput extends DeleteDeliveryStreamO
55
57
  * @throws {@link ResourceNotFoundException} (client fault)
56
58
  * <p>The specified resource could not be found.</p>
57
59
  *
60
+ * @throws {@link FirehoseServiceException}
61
+ * <p>Base exception class for all service exceptions from Firehose service.</p>
58
62
  *
59
63
  */
60
64
  export declare class DeleteDeliveryStreamCommand extends $Command<DeleteDeliveryStreamCommandInput, DeleteDeliveryStreamCommandOutput, FirehoseClientResolvedConfig> {
@@ -39,6 +39,429 @@ export interface DescribeDeliveryStreamCommandOutput extends DescribeDeliveryStr
39
39
  * };
40
40
  * const command = new DescribeDeliveryStreamCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // DescribeDeliveryStreamOutput
43
+ * // DeliveryStreamDescription: { // DeliveryStreamDescription
44
+ * // DeliveryStreamName: "STRING_VALUE", // required
45
+ * // DeliveryStreamARN: "STRING_VALUE", // required
46
+ * // DeliveryStreamStatus: "CREATING" || "CREATING_FAILED" || "DELETING" || "DELETING_FAILED" || "ACTIVE", // required
47
+ * // FailureDescription: { // FailureDescription
48
+ * // Type: "RETIRE_KMS_GRANT_FAILED" || "CREATE_KMS_GRANT_FAILED" || "KMS_ACCESS_DENIED" || "DISABLED_KMS_KEY" || "INVALID_KMS_KEY" || "KMS_KEY_NOT_FOUND" || "KMS_OPT_IN_REQUIRED" || "CREATE_ENI_FAILED" || "DELETE_ENI_FAILED" || "SUBNET_NOT_FOUND" || "SECURITY_GROUP_NOT_FOUND" || "ENI_ACCESS_DENIED" || "SUBNET_ACCESS_DENIED" || "SECURITY_GROUP_ACCESS_DENIED" || "UNKNOWN_ERROR", // required
49
+ * // Details: "STRING_VALUE", // required
50
+ * // },
51
+ * // DeliveryStreamEncryptionConfiguration: { // DeliveryStreamEncryptionConfiguration
52
+ * // KeyARN: "STRING_VALUE",
53
+ * // KeyType: "AWS_OWNED_CMK" || "CUSTOMER_MANAGED_CMK",
54
+ * // Status: "ENABLED" || "ENABLING" || "ENABLING_FAILED" || "DISABLED" || "DISABLING" || "DISABLING_FAILED",
55
+ * // FailureDescription: {
56
+ * // Type: "RETIRE_KMS_GRANT_FAILED" || "CREATE_KMS_GRANT_FAILED" || "KMS_ACCESS_DENIED" || "DISABLED_KMS_KEY" || "INVALID_KMS_KEY" || "KMS_KEY_NOT_FOUND" || "KMS_OPT_IN_REQUIRED" || "CREATE_ENI_FAILED" || "DELETE_ENI_FAILED" || "SUBNET_NOT_FOUND" || "SECURITY_GROUP_NOT_FOUND" || "ENI_ACCESS_DENIED" || "SUBNET_ACCESS_DENIED" || "SECURITY_GROUP_ACCESS_DENIED" || "UNKNOWN_ERROR", // required
57
+ * // Details: "STRING_VALUE", // required
58
+ * // },
59
+ * // },
60
+ * // DeliveryStreamType: "DirectPut" || "KinesisStreamAsSource", // required
61
+ * // VersionId: "STRING_VALUE", // required
62
+ * // CreateTimestamp: new Date("TIMESTAMP"),
63
+ * // LastUpdateTimestamp: new Date("TIMESTAMP"),
64
+ * // Source: { // SourceDescription
65
+ * // KinesisStreamSourceDescription: { // KinesisStreamSourceDescription
66
+ * // KinesisStreamARN: "STRING_VALUE",
67
+ * // RoleARN: "STRING_VALUE",
68
+ * // DeliveryStartTimestamp: new Date("TIMESTAMP"),
69
+ * // },
70
+ * // },
71
+ * // Destinations: [ // DestinationDescriptionList // required
72
+ * // { // DestinationDescription
73
+ * // DestinationId: "STRING_VALUE", // required
74
+ * // S3DestinationDescription: { // S3DestinationDescription
75
+ * // RoleARN: "STRING_VALUE", // required
76
+ * // BucketARN: "STRING_VALUE", // required
77
+ * // Prefix: "STRING_VALUE",
78
+ * // ErrorOutputPrefix: "STRING_VALUE",
79
+ * // BufferingHints: { // BufferingHints
80
+ * // SizeInMBs: Number("int"),
81
+ * // IntervalInSeconds: Number("int"),
82
+ * // },
83
+ * // CompressionFormat: "UNCOMPRESSED" || "GZIP" || "ZIP" || "Snappy" || "HADOOP_SNAPPY", // required
84
+ * // EncryptionConfiguration: { // EncryptionConfiguration
85
+ * // NoEncryptionConfig: "NoEncryption",
86
+ * // KMSEncryptionConfig: { // KMSEncryptionConfig
87
+ * // AWSKMSKeyARN: "STRING_VALUE", // required
88
+ * // },
89
+ * // },
90
+ * // CloudWatchLoggingOptions: { // CloudWatchLoggingOptions
91
+ * // Enabled: true || false,
92
+ * // LogGroupName: "STRING_VALUE",
93
+ * // LogStreamName: "STRING_VALUE",
94
+ * // },
95
+ * // },
96
+ * // ExtendedS3DestinationDescription: { // ExtendedS3DestinationDescription
97
+ * // RoleARN: "STRING_VALUE", // required
98
+ * // BucketARN: "STRING_VALUE", // required
99
+ * // Prefix: "STRING_VALUE",
100
+ * // ErrorOutputPrefix: "STRING_VALUE",
101
+ * // BufferingHints: {
102
+ * // SizeInMBs: Number("int"),
103
+ * // IntervalInSeconds: Number("int"),
104
+ * // },
105
+ * // CompressionFormat: "UNCOMPRESSED" || "GZIP" || "ZIP" || "Snappy" || "HADOOP_SNAPPY", // required
106
+ * // EncryptionConfiguration: {
107
+ * // NoEncryptionConfig: "NoEncryption",
108
+ * // KMSEncryptionConfig: {
109
+ * // AWSKMSKeyARN: "STRING_VALUE", // required
110
+ * // },
111
+ * // },
112
+ * // CloudWatchLoggingOptions: {
113
+ * // Enabled: true || false,
114
+ * // LogGroupName: "STRING_VALUE",
115
+ * // LogStreamName: "STRING_VALUE",
116
+ * // },
117
+ * // ProcessingConfiguration: { // ProcessingConfiguration
118
+ * // Enabled: true || false,
119
+ * // Processors: [ // ProcessorList
120
+ * // { // Processor
121
+ * // Type: "RecordDeAggregation" || "Lambda" || "MetadataExtraction" || "AppendDelimiterToRecord", // required
122
+ * // Parameters: [ // ProcessorParameterList
123
+ * // { // ProcessorParameter
124
+ * // ParameterName: "LambdaArn" || "NumberOfRetries" || "MetadataExtractionQuery" || "JsonParsingEngine" || "RoleArn" || "BufferSizeInMBs" || "BufferIntervalInSeconds" || "SubRecordType" || "Delimiter", // required
125
+ * // ParameterValue: "STRING_VALUE", // required
126
+ * // },
127
+ * // ],
128
+ * // },
129
+ * // ],
130
+ * // },
131
+ * // S3BackupMode: "Disabled" || "Enabled",
132
+ * // S3BackupDescription: {
133
+ * // RoleARN: "STRING_VALUE", // required
134
+ * // BucketARN: "STRING_VALUE", // required
135
+ * // Prefix: "STRING_VALUE",
136
+ * // ErrorOutputPrefix: "STRING_VALUE",
137
+ * // BufferingHints: {
138
+ * // SizeInMBs: Number("int"),
139
+ * // IntervalInSeconds: Number("int"),
140
+ * // },
141
+ * // CompressionFormat: "UNCOMPRESSED" || "GZIP" || "ZIP" || "Snappy" || "HADOOP_SNAPPY", // required
142
+ * // EncryptionConfiguration: {
143
+ * // NoEncryptionConfig: "NoEncryption",
144
+ * // KMSEncryptionConfig: {
145
+ * // AWSKMSKeyARN: "STRING_VALUE", // required
146
+ * // },
147
+ * // },
148
+ * // CloudWatchLoggingOptions: {
149
+ * // Enabled: true || false,
150
+ * // LogGroupName: "STRING_VALUE",
151
+ * // LogStreamName: "STRING_VALUE",
152
+ * // },
153
+ * // },
154
+ * // DataFormatConversionConfiguration: { // DataFormatConversionConfiguration
155
+ * // SchemaConfiguration: { // SchemaConfiguration
156
+ * // RoleARN: "STRING_VALUE",
157
+ * // CatalogId: "STRING_VALUE",
158
+ * // DatabaseName: "STRING_VALUE",
159
+ * // TableName: "STRING_VALUE",
160
+ * // Region: "STRING_VALUE",
161
+ * // VersionId: "STRING_VALUE",
162
+ * // },
163
+ * // InputFormatConfiguration: { // InputFormatConfiguration
164
+ * // Deserializer: { // Deserializer
165
+ * // OpenXJsonSerDe: { // OpenXJsonSerDe
166
+ * // ConvertDotsInJsonKeysToUnderscores: true || false,
167
+ * // CaseInsensitive: true || false,
168
+ * // ColumnToJsonKeyMappings: { // ColumnToJsonKeyMappings
169
+ * // "<keys>": "STRING_VALUE",
170
+ * // },
171
+ * // },
172
+ * // HiveJsonSerDe: { // HiveJsonSerDe
173
+ * // TimestampFormats: [ // ListOfNonEmptyStrings
174
+ * // "STRING_VALUE",
175
+ * // ],
176
+ * // },
177
+ * // },
178
+ * // },
179
+ * // OutputFormatConfiguration: { // OutputFormatConfiguration
180
+ * // Serializer: { // Serializer
181
+ * // ParquetSerDe: { // ParquetSerDe
182
+ * // BlockSizeBytes: Number("int"),
183
+ * // PageSizeBytes: Number("int"),
184
+ * // Compression: "UNCOMPRESSED" || "GZIP" || "SNAPPY",
185
+ * // EnableDictionaryCompression: true || false,
186
+ * // MaxPaddingBytes: Number("int"),
187
+ * // WriterVersion: "V1" || "V2",
188
+ * // },
189
+ * // OrcSerDe: { // OrcSerDe
190
+ * // StripeSizeBytes: Number("int"),
191
+ * // BlockSizeBytes: Number("int"),
192
+ * // RowIndexStride: Number("int"),
193
+ * // EnablePadding: true || false,
194
+ * // PaddingTolerance: Number("double"),
195
+ * // Compression: "NONE" || "ZLIB" || "SNAPPY",
196
+ * // BloomFilterColumns: [ // ListOfNonEmptyStringsWithoutWhitespace
197
+ * // "STRING_VALUE",
198
+ * // ],
199
+ * // BloomFilterFalsePositiveProbability: Number("double"),
200
+ * // DictionaryKeyThreshold: Number("double"),
201
+ * // FormatVersion: "V0_11" || "V0_12",
202
+ * // },
203
+ * // },
204
+ * // },
205
+ * // Enabled: true || false,
206
+ * // },
207
+ * // DynamicPartitioningConfiguration: { // DynamicPartitioningConfiguration
208
+ * // RetryOptions: { // RetryOptions
209
+ * // DurationInSeconds: Number("int"),
210
+ * // },
211
+ * // Enabled: true || false,
212
+ * // },
213
+ * // },
214
+ * // RedshiftDestinationDescription: { // RedshiftDestinationDescription
215
+ * // RoleARN: "STRING_VALUE", // required
216
+ * // ClusterJDBCURL: "STRING_VALUE", // required
217
+ * // CopyCommand: { // CopyCommand
218
+ * // DataTableName: "STRING_VALUE", // required
219
+ * // DataTableColumns: "STRING_VALUE",
220
+ * // CopyOptions: "STRING_VALUE",
221
+ * // },
222
+ * // Username: "STRING_VALUE", // required
223
+ * // RetryOptions: { // RedshiftRetryOptions
224
+ * // DurationInSeconds: Number("int"),
225
+ * // },
226
+ * // S3DestinationDescription: {
227
+ * // RoleARN: "STRING_VALUE", // required
228
+ * // BucketARN: "STRING_VALUE", // required
229
+ * // Prefix: "STRING_VALUE",
230
+ * // ErrorOutputPrefix: "STRING_VALUE",
231
+ * // BufferingHints: {
232
+ * // SizeInMBs: Number("int"),
233
+ * // IntervalInSeconds: Number("int"),
234
+ * // },
235
+ * // CompressionFormat: "UNCOMPRESSED" || "GZIP" || "ZIP" || "Snappy" || "HADOOP_SNAPPY", // required
236
+ * // EncryptionConfiguration: {
237
+ * // NoEncryptionConfig: "NoEncryption",
238
+ * // KMSEncryptionConfig: {
239
+ * // AWSKMSKeyARN: "STRING_VALUE", // required
240
+ * // },
241
+ * // },
242
+ * // CloudWatchLoggingOptions: {
243
+ * // Enabled: true || false,
244
+ * // LogGroupName: "STRING_VALUE",
245
+ * // LogStreamName: "STRING_VALUE",
246
+ * // },
247
+ * // },
248
+ * // ProcessingConfiguration: {
249
+ * // Enabled: true || false,
250
+ * // Processors: [
251
+ * // {
252
+ * // Type: "RecordDeAggregation" || "Lambda" || "MetadataExtraction" || "AppendDelimiterToRecord", // required
253
+ * // Parameters: [
254
+ * // {
255
+ * // ParameterName: "LambdaArn" || "NumberOfRetries" || "MetadataExtractionQuery" || "JsonParsingEngine" || "RoleArn" || "BufferSizeInMBs" || "BufferIntervalInSeconds" || "SubRecordType" || "Delimiter", // required
256
+ * // ParameterValue: "STRING_VALUE", // required
257
+ * // },
258
+ * // ],
259
+ * // },
260
+ * // ],
261
+ * // },
262
+ * // S3BackupMode: "Disabled" || "Enabled",
263
+ * // S3BackupDescription: {
264
+ * // RoleARN: "STRING_VALUE", // required
265
+ * // BucketARN: "STRING_VALUE", // required
266
+ * // Prefix: "STRING_VALUE",
267
+ * // ErrorOutputPrefix: "STRING_VALUE",
268
+ * // BufferingHints: {
269
+ * // SizeInMBs: Number("int"),
270
+ * // IntervalInSeconds: Number("int"),
271
+ * // },
272
+ * // CompressionFormat: "UNCOMPRESSED" || "GZIP" || "ZIP" || "Snappy" || "HADOOP_SNAPPY", // required
273
+ * // EncryptionConfiguration: {
274
+ * // NoEncryptionConfig: "NoEncryption",
275
+ * // KMSEncryptionConfig: {
276
+ * // AWSKMSKeyARN: "STRING_VALUE", // required
277
+ * // },
278
+ * // },
279
+ * // CloudWatchLoggingOptions: {
280
+ * // Enabled: true || false,
281
+ * // LogGroupName: "STRING_VALUE",
282
+ * // LogStreamName: "STRING_VALUE",
283
+ * // },
284
+ * // },
285
+ * // CloudWatchLoggingOptions: "<CloudWatchLoggingOptions>",
286
+ * // },
287
+ * // ElasticsearchDestinationDescription: { // ElasticsearchDestinationDescription
288
+ * // RoleARN: "STRING_VALUE",
289
+ * // DomainARN: "STRING_VALUE",
290
+ * // ClusterEndpoint: "STRING_VALUE",
291
+ * // IndexName: "STRING_VALUE",
292
+ * // TypeName: "STRING_VALUE",
293
+ * // IndexRotationPeriod: "NoRotation" || "OneHour" || "OneDay" || "OneWeek" || "OneMonth",
294
+ * // BufferingHints: { // ElasticsearchBufferingHints
295
+ * // IntervalInSeconds: Number("int"),
296
+ * // SizeInMBs: Number("int"),
297
+ * // },
298
+ * // RetryOptions: { // ElasticsearchRetryOptions
299
+ * // DurationInSeconds: Number("int"),
300
+ * // },
301
+ * // S3BackupMode: "FailedDocumentsOnly" || "AllDocuments",
302
+ * // S3DestinationDescription: {
303
+ * // RoleARN: "STRING_VALUE", // required
304
+ * // BucketARN: "STRING_VALUE", // required
305
+ * // Prefix: "STRING_VALUE",
306
+ * // ErrorOutputPrefix: "STRING_VALUE",
307
+ * // BufferingHints: "<BufferingHints>", // required
308
+ * // CompressionFormat: "UNCOMPRESSED" || "GZIP" || "ZIP" || "Snappy" || "HADOOP_SNAPPY", // required
309
+ * // EncryptionConfiguration: "<EncryptionConfiguration>", // required
310
+ * // CloudWatchLoggingOptions: "<CloudWatchLoggingOptions>",
311
+ * // },
312
+ * // ProcessingConfiguration: {
313
+ * // Enabled: true || false,
314
+ * // Processors: [
315
+ * // {
316
+ * // Type: "RecordDeAggregation" || "Lambda" || "MetadataExtraction" || "AppendDelimiterToRecord", // required
317
+ * // Parameters: [
318
+ * // {
319
+ * // ParameterName: "LambdaArn" || "NumberOfRetries" || "MetadataExtractionQuery" || "JsonParsingEngine" || "RoleArn" || "BufferSizeInMBs" || "BufferIntervalInSeconds" || "SubRecordType" || "Delimiter", // required
320
+ * // ParameterValue: "STRING_VALUE", // required
321
+ * // },
322
+ * // ],
323
+ * // },
324
+ * // ],
325
+ * // },
326
+ * // CloudWatchLoggingOptions: "<CloudWatchLoggingOptions>",
327
+ * // VpcConfigurationDescription: { // VpcConfigurationDescription
328
+ * // SubnetIds: [ // SubnetIdList // required
329
+ * // "STRING_VALUE",
330
+ * // ],
331
+ * // RoleARN: "STRING_VALUE", // required
332
+ * // SecurityGroupIds: [ // SecurityGroupIdList // required
333
+ * // "STRING_VALUE",
334
+ * // ],
335
+ * // VpcId: "STRING_VALUE", // required
336
+ * // },
337
+ * // },
338
+ * // AmazonopensearchserviceDestinationDescription: { // AmazonopensearchserviceDestinationDescription
339
+ * // RoleARN: "STRING_VALUE",
340
+ * // DomainARN: "STRING_VALUE",
341
+ * // ClusterEndpoint: "STRING_VALUE",
342
+ * // IndexName: "STRING_VALUE",
343
+ * // TypeName: "STRING_VALUE",
344
+ * // IndexRotationPeriod: "NoRotation" || "OneHour" || "OneDay" || "OneWeek" || "OneMonth",
345
+ * // BufferingHints: { // AmazonopensearchserviceBufferingHints
346
+ * // IntervalInSeconds: Number("int"),
347
+ * // SizeInMBs: Number("int"),
348
+ * // },
349
+ * // RetryOptions: { // AmazonopensearchserviceRetryOptions
350
+ * // DurationInSeconds: Number("int"),
351
+ * // },
352
+ * // S3BackupMode: "FailedDocumentsOnly" || "AllDocuments",
353
+ * // S3DestinationDescription: "<S3DestinationDescription>",
354
+ * // ProcessingConfiguration: {
355
+ * // Enabled: true || false,
356
+ * // Processors: [
357
+ * // {
358
+ * // Type: "RecordDeAggregation" || "Lambda" || "MetadataExtraction" || "AppendDelimiterToRecord", // required
359
+ * // Parameters: [
360
+ * // {
361
+ * // ParameterName: "LambdaArn" || "NumberOfRetries" || "MetadataExtractionQuery" || "JsonParsingEngine" || "RoleArn" || "BufferSizeInMBs" || "BufferIntervalInSeconds" || "SubRecordType" || "Delimiter", // required
362
+ * // ParameterValue: "STRING_VALUE", // required
363
+ * // },
364
+ * // ],
365
+ * // },
366
+ * // ],
367
+ * // },
368
+ * // CloudWatchLoggingOptions: "<CloudWatchLoggingOptions>",
369
+ * // VpcConfigurationDescription: {
370
+ * // SubnetIds: [ // required
371
+ * // "STRING_VALUE",
372
+ * // ],
373
+ * // RoleARN: "STRING_VALUE", // required
374
+ * // SecurityGroupIds: [ // required
375
+ * // "STRING_VALUE",
376
+ * // ],
377
+ * // VpcId: "STRING_VALUE", // required
378
+ * // },
379
+ * // },
380
+ * // SplunkDestinationDescription: { // SplunkDestinationDescription
381
+ * // HECEndpoint: "STRING_VALUE",
382
+ * // HECEndpointType: "Raw" || "Event",
383
+ * // HECToken: "STRING_VALUE",
384
+ * // HECAcknowledgmentTimeoutInSeconds: Number("int"),
385
+ * // RetryOptions: { // SplunkRetryOptions
386
+ * // DurationInSeconds: Number("int"),
387
+ * // },
388
+ * // S3BackupMode: "FailedEventsOnly" || "AllEvents",
389
+ * // S3DestinationDescription: "<S3DestinationDescription>",
390
+ * // ProcessingConfiguration: {
391
+ * // Enabled: true || false,
392
+ * // Processors: [
393
+ * // {
394
+ * // Type: "RecordDeAggregation" || "Lambda" || "MetadataExtraction" || "AppendDelimiterToRecord", // required
395
+ * // Parameters: [
396
+ * // {
397
+ * // ParameterName: "LambdaArn" || "NumberOfRetries" || "MetadataExtractionQuery" || "JsonParsingEngine" || "RoleArn" || "BufferSizeInMBs" || "BufferIntervalInSeconds" || "SubRecordType" || "Delimiter", // required
398
+ * // ParameterValue: "STRING_VALUE", // required
399
+ * // },
400
+ * // ],
401
+ * // },
402
+ * // ],
403
+ * // },
404
+ * // CloudWatchLoggingOptions: "<CloudWatchLoggingOptions>",
405
+ * // },
406
+ * // HttpEndpointDestinationDescription: { // HttpEndpointDestinationDescription
407
+ * // EndpointConfiguration: { // HttpEndpointDescription
408
+ * // Url: "STRING_VALUE",
409
+ * // Name: "STRING_VALUE",
410
+ * // },
411
+ * // BufferingHints: { // HttpEndpointBufferingHints
412
+ * // SizeInMBs: Number("int"),
413
+ * // IntervalInSeconds: Number("int"),
414
+ * // },
415
+ * // CloudWatchLoggingOptions: "<CloudWatchLoggingOptions>",
416
+ * // RequestConfiguration: { // HttpEndpointRequestConfiguration
417
+ * // ContentEncoding: "NONE" || "GZIP",
418
+ * // CommonAttributes: [ // HttpEndpointCommonAttributesList
419
+ * // { // HttpEndpointCommonAttribute
420
+ * // AttributeName: "STRING_VALUE", // required
421
+ * // AttributeValue: "STRING_VALUE", // required
422
+ * // },
423
+ * // ],
424
+ * // },
425
+ * // ProcessingConfiguration: "<ProcessingConfiguration>",
426
+ * // RoleARN: "STRING_VALUE",
427
+ * // RetryOptions: { // HttpEndpointRetryOptions
428
+ * // DurationInSeconds: Number("int"),
429
+ * // },
430
+ * // S3BackupMode: "FailedDataOnly" || "AllData",
431
+ * // S3DestinationDescription: "<S3DestinationDescription>",
432
+ * // },
433
+ * // AmazonOpenSearchServerlessDestinationDescription: { // AmazonOpenSearchServerlessDestinationDescription
434
+ * // RoleARN: "STRING_VALUE",
435
+ * // CollectionEndpoint: "STRING_VALUE",
436
+ * // IndexName: "STRING_VALUE",
437
+ * // BufferingHints: { // AmazonOpenSearchServerlessBufferingHints
438
+ * // IntervalInSeconds: Number("int"),
439
+ * // SizeInMBs: Number("int"),
440
+ * // },
441
+ * // RetryOptions: { // AmazonOpenSearchServerlessRetryOptions
442
+ * // DurationInSeconds: Number("int"),
443
+ * // },
444
+ * // S3BackupMode: "FailedDocumentsOnly" || "AllDocuments",
445
+ * // S3DestinationDescription: "<S3DestinationDescription>",
446
+ * // ProcessingConfiguration: "<ProcessingConfiguration>",
447
+ * // CloudWatchLoggingOptions: "<CloudWatchLoggingOptions>",
448
+ * // VpcConfigurationDescription: {
449
+ * // SubnetIds: [ // required
450
+ * // "STRING_VALUE",
451
+ * // ],
452
+ * // RoleARN: "STRING_VALUE", // required
453
+ * // SecurityGroupIds: [ // required
454
+ * // "STRING_VALUE",
455
+ * // ],
456
+ * // VpcId: "STRING_VALUE", // required
457
+ * // },
458
+ * // },
459
+ * // },
460
+ * // ],
461
+ * // HasMoreDestinations: true || false, // required
462
+ * // },
463
+ * // };
464
+ *
42
465
  * ```
43
466
  *
44
467
  * @param DescribeDeliveryStreamCommandInput - {@link DescribeDeliveryStreamCommandInput}
@@ -50,6 +473,8 @@ export interface DescribeDeliveryStreamCommandOutput extends DescribeDeliveryStr
50
473
  * @throws {@link ResourceNotFoundException} (client fault)
51
474
  * <p>The specified resource could not be found.</p>
52
475
  *
476
+ * @throws {@link FirehoseServiceException}
477
+ * <p>Base exception class for all service exceptions from Firehose service.</p>
53
478
  *
54
479
  */
55
480
  export declare class DescribeDeliveryStreamCommand extends $Command<DescribeDeliveryStreamCommandInput, DescribeDeliveryStreamCommandOutput, FirehoseClientResolvedConfig> {
@@ -40,6 +40,13 @@ export interface ListDeliveryStreamsCommandOutput extends ListDeliveryStreamsOut
40
40
  * };
41
41
  * const command = new ListDeliveryStreamsCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // ListDeliveryStreamsOutput
44
+ * // DeliveryStreamNames: [ // DeliveryStreamNameList // required
45
+ * // "STRING_VALUE",
46
+ * // ],
47
+ * // HasMoreDeliveryStreams: true || false, // required
48
+ * // };
49
+ *
43
50
  * ```
44
51
  *
45
52
  * @param ListDeliveryStreamsCommandInput - {@link ListDeliveryStreamsCommandInput}
@@ -48,6 +55,8 @@ export interface ListDeliveryStreamsCommandOutput extends ListDeliveryStreamsOut
48
55
  * @see {@link ListDeliveryStreamsCommandOutput} for command's `response` shape.
49
56
  * @see {@link FirehoseClientResolvedConfig | config} for FirehoseClient's `config` shape.
50
57
  *
58
+ * @throws {@link FirehoseServiceException}
59
+ * <p>Base exception class for all service exceptions from Firehose service.</p>
51
60
  *
52
61
  */
53
62
  export declare class ListDeliveryStreamsCommand extends $Command<ListDeliveryStreamsCommandInput, ListDeliveryStreamsCommandOutput, FirehoseClientResolvedConfig> {
@@ -34,6 +34,16 @@ export interface ListTagsForDeliveryStreamCommandOutput extends ListTagsForDeliv
34
34
  * };
35
35
  * const command = new ListTagsForDeliveryStreamCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // ListTagsForDeliveryStreamOutput
38
+ * // Tags: [ // ListTagsForDeliveryStreamOutputTagList // required
39
+ * // { // Tag
40
+ * // Key: "STRING_VALUE", // required
41
+ * // Value: "STRING_VALUE",
42
+ * // },
43
+ * // ],
44
+ * // HasMoreTags: true || false, // required
45
+ * // };
46
+ *
37
47
  * ```
38
48
  *
39
49
  * @param ListTagsForDeliveryStreamCommandInput - {@link ListTagsForDeliveryStreamCommandInput}
@@ -51,6 +61,8 @@ export interface ListTagsForDeliveryStreamCommandOutput extends ListTagsForDeliv
51
61
  * @throws {@link ResourceNotFoundException} (client fault)
52
62
  * <p>The specified resource could not be found.</p>
53
63
  *
64
+ * @throws {@link FirehoseServiceException}
65
+ * <p>Base exception class for all service exceptions from Firehose service.</p>
54
66
  *
55
67
  */
56
68
  export declare class ListTagsForDeliveryStreamCommand extends $Command<ListTagsForDeliveryStreamCommandInput, ListTagsForDeliveryStreamCommandOutput, FirehoseClientResolvedConfig> {
@@ -86,6 +86,18 @@ export interface PutRecordBatchCommandOutput extends PutRecordBatchOutput, __Met
86
86
  * };
87
87
  * const command = new PutRecordBatchCommand(input);
88
88
  * const response = await client.send(command);
89
+ * // { // PutRecordBatchOutput
90
+ * // FailedPutCount: Number("int"), // required
91
+ * // Encrypted: true || false,
92
+ * // RequestResponses: [ // PutRecordBatchResponseEntryList // required
93
+ * // { // PutRecordBatchResponseEntry
94
+ * // RecordId: "STRING_VALUE",
95
+ * // ErrorCode: "STRING_VALUE",
96
+ * // ErrorMessage: "STRING_VALUE",
97
+ * // },
98
+ * // ],
99
+ * // };
100
+ *
89
101
  * ```
90
102
  *
91
103
  * @param PutRecordBatchCommandInput - {@link PutRecordBatchCommandInput}
@@ -113,6 +125,8 @@ export interface PutRecordBatchCommandOutput extends PutRecordBatchOutput, __Met
113
125
  * information about limits and how to request an increase, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/limits.html">Amazon Kinesis Data Firehose
114
126
  * Limits</a>.</p>
115
127
  *
128
+ * @throws {@link FirehoseServiceException}
129
+ * <p>Base exception class for all service exceptions from Firehose service.</p>
116
130
  *
117
131
  */
118
132
  export declare class PutRecordBatchCommand extends $Command<PutRecordBatchCommandInput, PutRecordBatchCommandOutput, FirehoseClientResolvedConfig> {
@@ -65,6 +65,11 @@ export interface PutRecordCommandOutput extends PutRecordOutput, __MetadataBeare
65
65
  * };
66
66
  * const command = new PutRecordCommand(input);
67
67
  * const response = await client.send(command);
68
+ * // { // PutRecordOutput
69
+ * // RecordId: "STRING_VALUE", // required
70
+ * // Encrypted: true || false,
71
+ * // };
72
+ *
68
73
  * ```
69
74
  *
70
75
  * @param PutRecordCommandInput - {@link PutRecordCommandInput}
@@ -92,6 +97,8 @@ export interface PutRecordCommandOutput extends PutRecordOutput, __MetadataBeare
92
97
  * information about limits and how to request an increase, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/limits.html">Amazon Kinesis Data Firehose
93
98
  * Limits</a>.</p>
94
99
  *
100
+ * @throws {@link FirehoseServiceException}
101
+ * <p>Base exception class for all service exceptions from Firehose service.</p>
95
102
  *
96
103
  */
97
104
  export declare class PutRecordCommand extends $Command<PutRecordCommandInput, PutRecordCommandOutput, FirehoseClientResolvedConfig> {
@@ -70,6 +70,8 @@ export interface StartDeliveryStreamEncryptionCommandOutput extends StartDeliver
70
70
  * };
71
71
  * const command = new StartDeliveryStreamEncryptionCommand(input);
72
72
  * const response = await client.send(command);
73
+ * // {};
74
+ *
73
75
  * ```
74
76
  *
75
77
  * @param StartDeliveryStreamEncryptionCommandInput - {@link StartDeliveryStreamEncryptionCommandInput}
@@ -97,6 +99,8 @@ export interface StartDeliveryStreamEncryptionCommandOutput extends StartDeliver
97
99
  * @throws {@link ResourceNotFoundException} (client fault)
98
100
  * <p>The specified resource could not be found.</p>
99
101
  *
102
+ * @throws {@link FirehoseServiceException}
103
+ * <p>Base exception class for all service exceptions from Firehose service.</p>
100
104
  *
101
105
  */
102
106
  export declare class StartDeliveryStreamEncryptionCommand extends $Command<StartDeliveryStreamEncryptionCommandInput, StartDeliveryStreamEncryptionCommandOutput, FirehoseClientResolvedConfig> {
@@ -50,6 +50,8 @@ export interface StopDeliveryStreamEncryptionCommandOutput extends StopDeliveryS
50
50
  * };
51
51
  * const command = new StopDeliveryStreamEncryptionCommand(input);
52
52
  * const response = await client.send(command);
53
+ * // {};
54
+ *
53
55
  * ```
54
56
  *
55
57
  * @param StopDeliveryStreamEncryptionCommandInput - {@link StopDeliveryStreamEncryptionCommandInput}
@@ -70,6 +72,8 @@ export interface StopDeliveryStreamEncryptionCommandOutput extends StopDeliveryS
70
72
  * @throws {@link ResourceNotFoundException} (client fault)
71
73
  * <p>The specified resource could not be found.</p>
72
74
  *
75
+ * @throws {@link FirehoseServiceException}
76
+ * <p>Base exception class for all service exceptions from Firehose service.</p>
73
77
  *
74
78
  */
75
79
  export declare class StopDeliveryStreamEncryptionCommand extends $Command<StopDeliveryStreamEncryptionCommandInput, StopDeliveryStreamEncryptionCommandOutput, FirehoseClientResolvedConfig> {
@@ -46,6 +46,8 @@ export interface TagDeliveryStreamCommandOutput extends TagDeliveryStreamOutput,
46
46
  * };
47
47
  * const command = new TagDeliveryStreamCommand(input);
48
48
  * const response = await client.send(command);
49
+ * // {};
50
+ *
49
51
  * ```
50
52
  *
51
53
  * @param TagDeliveryStreamCommandInput - {@link TagDeliveryStreamCommandInput}
@@ -66,6 +68,8 @@ export interface TagDeliveryStreamCommandOutput extends TagDeliveryStreamOutput,
66
68
  * @throws {@link ResourceNotFoundException} (client fault)
67
69
  * <p>The specified resource could not be found.</p>
68
70
  *
71
+ * @throws {@link FirehoseServiceException}
72
+ * <p>Base exception class for all service exceptions from Firehose service.</p>
69
73
  *
70
74
  */
71
75
  export declare class TagDeliveryStreamCommand extends $Command<TagDeliveryStreamCommandInput, TagDeliveryStreamCommandOutput, FirehoseClientResolvedConfig> {
@@ -37,6 +37,8 @@ export interface UntagDeliveryStreamCommandOutput extends UntagDeliveryStreamOut
37
37
  * };
38
38
  * const command = new UntagDeliveryStreamCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // {};
41
+ *
40
42
  * ```
41
43
  *
42
44
  * @param UntagDeliveryStreamCommandInput - {@link UntagDeliveryStreamCommandInput}
@@ -57,6 +59,8 @@ export interface UntagDeliveryStreamCommandOutput extends UntagDeliveryStreamOut
57
59
  * @throws {@link ResourceNotFoundException} (client fault)
58
60
  * <p>The specified resource could not be found.</p>
59
61
  *
62
+ * @throws {@link FirehoseServiceException}
63
+ * <p>Base exception class for all service exceptions from Firehose service.</p>
60
64
  *
61
65
  */
62
66
  export declare class UntagDeliveryStreamCommand extends $Command<UntagDeliveryStreamCommandInput, UntagDeliveryStreamCommandOutput, FirehoseClientResolvedConfig> {
@@ -410,6 +410,8 @@ export interface UpdateDestinationCommandOutput extends UpdateDestinationOutput,
410
410
  * };
411
411
  * const command = new UpdateDestinationCommand(input);
412
412
  * const response = await client.send(command);
413
+ * // {};
414
+ *
413
415
  * ```
414
416
  *
415
417
  * @param UpdateDestinationCommandInput - {@link UpdateDestinationCommandInput}
@@ -431,6 +433,8 @@ export interface UpdateDestinationCommandOutput extends UpdateDestinationOutput,
431
433
  * @throws {@link ResourceNotFoundException} (client fault)
432
434
  * <p>The specified resource could not be found.</p>
433
435
  *
436
+ * @throws {@link FirehoseServiceException}
437
+ * <p>Base exception class for all service exceptions from Firehose service.</p>
434
438
  *
435
439
  */
436
440
  export declare class UpdateDestinationCommand extends $Command<UpdateDestinationCommandInput, UpdateDestinationCommandOutput, FirehoseClientResolvedConfig> {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-firehose",
3
3
  "description": "AWS SDK for JavaScript Firehose Client for Node.js, Browser and React Native",
4
- "version": "3.321.1",
4
+ "version": "3.326.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,33 +21,33 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.321.1",
24
+ "@aws-sdk/client-sts": "3.326.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.321.1",
26
+ "@aws-sdk/credential-provider-node": "3.326.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",
30
- "@aws-sdk/middleware-content-length": "3.310.0",
31
- "@aws-sdk/middleware-endpoint": "3.310.0",
32
- "@aws-sdk/middleware-host-header": "3.310.0",
33
- "@aws-sdk/middleware-logger": "3.310.0",
34
- "@aws-sdk/middleware-recursion-detection": "3.310.0",
35
- "@aws-sdk/middleware-retry": "3.310.0",
36
- "@aws-sdk/middleware-serde": "3.310.0",
37
- "@aws-sdk/middleware-signing": "3.310.0",
38
- "@aws-sdk/middleware-stack": "3.310.0",
39
- "@aws-sdk/middleware-user-agent": "3.319.0",
30
+ "@aws-sdk/middleware-content-length": "3.325.0",
31
+ "@aws-sdk/middleware-endpoint": "3.325.0",
32
+ "@aws-sdk/middleware-host-header": "3.325.0",
33
+ "@aws-sdk/middleware-logger": "3.325.0",
34
+ "@aws-sdk/middleware-recursion-detection": "3.325.0",
35
+ "@aws-sdk/middleware-retry": "3.325.0",
36
+ "@aws-sdk/middleware-serde": "3.325.0",
37
+ "@aws-sdk/middleware-signing": "3.325.0",
38
+ "@aws-sdk/middleware-stack": "3.325.0",
39
+ "@aws-sdk/middleware-user-agent": "3.325.0",
40
40
  "@aws-sdk/node-config-provider": "3.310.0",
41
41
  "@aws-sdk/node-http-handler": "3.321.1",
42
42
  "@aws-sdk/protocol-http": "3.310.0",
43
- "@aws-sdk/smithy-client": "3.316.0",
43
+ "@aws-sdk/smithy-client": "3.325.0",
44
44
  "@aws-sdk/types": "3.310.0",
45
45
  "@aws-sdk/url-parser": "3.310.0",
46
46
  "@aws-sdk/util-base64": "3.310.0",
47
47
  "@aws-sdk/util-body-length-browser": "3.310.0",
48
48
  "@aws-sdk/util-body-length-node": "3.310.0",
49
- "@aws-sdk/util-defaults-mode-browser": "3.316.0",
50
- "@aws-sdk/util-defaults-mode-node": "3.316.0",
49
+ "@aws-sdk/util-defaults-mode-browser": "3.325.0",
50
+ "@aws-sdk/util-defaults-mode-node": "3.325.0",
51
51
  "@aws-sdk/util-endpoints": "3.319.0",
52
52
  "@aws-sdk/util-retry": "3.310.0",
53
53
  "@aws-sdk/util-user-agent-browser": "3.310.0",