aws-sdk-firehose 1.63.0 → 1.64.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-firehose/client.rb +240 -171
- data/lib/aws-sdk-firehose/client_api.rb +113 -0
- data/lib/aws-sdk-firehose/endpoints.rb +28 -0
- data/lib/aws-sdk-firehose/errors.rb +127 -0
- data/lib/aws-sdk-firehose/plugins/endpoints.rb +4 -0
- data/lib/aws-sdk-firehose/types.rb +722 -525
- data/lib/aws-sdk-firehose.rb +1 -1
- data/sig/client.rbs +66 -34
- data/sig/errors.rbs +24 -0
- data/sig/types.rbs +83 -2
- metadata +2 -2
@@ -43,8 +43,8 @@ module Aws::Firehose
|
|
43
43
|
#
|
44
44
|
# @!attribute [rw] role_arn
|
45
45
|
# The Amazon Resource Name (ARN) of the IAM role to be assumed by
|
46
|
-
#
|
47
|
-
#
|
46
|
+
# Firehose for calling the Serverless offering for Amazon OpenSearch
|
47
|
+
# Service Configuration API and for indexing documents.
|
48
48
|
# @return [String]
|
49
49
|
#
|
50
50
|
# @!attribute [rw] collection_endpoint
|
@@ -62,19 +62,19 @@ module Aws::Firehose
|
|
62
62
|
# @return [Types::AmazonOpenSearchServerlessBufferingHints]
|
63
63
|
#
|
64
64
|
# @!attribute [rw] retry_options
|
65
|
-
# The retry behavior in case
|
66
|
-
#
|
67
|
-
#
|
65
|
+
# The retry behavior in case Firehose is unable to deliver documents
|
66
|
+
# to the Serverless offering for Amazon OpenSearch Service. The
|
67
|
+
# default value is 300 (5 minutes).
|
68
68
|
# @return [Types::AmazonOpenSearchServerlessRetryOptions]
|
69
69
|
#
|
70
70
|
# @!attribute [rw] s3_backup_mode
|
71
71
|
# Defines how documents should be delivered to Amazon S3. When it is
|
72
|
-
# set to FailedDocumentsOnly,
|
73
|
-
#
|
74
|
-
#
|
75
|
-
#
|
76
|
-
#
|
77
|
-
#
|
72
|
+
# set to FailedDocumentsOnly, Firehose writes any documents that could
|
73
|
+
# not be indexed to the configured Amazon S3 destination, with
|
74
|
+
# AmazonOpenSearchService-failed/ appended to the key prefix. When set
|
75
|
+
# to AllDocuments, Firehose delivers all incoming records to Amazon
|
76
|
+
# S3, and also writes failed documents with
|
77
|
+
# AmazonOpenSearchService-failed/ appended to the prefix.
|
78
78
|
# @return [String]
|
79
79
|
#
|
80
80
|
# @!attribute [rw] s3_configuration
|
@@ -180,8 +180,8 @@ module Aws::Firehose
|
|
180
180
|
#
|
181
181
|
# @!attribute [rw] role_arn
|
182
182
|
# The Amazon Resource Name (ARN) of the IAM role to be assumed by
|
183
|
-
#
|
184
|
-
#
|
183
|
+
# Firehose for calling the Serverless offering for Amazon OpenSearch
|
184
|
+
# Service Configuration API and for indexing documents.
|
185
185
|
# @return [String]
|
186
186
|
#
|
187
187
|
# @!attribute [rw] collection_endpoint
|
@@ -199,9 +199,9 @@ module Aws::Firehose
|
|
199
199
|
# @return [Types::AmazonOpenSearchServerlessBufferingHints]
|
200
200
|
#
|
201
201
|
# @!attribute [rw] retry_options
|
202
|
-
# The retry behavior in case
|
203
|
-
#
|
204
|
-
#
|
202
|
+
# The retry behavior in case Firehose is unable to deliver documents
|
203
|
+
# to the Serverless offering for Amazon OpenSearch Service. The
|
204
|
+
# default value is 300 (5 minutes).
|
205
205
|
# @return [Types::AmazonOpenSearchServerlessRetryOptions]
|
206
206
|
#
|
207
207
|
# @!attribute [rw] s3_update
|
@@ -232,17 +232,16 @@ module Aws::Firehose
|
|
232
232
|
include Aws::Structure
|
233
233
|
end
|
234
234
|
|
235
|
-
# Configures retry behavior in case
|
236
|
-
#
|
237
|
-
# Service.
|
235
|
+
# Configures retry behavior in case Firehose is unable to deliver
|
236
|
+
# documents to the Serverless offering for Amazon OpenSearch Service.
|
238
237
|
#
|
239
238
|
# @!attribute [rw] duration_in_seconds
|
240
239
|
# After an initial failure to deliver to the Serverless offering for
|
241
240
|
# Amazon OpenSearch Service, the total amount of time during which
|
242
|
-
#
|
243
|
-
#
|
244
|
-
#
|
245
|
-
#
|
241
|
+
# Firehose retries delivery (including the first attempt). After this
|
242
|
+
# time has elapsed, the failed documents are written to Amazon S3.
|
243
|
+
# Default value is 300 seconds (5 minutes). A value of 0 (zero)
|
244
|
+
# results in no retries.
|
246
245
|
# @return [Integer]
|
247
246
|
#
|
248
247
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/AmazonOpenSearchServerlessRetryOptions AWS API Documentation
|
@@ -286,8 +285,8 @@ module Aws::Firehose
|
|
286
285
|
#
|
287
286
|
# @!attribute [rw] role_arn
|
288
287
|
# The Amazon Resource Name (ARN) of the IAM role to be assumed by
|
289
|
-
#
|
290
|
-
#
|
288
|
+
# Firehose for calling the Amazon OpenSearch Service Configuration API
|
289
|
+
# and for indexing documents.
|
291
290
|
# @return [String]
|
292
291
|
#
|
293
292
|
# @!attribute [rw] domain_arn
|
@@ -309,8 +308,8 @@ module Aws::Firehose
|
|
309
308
|
# @!attribute [rw] type_name
|
310
309
|
# The Amazon OpenSearch Service type name. For Elasticsearch 6.x,
|
311
310
|
# there can be only one type per index. If you try to specify a new
|
312
|
-
# type for an existing index that already has another type,
|
313
|
-
#
|
311
|
+
# type for an existing index that already has another type, Firehose
|
312
|
+
# returns an error during run time.
|
314
313
|
# @return [String]
|
315
314
|
#
|
316
315
|
# @!attribute [rw] index_rotation_period
|
@@ -325,19 +324,18 @@ module Aws::Firehose
|
|
325
324
|
# @return [Types::AmazonopensearchserviceBufferingHints]
|
326
325
|
#
|
327
326
|
# @!attribute [rw] retry_options
|
328
|
-
# The retry behavior in case
|
329
|
-
#
|
330
|
-
# 300 (5 minutes).
|
327
|
+
# The retry behavior in case Firehose is unable to deliver documents
|
328
|
+
# to Amazon OpenSearch Service. The default value is 300 (5 minutes).
|
331
329
|
# @return [Types::AmazonopensearchserviceRetryOptions]
|
332
330
|
#
|
333
331
|
# @!attribute [rw] s3_backup_mode
|
334
332
|
# Defines how documents should be delivered to Amazon S3. When it is
|
335
|
-
# set to FailedDocumentsOnly,
|
336
|
-
#
|
337
|
-
#
|
338
|
-
#
|
339
|
-
#
|
340
|
-
#
|
333
|
+
# set to FailedDocumentsOnly, Firehose writes any documents that could
|
334
|
+
# not be indexed to the configured Amazon S3 destination, with
|
335
|
+
# AmazonOpenSearchService-failed/ appended to the key prefix. When set
|
336
|
+
# to AllDocuments, Firehose delivers all incoming records to Amazon
|
337
|
+
# S3, and also writes failed documents with
|
338
|
+
# AmazonOpenSearchService-failed/ appended to the prefix.
|
341
339
|
# @return [String]
|
342
340
|
#
|
343
341
|
# @!attribute [rw] s3_configuration
|
@@ -360,8 +358,8 @@ module Aws::Firehose
|
|
360
358
|
#
|
361
359
|
# @!attribute [rw] document_id_options
|
362
360
|
# Indicates the method for setting up document ID. The supported
|
363
|
-
# methods are
|
364
|
-
#
|
361
|
+
# methods are Firehose generated document ID and OpenSearch Service
|
362
|
+
# generated document ID.
|
365
363
|
# @return [Types::DocumentIdOptions]
|
366
364
|
#
|
367
365
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/AmazonopensearchserviceDestinationConfiguration AWS API Documentation
|
@@ -397,9 +395,9 @@ module Aws::Firehose
|
|
397
395
|
# @return [String]
|
398
396
|
#
|
399
397
|
# @!attribute [rw] cluster_endpoint
|
400
|
-
# The endpoint to use when communicating with the cluster.
|
401
|
-
#
|
402
|
-
#
|
398
|
+
# The endpoint to use when communicating with the cluster. Firehose
|
399
|
+
# uses either this ClusterEndpoint or the DomainARN field to send data
|
400
|
+
# to Amazon OpenSearch Service.
|
403
401
|
# @return [String]
|
404
402
|
#
|
405
403
|
# @!attribute [rw] index_name
|
@@ -447,8 +445,8 @@ module Aws::Firehose
|
|
447
445
|
#
|
448
446
|
# @!attribute [rw] document_id_options
|
449
447
|
# Indicates the method for setting up document ID. The supported
|
450
|
-
# methods are
|
451
|
-
#
|
448
|
+
# methods are Firehose generated document ID and OpenSearch Service
|
449
|
+
# generated document ID.
|
452
450
|
# @return [Types::DocumentIdOptions]
|
453
451
|
#
|
454
452
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/AmazonopensearchserviceDestinationDescription AWS API Documentation
|
@@ -476,8 +474,8 @@ module Aws::Firehose
|
|
476
474
|
#
|
477
475
|
# @!attribute [rw] role_arn
|
478
476
|
# The Amazon Resource Name (ARN) of the IAM role to be assumed by
|
479
|
-
#
|
480
|
-
#
|
477
|
+
# Firehose for calling the Amazon OpenSearch Service Configuration API
|
478
|
+
# and for indexing documents.
|
481
479
|
# @return [String]
|
482
480
|
#
|
483
481
|
# @!attribute [rw] domain_arn
|
@@ -499,14 +497,14 @@ module Aws::Firehose
|
|
499
497
|
# @!attribute [rw] type_name
|
500
498
|
# The Amazon OpenSearch Service type name. For Elasticsearch 6.x,
|
501
499
|
# there can be only one type per index. If you try to specify a new
|
502
|
-
# type for an existing index that already has another type,
|
503
|
-
#
|
500
|
+
# type for an existing index that already has another type, Firehose
|
501
|
+
# returns an error during runtime.
|
504
502
|
#
|
505
503
|
# If you upgrade Elasticsearch from 6.x to 7.x and don’t update your
|
506
|
-
# delivery stream,
|
507
|
-
#
|
508
|
-
#
|
509
|
-
#
|
504
|
+
# delivery stream, Firehose still delivers data to Elasticsearch with
|
505
|
+
# the old index name and type name. If you want to update your
|
506
|
+
# delivery stream with a new index name, provide an empty string for
|
507
|
+
# TypeName.
|
510
508
|
# @return [String]
|
511
509
|
#
|
512
510
|
# @!attribute [rw] index_rotation_period
|
@@ -521,9 +519,8 @@ module Aws::Firehose
|
|
521
519
|
# @return [Types::AmazonopensearchserviceBufferingHints]
|
522
520
|
#
|
523
521
|
# @!attribute [rw] retry_options
|
524
|
-
# The retry behavior in case
|
525
|
-
#
|
526
|
-
# 300 (5 minutes).
|
522
|
+
# The retry behavior in case Firehose is unable to deliver documents
|
523
|
+
# to Amazon OpenSearch Service. The default value is 300 (5 minutes).
|
527
524
|
# @return [Types::AmazonopensearchserviceRetryOptions]
|
528
525
|
#
|
529
526
|
# @!attribute [rw] s3_update
|
@@ -541,8 +538,8 @@ module Aws::Firehose
|
|
541
538
|
#
|
542
539
|
# @!attribute [rw] document_id_options
|
543
540
|
# Indicates the method for setting up document ID. The supported
|
544
|
-
# methods are
|
545
|
-
#
|
541
|
+
# methods are Firehose generated document ID and OpenSearch Service
|
542
|
+
# generated document ID.
|
546
543
|
# @return [Types::DocumentIdOptions]
|
547
544
|
#
|
548
545
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/AmazonopensearchserviceDestinationUpdate AWS API Documentation
|
@@ -564,14 +561,14 @@ module Aws::Firehose
|
|
564
561
|
include Aws::Structure
|
565
562
|
end
|
566
563
|
|
567
|
-
# Configures retry behavior in case
|
568
|
-
#
|
564
|
+
# Configures retry behavior in case Firehose is unable to deliver
|
565
|
+
# documents to Amazon OpenSearch Service.
|
569
566
|
#
|
570
567
|
# @!attribute [rw] duration_in_seconds
|
571
568
|
# After an initial failure to deliver to Amazon OpenSearch Service,
|
572
|
-
# the total amount of time during which
|
573
|
-
#
|
574
|
-
#
|
569
|
+
# the total amount of time during which Firehose retries delivery
|
570
|
+
# (including the first attempt). After this time has elapsed, the
|
571
|
+
# failed documents are written to Amazon S3. Default value is 300
|
575
572
|
# seconds (5 minutes). A value of 0 (zero) results in no retries.
|
576
573
|
# @return [Integer]
|
577
574
|
#
|
@@ -604,10 +601,10 @@ module Aws::Firehose
|
|
604
601
|
|
605
602
|
# Describes hints for the buffering to perform before delivering data to
|
606
603
|
# the destination. These options are treated as hints, and therefore
|
607
|
-
#
|
608
|
-
#
|
609
|
-
#
|
610
|
-
#
|
604
|
+
# Firehose might choose to use different values when it is optimal. The
|
605
|
+
# `SizeInMBs` and `IntervalInSeconds` parameters are optional. However,
|
606
|
+
# if specify a value for one of them, you must also provide a value for
|
607
|
+
# the other.
|
611
608
|
#
|
612
609
|
# @!attribute [rw] size_in_m_bs
|
613
610
|
# Buffer incoming data to the specified size, in MiBs, before
|
@@ -694,7 +691,7 @@ module Aws::Firehose
|
|
694
691
|
# Optional parameters to use with the Amazon Redshift `COPY` command.
|
695
692
|
# For more information, see the "Optional Parameters" section of
|
696
693
|
# [Amazon Redshift COPY command][1]. Some possible examples that would
|
697
|
-
# apply to
|
694
|
+
# apply to Firehose are as follows:
|
698
695
|
#
|
699
696
|
# `delimiter '\t' lzop;` - fields are delimited with "\\t" (TAB
|
700
697
|
# character) and compressed using lzop.
|
@@ -856,13 +853,13 @@ module Aws::Firehose
|
|
856
853
|
include Aws::Structure
|
857
854
|
end
|
858
855
|
|
859
|
-
# Specifies that you want
|
860
|
-
#
|
861
|
-
#
|
862
|
-
#
|
863
|
-
#
|
864
|
-
#
|
865
|
-
#
|
856
|
+
# Specifies that you want Firehose to convert data from the JSON format
|
857
|
+
# to the Parquet or ORC format before writing it to Amazon S3. Firehose
|
858
|
+
# uses the serializer and deserializer that you specify, in addition to
|
859
|
+
# the column information from the Amazon Web Services Glue table, to
|
860
|
+
# deserialize your input data from JSON and then serialize it to the
|
861
|
+
# Parquet or ORC format. For more information, see [Firehose Record
|
862
|
+
# Format Conversion][1].
|
866
863
|
#
|
867
864
|
#
|
868
865
|
#
|
@@ -875,15 +872,15 @@ module Aws::Firehose
|
|
875
872
|
# @return [Types::SchemaConfiguration]
|
876
873
|
#
|
877
874
|
# @!attribute [rw] input_format_configuration
|
878
|
-
# Specifies the deserializer that you want
|
879
|
-
#
|
880
|
-
#
|
875
|
+
# Specifies the deserializer that you want Firehose to use to convert
|
876
|
+
# the format of your data from JSON. This parameter is required if
|
877
|
+
# `Enabled` is set to true.
|
881
878
|
# @return [Types::InputFormatConfiguration]
|
882
879
|
#
|
883
880
|
# @!attribute [rw] output_format_configuration
|
884
|
-
# Specifies the serializer that you want
|
885
|
-
#
|
886
|
-
#
|
881
|
+
# Specifies the serializer that you want Firehose to use to convert
|
882
|
+
# the format of your data to the Parquet or ORC format. This parameter
|
883
|
+
# is required if `Enabled` is set to true.
|
887
884
|
# @return [Types::OutputFormatConfiguration]
|
888
885
|
#
|
889
886
|
# @!attribute [rw] enabled
|
@@ -908,14 +905,13 @@ module Aws::Firehose
|
|
908
905
|
#
|
909
906
|
# @!attribute [rw] allow_force_delete
|
910
907
|
# Set this to true if you want to delete the delivery stream even if
|
911
|
-
#
|
912
|
-
#
|
913
|
-
#
|
914
|
-
#
|
915
|
-
#
|
916
|
-
#
|
917
|
-
#
|
918
|
-
# operation.
|
908
|
+
# Firehose is unable to retire the grant for the CMK. Firehose might
|
909
|
+
# be unable to retire the grant due to a customer error, such as when
|
910
|
+
# the CMK or the grant are in an invalid state. If you force deletion,
|
911
|
+
# you can then use the [RevokeGrant][1] operation to revoke the grant
|
912
|
+
# you gave to Firehose. If a failure to retire the grant happens due
|
913
|
+
# to an Amazon Web Services KMS issue, Firehose keeps retrying the
|
914
|
+
# delete operation.
|
919
915
|
#
|
920
916
|
# The default value is false.
|
921
917
|
#
|
@@ -1086,8 +1082,8 @@ module Aws::Firehose
|
|
1086
1082
|
# @!attribute [rw] key_arn
|
1087
1083
|
# If you set `KeyType` to `CUSTOMER_MANAGED_CMK`, you must specify the
|
1088
1084
|
# Amazon Resource Name (ARN) of the CMK. If you set `KeyType` to
|
1089
|
-
# `Amazon Web Services_OWNED_CMK`,
|
1090
|
-
#
|
1085
|
+
# `Amazon Web Services_OWNED_CMK`, Firehose uses a service-account
|
1086
|
+
# CMK.
|
1091
1087
|
# @return [String]
|
1092
1088
|
#
|
1093
1089
|
# @!attribute [rw] key_type
|
@@ -1096,26 +1092,24 @@ module Aws::Firehose
|
|
1096
1092
|
# For more information about CMKs, see [Customer Master Keys
|
1097
1093
|
# (CMKs)][1]. When you invoke CreateDeliveryStream or
|
1098
1094
|
# StartDeliveryStreamEncryption with `KeyType` set to
|
1099
|
-
# CUSTOMER\_MANAGED\_CMK,
|
1100
|
-
#
|
1101
|
-
#
|
1102
|
-
#
|
1095
|
+
# CUSTOMER\_MANAGED\_CMK, Firehose invokes the Amazon KMS operation
|
1096
|
+
# [CreateGrant][2] to create a grant that allows the Firehose service
|
1097
|
+
# to use the customer managed CMK to perform encryption and
|
1098
|
+
# decryption. Firehose manages that grant.
|
1103
1099
|
#
|
1104
1100
|
# When you invoke StartDeliveryStreamEncryption to change the CMK for
|
1105
1101
|
# a delivery stream that is encrypted with a customer managed CMK,
|
1106
|
-
#
|
1107
|
-
# retirement.
|
1102
|
+
# Firehose schedules the grant it had on the old CMK for retirement.
|
1108
1103
|
#
|
1109
1104
|
# You can use a CMK of type CUSTOMER\_MANAGED\_CMK to encrypt up to
|
1110
1105
|
# 500 delivery streams. If a CreateDeliveryStream or
|
1111
|
-
# StartDeliveryStreamEncryption operation exceeds this limit,
|
1112
|
-
#
|
1106
|
+
# StartDeliveryStreamEncryption operation exceeds this limit, Firehose
|
1107
|
+
# throws a `LimitExceededException`.
|
1113
1108
|
#
|
1114
|
-
# To encrypt your delivery stream, use symmetric CMKs.
|
1115
|
-
#
|
1116
|
-
#
|
1117
|
-
#
|
1118
|
-
# guide.
|
1109
|
+
# To encrypt your delivery stream, use symmetric CMKs. Firehose
|
1110
|
+
# doesn't support asymmetric CMKs. For information about symmetric
|
1111
|
+
# and asymmetric CMKs, see [About Symmetric and Asymmetric CMKs][3] in
|
1112
|
+
# the Amazon Web Services Key Management Service developer guide.
|
1119
1113
|
#
|
1120
1114
|
#
|
1121
1115
|
#
|
@@ -1144,8 +1138,7 @@ module Aws::Firehose
|
|
1144
1138
|
#
|
1145
1139
|
# @!attribute [rw] exclusive_start_destination_id
|
1146
1140
|
# The ID of the destination to start returning the destination
|
1147
|
-
# information.
|
1148
|
-
# delivery stream.
|
1141
|
+
# information. Firehose supports one destination per delivery stream.
|
1149
1142
|
# @return [String]
|
1150
1143
|
#
|
1151
1144
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/DescribeDeliveryStreamInput AWS API Documentation
|
@@ -1170,11 +1163,10 @@ module Aws::Firehose
|
|
1170
1163
|
include Aws::Structure
|
1171
1164
|
end
|
1172
1165
|
|
1173
|
-
# The deserializer you want
|
1174
|
-
#
|
1175
|
-
#
|
1176
|
-
#
|
1177
|
-
# and the [OpenX JSON SerDe][2].
|
1166
|
+
# The deserializer you want Firehose to use for converting the input
|
1167
|
+
# data from JSON. Firehose then serializes the data to its final format
|
1168
|
+
# using the Serializer. Firehose supports two types of deserializers:
|
1169
|
+
# the [Apache Hive JSON SerDe][1] and the [OpenX JSON SerDe][2].
|
1178
1170
|
#
|
1179
1171
|
#
|
1180
1172
|
#
|
@@ -1182,21 +1174,21 @@ module Aws::Firehose
|
|
1182
1174
|
# [2]: https://github.com/rcongiu/Hive-JSON-Serde
|
1183
1175
|
#
|
1184
1176
|
# @!attribute [rw] open_x_json_ser_de
|
1185
|
-
# The OpenX SerDe. Used by
|
1186
|
-
#
|
1187
|
-
#
|
1177
|
+
# The OpenX SerDe. Used by Firehose for deserializing data, which
|
1178
|
+
# means converting it from the JSON format in preparation for
|
1179
|
+
# serializing it to the Parquet or ORC format. This is one of two
|
1188
1180
|
# deserializers you can choose, depending on which one offers the
|
1189
1181
|
# functionality you need. The other option is the native Hive /
|
1190
1182
|
# HCatalog JsonSerDe.
|
1191
1183
|
# @return [Types::OpenXJsonSerDe]
|
1192
1184
|
#
|
1193
1185
|
# @!attribute [rw] hive_json_ser_de
|
1194
|
-
# The native Hive / HCatalog JsonSerDe. Used by
|
1195
|
-
#
|
1196
|
-
#
|
1197
|
-
#
|
1198
|
-
#
|
1199
|
-
#
|
1186
|
+
# The native Hive / HCatalog JsonSerDe. Used by Firehose for
|
1187
|
+
# deserializing data, which means converting it from the JSON format
|
1188
|
+
# in preparation for serializing it to the Parquet or ORC format. This
|
1189
|
+
# is one of two deserializers you can choose, depending on which one
|
1190
|
+
# offers the functionality you need. The other option is the OpenX
|
1191
|
+
# SerDe.
|
1200
1192
|
# @return [Types::HiveJsonSerDe]
|
1201
1193
|
#
|
1202
1194
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/Deserializer AWS API Documentation
|
@@ -1269,25 +1261,25 @@ module Aws::Firehose
|
|
1269
1261
|
end
|
1270
1262
|
|
1271
1263
|
# Indicates the method for setting up document ID. The supported methods
|
1272
|
-
# are
|
1273
|
-
#
|
1264
|
+
# are Firehose generated document ID and OpenSearch Service generated
|
1265
|
+
# document ID.
|
1274
1266
|
#
|
1275
1267
|
# @!attribute [rw] default_document_id_format
|
1276
|
-
# When the `FIREHOSE_DEFAULT` option is chosen,
|
1277
|
-
#
|
1278
|
-
#
|
1279
|
-
#
|
1280
|
-
#
|
1281
|
-
#
|
1282
|
-
# When the `NO_DOCUMENT_ID` option is chosen,
|
1283
|
-
#
|
1284
|
-
#
|
1285
|
-
#
|
1286
|
-
#
|
1287
|
-
#
|
1288
|
-
#
|
1289
|
-
#
|
1290
|
-
#
|
1268
|
+
# When the `FIREHOSE_DEFAULT` option is chosen, Firehose generates a
|
1269
|
+
# unique document ID for each record based on a unique internal
|
1270
|
+
# identifier. The generated document ID is stable across multiple
|
1271
|
+
# delivery attempts, which helps prevent the same record from being
|
1272
|
+
# indexed multiple times with different document IDs.
|
1273
|
+
#
|
1274
|
+
# When the `NO_DOCUMENT_ID` option is chosen, Firehose does not
|
1275
|
+
# include any document IDs in the requests it sends to the Amazon
|
1276
|
+
# OpenSearch Service. This causes the Amazon OpenSearch Service domain
|
1277
|
+
# to generate document IDs. In case of multiple delivery attempts,
|
1278
|
+
# this may cause the same record to be indexed more than once with
|
1279
|
+
# different document IDs. This option enables write-heavy operations,
|
1280
|
+
# such as the ingestion of logs and observability data, to consume
|
1281
|
+
# less resources in the Amazon OpenSearch Service domain, resulting in
|
1282
|
+
# improved performance.
|
1291
1283
|
# @return [String]
|
1292
1284
|
#
|
1293
1285
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/DocumentIdOptions AWS API Documentation
|
@@ -1304,13 +1296,13 @@ module Aws::Firehose
|
|
1304
1296
|
# Amazon S3 destinations.
|
1305
1297
|
#
|
1306
1298
|
# @!attribute [rw] retry_options
|
1307
|
-
# The retry behavior in case
|
1308
|
-
#
|
1299
|
+
# The retry behavior in case Firehose is unable to deliver data to an
|
1300
|
+
# Amazon S3 prefix.
|
1309
1301
|
# @return [Types::RetryOptions]
|
1310
1302
|
#
|
1311
1303
|
# @!attribute [rw] enabled
|
1312
|
-
# Specifies that the dynamic partitioning is enabled for this
|
1313
|
-
#
|
1304
|
+
# Specifies that the dynamic partitioning is enabled for this Firehose
|
1305
|
+
# delivery stream.
|
1314
1306
|
# @return [Boolean]
|
1315
1307
|
#
|
1316
1308
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/DynamicPartitioningConfiguration AWS API Documentation
|
@@ -1354,11 +1346,10 @@ module Aws::Firehose
|
|
1354
1346
|
#
|
1355
1347
|
# @!attribute [rw] role_arn
|
1356
1348
|
# The Amazon Resource Name (ARN) of the IAM role to be assumed by
|
1357
|
-
#
|
1358
|
-
#
|
1359
|
-
#
|
1360
|
-
#
|
1361
|
-
# Namespaces][2].
|
1349
|
+
# Firehose for calling the Amazon ES Configuration API and for
|
1350
|
+
# indexing documents. For more information, see [Grant Firehose Access
|
1351
|
+
# to an Amazon S3 Destination][1] and [Amazon Resource Names (ARNs)
|
1352
|
+
# and Amazon Web Services Service Namespaces][2].
|
1362
1353
|
#
|
1363
1354
|
#
|
1364
1355
|
#
|
@@ -1392,8 +1383,8 @@ module Aws::Firehose
|
|
1392
1383
|
# @!attribute [rw] type_name
|
1393
1384
|
# The Elasticsearch type name. For Elasticsearch 6.x, there can be
|
1394
1385
|
# only one type per index. If you try to specify a new type for an
|
1395
|
-
# existing index that already has another type,
|
1396
|
-
#
|
1386
|
+
# existing index that already has another type, Firehose returns an
|
1387
|
+
# error during run time.
|
1397
1388
|
#
|
1398
1389
|
# For Elasticsearch 7.x, don't specify a `TypeName`.
|
1399
1390
|
# @return [String]
|
@@ -1415,21 +1406,20 @@ module Aws::Firehose
|
|
1415
1406
|
# @return [Types::ElasticsearchBufferingHints]
|
1416
1407
|
#
|
1417
1408
|
# @!attribute [rw] retry_options
|
1418
|
-
# The retry behavior in case
|
1419
|
-
#
|
1420
|
-
# minutes).
|
1409
|
+
# The retry behavior in case Firehose is unable to deliver documents
|
1410
|
+
# to Amazon ES. The default value is 300 (5 minutes).
|
1421
1411
|
# @return [Types::ElasticsearchRetryOptions]
|
1422
1412
|
#
|
1423
1413
|
# @!attribute [rw] s3_backup_mode
|
1424
1414
|
# Defines how documents should be delivered to Amazon S3. When it is
|
1425
|
-
# set to `FailedDocumentsOnly`,
|
1426
|
-
#
|
1427
|
-
#
|
1428
|
-
#
|
1429
|
-
#
|
1430
|
-
#
|
1431
|
-
#
|
1432
|
-
#
|
1415
|
+
# set to `FailedDocumentsOnly`, Firehose writes any documents that
|
1416
|
+
# could not be indexed to the configured Amazon S3 destination, with
|
1417
|
+
# `AmazonOpenSearchService-failed/` appended to the key prefix. When
|
1418
|
+
# set to `AllDocuments`, Firehose delivers all incoming records to
|
1419
|
+
# Amazon S3, and also writes failed documents with
|
1420
|
+
# `AmazonOpenSearchService-failed/` appended to the prefix. For more
|
1421
|
+
# information, see [Amazon S3 Backup for the Amazon ES
|
1422
|
+
# Destination][1]. Default value is `FailedDocumentsOnly`.
|
1433
1423
|
#
|
1434
1424
|
# You can't change this backup mode after you create the delivery
|
1435
1425
|
# stream.
|
@@ -1457,8 +1447,8 @@ module Aws::Firehose
|
|
1457
1447
|
#
|
1458
1448
|
# @!attribute [rw] document_id_options
|
1459
1449
|
# Indicates the method for setting up document ID. The supported
|
1460
|
-
# methods are
|
1461
|
-
#
|
1450
|
+
# methods are Firehose generated document ID and OpenSearch Service
|
1451
|
+
# generated document ID.
|
1462
1452
|
# @return [Types::DocumentIdOptions]
|
1463
1453
|
#
|
1464
1454
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/ElasticsearchDestinationConfiguration AWS API Documentation
|
@@ -1499,8 +1489,8 @@ module Aws::Firehose
|
|
1499
1489
|
# Resource Names (ARNs) and Amazon Web Services Service
|
1500
1490
|
# Namespaces][1].
|
1501
1491
|
#
|
1502
|
-
#
|
1503
|
-
# to
|
1492
|
+
# Firehose uses either `ClusterEndpoint` or `DomainARN` to send data
|
1493
|
+
# to Amazon ES.
|
1504
1494
|
#
|
1505
1495
|
#
|
1506
1496
|
#
|
@@ -1508,9 +1498,9 @@ module Aws::Firehose
|
|
1508
1498
|
# @return [String]
|
1509
1499
|
#
|
1510
1500
|
# @!attribute [rw] cluster_endpoint
|
1511
|
-
# The endpoint to use when communicating with the cluster.
|
1512
|
-
#
|
1513
|
-
#
|
1501
|
+
# The endpoint to use when communicating with the cluster. Firehose
|
1502
|
+
# uses either this `ClusterEndpoint` or the `DomainARN` field to send
|
1503
|
+
# data to Amazon ES.
|
1514
1504
|
# @return [String]
|
1515
1505
|
#
|
1516
1506
|
# @!attribute [rw] index_name
|
@@ -1558,8 +1548,8 @@ module Aws::Firehose
|
|
1558
1548
|
#
|
1559
1549
|
# @!attribute [rw] document_id_options
|
1560
1550
|
# Indicates the method for setting up document ID. The supported
|
1561
|
-
# methods are
|
1562
|
-
#
|
1551
|
+
# methods are Firehose generated document ID and OpenSearch Service
|
1552
|
+
# generated document ID.
|
1563
1553
|
# @return [Types::DocumentIdOptions]
|
1564
1554
|
#
|
1565
1555
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/ElasticsearchDestinationDescription AWS API Documentation
|
@@ -1587,11 +1577,10 @@ module Aws::Firehose
|
|
1587
1577
|
#
|
1588
1578
|
# @!attribute [rw] role_arn
|
1589
1579
|
# The Amazon Resource Name (ARN) of the IAM role to be assumed by
|
1590
|
-
#
|
1591
|
-
#
|
1592
|
-
#
|
1593
|
-
#
|
1594
|
-
# Namespaces][2].
|
1580
|
+
# Firehose for calling the Amazon ES Configuration API and for
|
1581
|
+
# indexing documents. For more information, see [Grant Firehose Access
|
1582
|
+
# to an Amazon S3 Destination][1] and [Amazon Resource Names (ARNs)
|
1583
|
+
# and Amazon Web Services Service Namespaces][2].
|
1595
1584
|
#
|
1596
1585
|
#
|
1597
1586
|
#
|
@@ -1625,14 +1614,14 @@ module Aws::Firehose
|
|
1625
1614
|
# @!attribute [rw] type_name
|
1626
1615
|
# The Elasticsearch type name. For Elasticsearch 6.x, there can be
|
1627
1616
|
# only one type per index. If you try to specify a new type for an
|
1628
|
-
# existing index that already has another type,
|
1629
|
-
#
|
1617
|
+
# existing index that already has another type, Firehose returns an
|
1618
|
+
# error during runtime.
|
1630
1619
|
#
|
1631
1620
|
# If you upgrade Elasticsearch from 6.x to 7.x and don’t update your
|
1632
|
-
# delivery stream,
|
1633
|
-
#
|
1634
|
-
#
|
1635
|
-
#
|
1621
|
+
# delivery stream, Firehose still delivers data to Elasticsearch with
|
1622
|
+
# the old index name and type name. If you want to update your
|
1623
|
+
# delivery stream with a new index name, provide an empty string for
|
1624
|
+
# `TypeName`.
|
1636
1625
|
# @return [String]
|
1637
1626
|
#
|
1638
1627
|
# @!attribute [rw] index_rotation_period
|
@@ -1652,9 +1641,8 @@ module Aws::Firehose
|
|
1652
1641
|
# @return [Types::ElasticsearchBufferingHints]
|
1653
1642
|
#
|
1654
1643
|
# @!attribute [rw] retry_options
|
1655
|
-
# The retry behavior in case
|
1656
|
-
#
|
1657
|
-
# minutes).
|
1644
|
+
# The retry behavior in case Firehose is unable to deliver documents
|
1645
|
+
# to Amazon ES. The default value is 300 (5 minutes).
|
1658
1646
|
# @return [Types::ElasticsearchRetryOptions]
|
1659
1647
|
#
|
1660
1648
|
# @!attribute [rw] s3_update
|
@@ -1671,8 +1659,8 @@ module Aws::Firehose
|
|
1671
1659
|
#
|
1672
1660
|
# @!attribute [rw] document_id_options
|
1673
1661
|
# Indicates the method for setting up document ID. The supported
|
1674
|
-
# methods are
|
1675
|
-
#
|
1662
|
+
# methods are Firehose generated document ID and OpenSearch Service
|
1663
|
+
# generated document ID.
|
1676
1664
|
# @return [Types::DocumentIdOptions]
|
1677
1665
|
#
|
1678
1666
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/ElasticsearchDestinationUpdate AWS API Documentation
|
@@ -1694,15 +1682,15 @@ module Aws::Firehose
|
|
1694
1682
|
include Aws::Structure
|
1695
1683
|
end
|
1696
1684
|
|
1697
|
-
# Configures retry behavior in case
|
1698
|
-
#
|
1685
|
+
# Configures retry behavior in case Firehose is unable to deliver
|
1686
|
+
# documents to Amazon ES.
|
1699
1687
|
#
|
1700
1688
|
# @!attribute [rw] duration_in_seconds
|
1701
1689
|
# After an initial failure to deliver to Amazon ES, the total amount
|
1702
|
-
# of time during which
|
1703
|
-
#
|
1704
|
-
#
|
1705
|
-
#
|
1690
|
+
# of time during which Firehose retries delivery (including the first
|
1691
|
+
# attempt). After this time has elapsed, the failed documents are
|
1692
|
+
# written to Amazon S3. Default value is 300 seconds (5 minutes). A
|
1693
|
+
# value of 0 (zero) results in no retries.
|
1706
1694
|
# @return [Integer]
|
1707
1695
|
#
|
1708
1696
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/ElasticsearchRetryOptions AWS API Documentation
|
@@ -1765,10 +1753,10 @@ module Aws::Firehose
|
|
1765
1753
|
# @return [String]
|
1766
1754
|
#
|
1767
1755
|
# @!attribute [rw] error_output_prefix
|
1768
|
-
# A prefix that
|
1769
|
-
#
|
1770
|
-
#
|
1771
|
-
#
|
1756
|
+
# A prefix that Firehose evaluates and adds to failed records before
|
1757
|
+
# writing them to S3. This prefix appears immediately following the
|
1758
|
+
# bucket name. For information about how to specify this prefix, see
|
1759
|
+
# [Custom Prefixes for Amazon S3 Objects][1].
|
1772
1760
|
#
|
1773
1761
|
#
|
1774
1762
|
#
|
@@ -1821,6 +1809,15 @@ module Aws::Firehose
|
|
1821
1809
|
# for Amazon S3 destinations.
|
1822
1810
|
# @return [Types::DynamicPartitioningConfiguration]
|
1823
1811
|
#
|
1812
|
+
# @!attribute [rw] file_extension
|
1813
|
+
# Specify a file extension. It will override the default file
|
1814
|
+
# extension
|
1815
|
+
# @return [String]
|
1816
|
+
#
|
1817
|
+
# @!attribute [rw] custom_time_zone
|
1818
|
+
# The time zone you prefer. UTC is the default.
|
1819
|
+
# @return [String]
|
1820
|
+
#
|
1824
1821
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/ExtendedS3DestinationConfiguration AWS API Documentation
|
1825
1822
|
#
|
1826
1823
|
class ExtendedS3DestinationConfiguration < Struct.new(
|
@@ -1836,7 +1833,9 @@ module Aws::Firehose
|
|
1836
1833
|
:s3_backup_mode,
|
1837
1834
|
:s3_backup_configuration,
|
1838
1835
|
:data_format_conversion_configuration,
|
1839
|
-
:dynamic_partitioning_configuration
|
1836
|
+
:dynamic_partitioning_configuration,
|
1837
|
+
:file_extension,
|
1838
|
+
:custom_time_zone)
|
1840
1839
|
SENSITIVE = []
|
1841
1840
|
include Aws::Structure
|
1842
1841
|
end
|
@@ -1873,10 +1872,10 @@ module Aws::Firehose
|
|
1873
1872
|
# @return [String]
|
1874
1873
|
#
|
1875
1874
|
# @!attribute [rw] error_output_prefix
|
1876
|
-
# A prefix that
|
1877
|
-
#
|
1878
|
-
#
|
1879
|
-
#
|
1875
|
+
# A prefix that Firehose evaluates and adds to failed records before
|
1876
|
+
# writing them to S3. This prefix appears immediately following the
|
1877
|
+
# bucket name. For information about how to specify this prefix, see
|
1878
|
+
# [Custom Prefixes for Amazon S3 Objects][1].
|
1880
1879
|
#
|
1881
1880
|
#
|
1882
1881
|
#
|
@@ -1926,6 +1925,15 @@ module Aws::Firehose
|
|
1926
1925
|
# for Amazon S3 destinations.
|
1927
1926
|
# @return [Types::DynamicPartitioningConfiguration]
|
1928
1927
|
#
|
1928
|
+
# @!attribute [rw] file_extension
|
1929
|
+
# Specify a file extension. It will override the default file
|
1930
|
+
# extension
|
1931
|
+
# @return [String]
|
1932
|
+
#
|
1933
|
+
# @!attribute [rw] custom_time_zone
|
1934
|
+
# The time zone you prefer. UTC is the default.
|
1935
|
+
# @return [String]
|
1936
|
+
#
|
1929
1937
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/ExtendedS3DestinationDescription AWS API Documentation
|
1930
1938
|
#
|
1931
1939
|
class ExtendedS3DestinationDescription < Struct.new(
|
@@ -1941,7 +1949,9 @@ module Aws::Firehose
|
|
1941
1949
|
:s3_backup_mode,
|
1942
1950
|
:s3_backup_description,
|
1943
1951
|
:data_format_conversion_configuration,
|
1944
|
-
:dynamic_partitioning_configuration
|
1952
|
+
:dynamic_partitioning_configuration,
|
1953
|
+
:file_extension,
|
1954
|
+
:custom_time_zone)
|
1945
1955
|
SENSITIVE = []
|
1946
1956
|
include Aws::Structure
|
1947
1957
|
end
|
@@ -1978,10 +1988,10 @@ module Aws::Firehose
|
|
1978
1988
|
# @return [String]
|
1979
1989
|
#
|
1980
1990
|
# @!attribute [rw] error_output_prefix
|
1981
|
-
# A prefix that
|
1982
|
-
#
|
1983
|
-
#
|
1984
|
-
#
|
1991
|
+
# A prefix that Firehose evaluates and adds to failed records before
|
1992
|
+
# writing them to S3. This prefix appears immediately following the
|
1993
|
+
# bucket name. For information about how to specify this prefix, see
|
1994
|
+
# [Custom Prefixes for Amazon S3 Objects][1].
|
1985
1995
|
#
|
1986
1996
|
#
|
1987
1997
|
#
|
@@ -2033,6 +2043,15 @@ module Aws::Firehose
|
|
2033
2043
|
# for Amazon S3 destinations.
|
2034
2044
|
# @return [Types::DynamicPartitioningConfiguration]
|
2035
2045
|
#
|
2046
|
+
# @!attribute [rw] file_extension
|
2047
|
+
# Specify a file extension. It will override the default file
|
2048
|
+
# extension
|
2049
|
+
# @return [String]
|
2050
|
+
#
|
2051
|
+
# @!attribute [rw] custom_time_zone
|
2052
|
+
# The time zone you prefer. UTC is the default.
|
2053
|
+
# @return [String]
|
2054
|
+
#
|
2036
2055
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/ExtendedS3DestinationUpdate AWS API Documentation
|
2037
2056
|
#
|
2038
2057
|
class ExtendedS3DestinationUpdate < Struct.new(
|
@@ -2048,7 +2067,9 @@ module Aws::Firehose
|
|
2048
2067
|
:s3_backup_mode,
|
2049
2068
|
:s3_backup_update,
|
2050
2069
|
:data_format_conversion_configuration,
|
2051
|
-
:dynamic_partitioning_configuration
|
2070
|
+
:dynamic_partitioning_configuration,
|
2071
|
+
:file_extension,
|
2072
|
+
:custom_time_zone)
|
2052
2073
|
SENSITIVE = []
|
2053
2074
|
include Aws::Structure
|
2054
2075
|
end
|
@@ -2074,22 +2095,46 @@ module Aws::Firehose
|
|
2074
2095
|
include Aws::Structure
|
2075
2096
|
end
|
2076
2097
|
|
2077
|
-
#
|
2078
|
-
#
|
2079
|
-
#
|
2080
|
-
#
|
2081
|
-
#
|
2082
|
-
|
2098
|
+
# @!attribute [rw] delivery_stream_arn
|
2099
|
+
# @return [String]
|
2100
|
+
#
|
2101
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/GetKinesisStreamInput AWS API Documentation
|
2102
|
+
#
|
2103
|
+
class GetKinesisStreamInput < Struct.new(
|
2104
|
+
:delivery_stream_arn)
|
2105
|
+
SENSITIVE = []
|
2106
|
+
include Aws::Structure
|
2107
|
+
end
|
2108
|
+
|
2109
|
+
# @!attribute [rw] kinesis_stream_arn
|
2110
|
+
# @return [String]
|
2111
|
+
#
|
2112
|
+
# @!attribute [rw] credentials_for_reading_kinesis_stream
|
2113
|
+
# @return [Types::SessionCredentials]
|
2114
|
+
#
|
2115
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/GetKinesisStreamOutput AWS API Documentation
|
2116
|
+
#
|
2117
|
+
class GetKinesisStreamOutput < Struct.new(
|
2118
|
+
:kinesis_stream_arn,
|
2119
|
+
:credentials_for_reading_kinesis_stream)
|
2120
|
+
SENSITIVE = [:credentials_for_reading_kinesis_stream]
|
2121
|
+
include Aws::Structure
|
2122
|
+
end
|
2123
|
+
|
2124
|
+
# The native Hive / HCatalog JsonSerDe. Used by Firehose for
|
2125
|
+
# deserializing data, which means converting it from the JSON format in
|
2126
|
+
# preparation for serializing it to the Parquet or ORC format. This is
|
2127
|
+
# one of two deserializers you can choose, depending on which one offers
|
2128
|
+
# the functionality you need. The other option is the OpenX SerDe.
|
2083
2129
|
#
|
2084
2130
|
# @!attribute [rw] timestamp_formats
|
2085
|
-
# Indicates how you want
|
2086
|
-
#
|
2087
|
-
#
|
2088
|
-
#
|
2089
|
-
#
|
2090
|
-
#
|
2091
|
-
#
|
2092
|
-
# default.
|
2131
|
+
# Indicates how you want Firehose to parse the date and timestamps
|
2132
|
+
# that may be present in your input data JSON. To specify these format
|
2133
|
+
# strings, follow the pattern syntax of JodaTime's DateTimeFormat
|
2134
|
+
# format strings. For more information, see [Class DateTimeFormat][1].
|
2135
|
+
# You can also use the special value `millis` to parse timestamps in
|
2136
|
+
# epoch milliseconds. If you don't specify a format, Firehose uses
|
2137
|
+
# `java.sql.Timestamp::valueOf` by default.
|
2093
2138
|
#
|
2094
2139
|
#
|
2095
2140
|
#
|
@@ -2105,11 +2150,11 @@ module Aws::Firehose
|
|
2105
2150
|
end
|
2106
2151
|
|
2107
2152
|
# Describes the buffering options that can be applied before data is
|
2108
|
-
# delivered to the HTTP endpoint destination.
|
2109
|
-
#
|
2110
|
-
#
|
2111
|
-
#
|
2112
|
-
#
|
2153
|
+
# delivered to the HTTP endpoint destination. Firehose treats these
|
2154
|
+
# options as hints, and it might choose to use more optimal values. The
|
2155
|
+
# `SizeInMBs` and `IntervalInSeconds` parameters are optional. However,
|
2156
|
+
# if specify a value for one of them, you must also provide a value for
|
2157
|
+
# the other.
|
2113
2158
|
#
|
2114
2159
|
# @!attribute [rw] size_in_m_bs
|
2115
2160
|
# Buffer incoming data to the specified size, in MBs, before
|
@@ -2217,11 +2262,11 @@ module Aws::Firehose
|
|
2217
2262
|
#
|
2218
2263
|
# @!attribute [rw] buffering_hints
|
2219
2264
|
# The buffering options that can be used before data is delivered to
|
2220
|
-
# the specified destination.
|
2221
|
-
#
|
2222
|
-
#
|
2223
|
-
#
|
2224
|
-
#
|
2265
|
+
# the specified destination. Firehose treats these options as hints,
|
2266
|
+
# and it might choose to use more optimal values. The `SizeInMBs` and
|
2267
|
+
# `IntervalInSeconds` parameters are optional. However, if you specify
|
2268
|
+
# a value for one of them, you must also provide a value for the
|
2269
|
+
# other.
|
2225
2270
|
# @return [Types::HttpEndpointBufferingHints]
|
2226
2271
|
#
|
2227
2272
|
# @!attribute [rw] cloud_watch_logging_options
|
@@ -2239,23 +2284,23 @@ module Aws::Firehose
|
|
2239
2284
|
# @return [Types::ProcessingConfiguration]
|
2240
2285
|
#
|
2241
2286
|
# @!attribute [rw] role_arn
|
2242
|
-
#
|
2243
|
-
#
|
2287
|
+
# Firehose uses this IAM role for all the permissions that the
|
2288
|
+
# delivery stream needs.
|
2244
2289
|
# @return [String]
|
2245
2290
|
#
|
2246
2291
|
# @!attribute [rw] retry_options
|
2247
|
-
# Describes the retry behavior in case
|
2248
|
-
#
|
2249
|
-
#
|
2250
|
-
#
|
2292
|
+
# Describes the retry behavior in case Firehose is unable to deliver
|
2293
|
+
# data to the specified HTTP endpoint destination, or if it doesn't
|
2294
|
+
# receive a valid acknowledgment of receipt from the specified HTTP
|
2295
|
+
# endpoint destination.
|
2251
2296
|
# @return [Types::HttpEndpointRetryOptions]
|
2252
2297
|
#
|
2253
2298
|
# @!attribute [rw] s3_backup_mode
|
2254
|
-
# Describes the S3 bucket backup options for the data that
|
2255
|
-
#
|
2256
|
-
#
|
2257
|
-
#
|
2258
|
-
#
|
2299
|
+
# Describes the S3 bucket backup options for the data that Firehose
|
2300
|
+
# delivers to the HTTP endpoint destination. You can back up all
|
2301
|
+
# documents (`AllData`) or only the documents that Firehose could not
|
2302
|
+
# deliver to the specified HTTP endpoint destination
|
2303
|
+
# (`FailedDataOnly`).
|
2259
2304
|
# @return [String]
|
2260
2305
|
#
|
2261
2306
|
# @!attribute [rw] s3_configuration
|
@@ -2286,11 +2331,11 @@ module Aws::Firehose
|
|
2286
2331
|
#
|
2287
2332
|
# @!attribute [rw] buffering_hints
|
2288
2333
|
# Describes buffering options that can be applied to the data before
|
2289
|
-
# it is delivered to the HTTPS endpoint destination.
|
2290
|
-
#
|
2291
|
-
#
|
2292
|
-
#
|
2293
|
-
#
|
2334
|
+
# it is delivered to the HTTPS endpoint destination. Firehose teats
|
2335
|
+
# these options as hints, and it might choose to use more optimal
|
2336
|
+
# values. The `SizeInMBs` and `IntervalInSeconds` parameters are
|
2337
|
+
# optional. However, if specify a value for one of them, you must also
|
2338
|
+
# provide a value for the other.
|
2294
2339
|
# @return [Types::HttpEndpointBufferingHints]
|
2295
2340
|
#
|
2296
2341
|
# @!attribute [rw] cloud_watch_logging_options
|
@@ -2308,23 +2353,23 @@ module Aws::Firehose
|
|
2308
2353
|
# @return [Types::ProcessingConfiguration]
|
2309
2354
|
#
|
2310
2355
|
# @!attribute [rw] role_arn
|
2311
|
-
#
|
2312
|
-
#
|
2356
|
+
# Firehose uses this IAM role for all the permissions that the
|
2357
|
+
# delivery stream needs.
|
2313
2358
|
# @return [String]
|
2314
2359
|
#
|
2315
2360
|
# @!attribute [rw] retry_options
|
2316
|
-
# Describes the retry behavior in case
|
2317
|
-
#
|
2318
|
-
#
|
2319
|
-
#
|
2361
|
+
# Describes the retry behavior in case Firehose is unable to deliver
|
2362
|
+
# data to the specified HTTP endpoint destination, or if it doesn't
|
2363
|
+
# receive a valid acknowledgment of receipt from the specified HTTP
|
2364
|
+
# endpoint destination.
|
2320
2365
|
# @return [Types::HttpEndpointRetryOptions]
|
2321
2366
|
#
|
2322
2367
|
# @!attribute [rw] s3_backup_mode
|
2323
2368
|
# Describes the S3 bucket backup options for the data that Kinesis
|
2324
2369
|
# Firehose delivers to the HTTP endpoint destination. You can back up
|
2325
|
-
# all documents (`AllData`) or only the documents that
|
2326
|
-
#
|
2327
|
-
#
|
2370
|
+
# all documents (`AllData`) or only the documents that Firehose could
|
2371
|
+
# not deliver to the specified HTTP endpoint destination
|
2372
|
+
# (`FailedDataOnly`).
|
2328
2373
|
# @return [String]
|
2329
2374
|
#
|
2330
2375
|
# @!attribute [rw] s3_destination_description
|
@@ -2355,11 +2400,11 @@ module Aws::Firehose
|
|
2355
2400
|
#
|
2356
2401
|
# @!attribute [rw] buffering_hints
|
2357
2402
|
# Describes buffering options that can be applied to the data before
|
2358
|
-
# it is delivered to the HTTPS endpoint destination.
|
2359
|
-
#
|
2360
|
-
#
|
2361
|
-
#
|
2362
|
-
#
|
2403
|
+
# it is delivered to the HTTPS endpoint destination. Firehose teats
|
2404
|
+
# these options as hints, and it might choose to use more optimal
|
2405
|
+
# values. The `SizeInMBs` and `IntervalInSeconds` parameters are
|
2406
|
+
# optional. However, if specify a value for one of them, you must also
|
2407
|
+
# provide a value for the other.
|
2363
2408
|
# @return [Types::HttpEndpointBufferingHints]
|
2364
2409
|
#
|
2365
2410
|
# @!attribute [rw] cloud_watch_logging_options
|
@@ -2377,23 +2422,23 @@ module Aws::Firehose
|
|
2377
2422
|
# @return [Types::ProcessingConfiguration]
|
2378
2423
|
#
|
2379
2424
|
# @!attribute [rw] role_arn
|
2380
|
-
#
|
2381
|
-
#
|
2425
|
+
# Firehose uses this IAM role for all the permissions that the
|
2426
|
+
# delivery stream needs.
|
2382
2427
|
# @return [String]
|
2383
2428
|
#
|
2384
2429
|
# @!attribute [rw] retry_options
|
2385
|
-
# Describes the retry behavior in case
|
2386
|
-
#
|
2387
|
-
#
|
2388
|
-
#
|
2430
|
+
# Describes the retry behavior in case Firehose is unable to deliver
|
2431
|
+
# data to the specified HTTP endpoint destination, or if it doesn't
|
2432
|
+
# receive a valid acknowledgment of receipt from the specified HTTP
|
2433
|
+
# endpoint destination.
|
2389
2434
|
# @return [Types::HttpEndpointRetryOptions]
|
2390
2435
|
#
|
2391
2436
|
# @!attribute [rw] s3_backup_mode
|
2392
2437
|
# Describes the S3 bucket backup options for the data that Kinesis
|
2393
2438
|
# Firehose delivers to the HTTP endpoint destination. You can back up
|
2394
|
-
# all documents (`AllData`) or only the documents that
|
2395
|
-
#
|
2396
|
-
#
|
2439
|
+
# all documents (`AllData`) or only the documents that Firehose could
|
2440
|
+
# not deliver to the specified HTTP endpoint destination
|
2441
|
+
# (`FailedDataOnly`).
|
2397
2442
|
# @return [String]
|
2398
2443
|
#
|
2399
2444
|
# @!attribute [rw] s3_update
|
@@ -2419,10 +2464,10 @@ module Aws::Firehose
|
|
2419
2464
|
# The configuration of the HTTP endpoint request.
|
2420
2465
|
#
|
2421
2466
|
# @!attribute [rw] content_encoding
|
2422
|
-
#
|
2423
|
-
#
|
2424
|
-
#
|
2425
|
-
#
|
2467
|
+
# Firehose uses the content encoding to compress the body of a request
|
2468
|
+
# before sending the request to the destination. For more information,
|
2469
|
+
# see [Content-Encoding][1] in MDN Web Docs, the official Mozilla
|
2470
|
+
# documentation.
|
2426
2471
|
#
|
2427
2472
|
#
|
2428
2473
|
#
|
@@ -2442,17 +2487,17 @@ module Aws::Firehose
|
|
2442
2487
|
include Aws::Structure
|
2443
2488
|
end
|
2444
2489
|
|
2445
|
-
# Describes the retry behavior in case
|
2446
|
-
#
|
2447
|
-
#
|
2448
|
-
#
|
2490
|
+
# Describes the retry behavior in case Firehose is unable to deliver
|
2491
|
+
# data to the specified HTTP endpoint destination, or if it doesn't
|
2492
|
+
# receive a valid acknowledgment of receipt from the specified HTTP
|
2493
|
+
# endpoint destination.
|
2449
2494
|
#
|
2450
2495
|
# @!attribute [rw] duration_in_seconds
|
2451
|
-
# The total amount of time that
|
2452
|
-
#
|
2453
|
-
#
|
2454
|
-
#
|
2455
|
-
#
|
2496
|
+
# The total amount of time that Firehose spends on retries. This
|
2497
|
+
# duration starts after the initial attempt to send data to the custom
|
2498
|
+
# destination via HTTPS endpoint fails. It doesn't include the
|
2499
|
+
# periods during which Firehose waits for acknowledgment from the
|
2500
|
+
# specified destination after each attempt.
|
2456
2501
|
# @return [Integer]
|
2457
2502
|
#
|
2458
2503
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/HttpEndpointRetryOptions AWS API Documentation
|
@@ -2495,11 +2540,11 @@ module Aws::Firehose
|
|
2495
2540
|
include Aws::Structure
|
2496
2541
|
end
|
2497
2542
|
|
2498
|
-
#
|
2499
|
-
#
|
2500
|
-
#
|
2501
|
-
#
|
2502
|
-
#
|
2543
|
+
# Firehose throws this exception when an attempt to put records or to
|
2544
|
+
# start or stop delivery stream encryption fails. This happens when the
|
2545
|
+
# KMS service throws one of the following exception types:
|
2546
|
+
# `AccessDeniedException`, `InvalidStateException`, `DisabledException`,
|
2547
|
+
# or `NotFoundException`.
|
2503
2548
|
#
|
2504
2549
|
# @!attribute [rw] code
|
2505
2550
|
# @return [String]
|
@@ -2534,6 +2579,21 @@ module Aws::Firehose
|
|
2534
2579
|
include Aws::Structure
|
2535
2580
|
end
|
2536
2581
|
|
2582
|
+
# @!attribute [rw] message
|
2583
|
+
# @return [String]
|
2584
|
+
#
|
2585
|
+
# @!attribute [rw] source
|
2586
|
+
# @return [String]
|
2587
|
+
#
|
2588
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/InvalidStreamTypeException AWS API Documentation
|
2589
|
+
#
|
2590
|
+
class InvalidStreamTypeException < Struct.new(
|
2591
|
+
:message,
|
2592
|
+
:source)
|
2593
|
+
SENSITIVE = []
|
2594
|
+
include Aws::Structure
|
2595
|
+
end
|
2596
|
+
|
2537
2597
|
# Describes an encryption key for a destination in Amazon S3.
|
2538
2598
|
#
|
2539
2599
|
# @!attribute [rw] awskms_key_arn
|
@@ -2586,8 +2646,8 @@ module Aws::Firehose
|
|
2586
2646
|
include Aws::Structure
|
2587
2647
|
end
|
2588
2648
|
|
2589
|
-
# Details about a Kinesis data stream used as the source for a
|
2590
|
-
#
|
2649
|
+
# Details about a Kinesis data stream used as the source for a Firehose
|
2650
|
+
# delivery stream.
|
2591
2651
|
#
|
2592
2652
|
# @!attribute [rw] kinesis_stream_arn
|
2593
2653
|
# The Amazon Resource Name (ARN) of the source Kinesis data stream.
|
@@ -2610,8 +2670,8 @@ module Aws::Firehose
|
|
2610
2670
|
# @return [String]
|
2611
2671
|
#
|
2612
2672
|
# @!attribute [rw] delivery_start_timestamp
|
2613
|
-
#
|
2614
|
-
#
|
2673
|
+
# Firehose starts retrieving records from the Kinesis data stream
|
2674
|
+
# starting with this timestamp.
|
2615
2675
|
# @return [Time]
|
2616
2676
|
#
|
2617
2677
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/KinesisStreamSourceDescription AWS API Documentation
|
@@ -2763,8 +2823,8 @@ module Aws::Firehose
|
|
2763
2823
|
include Aws::Structure
|
2764
2824
|
end
|
2765
2825
|
|
2766
|
-
# Details about the Amazon MSK cluster used as the source for a
|
2767
|
-
#
|
2826
|
+
# Details about the Amazon MSK cluster used as the source for a Firehose
|
2827
|
+
# delivery stream.
|
2768
2828
|
#
|
2769
2829
|
# @!attribute [rw] msk_cluster_arn
|
2770
2830
|
# The ARN of the Amazon MSK cluster.
|
@@ -2779,8 +2839,8 @@ module Aws::Firehose
|
|
2779
2839
|
# @return [Types::AuthenticationConfiguration]
|
2780
2840
|
#
|
2781
2841
|
# @!attribute [rw] delivery_start_timestamp
|
2782
|
-
#
|
2783
|
-
#
|
2842
|
+
# Firehose starts retrieving records from the topic within the Amazon
|
2843
|
+
# MSK cluster starting with this timestamp.
|
2784
2844
|
# @return [Time]
|
2785
2845
|
#
|
2786
2846
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/MSKSourceDescription AWS API Documentation
|
@@ -2794,27 +2854,26 @@ module Aws::Firehose
|
|
2794
2854
|
include Aws::Structure
|
2795
2855
|
end
|
2796
2856
|
|
2797
|
-
# The OpenX SerDe. Used by
|
2798
|
-
#
|
2799
|
-
#
|
2800
|
-
#
|
2801
|
-
#
|
2802
|
-
# JsonSerDe.
|
2857
|
+
# The OpenX SerDe. Used by Firehose for deserializing data, which means
|
2858
|
+
# converting it from the JSON format in preparation for serializing it
|
2859
|
+
# to the Parquet or ORC format. This is one of two deserializers you can
|
2860
|
+
# choose, depending on which one offers the functionality you need. The
|
2861
|
+
# other option is the native Hive / HCatalog JsonSerDe.
|
2803
2862
|
#
|
2804
2863
|
# @!attribute [rw] convert_dots_in_json_keys_to_underscores
|
2805
2864
|
# When set to `true`, specifies that the names of the keys include
|
2806
|
-
# dots and that you want
|
2807
|
-
#
|
2808
|
-
#
|
2809
|
-
#
|
2865
|
+
# dots and that you want Firehose to replace them with underscores.
|
2866
|
+
# This is useful because Apache Hive does not allow dots in column
|
2867
|
+
# names. For example, if the JSON contains a key whose name is
|
2868
|
+
# "a.b", you can define the column name to be "a\_b" when using
|
2810
2869
|
# this option.
|
2811
2870
|
#
|
2812
2871
|
# The default is `false`.
|
2813
2872
|
# @return [Boolean]
|
2814
2873
|
#
|
2815
2874
|
# @!attribute [rw] case_insensitive
|
2816
|
-
# When set to `true`, which is the default,
|
2817
|
-
#
|
2875
|
+
# When set to `true`, which is the default, Firehose converts JSON
|
2876
|
+
# keys to lowercase before deserializing them.
|
2818
2877
|
# @return [Boolean]
|
2819
2878
|
#
|
2820
2879
|
# @!attribute [rw] column_to_json_key_mappings
|
@@ -2850,8 +2909,8 @@ module Aws::Firehose
|
|
2850
2909
|
# @!attribute [rw] block_size_bytes
|
2851
2910
|
# The Hadoop Distributed File System (HDFS) block size. This is useful
|
2852
2911
|
# if you intend to copy the data from Amazon S3 to HDFS before
|
2853
|
-
# querying. The default is 256 MiB and the minimum is 64 MiB.
|
2854
|
-
#
|
2912
|
+
# querying. The default is 256 MiB and the minimum is 64 MiB. Firehose
|
2913
|
+
# uses this value for padding calculations.
|
2855
2914
|
# @return [Integer]
|
2856
2915
|
#
|
2857
2916
|
# @!attribute [rw] row_index_stride
|
@@ -2878,8 +2937,8 @@ module Aws::Firehose
|
|
2878
2937
|
# ensures that no stripe crosses block boundaries and causes remote
|
2879
2938
|
# reads within a node-local task.
|
2880
2939
|
#
|
2881
|
-
#
|
2882
|
-
#
|
2940
|
+
# Firehose ignores this parameter when OrcSerDe$EnablePadding is
|
2941
|
+
# `false`.
|
2883
2942
|
# @return [Float]
|
2884
2943
|
#
|
2885
2944
|
# @!attribute [rw] compression
|
@@ -2888,8 +2947,8 @@ module Aws::Firehose
|
|
2888
2947
|
# @return [String]
|
2889
2948
|
#
|
2890
2949
|
# @!attribute [rw] bloom_filter_columns
|
2891
|
-
# The column names for which you want
|
2892
|
-
#
|
2950
|
+
# The column names for which you want Firehose to create bloom
|
2951
|
+
# filters. The default is `null`.
|
2893
2952
|
# @return [Array<String>]
|
2894
2953
|
#
|
2895
2954
|
# @!attribute [rw] bloom_filter_false_positive_probability
|
@@ -2927,9 +2986,9 @@ module Aws::Firehose
|
|
2927
2986
|
include Aws::Structure
|
2928
2987
|
end
|
2929
2988
|
|
2930
|
-
# Specifies the serializer that you want
|
2931
|
-
#
|
2932
|
-
#
|
2989
|
+
# Specifies the serializer that you want Firehose to use to convert the
|
2990
|
+
# format of your data before it writes it to Amazon S3. This parameter
|
2991
|
+
# is required if `Enabled` is set to true.
|
2933
2992
|
#
|
2934
2993
|
# @!attribute [rw] serializer
|
2935
2994
|
# Specifies which serializer to use. You can choose either the ORC
|
@@ -2956,8 +3015,8 @@ module Aws::Firehose
|
|
2956
3015
|
# @!attribute [rw] block_size_bytes
|
2957
3016
|
# The Hadoop Distributed File System (HDFS) block size. This is useful
|
2958
3017
|
# if you intend to copy the data from Amazon S3 to HDFS before
|
2959
|
-
# querying. The default is 256 MiB and the minimum is 64 MiB.
|
2960
|
-
#
|
3018
|
+
# querying. The default is 256 MiB and the minimum is 64 MiB. Firehose
|
3019
|
+
# uses this value for padding calculations.
|
2961
3020
|
# @return [Integer]
|
2962
3021
|
#
|
2963
3022
|
# @!attribute [rw] page_size_bytes
|
@@ -3022,6 +3081,13 @@ module Aws::Firehose
|
|
3022
3081
|
|
3023
3082
|
# Describes a data processor.
|
3024
3083
|
#
|
3084
|
+
# <note markdown="1"> If you want to add a new line delimiter between records in objects
|
3085
|
+
# that are delivered to Amazon S3, choose `AppendDelimiterToRecord` as a
|
3086
|
+
# processor type. You don’t have to put a processor parameter when you
|
3087
|
+
# select `AppendDelimiterToRecord`.
|
3088
|
+
#
|
3089
|
+
# </note>
|
3090
|
+
#
|
3025
3091
|
# @!attribute [rw] type
|
3026
3092
|
# The type of processor.
|
3027
3093
|
# @return [String]
|
@@ -3215,9 +3281,8 @@ module Aws::Firehose
|
|
3215
3281
|
# @return [String]
|
3216
3282
|
#
|
3217
3283
|
# @!attribute [rw] retry_options
|
3218
|
-
# The retry behavior in case
|
3219
|
-
#
|
3220
|
-
# minutes).
|
3284
|
+
# The retry behavior in case Firehose is unable to deliver documents
|
3285
|
+
# to Amazon Redshift. Default value is 3600 (60 minutes).
|
3221
3286
|
# @return [Types::RedshiftRetryOptions]
|
3222
3287
|
#
|
3223
3288
|
# @!attribute [rw] s3_configuration
|
@@ -3293,9 +3358,8 @@ module Aws::Firehose
|
|
3293
3358
|
# @return [String]
|
3294
3359
|
#
|
3295
3360
|
# @!attribute [rw] retry_options
|
3296
|
-
# The retry behavior in case
|
3297
|
-
#
|
3298
|
-
# minutes).
|
3361
|
+
# The retry behavior in case Firehose is unable to deliver documents
|
3362
|
+
# to Amazon Redshift. Default value is 3600 (60 minutes).
|
3299
3363
|
# @return [Types::RedshiftRetryOptions]
|
3300
3364
|
#
|
3301
3365
|
# @!attribute [rw] s3_destination_description
|
@@ -3364,9 +3428,8 @@ module Aws::Firehose
|
|
3364
3428
|
# @return [String]
|
3365
3429
|
#
|
3366
3430
|
# @!attribute [rw] retry_options
|
3367
|
-
# The retry behavior in case
|
3368
|
-
#
|
3369
|
-
# minutes).
|
3431
|
+
# The retry behavior in case Firehose is unable to deliver documents
|
3432
|
+
# to Amazon Redshift. Default value is 3600 (60 minutes).
|
3370
3433
|
# @return [Types::RedshiftRetryOptions]
|
3371
3434
|
#
|
3372
3435
|
# @!attribute [rw] s3_update
|
@@ -3414,16 +3477,15 @@ module Aws::Firehose
|
|
3414
3477
|
include Aws::Structure
|
3415
3478
|
end
|
3416
3479
|
|
3417
|
-
# Configures retry behavior in case
|
3418
|
-
#
|
3480
|
+
# Configures retry behavior in case Firehose is unable to deliver
|
3481
|
+
# documents to Amazon Redshift.
|
3419
3482
|
#
|
3420
3483
|
# @!attribute [rw] duration_in_seconds
|
3421
|
-
# The length of time during which
|
3422
|
-
#
|
3423
|
-
#
|
3424
|
-
#
|
3425
|
-
#
|
3426
|
-
# takes longer than the current value.
|
3484
|
+
# The length of time during which Firehose retries delivery after a
|
3485
|
+
# failure, starting from the initial request and including the first
|
3486
|
+
# attempt. The default value is 3600 seconds (60 minutes). Firehose
|
3487
|
+
# does not retry if the value of `DurationInSeconds` is 0 (zero) or if
|
3488
|
+
# the first delivery attempt takes longer than the current value.
|
3427
3489
|
# @return [Integer]
|
3428
3490
|
#
|
3429
3491
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/RedshiftRetryOptions AWS API Documentation
|
@@ -3462,12 +3524,12 @@ module Aws::Firehose
|
|
3462
3524
|
include Aws::Structure
|
3463
3525
|
end
|
3464
3526
|
|
3465
|
-
# The retry behavior in case
|
3466
|
-
#
|
3527
|
+
# The retry behavior in case Firehose is unable to deliver data to an
|
3528
|
+
# Amazon S3 prefix.
|
3467
3529
|
#
|
3468
3530
|
# @!attribute [rw] duration_in_seconds
|
3469
|
-
# The period of time during which
|
3470
|
-
#
|
3531
|
+
# The period of time during which Firehose retries to deliver data to
|
3532
|
+
# the specified Amazon S3 prefix.
|
3471
3533
|
# @return [Integer]
|
3472
3534
|
#
|
3473
3535
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/RetryOptions AWS API Documentation
|
@@ -3510,10 +3572,10 @@ module Aws::Firehose
|
|
3510
3572
|
# @return [String]
|
3511
3573
|
#
|
3512
3574
|
# @!attribute [rw] error_output_prefix
|
3513
|
-
# A prefix that
|
3514
|
-
#
|
3515
|
-
#
|
3516
|
-
#
|
3575
|
+
# A prefix that Firehose evaluates and adds to failed records before
|
3576
|
+
# writing them to S3. This prefix appears immediately following the
|
3577
|
+
# bucket name. For information about how to specify this prefix, see
|
3578
|
+
# [Custom Prefixes for Amazon S3 Objects][1].
|
3517
3579
|
#
|
3518
3580
|
#
|
3519
3581
|
#
|
@@ -3590,10 +3652,10 @@ module Aws::Firehose
|
|
3590
3652
|
# @return [String]
|
3591
3653
|
#
|
3592
3654
|
# @!attribute [rw] error_output_prefix
|
3593
|
-
# A prefix that
|
3594
|
-
#
|
3595
|
-
#
|
3596
|
-
#
|
3655
|
+
# A prefix that Firehose evaluates and adds to failed records before
|
3656
|
+
# writing them to S3. This prefix appears immediately following the
|
3657
|
+
# bucket name. For information about how to specify this prefix, see
|
3658
|
+
# [Custom Prefixes for Amazon S3 Objects][1].
|
3597
3659
|
#
|
3598
3660
|
#
|
3599
3661
|
#
|
@@ -3666,10 +3728,10 @@ module Aws::Firehose
|
|
3666
3728
|
# @return [String]
|
3667
3729
|
#
|
3668
3730
|
# @!attribute [rw] error_output_prefix
|
3669
|
-
# A prefix that
|
3670
|
-
#
|
3671
|
-
#
|
3672
|
-
#
|
3731
|
+
# A prefix that Firehose evaluates and adds to failed records before
|
3732
|
+
# writing them to S3. This prefix appears immediately following the
|
3733
|
+
# bucket name. For information about how to specify this prefix, see
|
3734
|
+
# [Custom Prefixes for Amazon S3 Objects][1].
|
3673
3735
|
#
|
3674
3736
|
#
|
3675
3737
|
#
|
@@ -3714,14 +3776,14 @@ module Aws::Firehose
|
|
3714
3776
|
include Aws::Structure
|
3715
3777
|
end
|
3716
3778
|
|
3717
|
-
# Specifies the schema to which you want
|
3718
|
-
#
|
3719
|
-
#
|
3779
|
+
# Specifies the schema to which you want Firehose to configure your data
|
3780
|
+
# before it writes it to Amazon S3. This parameter is required if
|
3781
|
+
# `Enabled` is set to true.
|
3720
3782
|
#
|
3721
3783
|
# @!attribute [rw] role_arn
|
3722
|
-
# The role that
|
3723
|
-
#
|
3724
|
-
#
|
3784
|
+
# The role that Firehose can use to access Amazon Web Services Glue.
|
3785
|
+
# This role must be in the same account you use for Firehose.
|
3786
|
+
# Cross-account roles aren't allowed.
|
3725
3787
|
#
|
3726
3788
|
# If the `SchemaConfiguration` request parameter is used as part of
|
3727
3789
|
# invoking the `CreateDeliveryStream` API, then the `RoleARN` property
|
@@ -3759,8 +3821,8 @@ module Aws::Firehose
|
|
3759
3821
|
# @!attribute [rw] version_id
|
3760
3822
|
# Specifies the table version for the output data schema. If you
|
3761
3823
|
# don't specify this version ID, or if you set it to `LATEST`,
|
3762
|
-
#
|
3763
|
-
#
|
3824
|
+
# Firehose uses the most recent version. This means that any updates
|
3825
|
+
# to the table are automatically picked up.
|
3764
3826
|
# @return [String]
|
3765
3827
|
#
|
3766
3828
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/SchemaConfiguration AWS API Documentation
|
@@ -3776,10 +3838,9 @@ module Aws::Firehose
|
|
3776
3838
|
include Aws::Structure
|
3777
3839
|
end
|
3778
3840
|
|
3779
|
-
# The serializer that you want
|
3780
|
-
#
|
3781
|
-
#
|
3782
|
-
# [Parquet SerDe][2].
|
3841
|
+
# The serializer that you want Firehose to use to convert data to the
|
3842
|
+
# target format before writing it to Amazon S3. Firehose supports two
|
3843
|
+
# types of serializers: the [ORC SerDe][1] and the [Parquet SerDe][2].
|
3783
3844
|
#
|
3784
3845
|
#
|
3785
3846
|
#
|
@@ -3817,8 +3878,7 @@ module Aws::Firehose
|
|
3817
3878
|
# The service is unavailable. Back off and retry the operation. If you
|
3818
3879
|
# continue to see the exception, throughput limits for the delivery
|
3819
3880
|
# stream may have been exceeded. For more information about limits and
|
3820
|
-
# how to request an increase, see [Amazon
|
3821
|
-
# Limits][1].
|
3881
|
+
# how to request an increase, see [Amazon Firehose Limits][1].
|
3822
3882
|
#
|
3823
3883
|
#
|
3824
3884
|
#
|
@@ -3836,6 +3896,29 @@ module Aws::Firehose
|
|
3836
3896
|
include Aws::Structure
|
3837
3897
|
end
|
3838
3898
|
|
3899
|
+
# @!attribute [rw] access_key_id
|
3900
|
+
# @return [String]
|
3901
|
+
#
|
3902
|
+
# @!attribute [rw] secret_access_key
|
3903
|
+
# @return [String]
|
3904
|
+
#
|
3905
|
+
# @!attribute [rw] session_token
|
3906
|
+
# @return [String]
|
3907
|
+
#
|
3908
|
+
# @!attribute [rw] expiration
|
3909
|
+
# @return [Time]
|
3910
|
+
#
|
3911
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/SessionCredentials AWS API Documentation
|
3912
|
+
#
|
3913
|
+
class SessionCredentials < Struct.new(
|
3914
|
+
:access_key_id,
|
3915
|
+
:secret_access_key,
|
3916
|
+
:session_token,
|
3917
|
+
:expiration)
|
3918
|
+
SENSITIVE = [:access_key_id, :secret_access_key, :session_token]
|
3919
|
+
include Aws::Structure
|
3920
|
+
end
|
3921
|
+
|
3839
3922
|
# Configure Snowflake destination
|
3840
3923
|
#
|
3841
3924
|
# @!attribute [rw] account_url
|
@@ -3929,8 +4012,8 @@ module Aws::Firehose
|
|
3929
4012
|
# @return [String]
|
3930
4013
|
#
|
3931
4014
|
# @!attribute [rw] retry_options
|
3932
|
-
# The time period where
|
3933
|
-
#
|
4015
|
+
# The time period where Firehose will retry sending data to the chosen
|
4016
|
+
# HTTP endpoint.
|
3934
4017
|
# @return [Types::SnowflakeRetryOptions]
|
3935
4018
|
#
|
3936
4019
|
# @!attribute [rw] s3_backup_mode
|
@@ -4039,8 +4122,8 @@ module Aws::Firehose
|
|
4039
4122
|
# @return [String]
|
4040
4123
|
#
|
4041
4124
|
# @!attribute [rw] retry_options
|
4042
|
-
# The time period where
|
4043
|
-
#
|
4125
|
+
# The time period where Firehose will retry sending data to the chosen
|
4126
|
+
# HTTP endpoint.
|
4044
4127
|
# @return [Types::SnowflakeRetryOptions]
|
4045
4128
|
#
|
4046
4129
|
# @!attribute [rw] s3_backup_mode
|
@@ -4157,26 +4240,24 @@ module Aws::Firehose
|
|
4157
4240
|
# @return [String]
|
4158
4241
|
#
|
4159
4242
|
# @!attribute [rw] retry_options
|
4160
|
-
# Specify how long
|
4161
|
-
#
|
4162
|
-
#
|
4163
|
-
#
|
4164
|
-
#
|
4165
|
-
#
|
4166
|
-
#
|
4167
|
-
#
|
4168
|
-
# Every time that Kinesis Data Firehose sends data to the HTTP
|
4243
|
+
# Specify how long Firehose retries sending data to the New Relic HTTP
|
4244
|
+
# endpoint. After sending data, Firehose first waits for an
|
4245
|
+
# acknowledgment from the HTTP endpoint. If an error occurs or the
|
4246
|
+
# acknowledgment doesn’t arrive within the acknowledgment timeout
|
4247
|
+
# period, Firehose starts the retry duration counter. It keeps
|
4248
|
+
# retrying until the retry duration expires. After that, Firehose
|
4249
|
+
# considers it a data delivery failure and backs up the data to your
|
4250
|
+
# Amazon S3 bucket. Every time that Firehose sends data to the HTTP
|
4169
4251
|
# endpoint (either the initial attempt or a retry), it restarts the
|
4170
4252
|
# acknowledgement timeout counter and waits for an acknowledgement
|
4171
|
-
# from the HTTP endpoint. Even if the retry duration expires,
|
4172
|
-
#
|
4173
|
-
#
|
4174
|
-
#
|
4175
|
-
#
|
4176
|
-
#
|
4177
|
-
#
|
4178
|
-
#
|
4179
|
-
# value to 0.
|
4253
|
+
# from the HTTP endpoint. Even if the retry duration expires, Firehose
|
4254
|
+
# still waits for the acknowledgment until it receives it or the
|
4255
|
+
# acknowledgement timeout period is reached. If the acknowledgment
|
4256
|
+
# times out, Firehose determines whether there's time left in the
|
4257
|
+
# retry counter. If there is time left, it retries again and repeats
|
4258
|
+
# the logic until it receives an acknowledgment or determines that the
|
4259
|
+
# retry time has expired. If you don't want Firehose to retry sending
|
4260
|
+
# data, set this value to 0.
|
4180
4261
|
# @return [Types::SnowflakeRetryOptions]
|
4181
4262
|
#
|
4182
4263
|
# @!attribute [rw] s3_backup_mode
|
@@ -4211,29 +4292,27 @@ module Aws::Firehose
|
|
4211
4292
|
include Aws::Structure
|
4212
4293
|
end
|
4213
4294
|
|
4214
|
-
# Specify how long
|
4215
|
-
#
|
4216
|
-
#
|
4217
|
-
#
|
4218
|
-
# period,
|
4219
|
-
#
|
4220
|
-
#
|
4221
|
-
#
|
4222
|
-
#
|
4223
|
-
#
|
4224
|
-
#
|
4225
|
-
#
|
4226
|
-
#
|
4227
|
-
#
|
4228
|
-
#
|
4229
|
-
#
|
4230
|
-
#
|
4231
|
-
# don't want Kinesis Data Firehose to retry sending data, set this
|
4232
|
-
# value to 0.
|
4295
|
+
# Specify how long Firehose retries sending data to the New Relic HTTP
|
4296
|
+
# endpoint. After sending data, Firehose first waits for an
|
4297
|
+
# acknowledgment from the HTTP endpoint. If an error occurs or the
|
4298
|
+
# acknowledgment doesn’t arrive within the acknowledgment timeout
|
4299
|
+
# period, Firehose starts the retry duration counter. It keeps retrying
|
4300
|
+
# until the retry duration expires. After that, Firehose considers it a
|
4301
|
+
# data delivery failure and backs up the data to your Amazon S3 bucket.
|
4302
|
+
# Every time that Firehose sends data to the HTTP endpoint (either the
|
4303
|
+
# initial attempt or a retry), it restarts the acknowledgement timeout
|
4304
|
+
# counter and waits for an acknowledgement from the HTTP endpoint. Even
|
4305
|
+
# if the retry duration expires, Firehose still waits for the
|
4306
|
+
# acknowledgment until it receives it or the acknowledgement timeout
|
4307
|
+
# period is reached. If the acknowledgment times out, Firehose
|
4308
|
+
# determines whether there's time left in the retry counter. If there
|
4309
|
+
# is time left, it retries again and repeats the logic until it receives
|
4310
|
+
# an acknowledgment or determines that the retry time has expired. If
|
4311
|
+
# you don't want Firehose to retry sending data, set this value to 0.
|
4233
4312
|
#
|
4234
4313
|
# @!attribute [rw] duration_in_seconds
|
4235
|
-
# the time period where
|
4236
|
-
#
|
4314
|
+
# the time period where Firehose will retry sending data to the chosen
|
4315
|
+
# HTTP endpoint.
|
4237
4316
|
# @return [Integer]
|
4238
4317
|
#
|
4239
4318
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/SnowflakeRetryOptions AWS API Documentation
|
@@ -4284,8 +4363,8 @@ module Aws::Firehose
|
|
4284
4363
|
include Aws::Structure
|
4285
4364
|
end
|
4286
4365
|
|
4287
|
-
# Details about a Kinesis data stream used as the source for a
|
4288
|
-
#
|
4366
|
+
# Details about a Kinesis data stream used as the source for a Firehose
|
4367
|
+
# delivery stream.
|
4289
4368
|
#
|
4290
4369
|
# @!attribute [rw] kinesis_stream_source_description
|
4291
4370
|
# The KinesisStreamSourceDescription value for the source Kinesis data
|
@@ -4332,8 +4411,8 @@ module Aws::Firehose
|
|
4332
4411
|
# Describes the configuration of a destination in Splunk.
|
4333
4412
|
#
|
4334
4413
|
# @!attribute [rw] hec_endpoint
|
4335
|
-
# The HTTP Event Collector (HEC) endpoint to which
|
4336
|
-
#
|
4414
|
+
# The HTTP Event Collector (HEC) endpoint to which Firehose sends your
|
4415
|
+
# data.
|
4337
4416
|
# @return [String]
|
4338
4417
|
#
|
4339
4418
|
# @!attribute [rw] hec_endpoint_type
|
@@ -4346,25 +4425,25 @@ module Aws::Firehose
|
|
4346
4425
|
# @return [String]
|
4347
4426
|
#
|
4348
4427
|
# @!attribute [rw] hec_acknowledgment_timeout_in_seconds
|
4349
|
-
# The amount of time that
|
4350
|
-
#
|
4351
|
-
#
|
4352
|
-
#
|
4428
|
+
# The amount of time that Firehose waits to receive an acknowledgment
|
4429
|
+
# from Splunk after it sends it data. At the end of the timeout
|
4430
|
+
# period, Firehose either tries to send the data again or considers it
|
4431
|
+
# an error, based on your retry settings.
|
4353
4432
|
# @return [Integer]
|
4354
4433
|
#
|
4355
4434
|
# @!attribute [rw] retry_options
|
4356
|
-
# The retry behavior in case
|
4357
|
-
#
|
4358
|
-
#
|
4435
|
+
# The retry behavior in case Firehose is unable to deliver data to
|
4436
|
+
# Splunk, or if it doesn't receive an acknowledgment of receipt from
|
4437
|
+
# Splunk.
|
4359
4438
|
# @return [Types::SplunkRetryOptions]
|
4360
4439
|
#
|
4361
4440
|
# @!attribute [rw] s3_backup_mode
|
4362
4441
|
# Defines how documents should be delivered to Amazon S3. When set to
|
4363
|
-
# `FailedEventsOnly`,
|
4364
|
-
#
|
4365
|
-
# `AllEvents`,
|
4366
|
-
#
|
4367
|
-
#
|
4442
|
+
# `FailedEventsOnly`, Firehose writes any data that could not be
|
4443
|
+
# indexed to the configured Amazon S3 destination. When set to
|
4444
|
+
# `AllEvents`, Firehose delivers all incoming records to Amazon S3,
|
4445
|
+
# and also writes failed documents to Amazon S3. The default value is
|
4446
|
+
# `FailedEventsOnly`.
|
4368
4447
|
#
|
4369
4448
|
# You can update this backup mode from `FailedEventsOnly` to
|
4370
4449
|
# `AllEvents`. You can't update it from `AllEvents` to
|
@@ -4408,8 +4487,8 @@ module Aws::Firehose
|
|
4408
4487
|
# Describes a destination in Splunk.
|
4409
4488
|
#
|
4410
4489
|
# @!attribute [rw] hec_endpoint
|
4411
|
-
# The HTTP Event Collector (HEC) endpoint to which
|
4412
|
-
#
|
4490
|
+
# The HTTP Event Collector (HEC) endpoint to which Firehose sends your
|
4491
|
+
# data.
|
4413
4492
|
# @return [String]
|
4414
4493
|
#
|
4415
4494
|
# @!attribute [rw] hec_endpoint_type
|
@@ -4422,25 +4501,25 @@ module Aws::Firehose
|
|
4422
4501
|
# @return [String]
|
4423
4502
|
#
|
4424
4503
|
# @!attribute [rw] hec_acknowledgment_timeout_in_seconds
|
4425
|
-
# The amount of time that
|
4426
|
-
#
|
4427
|
-
#
|
4428
|
-
#
|
4504
|
+
# The amount of time that Firehose waits to receive an acknowledgment
|
4505
|
+
# from Splunk after it sends it data. At the end of the timeout
|
4506
|
+
# period, Firehose either tries to send the data again or considers it
|
4507
|
+
# an error, based on your retry settings.
|
4429
4508
|
# @return [Integer]
|
4430
4509
|
#
|
4431
4510
|
# @!attribute [rw] retry_options
|
4432
|
-
# The retry behavior in case
|
4433
|
-
#
|
4434
|
-
#
|
4511
|
+
# The retry behavior in case Firehose is unable to deliver data to
|
4512
|
+
# Splunk or if it doesn't receive an acknowledgment of receipt from
|
4513
|
+
# Splunk.
|
4435
4514
|
# @return [Types::SplunkRetryOptions]
|
4436
4515
|
#
|
4437
4516
|
# @!attribute [rw] s3_backup_mode
|
4438
4517
|
# Defines how documents should be delivered to Amazon S3. When set to
|
4439
|
-
# `FailedDocumentsOnly`,
|
4440
|
-
#
|
4441
|
-
#
|
4442
|
-
#
|
4443
|
-
#
|
4518
|
+
# `FailedDocumentsOnly`, Firehose writes any data that could not be
|
4519
|
+
# indexed to the configured Amazon S3 destination. When set to
|
4520
|
+
# `AllDocuments`, Firehose delivers all incoming records to Amazon S3,
|
4521
|
+
# and also writes failed documents to Amazon S3. Default value is
|
4522
|
+
# `FailedDocumentsOnly`.
|
4444
4523
|
# @return [String]
|
4445
4524
|
#
|
4446
4525
|
# @!attribute [rw] s3_destination_description
|
@@ -4480,8 +4559,8 @@ module Aws::Firehose
|
|
4480
4559
|
# Describes an update for a destination in Splunk.
|
4481
4560
|
#
|
4482
4561
|
# @!attribute [rw] hec_endpoint
|
4483
|
-
# The HTTP Event Collector (HEC) endpoint to which
|
4484
|
-
#
|
4562
|
+
# The HTTP Event Collector (HEC) endpoint to which Firehose sends your
|
4563
|
+
# data.
|
4485
4564
|
# @return [String]
|
4486
4565
|
#
|
4487
4566
|
# @!attribute [rw] hec_endpoint_type
|
@@ -4494,25 +4573,25 @@ module Aws::Firehose
|
|
4494
4573
|
# @return [String]
|
4495
4574
|
#
|
4496
4575
|
# @!attribute [rw] hec_acknowledgment_timeout_in_seconds
|
4497
|
-
# The amount of time that
|
4498
|
-
#
|
4499
|
-
#
|
4500
|
-
#
|
4576
|
+
# The amount of time that Firehose waits to receive an acknowledgment
|
4577
|
+
# from Splunk after it sends data. At the end of the timeout period,
|
4578
|
+
# Firehose either tries to send the data again or considers it an
|
4579
|
+
# error, based on your retry settings.
|
4501
4580
|
# @return [Integer]
|
4502
4581
|
#
|
4503
4582
|
# @!attribute [rw] retry_options
|
4504
|
-
# The retry behavior in case
|
4505
|
-
#
|
4506
|
-
#
|
4583
|
+
# The retry behavior in case Firehose is unable to deliver data to
|
4584
|
+
# Splunk or if it doesn't receive an acknowledgment of receipt from
|
4585
|
+
# Splunk.
|
4507
4586
|
# @return [Types::SplunkRetryOptions]
|
4508
4587
|
#
|
4509
4588
|
# @!attribute [rw] s3_backup_mode
|
4510
|
-
# Specifies how you want
|
4511
|
-
#
|
4512
|
-
#
|
4513
|
-
#
|
4514
|
-
#
|
4515
|
-
#
|
4589
|
+
# Specifies how you want Firehose to back up documents to Amazon S3.
|
4590
|
+
# When set to `FailedDocumentsOnly`, Firehose writes any data that
|
4591
|
+
# could not be indexed to the configured Amazon S3 destination. When
|
4592
|
+
# set to `AllEvents`, Firehose delivers all incoming records to Amazon
|
4593
|
+
# S3, and also writes failed documents to Amazon S3. The default value
|
4594
|
+
# is `FailedEventsOnly`.
|
4516
4595
|
#
|
4517
4596
|
# You can update this backup mode from `FailedEventsOnly` to
|
4518
4597
|
# `AllEvents`. You can't update it from `AllEvents` to
|
@@ -4553,16 +4632,15 @@ module Aws::Firehose
|
|
4553
4632
|
include Aws::Structure
|
4554
4633
|
end
|
4555
4634
|
|
4556
|
-
# Configures retry behavior in case
|
4557
|
-
#
|
4558
|
-
#
|
4635
|
+
# Configures retry behavior in case Firehose is unable to deliver
|
4636
|
+
# documents to Splunk, or if it doesn't receive an acknowledgment from
|
4637
|
+
# Splunk.
|
4559
4638
|
#
|
4560
4639
|
# @!attribute [rw] duration_in_seconds
|
4561
|
-
# The total amount of time that
|
4562
|
-
#
|
4563
|
-
#
|
4564
|
-
#
|
4565
|
-
# each attempt.
|
4640
|
+
# The total amount of time that Firehose spends on retries. This
|
4641
|
+
# duration starts after the initial attempt to send data to Splunk
|
4642
|
+
# fails. It doesn't include the periods during which Firehose waits
|
4643
|
+
# for acknowledgment from Splunk after each attempt.
|
4566
4644
|
# @return [Integer]
|
4567
4645
|
#
|
4568
4646
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/SplunkRetryOptions AWS API Documentation
|
@@ -4658,6 +4736,125 @@ module Aws::Firehose
|
|
4658
4736
|
#
|
4659
4737
|
class TagDeliveryStreamOutput < Aws::EmptyStructure; end
|
4660
4738
|
|
4739
|
+
# @!attribute [rw] message
|
4740
|
+
# @return [String]
|
4741
|
+
#
|
4742
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/TagrisAccessDeniedException AWS API Documentation
|
4743
|
+
#
|
4744
|
+
class TagrisAccessDeniedException < Struct.new(
|
4745
|
+
:message)
|
4746
|
+
SENSITIVE = []
|
4747
|
+
include Aws::Structure
|
4748
|
+
end
|
4749
|
+
|
4750
|
+
# @!attribute [rw] message
|
4751
|
+
# @return [String]
|
4752
|
+
#
|
4753
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/TagrisInternalServiceException AWS API Documentation
|
4754
|
+
#
|
4755
|
+
class TagrisInternalServiceException < Struct.new(
|
4756
|
+
:message)
|
4757
|
+
SENSITIVE = []
|
4758
|
+
include Aws::Structure
|
4759
|
+
end
|
4760
|
+
|
4761
|
+
# @!attribute [rw] message
|
4762
|
+
# @return [String]
|
4763
|
+
#
|
4764
|
+
# @!attribute [rw] sweep_list_item
|
4765
|
+
# @return [Types::TagrisSweepListItem]
|
4766
|
+
#
|
4767
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/TagrisInvalidArnException AWS API Documentation
|
4768
|
+
#
|
4769
|
+
class TagrisInvalidArnException < Struct.new(
|
4770
|
+
:message,
|
4771
|
+
:sweep_list_item)
|
4772
|
+
SENSITIVE = []
|
4773
|
+
include Aws::Structure
|
4774
|
+
end
|
4775
|
+
|
4776
|
+
# @!attribute [rw] message
|
4777
|
+
# @return [String]
|
4778
|
+
#
|
4779
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/TagrisInvalidParameterException AWS API Documentation
|
4780
|
+
#
|
4781
|
+
class TagrisInvalidParameterException < Struct.new(
|
4782
|
+
:message)
|
4783
|
+
SENSITIVE = []
|
4784
|
+
include Aws::Structure
|
4785
|
+
end
|
4786
|
+
|
4787
|
+
# @!attribute [rw] message
|
4788
|
+
# @return [String]
|
4789
|
+
#
|
4790
|
+
# @!attribute [rw] resource_existence_information
|
4791
|
+
# @return [Hash<String,String>]
|
4792
|
+
#
|
4793
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/TagrisPartialResourcesExistResultsException AWS API Documentation
|
4794
|
+
#
|
4795
|
+
class TagrisPartialResourcesExistResultsException < Struct.new(
|
4796
|
+
:message,
|
4797
|
+
:resource_existence_information)
|
4798
|
+
SENSITIVE = []
|
4799
|
+
include Aws::Structure
|
4800
|
+
end
|
4801
|
+
|
4802
|
+
# @!attribute [rw] tagris_account_id
|
4803
|
+
# @return [String]
|
4804
|
+
#
|
4805
|
+
# @!attribute [rw] tagris_amazon_resource_name
|
4806
|
+
# @return [String]
|
4807
|
+
#
|
4808
|
+
# @!attribute [rw] tagris_internal_id
|
4809
|
+
# @return [String]
|
4810
|
+
#
|
4811
|
+
# @!attribute [rw] tagris_version
|
4812
|
+
# @return [Integer]
|
4813
|
+
#
|
4814
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/TagrisSweepListItem AWS API Documentation
|
4815
|
+
#
|
4816
|
+
class TagrisSweepListItem < Struct.new(
|
4817
|
+
:tagris_account_id,
|
4818
|
+
:tagris_amazon_resource_name,
|
4819
|
+
:tagris_internal_id,
|
4820
|
+
:tagris_version)
|
4821
|
+
SENSITIVE = []
|
4822
|
+
include Aws::Structure
|
4823
|
+
end
|
4824
|
+
|
4825
|
+
# @!attribute [rw] message
|
4826
|
+
# @return [String]
|
4827
|
+
#
|
4828
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/TagrisThrottledException AWS API Documentation
|
4829
|
+
#
|
4830
|
+
class TagrisThrottledException < Struct.new(
|
4831
|
+
:message)
|
4832
|
+
SENSITIVE = []
|
4833
|
+
include Aws::Structure
|
4834
|
+
end
|
4835
|
+
|
4836
|
+
# @!attribute [rw] tagris_sweep_list
|
4837
|
+
# @return [Array<Types::TagrisSweepListItem>]
|
4838
|
+
#
|
4839
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/TagrisVerifyResourcesExistInput AWS API Documentation
|
4840
|
+
#
|
4841
|
+
class TagrisVerifyResourcesExistInput < Struct.new(
|
4842
|
+
:tagris_sweep_list)
|
4843
|
+
SENSITIVE = []
|
4844
|
+
include Aws::Structure
|
4845
|
+
end
|
4846
|
+
|
4847
|
+
# @!attribute [rw] tagris_sweep_list_result
|
4848
|
+
# @return [Hash<String,String>]
|
4849
|
+
#
|
4850
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/TagrisVerifyResourcesExistOutput AWS API Documentation
|
4851
|
+
#
|
4852
|
+
class TagrisVerifyResourcesExistOutput < Struct.new(
|
4853
|
+
:tagris_sweep_list_result)
|
4854
|
+
SENSITIVE = []
|
4855
|
+
include Aws::Structure
|
4856
|
+
end
|
4857
|
+
|
4661
4858
|
# @!attribute [rw] delivery_stream_name
|
4662
4859
|
# The name of the delivery stream.
|
4663
4860
|
# @return [String]
|
@@ -4762,22 +4959,22 @@ module Aws::Firehose
|
|
4762
4959
|
# Serverless destination.
|
4763
4960
|
#
|
4764
4961
|
# @!attribute [rw] subnet_ids
|
4765
|
-
# The IDs of the subnets that you want
|
4766
|
-
#
|
4767
|
-
#
|
4768
|
-
#
|
4769
|
-
#
|
4770
|
-
#
|
4771
|
-
#
|
4962
|
+
# The IDs of the subnets that you want Firehose to use to create ENIs
|
4963
|
+
# in the VPC of the Amazon ES destination. Make sure that the routing
|
4964
|
+
# tables and inbound and outbound rules allow traffic to flow from the
|
4965
|
+
# subnets whose IDs are specified here to the subnets that have the
|
4966
|
+
# destination Amazon ES endpoints. Firehose creates at least one ENI
|
4967
|
+
# in each of the subnets that are specified here. Do not delete or
|
4968
|
+
# modify these ENIs.
|
4772
4969
|
#
|
4773
|
-
# The number of ENIs that
|
4774
|
-
#
|
4775
|
-
#
|
4776
|
-
#
|
4777
|
-
#
|
4778
|
-
#
|
4779
|
-
#
|
4780
|
-
#
|
4970
|
+
# The number of ENIs that Firehose creates in the subnets specified
|
4971
|
+
# here scales up and down automatically based on throughput. To enable
|
4972
|
+
# Firehose to scale up the number of ENIs to match throughput, ensure
|
4973
|
+
# that you have sufficient quota. To help you calculate the quota you
|
4974
|
+
# need, assume that Firehose can create up to three ENIs for this
|
4975
|
+
# delivery stream for each of the subnets specified here. For more
|
4976
|
+
# information about ENI quota, see [Network Interfaces ][1] in the
|
4977
|
+
# Amazon VPC Quotas topic.
|
4781
4978
|
#
|
4782
4979
|
#
|
4783
4980
|
#
|
@@ -4787,10 +4984,9 @@ module Aws::Firehose
|
|
4787
4984
|
# @!attribute [rw] role_arn
|
4788
4985
|
# The ARN of the IAM role that you want the delivery stream to use to
|
4789
4986
|
# create endpoints in the destination VPC. You can use your existing
|
4790
|
-
#
|
4791
|
-
#
|
4792
|
-
#
|
4793
|
-
# permissions:
|
4987
|
+
# Firehose delivery role or you can specify a new role. In either
|
4988
|
+
# case, make sure that the role trusts the Firehose service principal
|
4989
|
+
# and that it grants the following permissions:
|
4794
4990
|
#
|
4795
4991
|
# * `ec2:DescribeVpcs`
|
4796
4992
|
#
|
@@ -4808,25 +5004,27 @@ module Aws::Firehose
|
|
4808
5004
|
#
|
4809
5005
|
# * `ec2:DeleteNetworkInterface`
|
4810
5006
|
#
|
4811
|
-
#
|
4812
|
-
#
|
4813
|
-
#
|
4814
|
-
#
|
5007
|
+
# When you specify subnets for delivering data to the destination in a
|
5008
|
+
# private VPC, make sure you have enough number of free IP addresses
|
5009
|
+
# in chosen subnets. If there is no available free IP address in a
|
5010
|
+
# specified subnet, Firehose cannot create or add ENIs for the data
|
5011
|
+
# delivery in the private VPC, and the delivery will be degraded or
|
5012
|
+
# fail.
|
4815
5013
|
# @return [String]
|
4816
5014
|
#
|
4817
5015
|
# @!attribute [rw] security_group_ids
|
4818
|
-
# The IDs of the security groups that you want
|
4819
|
-
#
|
4820
|
-
#
|
4821
|
-
#
|
4822
|
-
#
|
4823
|
-
#
|
4824
|
-
#
|
4825
|
-
#
|
4826
|
-
#
|
4827
|
-
#
|
4828
|
-
#
|
4829
|
-
#
|
5016
|
+
# The IDs of the security groups that you want Firehose to use when it
|
5017
|
+
# creates ENIs in the VPC of the Amazon ES destination. You can use
|
5018
|
+
# the same security group that the Amazon ES domain uses or different
|
5019
|
+
# ones. If you specify different security groups here, ensure that
|
5020
|
+
# they allow outbound HTTPS traffic to the Amazon ES domain's
|
5021
|
+
# security group. Also ensure that the Amazon ES domain's security
|
5022
|
+
# group allows HTTPS traffic from the security groups specified here.
|
5023
|
+
# If you use the same security group for both your delivery stream and
|
5024
|
+
# the Amazon ES domain, make sure the security group inbound rule
|
5025
|
+
# allows HTTPS traffic. For more information about security group
|
5026
|
+
# rules, see [Security group rules][1] in the Amazon VPC
|
5027
|
+
# documentation.
|
4830
5028
|
#
|
4831
5029
|
#
|
4832
5030
|
#
|
@@ -4846,22 +5044,22 @@ module Aws::Firehose
|
|
4846
5044
|
# The details of the VPC of the Amazon ES destination.
|
4847
5045
|
#
|
4848
5046
|
# @!attribute [rw] subnet_ids
|
4849
|
-
# The IDs of the subnets that
|
4850
|
-
#
|
4851
|
-
#
|
4852
|
-
#
|
4853
|
-
#
|
4854
|
-
#
|
4855
|
-
#
|
5047
|
+
# The IDs of the subnets that Firehose uses to create ENIs in the VPC
|
5048
|
+
# of the Amazon ES destination. Make sure that the routing tables and
|
5049
|
+
# inbound and outbound rules allow traffic to flow from the subnets
|
5050
|
+
# whose IDs are specified here to the subnets that have the
|
5051
|
+
# destination Amazon ES endpoints. Firehose creates at least one ENI
|
5052
|
+
# in each of the subnets that are specified here. Do not delete or
|
5053
|
+
# modify these ENIs.
|
4856
5054
|
#
|
4857
|
-
# The number of ENIs that
|
4858
|
-
#
|
4859
|
-
#
|
4860
|
-
#
|
4861
|
-
#
|
4862
|
-
#
|
4863
|
-
#
|
4864
|
-
#
|
5055
|
+
# The number of ENIs that Firehose creates in the subnets specified
|
5056
|
+
# here scales up and down automatically based on throughput. To enable
|
5057
|
+
# Firehose to scale up the number of ENIs to match throughput, ensure
|
5058
|
+
# that you have sufficient quota. To help you calculate the quota you
|
5059
|
+
# need, assume that Firehose can create up to three ENIs for this
|
5060
|
+
# delivery stream for each of the subnets specified here. For more
|
5061
|
+
# information about ENI quota, see [Network Interfaces ][1] in the
|
5062
|
+
# Amazon VPC Quotas topic.
|
4865
5063
|
#
|
4866
5064
|
#
|
4867
5065
|
#
|
@@ -4870,10 +5068,10 @@ module Aws::Firehose
|
|
4870
5068
|
#
|
4871
5069
|
# @!attribute [rw] role_arn
|
4872
5070
|
# The ARN of the IAM role that the delivery stream uses to create
|
4873
|
-
# endpoints in the destination VPC. You can use your existing
|
4874
|
-
#
|
4875
|
-
#
|
4876
|
-
#
|
5071
|
+
# endpoints in the destination VPC. You can use your existing Firehose
|
5072
|
+
# delivery role or you can specify a new role. In either case, make
|
5073
|
+
# sure that the role trusts the Firehose service principal and that it
|
5074
|
+
# grants the following permissions:
|
4877
5075
|
#
|
4878
5076
|
# * `ec2:DescribeVpcs`
|
4879
5077
|
#
|
@@ -4892,22 +5090,21 @@ module Aws::Firehose
|
|
4892
5090
|
# * `ec2:DeleteNetworkInterface`
|
4893
5091
|
#
|
4894
5092
|
# If you revoke these permissions after you create the delivery
|
4895
|
-
# stream,
|
4896
|
-
#
|
4897
|
-
# performance.
|
5093
|
+
# stream, Firehose can't scale out by creating more ENIs when
|
5094
|
+
# necessary. You might therefore see a degradation in performance.
|
4898
5095
|
# @return [String]
|
4899
5096
|
#
|
4900
5097
|
# @!attribute [rw] security_group_ids
|
4901
|
-
# The IDs of the security groups that
|
4902
|
-
#
|
4903
|
-
#
|
4904
|
-
#
|
4905
|
-
#
|
4906
|
-
#
|
4907
|
-
#
|
4908
|
-
#
|
4909
|
-
#
|
4910
|
-
#
|
5098
|
+
# The IDs of the security groups that Firehose uses when it creates
|
5099
|
+
# ENIs in the VPC of the Amazon ES destination. You can use the same
|
5100
|
+
# security group that the Amazon ES domain uses or different ones. If
|
5101
|
+
# you specify different security groups, ensure that they allow
|
5102
|
+
# outbound HTTPS traffic to the Amazon ES domain's security group.
|
5103
|
+
# Also ensure that the Amazon ES domain's security group allows HTTPS
|
5104
|
+
# traffic from the security groups specified here. If you use the same
|
5105
|
+
# security group for both your delivery stream and the Amazon ES
|
5106
|
+
# domain, make sure the security group inbound rule allows HTTPS
|
5107
|
+
# traffic. For more information about security group rules, see
|
4911
5108
|
# [Security group rules][1] in the Amazon VPC documentation.
|
4912
5109
|
#
|
4913
5110
|
#
|