aws-sdk-firehose 1.1.0 → 1.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-firehose.rb +1 -1
- data/lib/aws-sdk-firehose/client.rb +262 -133
- data/lib/aws-sdk-firehose/client_api.rb +79 -0
- data/lib/aws-sdk-firehose/types.rb +334 -178
- metadata +3 -3
@@ -75,6 +75,10 @@ module Aws::Firehose
|
|
75
75
|
ListDeliveryStreamsInput = Shapes::StructureShape.new(name: 'ListDeliveryStreamsInput')
|
76
76
|
ListDeliveryStreamsInputLimit = Shapes::IntegerShape.new(name: 'ListDeliveryStreamsInputLimit')
|
77
77
|
ListDeliveryStreamsOutput = Shapes::StructureShape.new(name: 'ListDeliveryStreamsOutput')
|
78
|
+
ListTagsForDeliveryStreamInput = Shapes::StructureShape.new(name: 'ListTagsForDeliveryStreamInput')
|
79
|
+
ListTagsForDeliveryStreamInputLimit = Shapes::IntegerShape.new(name: 'ListTagsForDeliveryStreamInputLimit')
|
80
|
+
ListTagsForDeliveryStreamOutput = Shapes::StructureShape.new(name: 'ListTagsForDeliveryStreamOutput')
|
81
|
+
ListTagsForDeliveryStreamOutputTagList = Shapes::ListShape.new(name: 'ListTagsForDeliveryStreamOutputTagList')
|
78
82
|
LogGroupName = Shapes::StringShape.new(name: 'LogGroupName')
|
79
83
|
LogStreamName = Shapes::StringShape.new(name: 'LogStreamName')
|
80
84
|
NoEncryptionConfig = Shapes::StringShape.new(name: 'NoEncryptionConfig')
|
@@ -120,7 +124,16 @@ module Aws::Firehose
|
|
120
124
|
SplunkRetryDurationInSeconds = Shapes::IntegerShape.new(name: 'SplunkRetryDurationInSeconds')
|
121
125
|
SplunkRetryOptions = Shapes::StructureShape.new(name: 'SplunkRetryOptions')
|
122
126
|
SplunkS3BackupMode = Shapes::StringShape.new(name: 'SplunkS3BackupMode')
|
127
|
+
Tag = Shapes::StructureShape.new(name: 'Tag')
|
128
|
+
TagDeliveryStreamInput = Shapes::StructureShape.new(name: 'TagDeliveryStreamInput')
|
129
|
+
TagDeliveryStreamInputTagList = Shapes::ListShape.new(name: 'TagDeliveryStreamInputTagList')
|
130
|
+
TagDeliveryStreamOutput = Shapes::StructureShape.new(name: 'TagDeliveryStreamOutput')
|
131
|
+
TagKey = Shapes::StringShape.new(name: 'TagKey')
|
132
|
+
TagKeyList = Shapes::ListShape.new(name: 'TagKeyList')
|
133
|
+
TagValue = Shapes::StringShape.new(name: 'TagValue')
|
123
134
|
Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
|
135
|
+
UntagDeliveryStreamInput = Shapes::StructureShape.new(name: 'UntagDeliveryStreamInput')
|
136
|
+
UntagDeliveryStreamOutput = Shapes::StructureShape.new(name: 'UntagDeliveryStreamOutput')
|
124
137
|
UpdateDestinationInput = Shapes::StructureShape.new(name: 'UpdateDestinationInput')
|
125
138
|
UpdateDestinationOutput = Shapes::StructureShape.new(name: 'UpdateDestinationOutput')
|
126
139
|
Username = Shapes::StringShape.new(name: 'Username')
|
@@ -295,6 +308,17 @@ module Aws::Firehose
|
|
295
308
|
ListDeliveryStreamsOutput.add_member(:has_more_delivery_streams, Shapes::ShapeRef.new(shape: BooleanObject, required: true, location_name: "HasMoreDeliveryStreams"))
|
296
309
|
ListDeliveryStreamsOutput.struct_class = Types::ListDeliveryStreamsOutput
|
297
310
|
|
311
|
+
ListTagsForDeliveryStreamInput.add_member(:delivery_stream_name, Shapes::ShapeRef.new(shape: DeliveryStreamName, required: true, location_name: "DeliveryStreamName"))
|
312
|
+
ListTagsForDeliveryStreamInput.add_member(:exclusive_start_tag_key, Shapes::ShapeRef.new(shape: TagKey, location_name: "ExclusiveStartTagKey"))
|
313
|
+
ListTagsForDeliveryStreamInput.add_member(:limit, Shapes::ShapeRef.new(shape: ListTagsForDeliveryStreamInputLimit, location_name: "Limit"))
|
314
|
+
ListTagsForDeliveryStreamInput.struct_class = Types::ListTagsForDeliveryStreamInput
|
315
|
+
|
316
|
+
ListTagsForDeliveryStreamOutput.add_member(:tags, Shapes::ShapeRef.new(shape: ListTagsForDeliveryStreamOutputTagList, required: true, location_name: "Tags"))
|
317
|
+
ListTagsForDeliveryStreamOutput.add_member(:has_more_tags, Shapes::ShapeRef.new(shape: BooleanObject, required: true, location_name: "HasMoreTags"))
|
318
|
+
ListTagsForDeliveryStreamOutput.struct_class = Types::ListTagsForDeliveryStreamOutput
|
319
|
+
|
320
|
+
ListTagsForDeliveryStreamOutputTagList.member = Shapes::ShapeRef.new(shape: Tag)
|
321
|
+
|
298
322
|
ProcessingConfiguration.add_member(:enabled, Shapes::ShapeRef.new(shape: BooleanObject, location_name: "Enabled"))
|
299
323
|
ProcessingConfiguration.add_member(:processors, Shapes::ShapeRef.new(shape: ProcessorList, location_name: "Processors"))
|
300
324
|
ProcessingConfiguration.struct_class = Types::ProcessingConfiguration
|
@@ -445,6 +469,26 @@ module Aws::Firehose
|
|
445
469
|
SplunkRetryOptions.add_member(:duration_in_seconds, Shapes::ShapeRef.new(shape: SplunkRetryDurationInSeconds, location_name: "DurationInSeconds"))
|
446
470
|
SplunkRetryOptions.struct_class = Types::SplunkRetryOptions
|
447
471
|
|
472
|
+
Tag.add_member(:key, Shapes::ShapeRef.new(shape: TagKey, required: true, location_name: "Key"))
|
473
|
+
Tag.add_member(:value, Shapes::ShapeRef.new(shape: TagValue, location_name: "Value"))
|
474
|
+
Tag.struct_class = Types::Tag
|
475
|
+
|
476
|
+
TagDeliveryStreamInput.add_member(:delivery_stream_name, Shapes::ShapeRef.new(shape: DeliveryStreamName, required: true, location_name: "DeliveryStreamName"))
|
477
|
+
TagDeliveryStreamInput.add_member(:tags, Shapes::ShapeRef.new(shape: TagDeliveryStreamInputTagList, required: true, location_name: "Tags"))
|
478
|
+
TagDeliveryStreamInput.struct_class = Types::TagDeliveryStreamInput
|
479
|
+
|
480
|
+
TagDeliveryStreamInputTagList.member = Shapes::ShapeRef.new(shape: Tag)
|
481
|
+
|
482
|
+
TagDeliveryStreamOutput.struct_class = Types::TagDeliveryStreamOutput
|
483
|
+
|
484
|
+
TagKeyList.member = Shapes::ShapeRef.new(shape: TagKey)
|
485
|
+
|
486
|
+
UntagDeliveryStreamInput.add_member(:delivery_stream_name, Shapes::ShapeRef.new(shape: DeliveryStreamName, required: true, location_name: "DeliveryStreamName"))
|
487
|
+
UntagDeliveryStreamInput.add_member(:tag_keys, Shapes::ShapeRef.new(shape: TagKeyList, required: true, location_name: "TagKeys"))
|
488
|
+
UntagDeliveryStreamInput.struct_class = Types::UntagDeliveryStreamInput
|
489
|
+
|
490
|
+
UntagDeliveryStreamOutput.struct_class = Types::UntagDeliveryStreamOutput
|
491
|
+
|
448
492
|
UpdateDestinationInput.add_member(:delivery_stream_name, Shapes::ShapeRef.new(shape: DeliveryStreamName, required: true, location_name: "DeliveryStreamName"))
|
449
493
|
UpdateDestinationInput.add_member(:current_delivery_stream_version_id, Shapes::ShapeRef.new(shape: DeliveryStreamVersionId, required: true, location_name: "CurrentDeliveryStreamVersionId"))
|
450
494
|
UpdateDestinationInput.add_member(:destination_id, Shapes::ShapeRef.new(shape: DestinationId, required: true, location_name: "DestinationId"))
|
@@ -510,6 +554,17 @@ module Aws::Firehose
|
|
510
554
|
o.output = Shapes::ShapeRef.new(shape: ListDeliveryStreamsOutput)
|
511
555
|
end)
|
512
556
|
|
557
|
+
api.add_operation(:list_tags_for_delivery_stream, Seahorse::Model::Operation.new.tap do |o|
|
558
|
+
o.name = "ListTagsForDeliveryStream"
|
559
|
+
o.http_method = "POST"
|
560
|
+
o.http_request_uri = "/"
|
561
|
+
o.input = Shapes::ShapeRef.new(shape: ListTagsForDeliveryStreamInput)
|
562
|
+
o.output = Shapes::ShapeRef.new(shape: ListTagsForDeliveryStreamOutput)
|
563
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
564
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidArgumentException)
|
565
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
566
|
+
end)
|
567
|
+
|
513
568
|
api.add_operation(:put_record, Seahorse::Model::Operation.new.tap do |o|
|
514
569
|
o.name = "PutRecord"
|
515
570
|
o.http_method = "POST"
|
@@ -532,6 +587,30 @@ module Aws::Firehose
|
|
532
587
|
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
533
588
|
end)
|
534
589
|
|
590
|
+
api.add_operation(:tag_delivery_stream, Seahorse::Model::Operation.new.tap do |o|
|
591
|
+
o.name = "TagDeliveryStream"
|
592
|
+
o.http_method = "POST"
|
593
|
+
o.http_request_uri = "/"
|
594
|
+
o.input = Shapes::ShapeRef.new(shape: TagDeliveryStreamInput)
|
595
|
+
o.output = Shapes::ShapeRef.new(shape: TagDeliveryStreamOutput)
|
596
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
597
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
|
598
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidArgumentException)
|
599
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
600
|
+
end)
|
601
|
+
|
602
|
+
api.add_operation(:untag_delivery_stream, Seahorse::Model::Operation.new.tap do |o|
|
603
|
+
o.name = "UntagDeliveryStream"
|
604
|
+
o.http_method = "POST"
|
605
|
+
o.http_request_uri = "/"
|
606
|
+
o.input = Shapes::ShapeRef.new(shape: UntagDeliveryStreamInput)
|
607
|
+
o.output = Shapes::ShapeRef.new(shape: UntagDeliveryStreamOutput)
|
608
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
609
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
|
610
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidArgumentException)
|
611
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
612
|
+
end)
|
613
|
+
|
535
614
|
api.add_operation(:update_destination, Seahorse::Model::Operation.new.tap do |o|
|
536
615
|
o.name = "UpdateDestination"
|
537
616
|
o.http_method = "POST"
|
@@ -9,9 +9,9 @@ module Aws::Firehose
|
|
9
9
|
module Types
|
10
10
|
|
11
11
|
# Describes hints for the buffering to perform before delivering data to
|
12
|
-
# the destination.
|
13
|
-
#
|
14
|
-
#
|
12
|
+
# the destination. These options are treated as hints, and therefore
|
13
|
+
# Kinesis Data Firehose might choose to use different values whenever it
|
14
|
+
# is optimal.
|
15
15
|
#
|
16
16
|
# @note When making an API call, you may pass BufferingHints
|
17
17
|
# data as a hash:
|
@@ -103,7 +103,7 @@ module Aws::Firehose
|
|
103
103
|
# Optional parameters to use with the Amazon Redshift `COPY` command.
|
104
104
|
# For more information, see the "Optional Parameters" section of
|
105
105
|
# [Amazon Redshift COPY command][1]. Some possible examples that would
|
106
|
-
# apply to Kinesis Firehose are as follows:
|
106
|
+
# apply to Kinesis Data Firehose are as follows:
|
107
107
|
#
|
108
108
|
# `delimiter '\t' lzop;` - fields are delimited with "\\t" (TAB
|
109
109
|
# character) and compressed using lzop.
|
@@ -411,8 +411,8 @@ module Aws::Firehose
|
|
411
411
|
#
|
412
412
|
# @!attribute [rw] delivery_stream_name
|
413
413
|
# The name of the delivery stream. This name must be unique per AWS
|
414
|
-
# account in the same
|
415
|
-
# accounts or different
|
414
|
+
# account in the same Region. If the delivery streams are in different
|
415
|
+
# accounts or different Regions, you can have multiple delivery
|
416
416
|
# streams with the same name.
|
417
417
|
# @return [String]
|
418
418
|
#
|
@@ -423,14 +423,15 @@ module Aws::Firehose
|
|
423
423
|
# * `DirectPut`\: Provider applications access the delivery stream
|
424
424
|
# directly.
|
425
425
|
#
|
426
|
-
# * `KinesisStreamAsSource`\: The delivery stream uses a Kinesis
|
426
|
+
# * `KinesisStreamAsSource`\: The delivery stream uses a Kinesis data
|
427
427
|
# stream as a source.
|
428
428
|
# @return [String]
|
429
429
|
#
|
430
430
|
# @!attribute [rw] kinesis_stream_source_configuration
|
431
|
-
# When a Kinesis stream is used as the source for the delivery
|
432
|
-
# a KinesisStreamSourceConfiguration containing the Kinesis
|
433
|
-
# and the role ARN for the
|
431
|
+
# When a Kinesis data stream is used as the source for the delivery
|
432
|
+
# stream, a KinesisStreamSourceConfiguration containing the Kinesis
|
433
|
+
# data stream Amazon Resource Name (ARN) and the role ARN for the
|
434
|
+
# source stream.
|
434
435
|
# @return [Types::KinesisStreamSourceConfiguration]
|
435
436
|
#
|
436
437
|
# @!attribute [rw] s3_destination_configuration
|
@@ -522,7 +523,7 @@ module Aws::Firehose
|
|
522
523
|
# * `DirectPut`\: Provider applications access the delivery stream
|
523
524
|
# directly.
|
524
525
|
#
|
525
|
-
# * `KinesisStreamAsSource`\: The delivery stream uses a Kinesis
|
526
|
+
# * `KinesisStreamAsSource`\: The delivery stream uses a Kinesis data
|
526
527
|
# stream as a source.
|
527
528
|
# @return [String]
|
528
529
|
#
|
@@ -543,7 +544,7 @@ module Aws::Firehose
|
|
543
544
|
#
|
544
545
|
# @!attribute [rw] source
|
545
546
|
# If the `DeliveryStreamType` parameter is `KinesisStreamAsSource`, a
|
546
|
-
# SourceDescription object describing the source Kinesis stream.
|
547
|
+
# SourceDescription object describing the source Kinesis data stream.
|
547
548
|
# @return [Types::SourceDescription]
|
548
549
|
#
|
549
550
|
# @!attribute [rw] destinations
|
@@ -590,8 +591,8 @@ module Aws::Firehose
|
|
590
591
|
#
|
591
592
|
# @!attribute [rw] exclusive_start_destination_id
|
592
593
|
# The ID of the destination to start returning the destination
|
593
|
-
# information. Currently, Kinesis Firehose supports one
|
594
|
-
# per delivery stream.
|
594
|
+
# information. Currently, Kinesis Data Firehose supports one
|
595
|
+
# destination per delivery stream.
|
595
596
|
# @return [String]
|
596
597
|
#
|
597
598
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/DescribeDeliveryStreamInput AWS API Documentation
|
@@ -749,9 +750,10 @@ module Aws::Firehose
|
|
749
750
|
# }
|
750
751
|
#
|
751
752
|
# @!attribute [rw] role_arn
|
752
|
-
# The ARN of the IAM role to be assumed by
|
753
|
-
# calling the Amazon ES Configuration API
|
754
|
-
# For more information, see [
|
753
|
+
# The Amazon Resource Name (ARN) of the IAM role to be assumed by
|
754
|
+
# Kinesis Data Firehose for calling the Amazon ES Configuration API
|
755
|
+
# and for indexing documents. For more information, see [Grant Kinesis
|
756
|
+
# Data Firehose Access to an Amazon Destination][1].
|
755
757
|
#
|
756
758
|
#
|
757
759
|
#
|
@@ -762,7 +764,7 @@ module Aws::Firehose
|
|
762
764
|
# The ARN of the Amazon ES domain. The IAM role must have permissions
|
763
765
|
# for `DescribeElasticsearchDomain`, `DescribeElasticsearchDomains`,
|
764
766
|
# and `DescribeElasticsearchDomainConfig` after assuming the role
|
765
|
-
# specified in
|
767
|
+
# specified in `RoleARN`.
|
766
768
|
# @return [String]
|
767
769
|
#
|
768
770
|
# @!attribute [rw] index_name
|
@@ -776,9 +778,8 @@ module Aws::Firehose
|
|
776
778
|
# @!attribute [rw] index_rotation_period
|
777
779
|
# The Elasticsearch index rotation period. Index rotation appends a
|
778
780
|
# time stamp to the IndexName to facilitate the expiration of old
|
779
|
-
# data. For more information, see [Index Rotation for Amazon
|
780
|
-
#
|
781
|
-
# is `OneDay`.
|
781
|
+
# data. For more information, see [Index Rotation for the Amazon ES
|
782
|
+
# Destination][1]. The default value is `OneDay`.
|
782
783
|
#
|
783
784
|
#
|
784
785
|
#
|
@@ -787,28 +788,29 @@ module Aws::Firehose
|
|
787
788
|
#
|
788
789
|
# @!attribute [rw] buffering_hints
|
789
790
|
# The buffering options. If no value is specified, the default values
|
790
|
-
# for
|
791
|
+
# for `ElasticsearchBufferingHints` are used.
|
791
792
|
# @return [Types::ElasticsearchBufferingHints]
|
792
793
|
#
|
793
794
|
# @!attribute [rw] retry_options
|
794
|
-
# The retry behavior in case Kinesis Firehose is unable to
|
795
|
-
# documents to Amazon ES. The default value is 300 (5
|
795
|
+
# The retry behavior in case Kinesis Data Firehose is unable to
|
796
|
+
# deliver documents to Amazon ES. The default value is 300 (5
|
797
|
+
# minutes).
|
796
798
|
# @return [Types::ElasticsearchRetryOptions]
|
797
799
|
#
|
798
800
|
# @!attribute [rw] s3_backup_mode
|
799
801
|
# Defines how documents should be delivered to Amazon S3. When set to
|
800
|
-
# FailedDocumentsOnly
|
801
|
-
# could not be indexed to the configured Amazon S3 destination,
|
802
|
-
# elasticsearch-failed
|
803
|
-
# AllDocuments
|
804
|
-
# Amazon S3, and also writes failed documents with
|
805
|
-
# elasticsearch-failed
|
806
|
-
# see [
|
807
|
-
#
|
802
|
+
# `FailedDocumentsOnly`, Kinesis Data Firehose writes any documents
|
803
|
+
# that could not be indexed to the configured Amazon S3 destination,
|
804
|
+
# with `elasticsearch-failed/` appended to the key prefix. When set to
|
805
|
+
# `AllDocuments`, Kinesis Data Firehose delivers all incoming records
|
806
|
+
# to Amazon S3, and also writes failed documents with
|
807
|
+
# `elasticsearch-failed/` appended to the prefix. For more
|
808
|
+
# information, see [Data Delivery Failure Handling][1]. Default value
|
809
|
+
# is `FailedDocumentsOnly`.
|
808
810
|
#
|
809
811
|
#
|
810
812
|
#
|
811
|
-
# [1]: http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#
|
813
|
+
# [1]: http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#retry
|
812
814
|
# @return [String]
|
813
815
|
#
|
814
816
|
# @!attribute [rw] s3_configuration
|
@@ -843,7 +845,7 @@ module Aws::Firehose
|
|
843
845
|
# The destination description in Amazon ES.
|
844
846
|
#
|
845
847
|
# @!attribute [rw] role_arn
|
846
|
-
# The ARN of the AWS credentials.
|
848
|
+
# The Amazon Resource Name (ARN) of the AWS credentials.
|
847
849
|
# @return [String]
|
848
850
|
#
|
849
851
|
# @!attribute [rw] domain_arn
|
@@ -964,9 +966,10 @@ module Aws::Firehose
|
|
964
966
|
# }
|
965
967
|
#
|
966
968
|
# @!attribute [rw] role_arn
|
967
|
-
# The ARN of the IAM role to be assumed by
|
968
|
-
# calling the Amazon ES Configuration API
|
969
|
-
# For more information, see [
|
969
|
+
# The Amazon Resource Name (ARN) of the IAM role to be assumed by
|
970
|
+
# Kinesis Data Firehose for calling the Amazon ES Configuration API
|
971
|
+
# and for indexing documents. For more information, see [Grant Kinesis
|
972
|
+
# Data Firehose Access to an Amazon S3 Destination][1].
|
970
973
|
#
|
971
974
|
#
|
972
975
|
#
|
@@ -977,7 +980,7 @@ module Aws::Firehose
|
|
977
980
|
# The ARN of the Amazon ES domain. The IAM role must have permissions
|
978
981
|
# for `DescribeElasticsearchDomain`, `DescribeElasticsearchDomains`,
|
979
982
|
# and `DescribeElasticsearchDomainConfig` after assuming the IAM role
|
980
|
-
# specified in
|
983
|
+
# specified in `RoleARN`.
|
981
984
|
# @return [String]
|
982
985
|
#
|
983
986
|
# @!attribute [rw] index_name
|
@@ -991,8 +994,8 @@ module Aws::Firehose
|
|
991
994
|
# @!attribute [rw] index_rotation_period
|
992
995
|
# The Elasticsearch index rotation period. Index rotation appends a
|
993
996
|
# time stamp to IndexName to facilitate the expiration of old data.
|
994
|
-
# For more information, see [Index Rotation for Amazon
|
995
|
-
#
|
997
|
+
# For more information, see [Index Rotation for the Amazon ES
|
998
|
+
# Destination][1]. Default value is `OneDay`.
|
996
999
|
#
|
997
1000
|
#
|
998
1001
|
#
|
@@ -1001,12 +1004,13 @@ module Aws::Firehose
|
|
1001
1004
|
#
|
1002
1005
|
# @!attribute [rw] buffering_hints
|
1003
1006
|
# The buffering options. If no value is specified,
|
1004
|
-
#
|
1007
|
+
# `ElasticsearchBufferingHints` object default values are used.
|
1005
1008
|
# @return [Types::ElasticsearchBufferingHints]
|
1006
1009
|
#
|
1007
1010
|
# @!attribute [rw] retry_options
|
1008
|
-
# The retry behavior in case Kinesis Firehose is unable to
|
1009
|
-
# documents to Amazon ES. The default value is 300 (5
|
1011
|
+
# The retry behavior in case Kinesis Data Firehose is unable to
|
1012
|
+
# deliver documents to Amazon ES. The default value is 300 (5
|
1013
|
+
# minutes).
|
1010
1014
|
# @return [Types::ElasticsearchRetryOptions]
|
1011
1015
|
#
|
1012
1016
|
# @!attribute [rw] s3_update
|
@@ -1037,7 +1041,7 @@ module Aws::Firehose
|
|
1037
1041
|
include Aws::Structure
|
1038
1042
|
end
|
1039
1043
|
|
1040
|
-
# Configures retry behavior in case Kinesis Firehose is unable to
|
1044
|
+
# Configures retry behavior in case Kinesis Data Firehose is unable to
|
1041
1045
|
# deliver documents to Amazon ES.
|
1042
1046
|
#
|
1043
1047
|
# @note When making an API call, you may pass ElasticsearchRetryOptions
|
@@ -1049,7 +1053,7 @@ module Aws::Firehose
|
|
1049
1053
|
#
|
1050
1054
|
# @!attribute [rw] duration_in_seconds
|
1051
1055
|
# After an initial failure to deliver to Amazon ES, the total amount
|
1052
|
-
# of time during which Kinesis Firehose re-attempts delivery
|
1056
|
+
# of time during which Kinesis Data Firehose re-attempts delivery
|
1053
1057
|
# (including the first attempt). After this time has elapsed, the
|
1054
1058
|
# failed documents are written to Amazon S3. Default value is 300
|
1055
1059
|
# seconds (5 minutes). A value of 0 (zero) results in no retries.
|
@@ -1155,7 +1159,7 @@ module Aws::Firehose
|
|
1155
1159
|
# }
|
1156
1160
|
#
|
1157
1161
|
# @!attribute [rw] role_arn
|
1158
|
-
# The ARN of the AWS credentials.
|
1162
|
+
# The Amazon Resource Name (ARN) of the AWS credentials.
|
1159
1163
|
# @return [String]
|
1160
1164
|
#
|
1161
1165
|
# @!attribute [rw] bucket_arn
|
@@ -1164,15 +1168,15 @@ module Aws::Firehose
|
|
1164
1168
|
#
|
1165
1169
|
# @!attribute [rw] prefix
|
1166
1170
|
# The "YYYY/MM/DD/HH" time format prefix is automatically used for
|
1167
|
-
# delivered S3 files. You can specify an extra prefix to be
|
1168
|
-
# front of the time format prefix. If the prefix ends with a
|
1169
|
-
# appears as a folder in the S3 bucket. For more
|
1170
|
-
# [Amazon S3 Object Name Format][1] in the *Amazon
|
1171
|
-
# Developer Guide*.
|
1171
|
+
# delivered Amazon S3 files. You can specify an extra prefix to be
|
1172
|
+
# added in front of the time format prefix. If the prefix ends with a
|
1173
|
+
# slash, it appears as a folder in the S3 bucket. For more
|
1174
|
+
# information, see [Amazon S3 Object Name Format][1] in the *Amazon
|
1175
|
+
# Kinesis Data Firehose Developer Guide*.
|
1172
1176
|
#
|
1173
1177
|
#
|
1174
1178
|
#
|
1175
|
-
# [1]: http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html
|
1179
|
+
# [1]: http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#s3-object-name
|
1176
1180
|
# @return [String]
|
1177
1181
|
#
|
1178
1182
|
# @!attribute [rw] buffering_hints
|
@@ -1224,7 +1228,7 @@ module Aws::Firehose
|
|
1224
1228
|
# Describes a destination in Amazon S3.
|
1225
1229
|
#
|
1226
1230
|
# @!attribute [rw] role_arn
|
1227
|
-
# The ARN of the AWS credentials.
|
1231
|
+
# The Amazon Resource Name (ARN) of the AWS credentials.
|
1228
1232
|
# @return [String]
|
1229
1233
|
#
|
1230
1234
|
# @!attribute [rw] bucket_arn
|
@@ -1236,12 +1240,12 @@ module Aws::Firehose
|
|
1236
1240
|
# delivered S3 files. You can specify an extra prefix to be added in
|
1237
1241
|
# front of the time format prefix. If the prefix ends with a slash, it
|
1238
1242
|
# appears as a folder in the S3 bucket. For more information, see
|
1239
|
-
# [Amazon S3 Object Name Format][1] in the *Amazon Kinesis
|
1240
|
-
# Developer Guide*.
|
1243
|
+
# [Amazon S3 Object Name Format][1] in the *Amazon Kinesis Data
|
1244
|
+
# Firehose Developer Guide*.
|
1241
1245
|
#
|
1242
1246
|
#
|
1243
1247
|
#
|
1244
|
-
# [1]: http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html
|
1248
|
+
# [1]: http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#s3-object-name
|
1245
1249
|
# @return [String]
|
1246
1250
|
#
|
1247
1251
|
# @!attribute [rw] buffering_hints
|
@@ -1354,7 +1358,7 @@ module Aws::Firehose
|
|
1354
1358
|
# }
|
1355
1359
|
#
|
1356
1360
|
# @!attribute [rw] role_arn
|
1357
|
-
# The ARN of the AWS credentials.
|
1361
|
+
# The Amazon Resource Name (ARN) of the AWS credentials.
|
1358
1362
|
# @return [String]
|
1359
1363
|
#
|
1360
1364
|
# @!attribute [rw] bucket_arn
|
@@ -1363,15 +1367,15 @@ module Aws::Firehose
|
|
1363
1367
|
#
|
1364
1368
|
# @!attribute [rw] prefix
|
1365
1369
|
# The "YYYY/MM/DD/HH" time format prefix is automatically used for
|
1366
|
-
# delivered S3 files. You can specify an extra prefix to be
|
1367
|
-
# front of the time format prefix. If the prefix ends with a
|
1368
|
-
# appears as a folder in the S3 bucket. For more
|
1369
|
-
# [Amazon S3 Object Name Format][1] in the *Amazon
|
1370
|
-
# Developer Guide*.
|
1370
|
+
# delivered Amazon S3 files. You can specify an extra prefix to be
|
1371
|
+
# added in front of the time format prefix. If the prefix ends with a
|
1372
|
+
# slash, it appears as a folder in the S3 bucket. For more
|
1373
|
+
# information, see [Amazon S3 Object Name Format][1] in the *Amazon
|
1374
|
+
# Kinesis Data Firehose Developer Guide*.
|
1371
1375
|
#
|
1372
1376
|
#
|
1373
1377
|
#
|
1374
|
-
# [1]: http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html
|
1378
|
+
# [1]: http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#s3-object-name
|
1375
1379
|
# @return [String]
|
1376
1380
|
#
|
1377
1381
|
# @!attribute [rw] buffering_hints
|
@@ -1430,8 +1434,8 @@ module Aws::Firehose
|
|
1430
1434
|
# }
|
1431
1435
|
#
|
1432
1436
|
# @!attribute [rw] awskms_key_arn
|
1433
|
-
# The ARN of the encryption key. Must belong to
|
1434
|
-
# destination Amazon S3 bucket.
|
1437
|
+
# The Amazon Resource Name (ARN) of the encryption key. Must belong to
|
1438
|
+
# the same AWS Region as the destination Amazon S3 bucket.
|
1435
1439
|
# @return [String]
|
1436
1440
|
#
|
1437
1441
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/KMSEncryptionConfig AWS API Documentation
|
@@ -1441,8 +1445,8 @@ module Aws::Firehose
|
|
1441
1445
|
include Aws::Structure
|
1442
1446
|
end
|
1443
1447
|
|
1444
|
-
# The stream and role ARNs for a Kinesis
|
1445
|
-
# delivery stream.
|
1448
|
+
# The stream and role Amazon Resource Names (ARNs) for a Kinesis data
|
1449
|
+
# stream used as the source for a delivery stream.
|
1446
1450
|
#
|
1447
1451
|
# @note When making an API call, you may pass KinesisStreamSourceConfiguration
|
1448
1452
|
# data as a hash:
|
@@ -1453,11 +1457,11 @@ module Aws::Firehose
|
|
1453
1457
|
# }
|
1454
1458
|
#
|
1455
1459
|
# @!attribute [rw] kinesis_stream_arn
|
1456
|
-
# The ARN of the source Kinesis stream.
|
1460
|
+
# The ARN of the source Kinesis data stream.
|
1457
1461
|
# @return [String]
|
1458
1462
|
#
|
1459
1463
|
# @!attribute [rw] role_arn
|
1460
|
-
# The ARN of the role that provides access to the source Kinesis
|
1464
|
+
# The ARN of the role that provides access to the source Kinesis data
|
1461
1465
|
# stream.
|
1462
1466
|
# @return [String]
|
1463
1467
|
#
|
@@ -1469,20 +1473,20 @@ module Aws::Firehose
|
|
1469
1473
|
include Aws::Structure
|
1470
1474
|
end
|
1471
1475
|
|
1472
|
-
# Details about a Kinesis stream used as the source for a Kinesis
|
1473
|
-
# Firehose delivery stream.
|
1476
|
+
# Details about a Kinesis data stream used as the source for a Kinesis
|
1477
|
+
# Data Firehose delivery stream.
|
1474
1478
|
#
|
1475
1479
|
# @!attribute [rw] kinesis_stream_arn
|
1476
|
-
# The ARN of the source Kinesis stream.
|
1480
|
+
# The Amazon Resource Name (ARN) of the source Kinesis data stream.
|
1477
1481
|
# @return [String]
|
1478
1482
|
#
|
1479
1483
|
# @!attribute [rw] role_arn
|
1480
|
-
# The ARN of the role used by the source Kinesis stream.
|
1484
|
+
# The ARN of the role used by the source Kinesis data stream.
|
1481
1485
|
# @return [String]
|
1482
1486
|
#
|
1483
1487
|
# @!attribute [rw] delivery_start_timestamp
|
1484
|
-
# Kinesis Firehose starts retrieving records from the Kinesis
|
1485
|
-
# starting with this time stamp.
|
1488
|
+
# Kinesis Data Firehose starts retrieving records from the Kinesis
|
1489
|
+
# data stream starting with this time stamp.
|
1486
1490
|
# @return [Time]
|
1487
1491
|
#
|
1488
1492
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/KinesisStreamSourceDescription AWS API Documentation
|
@@ -1514,7 +1518,7 @@ module Aws::Firehose
|
|
1514
1518
|
# * `DirectPut`\: Provider applications access the delivery stream
|
1515
1519
|
# directly.
|
1516
1520
|
#
|
1517
|
-
# * `KinesisStreamAsSource`\: The delivery stream uses a Kinesis
|
1521
|
+
# * `KinesisStreamAsSource`\: The delivery stream uses a Kinesis data
|
1518
1522
|
# stream as a source.
|
1519
1523
|
#
|
1520
1524
|
# This parameter is optional. If this parameter is omitted, delivery
|
@@ -1550,6 +1554,61 @@ module Aws::Firehose
|
|
1550
1554
|
include Aws::Structure
|
1551
1555
|
end
|
1552
1556
|
|
1557
|
+
# @note When making an API call, you may pass ListTagsForDeliveryStreamInput
|
1558
|
+
# data as a hash:
|
1559
|
+
#
|
1560
|
+
# {
|
1561
|
+
# delivery_stream_name: "DeliveryStreamName", # required
|
1562
|
+
# exclusive_start_tag_key: "TagKey",
|
1563
|
+
# limit: 1,
|
1564
|
+
# }
|
1565
|
+
#
|
1566
|
+
# @!attribute [rw] delivery_stream_name
|
1567
|
+
# The name of the delivery stream whose tags you want to list.
|
1568
|
+
# @return [String]
|
1569
|
+
#
|
1570
|
+
# @!attribute [rw] exclusive_start_tag_key
|
1571
|
+
# The key to use as the starting point for the list of tags. If you
|
1572
|
+
# set this parameter, `ListTagsForDeliveryStream` gets all tags that
|
1573
|
+
# occur after `ExclusiveStartTagKey`.
|
1574
|
+
# @return [String]
|
1575
|
+
#
|
1576
|
+
# @!attribute [rw] limit
|
1577
|
+
# The number of tags to return. If this number is less than the total
|
1578
|
+
# number of tags associated with the delivery stream, `HasMoreTags` is
|
1579
|
+
# set to `true` in the response. To list additional tags, set
|
1580
|
+
# `ExclusiveStartTagKey` to the last key in the response.
|
1581
|
+
# @return [Integer]
|
1582
|
+
#
|
1583
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/ListTagsForDeliveryStreamInput AWS API Documentation
|
1584
|
+
#
|
1585
|
+
class ListTagsForDeliveryStreamInput < Struct.new(
|
1586
|
+
:delivery_stream_name,
|
1587
|
+
:exclusive_start_tag_key,
|
1588
|
+
:limit)
|
1589
|
+
include Aws::Structure
|
1590
|
+
end
|
1591
|
+
|
1592
|
+
# @!attribute [rw] tags
|
1593
|
+
# A list of tags associated with `DeliveryStreamName`, starting with
|
1594
|
+
# the first tag after `ExclusiveStartTagKey` and up to the specified
|
1595
|
+
# `Limit`.
|
1596
|
+
# @return [Array<Types::Tag>]
|
1597
|
+
#
|
1598
|
+
# @!attribute [rw] has_more_tags
|
1599
|
+
# If this is `true` in the response, more tags are available. To list
|
1600
|
+
# the remaining tags, set `ExclusiveStartTagKey` to the key of the
|
1601
|
+
# last tag returned and call `ListTagsForDeliveryStream` again.
|
1602
|
+
# @return [Boolean]
|
1603
|
+
#
|
1604
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/ListTagsForDeliveryStreamOutput AWS API Documentation
|
1605
|
+
#
|
1606
|
+
class ListTagsForDeliveryStreamOutput < Struct.new(
|
1607
|
+
:tags,
|
1608
|
+
:has_more_tags)
|
1609
|
+
include Aws::Structure
|
1610
|
+
end
|
1611
|
+
|
1553
1612
|
# Describes a data processing configuration.
|
1554
1613
|
#
|
1555
1614
|
# @note When making an API call, you may pass ProcessingConfiguration
|
@@ -1857,7 +1916,7 @@ module Aws::Firehose
|
|
1857
1916
|
# }
|
1858
1917
|
#
|
1859
1918
|
# @!attribute [rw] role_arn
|
1860
|
-
# The ARN of the AWS credentials.
|
1919
|
+
# The Amazon Resource Name (ARN) of the AWS credentials.
|
1861
1920
|
# @return [String]
|
1862
1921
|
#
|
1863
1922
|
# @!attribute [rw] cluster_jdbc_url
|
@@ -1877,8 +1936,9 @@ module Aws::Firehose
|
|
1877
1936
|
# @return [String]
|
1878
1937
|
#
|
1879
1938
|
# @!attribute [rw] retry_options
|
1880
|
-
# The retry behavior in case Kinesis Firehose is unable to
|
1881
|
-
# documents to Amazon Redshift. Default value is 3600 (60
|
1939
|
+
# The retry behavior in case Kinesis Data Firehose is unable to
|
1940
|
+
# deliver documents to Amazon Redshift. Default value is 3600 (60
|
1941
|
+
# minutes).
|
1882
1942
|
# @return [Types::RedshiftRetryOptions]
|
1883
1943
|
#
|
1884
1944
|
# @!attribute [rw] s3_configuration
|
@@ -1887,7 +1947,7 @@ module Aws::Firehose
|
|
1887
1947
|
# topic for CreateDeliveryStream.
|
1888
1948
|
#
|
1889
1949
|
# The compression formats `SNAPPY` or `ZIP` cannot be specified in
|
1890
|
-
#
|
1950
|
+
# `RedshiftDestinationConfiguration.S3Configuration` because the
|
1891
1951
|
# Amazon Redshift `COPY` operation that reads from the S3 bucket
|
1892
1952
|
# doesn't support these compression formats.
|
1893
1953
|
# @return [Types::S3DestinationConfiguration]
|
@@ -1928,7 +1988,7 @@ module Aws::Firehose
|
|
1928
1988
|
# Describes a destination in Amazon Redshift.
|
1929
1989
|
#
|
1930
1990
|
# @!attribute [rw] role_arn
|
1931
|
-
# The ARN of the AWS credentials.
|
1991
|
+
# The Amazon Resource Name (ARN) of the AWS credentials.
|
1932
1992
|
# @return [String]
|
1933
1993
|
#
|
1934
1994
|
# @!attribute [rw] cluster_jdbc_url
|
@@ -1944,8 +2004,9 @@ module Aws::Firehose
|
|
1944
2004
|
# @return [String]
|
1945
2005
|
#
|
1946
2006
|
# @!attribute [rw] retry_options
|
1947
|
-
# The retry behavior in case Kinesis Firehose is unable to
|
1948
|
-
# documents to Amazon Redshift. Default value is 3600 (60
|
2007
|
+
# The retry behavior in case Kinesis Data Firehose is unable to
|
2008
|
+
# deliver documents to Amazon Redshift. Default value is 3600 (60
|
2009
|
+
# minutes).
|
1949
2010
|
# @return [Types::RedshiftRetryOptions]
|
1950
2011
|
#
|
1951
2012
|
# @!attribute [rw] s3_destination_description
|
@@ -2067,7 +2128,7 @@ module Aws::Firehose
|
|
2067
2128
|
# }
|
2068
2129
|
#
|
2069
2130
|
# @!attribute [rw] role_arn
|
2070
|
-
# The ARN of the AWS credentials.
|
2131
|
+
# The Amazon Resource Name (ARN) of the AWS credentials.
|
2071
2132
|
# @return [String]
|
2072
2133
|
#
|
2073
2134
|
# @!attribute [rw] cluster_jdbc_url
|
@@ -2087,15 +2148,16 @@ module Aws::Firehose
|
|
2087
2148
|
# @return [String]
|
2088
2149
|
#
|
2089
2150
|
# @!attribute [rw] retry_options
|
2090
|
-
# The retry behavior in case Kinesis Firehose is unable to
|
2091
|
-
# documents to Amazon Redshift. Default value is 3600 (60
|
2151
|
+
# The retry behavior in case Kinesis Data Firehose is unable to
|
2152
|
+
# deliver documents to Amazon Redshift. Default value is 3600 (60
|
2153
|
+
# minutes).
|
2092
2154
|
# @return [Types::RedshiftRetryOptions]
|
2093
2155
|
#
|
2094
2156
|
# @!attribute [rw] s3_update
|
2095
2157
|
# The Amazon S3 destination.
|
2096
2158
|
#
|
2097
2159
|
# The compression formats `SNAPPY` or `ZIP` cannot be specified in
|
2098
|
-
#
|
2160
|
+
# `RedshiftDestinationUpdate.S3Update` because the Amazon Redshift
|
2099
2161
|
# `COPY` operation that reads from the S3 bucket doesn't support
|
2100
2162
|
# these compression formats.
|
2101
2163
|
# @return [Types::S3DestinationUpdate]
|
@@ -2133,7 +2195,7 @@ module Aws::Firehose
|
|
2133
2195
|
include Aws::Structure
|
2134
2196
|
end
|
2135
2197
|
|
2136
|
-
# Configures retry behavior in case Kinesis Firehose is unable to
|
2198
|
+
# Configures retry behavior in case Kinesis Data Firehose is unable to
|
2137
2199
|
# deliver documents to Amazon Redshift.
|
2138
2200
|
#
|
2139
2201
|
# @note When making an API call, you may pass RedshiftRetryOptions
|
@@ -2144,12 +2206,12 @@ module Aws::Firehose
|
|
2144
2206
|
# }
|
2145
2207
|
#
|
2146
2208
|
# @!attribute [rw] duration_in_seconds
|
2147
|
-
# The length of time during which Kinesis Firehose retries
|
2148
|
-
# after a failure, starting from the initial request and
|
2149
|
-
# first attempt. The default value is 3600 seconds (60
|
2150
|
-
# Kinesis Firehose does not retry if the value of
|
2151
|
-
# is 0 (zero) or if the first delivery attempt
|
2152
|
-
# current value.
|
2209
|
+
# The length of time during which Kinesis Data Firehose retries
|
2210
|
+
# delivery after a failure, starting from the initial request and
|
2211
|
+
# including the first attempt. The default value is 3600 seconds (60
|
2212
|
+
# minutes). Kinesis Data Firehose does not retry if the value of
|
2213
|
+
# `DurationInSeconds` is 0 (zero) or if the first delivery attempt
|
2214
|
+
# takes longer than the current value.
|
2153
2215
|
# @return [Integer]
|
2154
2216
|
#
|
2155
2217
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/RedshiftRetryOptions AWS API Documentation
|
@@ -2187,7 +2249,7 @@ module Aws::Firehose
|
|
2187
2249
|
# }
|
2188
2250
|
#
|
2189
2251
|
# @!attribute [rw] role_arn
|
2190
|
-
# The ARN of the AWS credentials.
|
2252
|
+
# The Amazon Resource Name (ARN) of the AWS credentials.
|
2191
2253
|
# @return [String]
|
2192
2254
|
#
|
2193
2255
|
# @!attribute [rw] bucket_arn
|
@@ -2196,19 +2258,19 @@ module Aws::Firehose
|
|
2196
2258
|
#
|
2197
2259
|
# @!attribute [rw] prefix
|
2198
2260
|
# The "YYYY/MM/DD/HH" time format prefix is automatically used for
|
2199
|
-
# delivered S3 files. You can specify an extra prefix to be
|
2200
|
-
# front of the time format prefix. If the prefix ends with a
|
2201
|
-
# appears as a folder in the S3 bucket. For more
|
2202
|
-
# [Amazon S3 Object Name Format][1] in the *Amazon
|
2203
|
-
# Developer Guide*.
|
2261
|
+
# delivered Amazon S3 files. You can specify an extra prefix to be
|
2262
|
+
# added in front of the time format prefix. If the prefix ends with a
|
2263
|
+
# slash, it appears as a folder in the S3 bucket. For more
|
2264
|
+
# information, see [Amazon S3 Object Name Format][1] in the *Amazon
|
2265
|
+
# Kinesis Data Firehose Developer Guide*.
|
2204
2266
|
#
|
2205
2267
|
#
|
2206
2268
|
#
|
2207
|
-
# [1]: http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html
|
2269
|
+
# [1]: http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#s3-object-name
|
2208
2270
|
# @return [String]
|
2209
2271
|
#
|
2210
2272
|
# @!attribute [rw] buffering_hints
|
2211
|
-
# The buffering option. If no value is specified,
|
2273
|
+
# The buffering option. If no value is specified, `BufferingHints`
|
2212
2274
|
# object default values are used.
|
2213
2275
|
# @return [Types::BufferingHints]
|
2214
2276
|
#
|
@@ -2246,7 +2308,7 @@ module Aws::Firehose
|
|
2246
2308
|
# Describes a destination in Amazon S3.
|
2247
2309
|
#
|
2248
2310
|
# @!attribute [rw] role_arn
|
2249
|
-
# The ARN of the AWS credentials.
|
2311
|
+
# The Amazon Resource Name (ARN) of the AWS credentials.
|
2250
2312
|
# @return [String]
|
2251
2313
|
#
|
2252
2314
|
# @!attribute [rw] bucket_arn
|
@@ -2255,19 +2317,19 @@ module Aws::Firehose
|
|
2255
2317
|
#
|
2256
2318
|
# @!attribute [rw] prefix
|
2257
2319
|
# The "YYYY/MM/DD/HH" time format prefix is automatically used for
|
2258
|
-
# delivered S3 files. You can specify an extra prefix to be
|
2259
|
-
# front of the time format prefix. If the prefix ends with a
|
2260
|
-
# appears as a folder in the S3 bucket. For more
|
2261
|
-
# [Amazon S3 Object Name Format][1] in the *Amazon
|
2262
|
-
# Developer Guide*.
|
2320
|
+
# delivered Amazon S3 files. You can specify an extra prefix to be
|
2321
|
+
# added in front of the time format prefix. If the prefix ends with a
|
2322
|
+
# slash, it appears as a folder in the S3 bucket. For more
|
2323
|
+
# information, see [Amazon S3 Object Name Format][1] in the *Amazon
|
2324
|
+
# Kinesis Data Firehose Developer Guide*.
|
2263
2325
|
#
|
2264
2326
|
#
|
2265
2327
|
#
|
2266
|
-
# [1]: http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html
|
2328
|
+
# [1]: http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#s3-object-name
|
2267
2329
|
# @return [String]
|
2268
2330
|
#
|
2269
2331
|
# @!attribute [rw] buffering_hints
|
2270
|
-
# The buffering option. If no value is specified,
|
2332
|
+
# The buffering option. If no value is specified, `BufferingHints`
|
2271
2333
|
# object default values are used.
|
2272
2334
|
# @return [Types::BufferingHints]
|
2273
2335
|
#
|
@@ -2326,7 +2388,7 @@ module Aws::Firehose
|
|
2326
2388
|
# }
|
2327
2389
|
#
|
2328
2390
|
# @!attribute [rw] role_arn
|
2329
|
-
# The ARN of the AWS credentials.
|
2391
|
+
# The Amazon Resource Name (ARN) of the AWS credentials.
|
2330
2392
|
# @return [String]
|
2331
2393
|
#
|
2332
2394
|
# @!attribute [rw] bucket_arn
|
@@ -2335,19 +2397,19 @@ module Aws::Firehose
|
|
2335
2397
|
#
|
2336
2398
|
# @!attribute [rw] prefix
|
2337
2399
|
# The "YYYY/MM/DD/HH" time format prefix is automatically used for
|
2338
|
-
# delivered S3 files. You can specify an extra prefix to be
|
2339
|
-
# front of the time format prefix. If the prefix ends with a
|
2340
|
-
# appears as a folder in the S3 bucket. For more
|
2341
|
-
# [Amazon S3 Object Name Format][1] in the *Amazon
|
2342
|
-
# Developer Guide*.
|
2400
|
+
# delivered Amazon S3 files. You can specify an extra prefix to be
|
2401
|
+
# added in front of the time format prefix. If the prefix ends with a
|
2402
|
+
# slash, it appears as a folder in the S3 bucket. For more
|
2403
|
+
# information, see [Amazon S3 Object Name Format][1] in the *Amazon
|
2404
|
+
# Kinesis Data Firehose Developer Guide*.
|
2343
2405
|
#
|
2344
2406
|
#
|
2345
2407
|
#
|
2346
|
-
# [1]: http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html
|
2408
|
+
# [1]: http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#s3-object-name
|
2347
2409
|
# @return [String]
|
2348
2410
|
#
|
2349
2411
|
# @!attribute [rw] buffering_hints
|
2350
|
-
# The buffering option. If no value is specified,
|
2412
|
+
# The buffering option. If no value is specified, `BufferingHints`
|
2351
2413
|
# object default values are used.
|
2352
2414
|
# @return [Types::BufferingHints]
|
2353
2415
|
#
|
@@ -2382,11 +2444,11 @@ module Aws::Firehose
|
|
2382
2444
|
include Aws::Structure
|
2383
2445
|
end
|
2384
2446
|
|
2385
|
-
# Details about a Kinesis stream used as the source for a Kinesis
|
2386
|
-
# Firehose delivery stream.
|
2447
|
+
# Details about a Kinesis data stream used as the source for a Kinesis
|
2448
|
+
# Data Firehose delivery stream.
|
2387
2449
|
#
|
2388
2450
|
# @!attribute [rw] kinesis_stream_source_description
|
2389
|
-
# The KinesisStreamSourceDescription value for the source Kinesis
|
2451
|
+
# The KinesisStreamSourceDescription value for the source Kinesis data
|
2390
2452
|
# stream.
|
2391
2453
|
# @return [Types::KinesisStreamSourceDescription]
|
2392
2454
|
#
|
@@ -2454,39 +2516,39 @@ module Aws::Firehose
|
|
2454
2516
|
# }
|
2455
2517
|
#
|
2456
2518
|
# @!attribute [rw] hec_endpoint
|
2457
|
-
# The HTTP Event Collector (HEC) endpoint to which Kinesis
|
2458
|
-
# sends your data.
|
2519
|
+
# The HTTP Event Collector (HEC) endpoint to which Kinesis Data
|
2520
|
+
# Firehose sends your data.
|
2459
2521
|
# @return [String]
|
2460
2522
|
#
|
2461
2523
|
# @!attribute [rw] hec_endpoint_type
|
2462
|
-
# This type can be either "Raw" or "Event"
|
2524
|
+
# This type can be either "Raw" or "Event."
|
2463
2525
|
# @return [String]
|
2464
2526
|
#
|
2465
2527
|
# @!attribute [rw] hec_token
|
2466
|
-
# This is a GUID you obtain from your Splunk cluster when you
|
2467
|
-
# new HEC endpoint.
|
2528
|
+
# This is a GUID that you obtain from your Splunk cluster when you
|
2529
|
+
# create a new HEC endpoint.
|
2468
2530
|
# @return [String]
|
2469
2531
|
#
|
2470
2532
|
# @!attribute [rw] hec_acknowledgment_timeout_in_seconds
|
2471
|
-
# The amount of time that Kinesis Firehose waits to receive an
|
2533
|
+
# The amount of time that Kinesis Data Firehose waits to receive an
|
2472
2534
|
# acknowledgment from Splunk after it sends it data. At the end of the
|
2473
|
-
# timeout period Kinesis Firehose either tries to send the data
|
2474
|
-
# or considers it an error, based on your retry settings.
|
2535
|
+
# timeout period, Kinesis Data Firehose either tries to send the data
|
2536
|
+
# again or considers it an error, based on your retry settings.
|
2475
2537
|
# @return [Integer]
|
2476
2538
|
#
|
2477
2539
|
# @!attribute [rw] retry_options
|
2478
|
-
# The retry behavior in case Kinesis Firehose is unable to
|
2479
|
-
# data to Splunk or if it doesn't receive an acknowledgment
|
2480
|
-
# receipt from Splunk.
|
2540
|
+
# The retry behavior in case Kinesis Data Firehose is unable to
|
2541
|
+
# deliver data to Splunk, or if it doesn't receive an acknowledgment
|
2542
|
+
# of receipt from Splunk.
|
2481
2543
|
# @return [Types::SplunkRetryOptions]
|
2482
2544
|
#
|
2483
2545
|
# @!attribute [rw] s3_backup_mode
|
2484
2546
|
# Defines how documents should be delivered to Amazon S3. When set to
|
2485
|
-
# `FailedDocumentsOnly`, Kinesis Firehose writes any data that
|
2486
|
-
# not be indexed to the configured Amazon S3 destination. When
|
2487
|
-
# `AllDocuments`, Kinesis Firehose delivers all incoming
|
2488
|
-
# Amazon S3, and also writes failed documents to Amazon S3.
|
2489
|
-
# value is `FailedDocumentsOnly`.
|
2547
|
+
# `FailedDocumentsOnly`, Kinesis Data Firehose writes any data that
|
2548
|
+
# could not be indexed to the configured Amazon S3 destination. When
|
2549
|
+
# set to `AllDocuments`, Kinesis Data Firehose delivers all incoming
|
2550
|
+
# records to Amazon S3, and also writes failed documents to Amazon S3.
|
2551
|
+
# Default value is `FailedDocumentsOnly`.
|
2490
2552
|
# @return [String]
|
2491
2553
|
#
|
2492
2554
|
# @!attribute [rw] s3_configuration
|
@@ -2519,12 +2581,12 @@ module Aws::Firehose
|
|
2519
2581
|
# Describes a destination in Splunk.
|
2520
2582
|
#
|
2521
2583
|
# @!attribute [rw] hec_endpoint
|
2522
|
-
# The HTTP Event Collector (HEC) endpoint to which Kinesis
|
2523
|
-
# sends your data.
|
2584
|
+
# The HTTP Event Collector (HEC) endpoint to which Kinesis Data
|
2585
|
+
# Firehose sends your data.
|
2524
2586
|
# @return [String]
|
2525
2587
|
#
|
2526
2588
|
# @!attribute [rw] hec_endpoint_type
|
2527
|
-
# This type can be either "Raw" or "Event"
|
2589
|
+
# This type can be either "Raw" or "Event."
|
2528
2590
|
# @return [String]
|
2529
2591
|
#
|
2530
2592
|
# @!attribute [rw] hec_token
|
@@ -2533,25 +2595,25 @@ module Aws::Firehose
|
|
2533
2595
|
# @return [String]
|
2534
2596
|
#
|
2535
2597
|
# @!attribute [rw] hec_acknowledgment_timeout_in_seconds
|
2536
|
-
# The amount of time that Kinesis Firehose waits to receive an
|
2598
|
+
# The amount of time that Kinesis Data Firehose waits to receive an
|
2537
2599
|
# acknowledgment from Splunk after it sends it data. At the end of the
|
2538
|
-
# timeout period Kinesis Firehose either tries to send the data
|
2539
|
-
# or considers it an error, based on your retry settings.
|
2600
|
+
# timeout period, Kinesis Data Firehose either tries to send the data
|
2601
|
+
# again or considers it an error, based on your retry settings.
|
2540
2602
|
# @return [Integer]
|
2541
2603
|
#
|
2542
2604
|
# @!attribute [rw] retry_options
|
2543
|
-
# The retry behavior in case Kinesis Firehose is unable to
|
2544
|
-
# data to Splunk or if it doesn't receive an acknowledgment
|
2545
|
-
# receipt from Splunk.
|
2605
|
+
# The retry behavior in case Kinesis Data Firehose is unable to
|
2606
|
+
# deliver data to Splunk or if it doesn't receive an acknowledgment
|
2607
|
+
# of receipt from Splunk.
|
2546
2608
|
# @return [Types::SplunkRetryOptions]
|
2547
2609
|
#
|
2548
2610
|
# @!attribute [rw] s3_backup_mode
|
2549
2611
|
# Defines how documents should be delivered to Amazon S3. When set to
|
2550
|
-
# `FailedDocumentsOnly`, Kinesis Firehose writes any data that
|
2551
|
-
# not be indexed to the configured Amazon S3 destination. When
|
2552
|
-
# `AllDocuments`, Kinesis Firehose delivers all incoming
|
2553
|
-
# Amazon S3, and also writes failed documents to Amazon S3.
|
2554
|
-
# value is `FailedDocumentsOnly`.
|
2612
|
+
# `FailedDocumentsOnly`, Kinesis Data Firehose writes any data that
|
2613
|
+
# could not be indexed to the configured Amazon S3 destination. When
|
2614
|
+
# set to `AllDocuments`, Kinesis Data Firehose delivers all incoming
|
2615
|
+
# records to Amazon S3, and also writes failed documents to Amazon S3.
|
2616
|
+
# Default value is `FailedDocumentsOnly`.
|
2555
2617
|
# @return [String]
|
2556
2618
|
#
|
2557
2619
|
# @!attribute [rw] s3_destination_description
|
@@ -2638,39 +2700,39 @@ module Aws::Firehose
|
|
2638
2700
|
# }
|
2639
2701
|
#
|
2640
2702
|
# @!attribute [rw] hec_endpoint
|
2641
|
-
# The HTTP Event Collector (HEC) endpoint to which Kinesis
|
2642
|
-
# sends your data.
|
2703
|
+
# The HTTP Event Collector (HEC) endpoint to which Kinesis Data
|
2704
|
+
# Firehose sends your data.
|
2643
2705
|
# @return [String]
|
2644
2706
|
#
|
2645
2707
|
# @!attribute [rw] hec_endpoint_type
|
2646
|
-
# This type can be either "Raw" or "Event"
|
2708
|
+
# This type can be either "Raw" or "Event."
|
2647
2709
|
# @return [String]
|
2648
2710
|
#
|
2649
2711
|
# @!attribute [rw] hec_token
|
2650
|
-
#
|
2712
|
+
# A GUID that you obtain from your Splunk cluster when you create a
|
2651
2713
|
# new HEC endpoint.
|
2652
2714
|
# @return [String]
|
2653
2715
|
#
|
2654
2716
|
# @!attribute [rw] hec_acknowledgment_timeout_in_seconds
|
2655
|
-
# The amount of time that Kinesis Firehose waits to receive an
|
2656
|
-
# acknowledgment from Splunk after it sends
|
2657
|
-
# timeout period Kinesis Firehose either tries to send the data
|
2658
|
-
# or considers it an error, based on your retry settings.
|
2717
|
+
# The amount of time that Kinesis Data Firehose waits to receive an
|
2718
|
+
# acknowledgment from Splunk after it sends data. At the end of the
|
2719
|
+
# timeout period, Kinesis Data Firehose either tries to send the data
|
2720
|
+
# again or considers it an error, based on your retry settings.
|
2659
2721
|
# @return [Integer]
|
2660
2722
|
#
|
2661
2723
|
# @!attribute [rw] retry_options
|
2662
|
-
# The retry behavior in case Kinesis Firehose is unable to
|
2663
|
-
# data to Splunk or if it doesn't receive an acknowledgment
|
2664
|
-
# receipt from Splunk.
|
2724
|
+
# The retry behavior in case Kinesis Data Firehose is unable to
|
2725
|
+
# deliver data to Splunk or if it doesn't receive an acknowledgment
|
2726
|
+
# of receipt from Splunk.
|
2665
2727
|
# @return [Types::SplunkRetryOptions]
|
2666
2728
|
#
|
2667
2729
|
# @!attribute [rw] s3_backup_mode
|
2668
2730
|
# Defines how documents should be delivered to Amazon S3. When set to
|
2669
|
-
# `FailedDocumentsOnly`, Kinesis Firehose writes any data that
|
2670
|
-
# not be indexed to the configured Amazon S3 destination. When
|
2671
|
-
# `AllDocuments`, Kinesis Firehose delivers all incoming
|
2672
|
-
# Amazon S3, and also writes failed documents to Amazon S3.
|
2673
|
-
# value is `FailedDocumentsOnly`.
|
2731
|
+
# `FailedDocumentsOnly`, Kinesis Data Firehose writes any data that
|
2732
|
+
# could not be indexed to the configured Amazon S3 destination. When
|
2733
|
+
# set to `AllDocuments`, Kinesis Data Firehose delivers all incoming
|
2734
|
+
# records to Amazon S3, and also writes failed documents to Amazon S3.
|
2735
|
+
# Default value is `FailedDocumentsOnly`.
|
2674
2736
|
# @return [String]
|
2675
2737
|
#
|
2676
2738
|
# @!attribute [rw] s3_update
|
@@ -2700,8 +2762,8 @@ module Aws::Firehose
|
|
2700
2762
|
include Aws::Structure
|
2701
2763
|
end
|
2702
2764
|
|
2703
|
-
# Configures retry behavior in case Kinesis Firehose is unable to
|
2704
|
-
# deliver documents to Splunk or if it doesn't receive an
|
2765
|
+
# Configures retry behavior in case Kinesis Data Firehose is unable to
|
2766
|
+
# deliver documents to Splunk, or if it doesn't receive an
|
2705
2767
|
# acknowledgment from Splunk.
|
2706
2768
|
#
|
2707
2769
|
# @note When making an API call, you may pass SplunkRetryOptions
|
@@ -2712,10 +2774,11 @@ module Aws::Firehose
|
|
2712
2774
|
# }
|
2713
2775
|
#
|
2714
2776
|
# @!attribute [rw] duration_in_seconds
|
2715
|
-
# The total amount of time that Kinesis Firehose spends on
|
2716
|
-
# This duration starts after the initial attempt to send data
|
2717
|
-
# Splunk fails
|
2718
|
-
# Firehose waits for acknowledgment from Splunk after
|
2777
|
+
# The total amount of time that Kinesis Data Firehose spends on
|
2778
|
+
# retries. This duration starts after the initial attempt to send data
|
2779
|
+
# to Splunk fails. It doesn't include the periods during which
|
2780
|
+
# Kinesis Data Firehose waits for acknowledgment from Splunk after
|
2781
|
+
# each attempt.
|
2719
2782
|
# @return [Integer]
|
2720
2783
|
#
|
2721
2784
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/SplunkRetryOptions AWS API Documentation
|
@@ -2725,6 +2788,99 @@ module Aws::Firehose
|
|
2725
2788
|
include Aws::Structure
|
2726
2789
|
end
|
2727
2790
|
|
2791
|
+
# Metadata that you can assign to a delivery stream, consisting of a
|
2792
|
+
# key-value pair.
|
2793
|
+
#
|
2794
|
+
# @note When making an API call, you may pass Tag
|
2795
|
+
# data as a hash:
|
2796
|
+
#
|
2797
|
+
# {
|
2798
|
+
# key: "TagKey", # required
|
2799
|
+
# value: "TagValue",
|
2800
|
+
# }
|
2801
|
+
#
|
2802
|
+
# @!attribute [rw] key
|
2803
|
+
# A unique identifier for the tag. Maximum length: 128 characters.
|
2804
|
+
# Valid characters: Unicode letters, digits, white space, \_ . / = + -
|
2805
|
+
# % @
|
2806
|
+
# @return [String]
|
2807
|
+
#
|
2808
|
+
# @!attribute [rw] value
|
2809
|
+
# An optional string, which you can use to describe or define the tag.
|
2810
|
+
# Maximum length: 256 characters. Valid characters: Unicode letters,
|
2811
|
+
# digits, white space, \_ . / = + - % @
|
2812
|
+
# @return [String]
|
2813
|
+
#
|
2814
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/Tag AWS API Documentation
|
2815
|
+
#
|
2816
|
+
class Tag < Struct.new(
|
2817
|
+
:key,
|
2818
|
+
:value)
|
2819
|
+
include Aws::Structure
|
2820
|
+
end
|
2821
|
+
|
2822
|
+
# @note When making an API call, you may pass TagDeliveryStreamInput
|
2823
|
+
# data as a hash:
|
2824
|
+
#
|
2825
|
+
# {
|
2826
|
+
# delivery_stream_name: "DeliveryStreamName", # required
|
2827
|
+
# tags: [ # required
|
2828
|
+
# {
|
2829
|
+
# key: "TagKey", # required
|
2830
|
+
# value: "TagValue",
|
2831
|
+
# },
|
2832
|
+
# ],
|
2833
|
+
# }
|
2834
|
+
#
|
2835
|
+
# @!attribute [rw] delivery_stream_name
|
2836
|
+
# The name of the delivery stream to which you want to add the tags.
|
2837
|
+
# @return [String]
|
2838
|
+
#
|
2839
|
+
# @!attribute [rw] tags
|
2840
|
+
# A set of key-value pairs to use to create the tags.
|
2841
|
+
# @return [Array<Types::Tag>]
|
2842
|
+
#
|
2843
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/TagDeliveryStreamInput AWS API Documentation
|
2844
|
+
#
|
2845
|
+
class TagDeliveryStreamInput < Struct.new(
|
2846
|
+
:delivery_stream_name,
|
2847
|
+
:tags)
|
2848
|
+
include Aws::Structure
|
2849
|
+
end
|
2850
|
+
|
2851
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/TagDeliveryStreamOutput AWS API Documentation
|
2852
|
+
#
|
2853
|
+
class TagDeliveryStreamOutput < Aws::EmptyStructure; end
|
2854
|
+
|
2855
|
+
# @note When making an API call, you may pass UntagDeliveryStreamInput
|
2856
|
+
# data as a hash:
|
2857
|
+
#
|
2858
|
+
# {
|
2859
|
+
# delivery_stream_name: "DeliveryStreamName", # required
|
2860
|
+
# tag_keys: ["TagKey"], # required
|
2861
|
+
# }
|
2862
|
+
#
|
2863
|
+
# @!attribute [rw] delivery_stream_name
|
2864
|
+
# The name of the delivery stream.
|
2865
|
+
# @return [String]
|
2866
|
+
#
|
2867
|
+
# @!attribute [rw] tag_keys
|
2868
|
+
# A list of tag keys. Each corresponding tag is removed from the
|
2869
|
+
# delivery stream.
|
2870
|
+
# @return [Array<String>]
|
2871
|
+
#
|
2872
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/UntagDeliveryStreamInput AWS API Documentation
|
2873
|
+
#
|
2874
|
+
class UntagDeliveryStreamInput < Struct.new(
|
2875
|
+
:delivery_stream_name,
|
2876
|
+
:tag_keys)
|
2877
|
+
include Aws::Structure
|
2878
|
+
end
|
2879
|
+
|
2880
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/UntagDeliveryStreamOutput AWS API Documentation
|
2881
|
+
#
|
2882
|
+
class UntagDeliveryStreamOutput < Aws::EmptyStructure; end
|
2883
|
+
|
2728
2884
|
# @note When making an API call, you may pass UpdateDestinationInput
|
2729
2885
|
# data as a hash:
|
2730
2886
|
#
|
@@ -2997,11 +3153,11 @@ module Aws::Firehose
|
|
2997
3153
|
# @return [String]
|
2998
3154
|
#
|
2999
3155
|
# @!attribute [rw] current_delivery_stream_version_id
|
3000
|
-
# Obtain this value from the
|
3001
|
-
# DeliveryStreamDescription. This value is required, and helps the
|
3002
|
-
# service
|
3003
|
-
#
|
3004
|
-
# destination fails. After the update is successful, the
|
3156
|
+
# Obtain this value from the `VersionId` result of
|
3157
|
+
# DeliveryStreamDescription. This value is required, and it helps the
|
3158
|
+
# service perform conditional operations. For example, if there is an
|
3159
|
+
# interleaving update and this value is null, then the update
|
3160
|
+
# destination fails. After the update is successful, the `VersionId`
|
3005
3161
|
# value is updated. The service then performs a merge of the old
|
3006
3162
|
# configuration with the new configuration.
|
3007
3163
|
# @return [String]
|