aws-sdk-firehose 1.84.0 → 1.86.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-firehose/client.rb +246 -117
- data/lib/aws-sdk-firehose/client_api.rb +119 -2
- data/lib/aws-sdk-firehose/types.rb +516 -190
- data/lib/aws-sdk-firehose.rb +1 -1
- data/sig/client.rbs +64 -4
- data/sig/resource.rbs +2 -0
- data/sig/types.rbs +103 -4
- metadata +4 -4
@@ -257,11 +257,34 @@ module Aws::Firehose
|
|
257
257
|
# Used when loading credentials from the shared credentials file
|
258
258
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
259
259
|
#
|
260
|
+
# @option options [String] :request_checksum_calculation ("when_supported")
|
261
|
+
# Determines when a checksum will be calculated for request payloads. Values are:
|
262
|
+
#
|
263
|
+
# * `when_supported` - (default) When set, a checksum will be
|
264
|
+
# calculated for all request payloads of operations modeled with the
|
265
|
+
# `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a
|
266
|
+
# `requestAlgorithmMember` is modeled.
|
267
|
+
# * `when_required` - When set, a checksum will only be calculated for
|
268
|
+
# request payloads of operations modeled with the `httpChecksum` trait where
|
269
|
+
# `requestChecksumRequired` is `true` or where a `requestAlgorithmMember`
|
270
|
+
# is modeled and supplied.
|
271
|
+
#
|
260
272
|
# @option options [Integer] :request_min_compression_size_bytes (10240)
|
261
273
|
# The minimum size in bytes that triggers compression for request
|
262
274
|
# bodies. The value must be non-negative integer value between 0
|
263
275
|
# and 10485780 bytes inclusive.
|
264
276
|
#
|
277
|
+
# @option options [String] :response_checksum_validation ("when_supported")
|
278
|
+
# Determines when checksum validation will be performed on response payloads. Values are:
|
279
|
+
#
|
280
|
+
# * `when_supported` - (default) When set, checksum validation is performed on all
|
281
|
+
# response payloads of operations modeled with the `httpChecksum` trait where
|
282
|
+
# `responseAlgorithms` is modeled, except when no modeled checksum algorithms
|
283
|
+
# are supported.
|
284
|
+
# * `when_required` - When set, checksum validation is not performed on
|
285
|
+
# response payloads of operations unless the checksum algorithm is supported and
|
286
|
+
# the `requestValidationModeMember` member is set to `ENABLED`.
|
287
|
+
#
|
265
288
|
# @option options [Proc] :retry_backoff
|
266
289
|
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
267
290
|
# This option is only used in the `legacy` retry mode.
|
@@ -454,39 +477,39 @@ module Aws::Firehose
|
|
454
477
|
|
455
478
|
# @!group API Operations
|
456
479
|
|
457
|
-
# Creates a Firehose
|
480
|
+
# Creates a Firehose stream.
|
458
481
|
#
|
459
|
-
# By default, you can create up to 50
|
482
|
+
# By default, you can create up to 50 Firehose streams per Amazon Web
|
460
483
|
# Services Region.
|
461
484
|
#
|
462
485
|
# This is an asynchronous operation that immediately returns. The
|
463
|
-
# initial status of the
|
464
|
-
#
|
465
|
-
# data. If the
|
486
|
+
# initial status of the Firehose stream is `CREATING`. After the
|
487
|
+
# Firehose stream is created, its status is `ACTIVE` and it now accepts
|
488
|
+
# data. If the Firehose stream creation fails, the status transitions to
|
466
489
|
# `CREATING_FAILED`. Attempts to send data to a delivery stream that is
|
467
490
|
# not in the `ACTIVE` state cause an exception. To check the state of a
|
468
|
-
#
|
491
|
+
# Firehose stream, use DescribeDeliveryStream.
|
469
492
|
#
|
470
|
-
# If the status of a
|
493
|
+
# If the status of a Firehose stream is `CREATING_FAILED`, this status
|
471
494
|
# doesn't change, and you can't invoke `CreateDeliveryStream` again on
|
472
495
|
# it. However, you can invoke the DeleteDeliveryStream operation to
|
473
496
|
# delete it.
|
474
497
|
#
|
475
|
-
# A Firehose
|
476
|
-
#
|
477
|
-
#
|
478
|
-
#
|
479
|
-
#
|
480
|
-
#
|
498
|
+
# A Firehose stream can be configured to receive records directly from
|
499
|
+
# providers using PutRecord or PutRecordBatch, or it can be configured
|
500
|
+
# to use an existing Kinesis stream as its source. To specify a Kinesis
|
501
|
+
# data stream as input, set the `DeliveryStreamType` parameter to
|
502
|
+
# `KinesisStreamAsSource`, and provide the Kinesis stream Amazon
|
503
|
+
# Resource Name (ARN) and role ARN in the
|
481
504
|
# `KinesisStreamSourceConfiguration` parameter.
|
482
505
|
#
|
483
|
-
# To create a
|
506
|
+
# To create a Firehose stream with server-side encryption (SSE) enabled,
|
484
507
|
# include DeliveryStreamEncryptionConfigurationInput in your request.
|
485
508
|
# This is optional. You can also invoke StartDeliveryStreamEncryption to
|
486
|
-
# turn on SSE for an existing
|
509
|
+
# turn on SSE for an existing Firehose stream that doesn't have SSE
|
487
510
|
# enabled.
|
488
511
|
#
|
489
|
-
# A
|
512
|
+
# A Firehose stream is configured with a single destination, such as
|
490
513
|
# Amazon Simple Storage Service (Amazon S3), Amazon Redshift, Amazon
|
491
514
|
# OpenSearch Service, Amazon OpenSearch Serverless, Splunk, and any
|
492
515
|
# custom HTTP endpoint or HTTP endpoints owned by or supported by
|
@@ -539,23 +562,23 @@ module Aws::Firehose
|
|
539
562
|
# [1]: https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3
|
540
563
|
#
|
541
564
|
# @option params [required, String] :delivery_stream_name
|
542
|
-
# The name of the
|
565
|
+
# The name of the Firehose stream. This name must be unique per Amazon
|
543
566
|
# Web Services account in the same Amazon Web Services Region. If the
|
544
|
-
#
|
545
|
-
# can have multiple
|
567
|
+
# Firehose streams are in different accounts or different Regions, you
|
568
|
+
# can have multiple Firehose streams with the same name.
|
546
569
|
#
|
547
570
|
# @option params [String] :delivery_stream_type
|
548
|
-
# The
|
571
|
+
# The Firehose stream type. This parameter can be one of the following
|
549
572
|
# values:
|
550
573
|
#
|
551
|
-
# * `DirectPut`: Provider applications access the
|
574
|
+
# * `DirectPut`: Provider applications access the Firehose stream
|
552
575
|
# directly.
|
553
576
|
#
|
554
|
-
# * `KinesisStreamAsSource`: The
|
577
|
+
# * `KinesisStreamAsSource`: The Firehose stream uses a Kinesis data
|
555
578
|
# stream as a source.
|
556
579
|
#
|
557
580
|
# @option params [Types::KinesisStreamSourceConfiguration] :kinesis_stream_source_configuration
|
558
|
-
# When a Kinesis data stream is used as the source for the
|
581
|
+
# When a Kinesis data stream is used as the source for the Firehose
|
559
582
|
# stream, a KinesisStreamSourceConfiguration containing the Kinesis data
|
560
583
|
# stream Amazon Resource Name (ARN) and the role ARN for the source
|
561
584
|
# stream.
|
@@ -590,21 +613,21 @@ module Aws::Firehose
|
|
590
613
|
# endpoint destination. You can specify only one destination.
|
591
614
|
#
|
592
615
|
# @option params [Array<Types::Tag>] :tags
|
593
|
-
# A set of tags to assign to the
|
616
|
+
# A set of tags to assign to the Firehose stream. A tag is a key-value
|
594
617
|
# pair that you can define and assign to Amazon Web Services resources.
|
595
618
|
# Tags are metadata. For example, you can add friendly names and
|
596
619
|
# descriptions or other types of information that can help you
|
597
|
-
# distinguish the
|
620
|
+
# distinguish the Firehose stream. For more information about tags, see
|
598
621
|
# [Using Cost Allocation Tags][1] in the Amazon Web Services Billing and
|
599
622
|
# Cost Management User Guide.
|
600
623
|
#
|
601
|
-
# You can specify up to 50 tags when creating a
|
624
|
+
# You can specify up to 50 tags when creating a Firehose stream.
|
602
625
|
#
|
603
626
|
# If you specify tags in the `CreateDeliveryStream` action, Amazon Data
|
604
627
|
# Firehose performs an additional authorization on the
|
605
628
|
# `firehose:TagDeliveryStream` action to verify if users have
|
606
629
|
# permissions to create tags. If you do not provide this permission,
|
607
|
-
# requests to create new Firehose
|
630
|
+
# requests to create new Firehose Firehose streams with IAM resource
|
608
631
|
# tags will fail with an `AccessDeniedException` such as following.
|
609
632
|
#
|
610
633
|
# **AccessDeniedException**
|
@@ -635,6 +658,7 @@ module Aws::Firehose
|
|
635
658
|
# @option params [Types::IcebergDestinationConfiguration] :iceberg_destination_configuration
|
636
659
|
# Configure Apache Iceberg Tables destination.
|
637
660
|
#
|
661
|
+
# @option params [Types::DatabaseSourceConfiguration] :database_source_configuration
|
638
662
|
# Amazon Data Firehose is in preview release and is subject to change.
|
639
663
|
#
|
640
664
|
# @return [Types::CreateDeliveryStreamOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -645,7 +669,7 @@ module Aws::Firehose
|
|
645
669
|
#
|
646
670
|
# resp = client.create_delivery_stream({
|
647
671
|
# delivery_stream_name: "DeliveryStreamName", # required
|
648
|
-
# delivery_stream_type: "DirectPut", # accepts DirectPut, KinesisStreamAsSource, MSKAsSource
|
672
|
+
# delivery_stream_type: "DirectPut", # accepts DirectPut, KinesisStreamAsSource, MSKAsSource, DatabaseAsSource
|
649
673
|
# kinesis_stream_source_configuration: {
|
650
674
|
# kinesis_stream_arn: "KinesisStreamARN", # required
|
651
675
|
# role_arn: "RoleARN", # required
|
@@ -1287,12 +1311,25 @@ module Aws::Firehose
|
|
1287
1311
|
# iceberg_destination_configuration: {
|
1288
1312
|
# destination_table_configuration_list: [
|
1289
1313
|
# {
|
1290
|
-
# destination_table_name: "
|
1291
|
-
# destination_database_name: "
|
1314
|
+
# destination_table_name: "StringWithLettersDigitsUnderscoresDots", # required
|
1315
|
+
# destination_database_name: "StringWithLettersDigitsUnderscoresDots", # required
|
1292
1316
|
# unique_keys: ["NonEmptyStringWithoutWhitespace"],
|
1317
|
+
# partition_spec: {
|
1318
|
+
# identity: [
|
1319
|
+
# {
|
1320
|
+
# source_name: "NonEmptyStringWithoutWhitespace", # required
|
1321
|
+
# },
|
1322
|
+
# ],
|
1323
|
+
# },
|
1293
1324
|
# s3_error_output_prefix: "ErrorOutputPrefix",
|
1294
1325
|
# },
|
1295
1326
|
# ],
|
1327
|
+
# schema_evolution_configuration: {
|
1328
|
+
# enabled: false, # required
|
1329
|
+
# },
|
1330
|
+
# table_creation_configuration: {
|
1331
|
+
# enabled: false, # required
|
1332
|
+
# },
|
1296
1333
|
# buffering_hints: {
|
1297
1334
|
# size_in_m_bs: 1,
|
1298
1335
|
# interval_in_seconds: 1,
|
@@ -1323,6 +1360,7 @@ module Aws::Firehose
|
|
1323
1360
|
# role_arn: "RoleARN", # required
|
1324
1361
|
# catalog_configuration: { # required
|
1325
1362
|
# catalog_arn: "GlueDataCatalogARN",
|
1363
|
+
# warehouse_location: "WarehouseLocation",
|
1326
1364
|
# },
|
1327
1365
|
# s3_configuration: { # required
|
1328
1366
|
# role_arn: "RoleARN", # required
|
@@ -1347,6 +1385,36 @@ module Aws::Firehose
|
|
1347
1385
|
# },
|
1348
1386
|
# },
|
1349
1387
|
# },
|
1388
|
+
# database_source_configuration: {
|
1389
|
+
# type: "MySQL", # required, accepts MySQL, PostgreSQL
|
1390
|
+
# endpoint: "DatabaseEndpoint", # required
|
1391
|
+
# port: 1, # required
|
1392
|
+
# ssl_mode: "Disabled", # accepts Disabled, Enabled
|
1393
|
+
# databases: { # required
|
1394
|
+
# include: ["DatabaseName"],
|
1395
|
+
# exclude: ["DatabaseName"],
|
1396
|
+
# },
|
1397
|
+
# tables: { # required
|
1398
|
+
# include: ["DatabaseTableName"],
|
1399
|
+
# exclude: ["DatabaseTableName"],
|
1400
|
+
# },
|
1401
|
+
# columns: {
|
1402
|
+
# include: ["DatabaseColumnName"],
|
1403
|
+
# exclude: ["DatabaseColumnName"],
|
1404
|
+
# },
|
1405
|
+
# surrogate_keys: ["NonEmptyStringWithoutWhitespace"],
|
1406
|
+
# snapshot_watermark_table: "DatabaseTableName", # required
|
1407
|
+
# database_source_authentication_configuration: { # required
|
1408
|
+
# secrets_manager_configuration: { # required
|
1409
|
+
# secret_arn: "SecretARN",
|
1410
|
+
# role_arn: "RoleARN",
|
1411
|
+
# enabled: false, # required
|
1412
|
+
# },
|
1413
|
+
# },
|
1414
|
+
# database_source_vpc_configuration: { # required
|
1415
|
+
# vpc_endpoint_service_name: "VpcEndpointServiceName", # required
|
1416
|
+
# },
|
1417
|
+
# },
|
1350
1418
|
# })
|
1351
1419
|
#
|
1352
1420
|
# @example Response structure
|
@@ -1362,33 +1430,33 @@ module Aws::Firehose
|
|
1362
1430
|
req.send_request(options)
|
1363
1431
|
end
|
1364
1432
|
|
1365
|
-
# Deletes a
|
1433
|
+
# Deletes a Firehose stream and its data.
|
1366
1434
|
#
|
1367
|
-
# You can delete a
|
1435
|
+
# You can delete a Firehose stream only if it is in one of the following
|
1368
1436
|
# states: `ACTIVE`, `DELETING`, `CREATING_FAILED`, or `DELETING_FAILED`.
|
1369
|
-
# You can't delete a
|
1370
|
-
# To check the state of a
|
1437
|
+
# You can't delete a Firehose stream that is in the `CREATING` state.
|
1438
|
+
# To check the state of a Firehose stream, use DescribeDeliveryStream.
|
1371
1439
|
#
|
1372
1440
|
# DeleteDeliveryStream is an asynchronous API. When an API request to
|
1373
|
-
# DeleteDeliveryStream succeeds, the
|
1374
|
-
# deletion, and it goes into the `DELETING` state.While the
|
1441
|
+
# DeleteDeliveryStream succeeds, the Firehose stream is marked for
|
1442
|
+
# deletion, and it goes into the `DELETING` state.While the Firehose
|
1375
1443
|
# stream is in the `DELETING` state, the service might continue to
|
1376
1444
|
# accept records, but it doesn't make any guarantees with respect to
|
1377
1445
|
# delivering the data. Therefore, as a best practice, first stop any
|
1378
|
-
# applications that are sending records before you delete a
|
1446
|
+
# applications that are sending records before you delete a Firehose
|
1379
1447
|
# stream.
|
1380
1448
|
#
|
1381
|
-
# Removal of a
|
1449
|
+
# Removal of a Firehose stream that is in the `DELETING` state is a low
|
1382
1450
|
# priority operation for the service. A stream may remain in the
|
1383
1451
|
# `DELETING` state for several minutes. Therefore, as a best practice,
|
1384
1452
|
# applications should not wait for streams in the `DELETING` state to be
|
1385
1453
|
# removed.
|
1386
1454
|
#
|
1387
1455
|
# @option params [required, String] :delivery_stream_name
|
1388
|
-
# The name of the
|
1456
|
+
# The name of the Firehose stream.
|
1389
1457
|
#
|
1390
1458
|
# @option params [Boolean] :allow_force_delete
|
1391
|
-
# Set this to true if you want to delete the
|
1459
|
+
# Set this to true if you want to delete the Firehose stream even if
|
1392
1460
|
# Firehose is unable to retire the grant for the CMK. Firehose might be
|
1393
1461
|
# unable to retire the grant due to a customer error, such as when the
|
1394
1462
|
# CMK or the grant are in an invalid state. If you force deletion, you
|
@@ -1421,12 +1489,12 @@ module Aws::Firehose
|
|
1421
1489
|
req.send_request(options)
|
1422
1490
|
end
|
1423
1491
|
|
1424
|
-
# Describes the specified
|
1425
|
-
# after your
|
1426
|
-
# to see whether the
|
1492
|
+
# Describes the specified Firehose stream and its status. For example,
|
1493
|
+
# after your Firehose stream is created, call `DescribeDeliveryStream`
|
1494
|
+
# to see whether the Firehose stream is `ACTIVE` and therefore ready for
|
1427
1495
|
# data to be sent to it.
|
1428
1496
|
#
|
1429
|
-
# If the status of a
|
1497
|
+
# If the status of a Firehose stream is `CREATING_FAILED`, this status
|
1430
1498
|
# doesn't change, and you can't invoke CreateDeliveryStream again on
|
1431
1499
|
# it. However, you can invoke the DeleteDeliveryStream operation to
|
1432
1500
|
# delete it. If the status is `DELETING_FAILED`, you can force deletion
|
@@ -1434,15 +1502,15 @@ module Aws::Firehose
|
|
1434
1502
|
# DeleteDeliveryStreamInput$AllowForceDelete set to true.
|
1435
1503
|
#
|
1436
1504
|
# @option params [required, String] :delivery_stream_name
|
1437
|
-
# The name of the
|
1505
|
+
# The name of the Firehose stream.
|
1438
1506
|
#
|
1439
1507
|
# @option params [Integer] :limit
|
1440
1508
|
# The limit on the number of destinations to return. You can have one
|
1441
|
-
# destination per
|
1509
|
+
# destination per Firehose stream.
|
1442
1510
|
#
|
1443
1511
|
# @option params [String] :exclusive_start_destination_id
|
1444
1512
|
# The ID of the destination to start returning the destination
|
1445
|
-
# information. Firehose supports one destination per
|
1513
|
+
# information. Firehose supports one destination per Firehose stream.
|
1446
1514
|
#
|
1447
1515
|
# @return [Types::DescribeDeliveryStreamOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1448
1516
|
#
|
@@ -1461,14 +1529,14 @@ module Aws::Firehose
|
|
1461
1529
|
# resp.delivery_stream_description.delivery_stream_name #=> String
|
1462
1530
|
# resp.delivery_stream_description.delivery_stream_arn #=> String
|
1463
1531
|
# resp.delivery_stream_description.delivery_stream_status #=> String, one of "CREATING", "CREATING_FAILED", "DELETING", "DELETING_FAILED", "ACTIVE"
|
1464
|
-
# resp.delivery_stream_description.failure_description.type #=> String, one of "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"
|
1532
|
+
# resp.delivery_stream_description.failure_description.type #=> String, one of "VPC_ENDPOINT_SERVICE_NAME_NOT_FOUND", "VPC_INTERFACE_ENDPOINT_SERVICE_ACCESS_DENIED", "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"
|
1465
1533
|
# resp.delivery_stream_description.failure_description.details #=> String
|
1466
1534
|
# resp.delivery_stream_description.delivery_stream_encryption_configuration.key_arn #=> String
|
1467
1535
|
# resp.delivery_stream_description.delivery_stream_encryption_configuration.key_type #=> String, one of "AWS_OWNED_CMK", "CUSTOMER_MANAGED_CMK"
|
1468
1536
|
# resp.delivery_stream_description.delivery_stream_encryption_configuration.status #=> String, one of "ENABLED", "ENABLING", "ENABLING_FAILED", "DISABLED", "DISABLING", "DISABLING_FAILED"
|
1469
|
-
# resp.delivery_stream_description.delivery_stream_encryption_configuration.failure_description.type #=> String, one of "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"
|
1537
|
+
# resp.delivery_stream_description.delivery_stream_encryption_configuration.failure_description.type #=> String, one of "VPC_ENDPOINT_SERVICE_NAME_NOT_FOUND", "VPC_INTERFACE_ENDPOINT_SERVICE_ACCESS_DENIED", "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"
|
1470
1538
|
# resp.delivery_stream_description.delivery_stream_encryption_configuration.failure_description.details #=> String
|
1471
|
-
# resp.delivery_stream_description.delivery_stream_type #=> String, one of "DirectPut", "KinesisStreamAsSource", "MSKAsSource"
|
1539
|
+
# resp.delivery_stream_description.delivery_stream_type #=> String, one of "DirectPut", "KinesisStreamAsSource", "MSKAsSource", "DatabaseAsSource"
|
1472
1540
|
# resp.delivery_stream_description.version_id #=> String
|
1473
1541
|
# resp.delivery_stream_description.create_timestamp #=> Time
|
1474
1542
|
# resp.delivery_stream_description.last_update_timestamp #=> Time
|
@@ -1481,6 +1549,37 @@ module Aws::Firehose
|
|
1481
1549
|
# resp.delivery_stream_description.source.msk_source_description.authentication_configuration.connectivity #=> String, one of "PUBLIC", "PRIVATE"
|
1482
1550
|
# resp.delivery_stream_description.source.msk_source_description.delivery_start_timestamp #=> Time
|
1483
1551
|
# resp.delivery_stream_description.source.msk_source_description.read_from_timestamp #=> Time
|
1552
|
+
# resp.delivery_stream_description.source.database_source_description.type #=> String, one of "MySQL", "PostgreSQL"
|
1553
|
+
# resp.delivery_stream_description.source.database_source_description.endpoint #=> String
|
1554
|
+
# resp.delivery_stream_description.source.database_source_description.port #=> Integer
|
1555
|
+
# resp.delivery_stream_description.source.database_source_description.ssl_mode #=> String, one of "Disabled", "Enabled"
|
1556
|
+
# resp.delivery_stream_description.source.database_source_description.databases.include #=> Array
|
1557
|
+
# resp.delivery_stream_description.source.database_source_description.databases.include[0] #=> String
|
1558
|
+
# resp.delivery_stream_description.source.database_source_description.databases.exclude #=> Array
|
1559
|
+
# resp.delivery_stream_description.source.database_source_description.databases.exclude[0] #=> String
|
1560
|
+
# resp.delivery_stream_description.source.database_source_description.tables.include #=> Array
|
1561
|
+
# resp.delivery_stream_description.source.database_source_description.tables.include[0] #=> String
|
1562
|
+
# resp.delivery_stream_description.source.database_source_description.tables.exclude #=> Array
|
1563
|
+
# resp.delivery_stream_description.source.database_source_description.tables.exclude[0] #=> String
|
1564
|
+
# resp.delivery_stream_description.source.database_source_description.columns.include #=> Array
|
1565
|
+
# resp.delivery_stream_description.source.database_source_description.columns.include[0] #=> String
|
1566
|
+
# resp.delivery_stream_description.source.database_source_description.columns.exclude #=> Array
|
1567
|
+
# resp.delivery_stream_description.source.database_source_description.columns.exclude[0] #=> String
|
1568
|
+
# resp.delivery_stream_description.source.database_source_description.surrogate_keys #=> Array
|
1569
|
+
# resp.delivery_stream_description.source.database_source_description.surrogate_keys[0] #=> String
|
1570
|
+
# resp.delivery_stream_description.source.database_source_description.snapshot_watermark_table #=> String
|
1571
|
+
# resp.delivery_stream_description.source.database_source_description.snapshot_info #=> Array
|
1572
|
+
# resp.delivery_stream_description.source.database_source_description.snapshot_info[0].id #=> String
|
1573
|
+
# resp.delivery_stream_description.source.database_source_description.snapshot_info[0].table #=> String
|
1574
|
+
# resp.delivery_stream_description.source.database_source_description.snapshot_info[0].request_timestamp #=> Time
|
1575
|
+
# resp.delivery_stream_description.source.database_source_description.snapshot_info[0].requested_by #=> String, one of "USER", "FIREHOSE"
|
1576
|
+
# resp.delivery_stream_description.source.database_source_description.snapshot_info[0].status #=> String, one of "IN_PROGRESS", "COMPLETE", "SUSPENDED"
|
1577
|
+
# resp.delivery_stream_description.source.database_source_description.snapshot_info[0].failure_description.type #=> String, one of "VPC_ENDPOINT_SERVICE_NAME_NOT_FOUND", "VPC_INTERFACE_ENDPOINT_SERVICE_ACCESS_DENIED", "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"
|
1578
|
+
# resp.delivery_stream_description.source.database_source_description.snapshot_info[0].failure_description.details #=> String
|
1579
|
+
# resp.delivery_stream_description.source.database_source_description.database_source_authentication_configuration.secrets_manager_configuration.secret_arn #=> String
|
1580
|
+
# resp.delivery_stream_description.source.database_source_description.database_source_authentication_configuration.secrets_manager_configuration.role_arn #=> String
|
1581
|
+
# resp.delivery_stream_description.source.database_source_description.database_source_authentication_configuration.secrets_manager_configuration.enabled #=> Boolean
|
1582
|
+
# resp.delivery_stream_description.source.database_source_description.database_source_vpc_configuration.vpc_endpoint_service_name #=> String
|
1484
1583
|
# resp.delivery_stream_description.destinations #=> Array
|
1485
1584
|
# resp.delivery_stream_description.destinations[0].destination_id #=> String
|
1486
1585
|
# resp.delivery_stream_description.destinations[0].s3_destination_description.role_arn #=> String
|
@@ -1826,7 +1925,11 @@ module Aws::Firehose
|
|
1826
1925
|
# resp.delivery_stream_description.destinations[0].iceberg_destination_description.destination_table_configuration_list[0].destination_database_name #=> String
|
1827
1926
|
# resp.delivery_stream_description.destinations[0].iceberg_destination_description.destination_table_configuration_list[0].unique_keys #=> Array
|
1828
1927
|
# resp.delivery_stream_description.destinations[0].iceberg_destination_description.destination_table_configuration_list[0].unique_keys[0] #=> String
|
1928
|
+
# resp.delivery_stream_description.destinations[0].iceberg_destination_description.destination_table_configuration_list[0].partition_spec.identity #=> Array
|
1929
|
+
# resp.delivery_stream_description.destinations[0].iceberg_destination_description.destination_table_configuration_list[0].partition_spec.identity[0].source_name #=> String
|
1829
1930
|
# resp.delivery_stream_description.destinations[0].iceberg_destination_description.destination_table_configuration_list[0].s3_error_output_prefix #=> String
|
1931
|
+
# resp.delivery_stream_description.destinations[0].iceberg_destination_description.schema_evolution_configuration.enabled #=> Boolean
|
1932
|
+
# resp.delivery_stream_description.destinations[0].iceberg_destination_description.table_creation_configuration.enabled #=> Boolean
|
1830
1933
|
# resp.delivery_stream_description.destinations[0].iceberg_destination_description.buffering_hints.size_in_m_bs #=> Integer
|
1831
1934
|
# resp.delivery_stream_description.destinations[0].iceberg_destination_description.buffering_hints.interval_in_seconds #=> Integer
|
1832
1935
|
# resp.delivery_stream_description.destinations[0].iceberg_destination_description.cloud_watch_logging_options.enabled #=> Boolean
|
@@ -1842,6 +1945,7 @@ module Aws::Firehose
|
|
1842
1945
|
# resp.delivery_stream_description.destinations[0].iceberg_destination_description.retry_options.duration_in_seconds #=> Integer
|
1843
1946
|
# resp.delivery_stream_description.destinations[0].iceberg_destination_description.role_arn #=> String
|
1844
1947
|
# resp.delivery_stream_description.destinations[0].iceberg_destination_description.catalog_configuration.catalog_arn #=> String
|
1948
|
+
# resp.delivery_stream_description.destinations[0].iceberg_destination_description.catalog_configuration.warehouse_location #=> String
|
1845
1949
|
# resp.delivery_stream_description.destinations[0].iceberg_destination_description.s3_destination_description.role_arn #=> String
|
1846
1950
|
# resp.delivery_stream_description.destinations[0].iceberg_destination_description.s3_destination_description.bucket_arn #=> String
|
1847
1951
|
# resp.delivery_stream_description.destinations[0].iceberg_destination_description.s3_destination_description.prefix #=> String
|
@@ -1865,36 +1969,36 @@ module Aws::Firehose
|
|
1865
1969
|
req.send_request(options)
|
1866
1970
|
end
|
1867
1971
|
|
1868
|
-
# Lists your
|
1972
|
+
# Lists your Firehose streams in alphabetical order of their names.
|
1869
1973
|
#
|
1870
|
-
# The number of
|
1974
|
+
# The number of Firehose streams might be too large to return using a
|
1871
1975
|
# single call to `ListDeliveryStreams`. You can limit the number of
|
1872
|
-
#
|
1976
|
+
# Firehose streams returned, using the `Limit` parameter. To determine
|
1873
1977
|
# whether there are more delivery streams to list, check the value of
|
1874
|
-
# `HasMoreDeliveryStreams` in the output. If there are more
|
1978
|
+
# `HasMoreDeliveryStreams` in the output. If there are more Firehose
|
1875
1979
|
# streams to list, you can request them by calling this operation again
|
1876
1980
|
# and setting the `ExclusiveStartDeliveryStreamName` parameter to the
|
1877
|
-
# name of the last
|
1981
|
+
# name of the last Firehose stream returned in the last call.
|
1878
1982
|
#
|
1879
1983
|
# @option params [Integer] :limit
|
1880
|
-
# The maximum number of
|
1984
|
+
# The maximum number of Firehose streams to list. The default value is
|
1881
1985
|
# 10.
|
1882
1986
|
#
|
1883
1987
|
# @option params [String] :delivery_stream_type
|
1884
|
-
# The
|
1988
|
+
# The Firehose stream type. This can be one of the following values:
|
1885
1989
|
#
|
1886
|
-
# * `DirectPut`: Provider applications access the
|
1990
|
+
# * `DirectPut`: Provider applications access the Firehose stream
|
1887
1991
|
# directly.
|
1888
1992
|
#
|
1889
|
-
# * `KinesisStreamAsSource`: The
|
1993
|
+
# * `KinesisStreamAsSource`: The Firehose stream uses a Kinesis data
|
1890
1994
|
# stream as a source.
|
1891
1995
|
#
|
1892
|
-
# This parameter is optional. If this parameter is omitted,
|
1996
|
+
# This parameter is optional. If this parameter is omitted, Firehose
|
1893
1997
|
# streams of all types are returned.
|
1894
1998
|
#
|
1895
1999
|
# @option params [String] :exclusive_start_delivery_stream_name
|
1896
|
-
# The list of
|
1897
|
-
# `ListDeliveryStreams` will start with the
|
2000
|
+
# The list of Firehose streams returned by this call to
|
2001
|
+
# `ListDeliveryStreams` will start with the Firehose stream whose name
|
1898
2002
|
# comes alphabetically immediately after the name you specify in
|
1899
2003
|
# `ExclusiveStartDeliveryStreamName`.
|
1900
2004
|
#
|
@@ -1907,7 +2011,7 @@ module Aws::Firehose
|
|
1907
2011
|
#
|
1908
2012
|
# resp = client.list_delivery_streams({
|
1909
2013
|
# limit: 1,
|
1910
|
-
# delivery_stream_type: "DirectPut", # accepts DirectPut, KinesisStreamAsSource, MSKAsSource
|
2014
|
+
# delivery_stream_type: "DirectPut", # accepts DirectPut, KinesisStreamAsSource, MSKAsSource, DatabaseAsSource
|
1911
2015
|
# exclusive_start_delivery_stream_name: "DeliveryStreamName",
|
1912
2016
|
# })
|
1913
2017
|
#
|
@@ -1926,11 +2030,11 @@ module Aws::Firehose
|
|
1926
2030
|
req.send_request(options)
|
1927
2031
|
end
|
1928
2032
|
|
1929
|
-
# Lists the tags for the specified
|
2033
|
+
# Lists the tags for the specified Firehose stream. This operation has a
|
1930
2034
|
# limit of five transactions per second per account.
|
1931
2035
|
#
|
1932
2036
|
# @option params [required, String] :delivery_stream_name
|
1933
|
-
# The name of the
|
2037
|
+
# The name of the Firehose stream whose tags you want to list.
|
1934
2038
|
#
|
1935
2039
|
# @option params [String] :exclusive_start_tag_key
|
1936
2040
|
# The key to use as the starting point for the list of tags. If you set
|
@@ -1939,7 +2043,7 @@ module Aws::Firehose
|
|
1939
2043
|
#
|
1940
2044
|
# @option params [Integer] :limit
|
1941
2045
|
# The number of tags to return. If this number is less than the total
|
1942
|
-
# number of tags associated with the
|
2046
|
+
# number of tags associated with the Firehose stream, `HasMoreTags` is
|
1943
2047
|
# set to `true` in the response. To list additional tags, set
|
1944
2048
|
# `ExclusiveStartTagKey` to the last key in the response.
|
1945
2049
|
#
|
@@ -1972,30 +2076,36 @@ module Aws::Firehose
|
|
1972
2076
|
req.send_request(options)
|
1973
2077
|
end
|
1974
2078
|
|
1975
|
-
# Writes a single data record into an
|
1976
|
-
#
|
1977
|
-
#
|
1978
|
-
# producers.
|
2079
|
+
# Writes a single data record into an Firehose stream. To write multiple
|
2080
|
+
# data records into a Firehose stream, use PutRecordBatch. Applications
|
2081
|
+
# using these operations are referred to as producers.
|
1979
2082
|
#
|
1980
|
-
# By default, each
|
2083
|
+
# By default, each Firehose stream can take in up to 2,000 transactions
|
1981
2084
|
# per second, 5,000 records per second, or 5 MB per second. If you use
|
1982
2085
|
# PutRecord and PutRecordBatch, the limits are an aggregate across these
|
1983
|
-
# two operations for each
|
2086
|
+
# two operations for each Firehose stream. For more information about
|
1984
2087
|
# limits and how to request an increase, see [Amazon Firehose
|
1985
2088
|
# Limits][1].
|
1986
2089
|
#
|
1987
2090
|
# Firehose accumulates and publishes a particular metric for a customer
|
1988
2091
|
# account in one minute intervals. It is possible that the bursts of
|
1989
|
-
# incoming bytes/records ingested to a
|
2092
|
+
# incoming bytes/records ingested to a Firehose stream last only for a
|
1990
2093
|
# few seconds. Due to this, the actual spikes in the traffic might not
|
1991
2094
|
# be fully visible in the customer's 1 minute CloudWatch metrics.
|
1992
2095
|
#
|
1993
|
-
# You must specify the name of the
|
2096
|
+
# You must specify the name of the Firehose stream and the data record
|
1994
2097
|
# when using PutRecord. The data record consists of a data blob that can
|
1995
2098
|
# be up to 1,000 KiB in size, and any kind of data. For example, it can
|
1996
2099
|
# be a segment from a log file, geographic location data, website
|
1997
2100
|
# clickstream data, and so on.
|
1998
2101
|
#
|
2102
|
+
# For multi record de-aggregation, you can not put more than 500 records
|
2103
|
+
# even if the data blob length is less than 1000 KiB. If you include
|
2104
|
+
# more than 500 records, the request succeeds but the record
|
2105
|
+
# de-aggregation doesn't work as expected and transformation lambda is
|
2106
|
+
# invoked with the complete base64 encoded data blob instead of
|
2107
|
+
# de-aggregated base64 decoded records.
|
2108
|
+
#
|
1999
2109
|
# Firehose buffers records before delivering them to the destination. To
|
2000
2110
|
# disambiguate the data blobs at the destination, a common solution is
|
2001
2111
|
# to use delimiters in the data, such as a newline (`\n`) or some other
|
@@ -2010,14 +2120,14 @@ module Aws::Firehose
|
|
2010
2120
|
# If the `PutRecord` operation throws a `ServiceUnavailableException`,
|
2011
2121
|
# the API is automatically reinvoked (retried) 3 times. If the exception
|
2012
2122
|
# persists, it is possible that the throughput limits have been exceeded
|
2013
|
-
# for the
|
2123
|
+
# for the Firehose stream.
|
2014
2124
|
#
|
2015
2125
|
# Re-invoking the Put API operations (for example, PutRecord and
|
2016
2126
|
# PutRecordBatch) can result in data duplicates. For larger data assets,
|
2017
2127
|
# allow for a longer time out before retrying Put API operations.
|
2018
2128
|
#
|
2019
2129
|
# Data records sent to Firehose are stored for 24 hours from the time
|
2020
|
-
# they are added to a
|
2130
|
+
# they are added to a Firehose stream as it tries to send the records to
|
2021
2131
|
# the destination. If the destination is unreachable for more than 24
|
2022
2132
|
# hours, the data is no longer available.
|
2023
2133
|
#
|
@@ -2030,7 +2140,7 @@ module Aws::Firehose
|
|
2030
2140
|
# [1]: https://docs.aws.amazon.com/firehose/latest/dev/limits.html
|
2031
2141
|
#
|
2032
2142
|
# @option params [required, String] :delivery_stream_name
|
2033
|
-
# The name of the
|
2143
|
+
# The name of the Firehose stream.
|
2034
2144
|
#
|
2035
2145
|
# @option params [required, Types::Record] :record
|
2036
2146
|
# The record.
|
@@ -2063,15 +2173,15 @@ module Aws::Firehose
|
|
2063
2173
|
req.send_request(options)
|
2064
2174
|
end
|
2065
2175
|
|
2066
|
-
# Writes multiple data records into a
|
2176
|
+
# Writes multiple data records into a Firehose stream in a single call,
|
2067
2177
|
# which can achieve higher throughput per producer than when writing
|
2068
|
-
# single records. To write single data records into a
|
2178
|
+
# single records. To write single data records into a Firehose stream,
|
2069
2179
|
# use PutRecord. Applications using these operations are referred to as
|
2070
2180
|
# producers.
|
2071
2181
|
#
|
2072
2182
|
# Firehose accumulates and publishes a particular metric for a customer
|
2073
2183
|
# account in one minute intervals. It is possible that the bursts of
|
2074
|
-
# incoming bytes/records ingested to a
|
2184
|
+
# incoming bytes/records ingested to a Firehose stream last only for a
|
2075
2185
|
# few seconds. Due to this, the actual spikes in the traffic might not
|
2076
2186
|
# be fully visible in the customer's 1 minute CloudWatch metrics.
|
2077
2187
|
#
|
@@ -2082,12 +2192,19 @@ module Aws::Firehose
|
|
2082
2192
|
# to a limit of 4 MB for the entire request. These limits cannot be
|
2083
2193
|
# changed.
|
2084
2194
|
#
|
2085
|
-
# You must specify the name of the
|
2195
|
+
# You must specify the name of the Firehose stream and the data record
|
2086
2196
|
# when using PutRecord. The data record consists of a data blob that can
|
2087
2197
|
# be up to 1,000 KB in size, and any kind of data. For example, it could
|
2088
2198
|
# be a segment from a log file, geographic location data, website
|
2089
2199
|
# clickstream data, and so on.
|
2090
2200
|
#
|
2201
|
+
# For multi record de-aggregation, you can not put more than 500 records
|
2202
|
+
# even if the data blob length is less than 1000 KiB. If you include
|
2203
|
+
# more than 500 records, the request succeeds but the record
|
2204
|
+
# de-aggregation doesn't work as expected and transformation lambda is
|
2205
|
+
# invoked with the complete base64 encoded data blob instead of
|
2206
|
+
# de-aggregated base64 decoded records.
|
2207
|
+
#
|
2091
2208
|
# Firehose buffers records before delivering them to the destination. To
|
2092
2209
|
# disambiguate the data blobs at the destination, a common solution is
|
2093
2210
|
# to use delimiters in the data, such as a newline (`\n`) or some other
|
@@ -2126,14 +2243,14 @@ module Aws::Firehose
|
|
2126
2243
|
# If PutRecordBatch throws `ServiceUnavailableException`, the API is
|
2127
2244
|
# automatically reinvoked (retried) 3 times. If the exception persists,
|
2128
2245
|
# it is possible that the throughput limits have been exceeded for the
|
2129
|
-
#
|
2246
|
+
# Firehose stream.
|
2130
2247
|
#
|
2131
2248
|
# Re-invoking the Put API operations (for example, PutRecord and
|
2132
2249
|
# PutRecordBatch) can result in data duplicates. For larger data assets,
|
2133
2250
|
# allow for a longer time out before retrying Put API operations.
|
2134
2251
|
#
|
2135
2252
|
# Data records sent to Firehose are stored for 24 hours from the time
|
2136
|
-
# they are added to a
|
2253
|
+
# they are added to a Firehose stream as it attempts to send the records
|
2137
2254
|
# to the destination. If the destination is unreachable for more than 24
|
2138
2255
|
# hours, the data is no longer available.
|
2139
2256
|
#
|
@@ -2146,7 +2263,7 @@ module Aws::Firehose
|
|
2146
2263
|
# [1]: https://docs.aws.amazon.com/firehose/latest/dev/limits.html
|
2147
2264
|
#
|
2148
2265
|
# @option params [required, String] :delivery_stream_name
|
2149
|
-
# The name of the
|
2266
|
+
# The name of the Firehose stream.
|
2150
2267
|
#
|
2151
2268
|
# @option params [required, Array<Types::Record>] :records
|
2152
2269
|
# One or more records.
|
@@ -2186,26 +2303,26 @@ module Aws::Firehose
|
|
2186
2303
|
req.send_request(options)
|
2187
2304
|
end
|
2188
2305
|
|
2189
|
-
# Enables server-side encryption (SSE) for the
|
2306
|
+
# Enables server-side encryption (SSE) for the Firehose stream.
|
2190
2307
|
#
|
2191
2308
|
# This operation is asynchronous. It returns immediately. When you
|
2192
2309
|
# invoke it, Firehose first sets the encryption status of the stream to
|
2193
|
-
# `ENABLING`, and then to `ENABLED`. The encryption status of a
|
2310
|
+
# `ENABLING`, and then to `ENABLED`. The encryption status of a Firehose
|
2194
2311
|
# stream is the `Status` property in
|
2195
2312
|
# DeliveryStreamEncryptionConfiguration. If the operation fails, the
|
2196
2313
|
# encryption status changes to `ENABLING_FAILED`. You can continue to
|
2197
|
-
# read and write data to your
|
2314
|
+
# read and write data to your Firehose stream while the encryption
|
2198
2315
|
# status is `ENABLING`, but the data is not encrypted. It can take up to
|
2199
2316
|
# 5 seconds after the encryption status changes to `ENABLED` before all
|
2200
|
-
# records written to the
|
2317
|
+
# records written to the Firehose stream are encrypted. To find out
|
2201
2318
|
# whether a record or a batch of records was encrypted, check the
|
2202
2319
|
# response elements PutRecordOutput$Encrypted and
|
2203
2320
|
# PutRecordBatchOutput$Encrypted, respectively.
|
2204
2321
|
#
|
2205
|
-
# To check the encryption status of a
|
2322
|
+
# To check the encryption status of a Firehose stream, use
|
2206
2323
|
# DescribeDeliveryStream.
|
2207
2324
|
#
|
2208
|
-
# Even if encryption is currently enabled for a
|
2325
|
+
# Even if encryption is currently enabled for a Firehose stream, you can
|
2209
2326
|
# still invoke this operation on it to change the ARN of the CMK or both
|
2210
2327
|
# its type and ARN. If you invoke this method to change the CMK, and the
|
2211
2328
|
# old CMK is of type `CUSTOMER_MANAGED_CMK`, Firehose schedules the
|
@@ -2218,29 +2335,29 @@ module Aws::Firehose
|
|
2218
2335
|
# should not be called with session credentials that are more than 6
|
2219
2336
|
# hours old.
|
2220
2337
|
#
|
2221
|
-
# If a
|
2338
|
+
# If a Firehose stream already has encryption enabled and then you
|
2222
2339
|
# invoke this operation to change the ARN of the CMK or both its type
|
2223
2340
|
# and ARN and you get `ENABLING_FAILED`, this only means that the
|
2224
2341
|
# attempt to change the CMK failed. In this case, encryption remains
|
2225
2342
|
# enabled with the old CMK.
|
2226
2343
|
#
|
2227
|
-
# If the encryption status of your
|
2344
|
+
# If the encryption status of your Firehose stream is `ENABLING_FAILED`,
|
2228
2345
|
# you can invoke this operation again with a valid CMK. The CMK must be
|
2229
2346
|
# enabled and the key policy mustn't explicitly deny the permission for
|
2230
2347
|
# Firehose to invoke KMS encrypt and decrypt operations.
|
2231
2348
|
#
|
2232
|
-
# You can enable SSE for a
|
2349
|
+
# You can enable SSE for a Firehose stream only if it's a Firehose
|
2233
2350
|
# stream that uses `DirectPut` as its source.
|
2234
2351
|
#
|
2235
2352
|
# The `StartDeliveryStreamEncryption` and `StopDeliveryStreamEncryption`
|
2236
|
-
# operations have a combined limit of 25 calls per
|
2353
|
+
# operations have a combined limit of 25 calls per Firehose stream per
|
2237
2354
|
# 24 hours. For example, you reach the limit if you call
|
2238
2355
|
# `StartDeliveryStreamEncryption` 13 times and
|
2239
|
-
# `StopDeliveryStreamEncryption` 12 times for the same
|
2356
|
+
# `StopDeliveryStreamEncryption` 12 times for the same Firehose stream
|
2240
2357
|
# in a 24-hour period.
|
2241
2358
|
#
|
2242
2359
|
# @option params [required, String] :delivery_stream_name
|
2243
|
-
# The name of the
|
2360
|
+
# The name of the Firehose stream for which you want to enable
|
2244
2361
|
# server-side encryption (SSE).
|
2245
2362
|
#
|
2246
2363
|
# @option params [Types::DeliveryStreamEncryptionConfigurationInput] :delivery_stream_encryption_configuration_input
|
@@ -2268,20 +2385,20 @@ module Aws::Firehose
|
|
2268
2385
|
req.send_request(options)
|
2269
2386
|
end
|
2270
2387
|
|
2271
|
-
# Disables server-side encryption (SSE) for the
|
2388
|
+
# Disables server-side encryption (SSE) for the Firehose stream.
|
2272
2389
|
#
|
2273
2390
|
# This operation is asynchronous. It returns immediately. When you
|
2274
2391
|
# invoke it, Firehose first sets the encryption status of the stream to
|
2275
2392
|
# `DISABLING`, and then to `DISABLED`. You can continue to read and
|
2276
2393
|
# write data to your stream while its status is `DISABLING`. It can take
|
2277
2394
|
# up to 5 seconds after the encryption status changes to `DISABLED`
|
2278
|
-
# before all records written to the
|
2395
|
+
# before all records written to the Firehose stream are no longer
|
2279
2396
|
# subject to encryption. To find out whether a record or a batch of
|
2280
2397
|
# records was encrypted, check the response elements
|
2281
2398
|
# PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted,
|
2282
2399
|
# respectively.
|
2283
2400
|
#
|
2284
|
-
# To check the encryption state of a
|
2401
|
+
# To check the encryption state of a Firehose stream, use
|
2285
2402
|
# DescribeDeliveryStream.
|
2286
2403
|
#
|
2287
2404
|
# If SSE is enabled using a customer managed CMK and then you invoke
|
@@ -2290,14 +2407,14 @@ module Aws::Firehose
|
|
2290
2407
|
# finished delivering records to the destination.
|
2291
2408
|
#
|
2292
2409
|
# The `StartDeliveryStreamEncryption` and `StopDeliveryStreamEncryption`
|
2293
|
-
# operations have a combined limit of 25 calls per
|
2410
|
+
# operations have a combined limit of 25 calls per Firehose stream per
|
2294
2411
|
# 24 hours. For example, you reach the limit if you call
|
2295
2412
|
# `StartDeliveryStreamEncryption` 13 times and
|
2296
|
-
# `StopDeliveryStreamEncryption` 12 times for the same
|
2413
|
+
# `StopDeliveryStreamEncryption` 12 times for the same Firehose stream
|
2297
2414
|
# in a 24-hour period.
|
2298
2415
|
#
|
2299
2416
|
# @option params [required, String] :delivery_stream_name
|
2300
|
-
# The name of the
|
2417
|
+
# The name of the Firehose stream for which you want to disable
|
2301
2418
|
# server-side encryption (SSE).
|
2302
2419
|
#
|
2303
2420
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
@@ -2317,17 +2434,17 @@ module Aws::Firehose
|
|
2317
2434
|
req.send_request(options)
|
2318
2435
|
end
|
2319
2436
|
|
2320
|
-
# Adds or updates tags for the specified
|
2437
|
+
# Adds or updates tags for the specified Firehose stream. A tag is a
|
2321
2438
|
# key-value pair that you can define and assign to Amazon Web Services
|
2322
2439
|
# resources. If you specify a tag that already exists, the tag value is
|
2323
2440
|
# replaced with the value that you specify in the request. Tags are
|
2324
2441
|
# metadata. For example, you can add friendly names and descriptions or
|
2325
|
-
# other types of information that can help you distinguish the
|
2442
|
+
# other types of information that can help you distinguish the Firehose
|
2326
2443
|
# stream. For more information about tags, see [Using Cost Allocation
|
2327
2444
|
# Tags][1] in the *Amazon Web Services Billing and Cost Management User
|
2328
2445
|
# Guide*.
|
2329
2446
|
#
|
2330
|
-
# Each
|
2447
|
+
# Each Firehose stream can have up to 50 tags.
|
2331
2448
|
#
|
2332
2449
|
# This operation has a limit of five transactions per second per
|
2333
2450
|
# account.
|
@@ -2337,7 +2454,7 @@ module Aws::Firehose
|
|
2337
2454
|
# [1]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html
|
2338
2455
|
#
|
2339
2456
|
# @option params [required, String] :delivery_stream_name
|
2340
|
-
# The name of the
|
2457
|
+
# The name of the Firehose stream to which you want to add the tags.
|
2341
2458
|
#
|
2342
2459
|
# @option params [required, Array<Types::Tag>] :tags
|
2343
2460
|
# A set of key-value pairs to use to create the tags.
|
@@ -2365,7 +2482,7 @@ module Aws::Firehose
|
|
2365
2482
|
req.send_request(options)
|
2366
2483
|
end
|
2367
2484
|
|
2368
|
-
# Removes tags from the specified
|
2485
|
+
# Removes tags from the specified Firehose stream. Removed tags are
|
2369
2486
|
# deleted, and you can't recover them after this operation successfully
|
2370
2487
|
# completes.
|
2371
2488
|
#
|
@@ -2375,7 +2492,7 @@ module Aws::Firehose
|
|
2375
2492
|
# account.
|
2376
2493
|
#
|
2377
2494
|
# @option params [required, String] :delivery_stream_name
|
2378
|
-
# The name of the
|
2495
|
+
# The name of the Firehose stream.
|
2379
2496
|
#
|
2380
2497
|
# @option params [required, Array<String>] :tag_keys
|
2381
2498
|
# A list of tag keys. Each corresponding tag is removed from the
|
@@ -2399,14 +2516,14 @@ module Aws::Firehose
|
|
2399
2516
|
req.send_request(options)
|
2400
2517
|
end
|
2401
2518
|
|
2402
|
-
# Updates the specified destination of the specified
|
2519
|
+
# Updates the specified destination of the specified Firehose stream.
|
2403
2520
|
#
|
2404
2521
|
# Use this operation to change the destination type (for example, to
|
2405
2522
|
# replace the Amazon S3 destination with Amazon Redshift) or change the
|
2406
2523
|
# parameters associated with a destination (for example, to change the
|
2407
2524
|
# bucket name of the Amazon S3 destination). The update might not occur
|
2408
|
-
# immediately. The target
|
2409
|
-
# configurations are updated, so data writes to the
|
2525
|
+
# immediately. The target Firehose stream remains active while the
|
2526
|
+
# configurations are updated, so data writes to the Firehose stream can
|
2410
2527
|
# continue during this process. The updated configurations are usually
|
2411
2528
|
# effective within a few minutes.
|
2412
2529
|
#
|
@@ -2435,7 +2552,7 @@ module Aws::Firehose
|
|
2435
2552
|
# `CurrentDeliveryStreamVersionId` in the next call.
|
2436
2553
|
#
|
2437
2554
|
# @option params [required, String] :delivery_stream_name
|
2438
|
-
# The name of the
|
2555
|
+
# The name of the Firehose stream.
|
2439
2556
|
#
|
2440
2557
|
# @option params [required, String] :current_delivery_stream_version_id
|
2441
2558
|
# Obtain this value from the `VersionId` result of
|
@@ -2480,8 +2597,6 @@ module Aws::Firehose
|
|
2480
2597
|
# @option params [Types::IcebergDestinationUpdate] :iceberg_destination_update
|
2481
2598
|
# Describes an update for a destination in Apache Iceberg Tables.
|
2482
2599
|
#
|
2483
|
-
# Amazon Data Firehose is in preview release and is subject to change.
|
2484
|
-
#
|
2485
2600
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2486
2601
|
#
|
2487
2602
|
# @example Request syntax with placeholder values
|
@@ -3087,12 +3202,25 @@ module Aws::Firehose
|
|
3087
3202
|
# iceberg_destination_update: {
|
3088
3203
|
# destination_table_configuration_list: [
|
3089
3204
|
# {
|
3090
|
-
# destination_table_name: "
|
3091
|
-
# destination_database_name: "
|
3205
|
+
# destination_table_name: "StringWithLettersDigitsUnderscoresDots", # required
|
3206
|
+
# destination_database_name: "StringWithLettersDigitsUnderscoresDots", # required
|
3092
3207
|
# unique_keys: ["NonEmptyStringWithoutWhitespace"],
|
3208
|
+
# partition_spec: {
|
3209
|
+
# identity: [
|
3210
|
+
# {
|
3211
|
+
# source_name: "NonEmptyStringWithoutWhitespace", # required
|
3212
|
+
# },
|
3213
|
+
# ],
|
3214
|
+
# },
|
3093
3215
|
# s3_error_output_prefix: "ErrorOutputPrefix",
|
3094
3216
|
# },
|
3095
3217
|
# ],
|
3218
|
+
# schema_evolution_configuration: {
|
3219
|
+
# enabled: false, # required
|
3220
|
+
# },
|
3221
|
+
# table_creation_configuration: {
|
3222
|
+
# enabled: false, # required
|
3223
|
+
# },
|
3096
3224
|
# buffering_hints: {
|
3097
3225
|
# size_in_m_bs: 1,
|
3098
3226
|
# interval_in_seconds: 1,
|
@@ -3123,6 +3251,7 @@ module Aws::Firehose
|
|
3123
3251
|
# role_arn: "RoleARN",
|
3124
3252
|
# catalog_configuration: {
|
3125
3253
|
# catalog_arn: "GlueDataCatalogARN",
|
3254
|
+
# warehouse_location: "WarehouseLocation",
|
3126
3255
|
# },
|
3127
3256
|
# s3_configuration: {
|
3128
3257
|
# role_arn: "RoleARN", # required
|
@@ -3176,7 +3305,7 @@ module Aws::Firehose
|
|
3176
3305
|
tracer: tracer
|
3177
3306
|
)
|
3178
3307
|
context[:gem_name] = 'aws-sdk-firehose'
|
3179
|
-
context[:gem_version] = '1.
|
3308
|
+
context[:gem_version] = '1.86.0'
|
3180
3309
|
Seahorse::Client::Request.new(handlers, context)
|
3181
3310
|
end
|
3182
3311
|
|