aws-sdk-firehose 1.0.0.rc13 → 1.0.0.rc14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-firehose.rb +1 -1
- data/lib/aws-sdk-firehose/client.rb +144 -67
- data/lib/aws-sdk-firehose/client_api.rb +55 -0
- data/lib/aws-sdk-firehose/types.rb +253 -74
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 3ca7250a5f2ae17471f564ce6d9661628c9b79fa
|
4
|
+
data.tar.gz: 2533dd5d1e0f468de1bfcaa02c0687ac77af4fba
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 43e33303e3c6a1a0af545d308c04017789299fceac977759eddc8107add62eff0687178721a3572ca94a5c3cb2e57c4c1636caedbc4bafa39f943ed722e3117f
|
7
|
+
data.tar.gz: 1243e4979d9907bcb6c9d3739f56991fe36a2501465d86d162e0d4f60ad4c60f923acf5c04cb48b73c510a3b98d9a2183313a1979c11508421e27110d655c0ea
|
data/lib/aws-sdk-firehose.rb
CHANGED
@@ -166,9 +166,16 @@ module Aws::Firehose
|
|
166
166
|
# `ACTIVE` state cause an exception. To check the state of a delivery
|
167
167
|
# stream, use DescribeDeliveryStream.
|
168
168
|
#
|
169
|
+
# A Kinesis Firehose delivery stream can be configured to receive
|
170
|
+
# records directly from providers using PutRecord or PutRecordBatch, or
|
171
|
+
# it can be configured to use an existing Kinesis stream as its source.
|
172
|
+
# To specify a Kinesis stream as input, set the `DeliveryStreamType`
|
173
|
+
# parameter to `KinesisStreamAsSource`, and provide the Kinesis stream
|
174
|
+
# ARN and role ARN in the `KinesisStreamSourceConfiguration` parameter.
|
175
|
+
#
|
169
176
|
# A delivery stream is configured with a single destination: Amazon S3,
|
170
|
-
# Amazon
|
171
|
-
#
|
177
|
+
# Amazon ES, or Amazon Redshift. You must specify only one of the
|
178
|
+
# following destination configuration parameters:
|
172
179
|
# **ExtendedS3DestinationConfiguration**,
|
173
180
|
# **S3DestinationConfiguration**,
|
174
181
|
# **ElasticsearchDestinationConfiguration**, or
|
@@ -177,10 +184,10 @@ module Aws::Firehose
|
|
177
184
|
# When you specify **S3DestinationConfiguration**, you can also provide
|
178
185
|
# the following optional values: **BufferingHints**,
|
179
186
|
# **EncryptionConfiguration**, and **CompressionFormat**. By default, if
|
180
|
-
# no **BufferingHints** value is provided, Firehose buffers data
|
181
|
-
# MB or for 5 minutes, whichever condition is satisfied first.
|
182
|
-
# **BufferingHints** is a hint, so there are some cases where
|
183
|
-
# service cannot adhere to these conditions strictly; for example,
|
187
|
+
# no **BufferingHints** value is provided, Kinesis Firehose buffers data
|
188
|
+
# up to 5 MB or for 5 minutes, whichever condition is satisfied first.
|
189
|
+
# Note that **BufferingHints** is a hint, so there are some cases where
|
190
|
+
# the service cannot adhere to these conditions strictly; for example,
|
184
191
|
# record boundaries are such that the size is a little over or under the
|
185
192
|
# configured buffering size. By default, no encryption is performed. We
|
186
193
|
# strongly recommend that you enable encryption to ensure secure data
|
@@ -189,10 +196,10 @@ module Aws::Firehose
|
|
189
196
|
# A few notes about Amazon Redshift as a destination:
|
190
197
|
#
|
191
198
|
# * An Amazon Redshift destination requires an S3 bucket as intermediate
|
192
|
-
# location, as Firehose first delivers data to S3 and then
|
193
|
-
# syntax to load data into an Amazon Redshift table. This
|
194
|
-
# in the
|
195
|
-
# parameter.
|
199
|
+
# location, as Kinesis Firehose first delivers data to S3 and then
|
200
|
+
# uses `COPY` syntax to load data into an Amazon Redshift table. This
|
201
|
+
# is specified in the
|
202
|
+
# **RedshiftDestinationConfiguration.S3Configuration** parameter.
|
196
203
|
#
|
197
204
|
# * The compression formats `SNAPPY` or `ZIP` cannot be specified in
|
198
205
|
# **RedshiftDestinationConfiguration.S3Configuration** because the
|
@@ -200,14 +207,15 @@ module Aws::Firehose
|
|
200
207
|
# doesn't support these compression formats.
|
201
208
|
#
|
202
209
|
# * We strongly recommend that you use the user name and password you
|
203
|
-
# provide exclusively with Firehose, and that the permissions
|
204
|
-
# account are restricted for Amazon Redshift `INSERT`
|
210
|
+
# provide exclusively with Kinesis Firehose, and that the permissions
|
211
|
+
# for the account are restricted for Amazon Redshift `INSERT`
|
212
|
+
# permissions.
|
205
213
|
#
|
206
|
-
# Firehose assumes the IAM role that is configured as part of
|
207
|
-
# destination. The role should allow the Firehose principal
|
208
|
-
# the role, and the role should have permissions that
|
209
|
-
# to deliver the data. For more information, see [Amazon S3
|
210
|
-
# Access][1] in the *Amazon Kinesis Firehose Developer Guide*.
|
214
|
+
# Kinesis Firehose assumes the IAM role that is configured as part of
|
215
|
+
# the destination. The role should allow the Kinesis Firehose principal
|
216
|
+
# to assume the role, and the role should have permissions that allow
|
217
|
+
# the service to deliver the data. For more information, see [Amazon S3
|
218
|
+
# Bucket Access][1] in the *Amazon Kinesis Firehose Developer Guide*.
|
211
219
|
#
|
212
220
|
#
|
213
221
|
#
|
@@ -215,9 +223,24 @@ module Aws::Firehose
|
|
215
223
|
#
|
216
224
|
# @option params [required, String] :delivery_stream_name
|
217
225
|
# The name of the delivery stream. This name must be unique per AWS
|
218
|
-
# account in the same region.
|
219
|
-
#
|
220
|
-
#
|
226
|
+
# account in the same region. If the delivery streams are in different
|
227
|
+
# accounts or different regions, you can have multiple delivery streams
|
228
|
+
# with the same name.
|
229
|
+
#
|
230
|
+
# @option params [String] :delivery_stream_type
|
231
|
+
# The delivery stream type. This parameter can be one of the following
|
232
|
+
# values:
|
233
|
+
#
|
234
|
+
# * `DirectPut`\: Provider applications access the delivery stream
|
235
|
+
# directly.
|
236
|
+
#
|
237
|
+
# * `KinesisStreamAsSource`\: The delivery stream uses a Kinesis stream
|
238
|
+
# as a source.
|
239
|
+
#
|
240
|
+
# @option params [Types::KinesisStreamSourceConfiguration] :kinesis_stream_source_configuration
|
241
|
+
# When a Kinesis stream is used as the source for the delivery stream, a
|
242
|
+
# KinesisStreamSourceConfiguration containing the Kinesis stream ARN and
|
243
|
+
# the role ARN for the source stream.
|
221
244
|
#
|
222
245
|
# @option params [Types::S3DestinationConfiguration] :s3_destination_configuration
|
223
246
|
# \[Deprecated\] The destination in Amazon S3. You can specify only one
|
@@ -241,6 +264,11 @@ module Aws::Firehose
|
|
241
264
|
#
|
242
265
|
# resp = client.create_delivery_stream({
|
243
266
|
# delivery_stream_name: "DeliveryStreamName", # required
|
267
|
+
# delivery_stream_type: "DirectPut", # accepts DirectPut, KinesisStreamAsSource
|
268
|
+
# kinesis_stream_source_configuration: {
|
269
|
+
# kinesis_stream_arn: "KinesisStreamARN", # required
|
270
|
+
# role_arn: "RoleARN", # required
|
271
|
+
# },
|
244
272
|
# s3_destination_configuration: {
|
245
273
|
# role_arn: "RoleARN", # required
|
246
274
|
# bucket_arn: "BucketARN", # required
|
@@ -513,8 +541,8 @@ module Aws::Firehose
|
|
513
541
|
#
|
514
542
|
# @option params [String] :exclusive_start_destination_id
|
515
543
|
# The ID of the destination to start returning the destination
|
516
|
-
# information. Currently Firehose supports one destination per
|
517
|
-
# stream.
|
544
|
+
# information. Currently, Kinesis Firehose supports one destination per
|
545
|
+
# delivery stream.
|
518
546
|
#
|
519
547
|
# @return [Types::DescribeDeliveryStreamOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
520
548
|
#
|
@@ -533,9 +561,13 @@ module Aws::Firehose
|
|
533
561
|
# resp.delivery_stream_description.delivery_stream_name #=> String
|
534
562
|
# resp.delivery_stream_description.delivery_stream_arn #=> String
|
535
563
|
# resp.delivery_stream_description.delivery_stream_status #=> String, one of "CREATING", "DELETING", "ACTIVE"
|
564
|
+
# resp.delivery_stream_description.delivery_stream_type #=> String, one of "DirectPut", "KinesisStreamAsSource"
|
536
565
|
# resp.delivery_stream_description.version_id #=> String
|
537
566
|
# resp.delivery_stream_description.create_timestamp #=> Time
|
538
567
|
# resp.delivery_stream_description.last_update_timestamp #=> Time
|
568
|
+
# resp.delivery_stream_description.source.kinesis_stream_source_description.kinesis_stream_arn #=> String
|
569
|
+
# resp.delivery_stream_description.source.kinesis_stream_source_description.role_arn #=> String
|
570
|
+
# resp.delivery_stream_description.source.kinesis_stream_source_description.delivery_start_timestamp #=> Time
|
539
571
|
# resp.delivery_stream_description.destinations #=> Array
|
540
572
|
# resp.delivery_stream_description.destinations[0].destination_id #=> String
|
541
573
|
# resp.delivery_stream_description.destinations[0].s3_destination_description.role_arn #=> String
|
@@ -657,6 +689,36 @@ module Aws::Firehose
|
|
657
689
|
req.send_request(options)
|
658
690
|
end
|
659
691
|
|
692
|
+
# @option params [required, String] :delivery_stream_arn
|
693
|
+
#
|
694
|
+
# @return [Types::GetKinesisStreamOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
695
|
+
#
|
696
|
+
# * {Types::GetKinesisStreamOutput#kinesis_stream_arn #kinesis_stream_arn} => String
|
697
|
+
# * {Types::GetKinesisStreamOutput#credentials_for_reading_kinesis_stream #credentials_for_reading_kinesis_stream} => Types::SessionCredentials
|
698
|
+
#
|
699
|
+
# @example Request syntax with placeholder values
|
700
|
+
#
|
701
|
+
# resp = client.get_kinesis_stream({
|
702
|
+
# delivery_stream_arn: "DeliveryStreamARN", # required
|
703
|
+
# })
|
704
|
+
#
|
705
|
+
# @example Response structure
|
706
|
+
#
|
707
|
+
# resp.kinesis_stream_arn #=> String
|
708
|
+
# resp.credentials_for_reading_kinesis_stream.access_key_id #=> String
|
709
|
+
# resp.credentials_for_reading_kinesis_stream.secret_access_key #=> String
|
710
|
+
# resp.credentials_for_reading_kinesis_stream.session_token #=> String
|
711
|
+
# resp.credentials_for_reading_kinesis_stream.expiration #=> Time
|
712
|
+
#
|
713
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/GetKinesisStream AWS API Documentation
|
714
|
+
#
|
715
|
+
# @overload get_kinesis_stream(params = {})
|
716
|
+
# @param [Hash] params ({})
|
717
|
+
def get_kinesis_stream(params = {}, options = {})
|
718
|
+
req = build_request(:get_kinesis_stream, params)
|
719
|
+
req.send_request(options)
|
720
|
+
end
|
721
|
+
|
660
722
|
# Lists your delivery streams.
|
661
723
|
#
|
662
724
|
# The number of delivery streams might be too large to return using a
|
@@ -671,6 +733,18 @@ module Aws::Firehose
|
|
671
733
|
# @option params [Integer] :limit
|
672
734
|
# The maximum number of delivery streams to list.
|
673
735
|
#
|
736
|
+
# @option params [String] :delivery_stream_type
|
737
|
+
# The delivery stream type. This can be one of the following values:
|
738
|
+
#
|
739
|
+
# * `DirectPut`\: Provider applications access the delivery stream
|
740
|
+
# directly.
|
741
|
+
#
|
742
|
+
# * `KinesisStreamAsSource`\: The delivery stream uses a Kinesis stream
|
743
|
+
# as a source.
|
744
|
+
#
|
745
|
+
# This parameter is optional. If this parameter is omitted, delivery
|
746
|
+
# streams of all types are returned.
|
747
|
+
#
|
674
748
|
# @option params [String] :exclusive_start_delivery_stream_name
|
675
749
|
# The name of the delivery stream to start the list with.
|
676
750
|
#
|
@@ -683,6 +757,7 @@ module Aws::Firehose
|
|
683
757
|
#
|
684
758
|
# resp = client.list_delivery_streams({
|
685
759
|
# limit: 1,
|
760
|
+
# delivery_stream_type: "DirectPut", # accepts DirectPut, KinesisStreamAsSource
|
686
761
|
# exclusive_start_delivery_stream_name: "DeliveryStreamName",
|
687
762
|
# })
|
688
763
|
#
|
@@ -716,15 +791,15 @@ module Aws::Firehose
|
|
716
791
|
# You must specify the name of the delivery stream and the data record
|
717
792
|
# when using PutRecord. The data record consists of a data blob that can
|
718
793
|
# be up to 1,000 KB in size, and any kind of data, for example, a
|
719
|
-
# segment from a log file, geographic location data,
|
720
|
-
#
|
794
|
+
# segment from a log file, geographic location data, website clickstream
|
795
|
+
# data, and so on.
|
721
796
|
#
|
722
|
-
# Firehose buffers records before delivering them to the
|
723
|
-
# disambiguate the data blobs at the destination, a
|
724
|
-
# to use delimiters in the data, such as a newline
|
725
|
-
# character unique within the data. This allows the
|
726
|
-
# application
|
727
|
-
# from the destination.
|
797
|
+
# Kinesis Firehose buffers records before delivering them to the
|
798
|
+
# destination. To disambiguate the data blobs at the destination, a
|
799
|
+
# common solution is to use delimiters in the data, such as a newline
|
800
|
+
# (`\n`) or some other character unique within the data. This allows the
|
801
|
+
# consumer application to parse individual data items when reading the
|
802
|
+
# data from the destination.
|
728
803
|
#
|
729
804
|
# The PutRecord operation returns a **RecordId**, which is a unique
|
730
805
|
# string assigned to each record. Producer applications can use this ID
|
@@ -734,10 +809,10 @@ module Aws::Firehose
|
|
734
809
|
# back off and retry. If the exception persists, it is possible that the
|
735
810
|
# throughput limits have been exceeded for the delivery stream.
|
736
811
|
#
|
737
|
-
# Data records sent to Firehose are stored for 24 hours from the
|
738
|
-
# they are added to a delivery stream as it attempts to send the
|
739
|
-
# to the destination. If the destination is unreachable for more
|
740
|
-
# hours, the data is no longer available.
|
812
|
+
# Data records sent to Kinesis Firehose are stored for 24 hours from the
|
813
|
+
# time they are added to a delivery stream as it attempts to send the
|
814
|
+
# records to the destination. If the destination is unreachable for more
|
815
|
+
# than 24 hours, the data is no longer available.
|
741
816
|
#
|
742
817
|
#
|
743
818
|
#
|
@@ -782,10 +857,10 @@ module Aws::Firehose
|
|
782
857
|
# producers.
|
783
858
|
#
|
784
859
|
# By default, each delivery stream can take in up to 2,000 transactions
|
785
|
-
# per second, 5,000 records per second, or 5 MB per second.
|
786
|
-
#
|
787
|
-
#
|
788
|
-
#
|
860
|
+
# per second, 5,000 records per second, or 5 MB per second. If you use
|
861
|
+
# PutRecord and PutRecordBatch, the limits are an aggregate across these
|
862
|
+
# two operations for each delivery stream. For more information about
|
863
|
+
# limits, see [Amazon Kinesis Firehose Limits][1].
|
789
864
|
#
|
790
865
|
# Each PutRecordBatch request supports up to 500 records. Each record in
|
791
866
|
# the request can be as large as 1,000 KB (before 64-bit encoding), up
|
@@ -794,27 +869,28 @@ module Aws::Firehose
|
|
794
869
|
#
|
795
870
|
# You must specify the name of the delivery stream and the data record
|
796
871
|
# when using PutRecord. The data record consists of a data blob that can
|
797
|
-
# be up to 1,000 KB in size, and any kind of data
|
798
|
-
# segment from a log file, geographic location data, web site
|
872
|
+
# be up to 1,000 KB in size, and any kind of data. For example, it could
|
873
|
+
# be a segment from a log file, geographic location data, web site
|
799
874
|
# clickstream data, and so on.
|
800
875
|
#
|
801
|
-
# Firehose buffers records before delivering them to the
|
802
|
-
# disambiguate the data blobs at the destination, a
|
803
|
-
# to use delimiters in the data, such as a newline
|
804
|
-
# character unique within the data. This allows the
|
805
|
-
# application
|
806
|
-
# from the destination.
|
876
|
+
# Kinesis Firehose buffers records before delivering them to the
|
877
|
+
# destination. To disambiguate the data blobs at the destination, a
|
878
|
+
# common solution is to use delimiters in the data, such as a newline
|
879
|
+
# (`\n`) or some other character unique within the data. This allows the
|
880
|
+
# consumer application to parse individual data items when reading the
|
881
|
+
# data from the destination.
|
807
882
|
#
|
808
883
|
# The PutRecordBatch response includes a count of failed records,
|
809
884
|
# **FailedPutCount**, and an array of responses, **RequestResponses**.
|
810
885
|
# Each entry in the **RequestResponses** array provides additional
|
811
|
-
# information about the processed record
|
886
|
+
# information about the processed record. It directly correlates with a
|
812
887
|
# record in the request array using the same ordering, from the top to
|
813
888
|
# the bottom. The response array always includes the same number of
|
814
889
|
# records as the request array. **RequestResponses** includes both
|
815
|
-
# successfully and unsuccessfully processed records. Firehose
|
816
|
-
# to process all records in each PutRecordBatch request. A
|
817
|
-
# failure does not stop the processing of subsequent
|
890
|
+
# successfully and unsuccessfully processed records. Kinesis Firehose
|
891
|
+
# attempts to process all records in each PutRecordBatch request. A
|
892
|
+
# single record failure does not stop the processing of subsequent
|
893
|
+
# records.
|
818
894
|
#
|
819
895
|
# A successfully processed record includes a **RecordId** value, which
|
820
896
|
# is unique for the record. An unsuccessfully processed record includes
|
@@ -835,10 +911,10 @@ module Aws::Firehose
|
|
835
911
|
# retry. If the exception persists, it is possible that the throughput
|
836
912
|
# limits have been exceeded for the delivery stream.
|
837
913
|
#
|
838
|
-
# Data records sent to Firehose are stored for 24 hours from the
|
839
|
-
# they are added to a delivery stream as it attempts to send the
|
840
|
-
# to the destination. If the destination is unreachable for more
|
841
|
-
# hours, the data is no longer available.
|
914
|
+
# Data records sent to Kinesis Firehose are stored for 24 hours from the
|
915
|
+
# time they are added to a delivery stream as it attempts to send the
|
916
|
+
# records to the destination. If the destination is unreachable for more
|
917
|
+
# than 24 hours, the data is no longer available.
|
842
918
|
#
|
843
919
|
#
|
844
920
|
#
|
@@ -898,24 +974,25 @@ module Aws::Firehose
|
|
898
974
|
# supported. For an Amazon ES destination, you can only update to
|
899
975
|
# another Amazon ES destination.
|
900
976
|
#
|
901
|
-
# If the destination type is the same, Firehose merges the
|
902
|
-
# parameters specified with the destination configuration
|
903
|
-
# exists on the delivery stream. If any of the parameters
|
904
|
-
# specified in the call, the existing values are retained. For
|
905
|
-
# in the Amazon S3 destination, if EncryptionConfiguration is
|
906
|
-
# specified then the existing EncryptionConfiguration is maintained
|
907
|
-
# the destination.
|
977
|
+
# If the destination type is the same, Kinesis Firehose merges the
|
978
|
+
# configuration parameters specified with the destination configuration
|
979
|
+
# that already exists on the delivery stream. If any of the parameters
|
980
|
+
# are not specified in the call, the existing values are retained. For
|
981
|
+
# example, in the Amazon S3 destination, if EncryptionConfiguration is
|
982
|
+
# not specified, then the existing EncryptionConfiguration is maintained
|
983
|
+
# on the destination.
|
908
984
|
#
|
909
985
|
# If the destination type is not the same, for example, changing the
|
910
|
-
# destination from Amazon S3 to Amazon Redshift, Firehose does
|
911
|
-
# any parameters. In this case, all parameters must be
|
986
|
+
# destination from Amazon S3 to Amazon Redshift, Kinesis Firehose does
|
987
|
+
# not merge any parameters. In this case, all parameters must be
|
988
|
+
# specified.
|
912
989
|
#
|
913
|
-
# Firehose uses **CurrentDeliveryStreamVersionId** to avoid race
|
990
|
+
# Kinesis Firehose uses **CurrentDeliveryStreamVersionId** to avoid race
|
914
991
|
# conditions and conflicting merges. This is a required field, and the
|
915
992
|
# service updates the configuration only if the existing configuration
|
916
993
|
# has a version ID that matches. After the update is applied
|
917
994
|
# successfully, the version ID is updated, and can be retrieved using
|
918
|
-
# DescribeDeliveryStream.
|
995
|
+
# DescribeDeliveryStream. Use the new version ID to set
|
919
996
|
# **CurrentDeliveryStreamVersionId** in the next call.
|
920
997
|
#
|
921
998
|
# @option params [required, String] :delivery_stream_name
|
@@ -924,7 +1001,7 @@ module Aws::Firehose
|
|
924
1001
|
# @option params [required, String] :current_delivery_stream_version_id
|
925
1002
|
# Obtain this value from the **VersionId** result of
|
926
1003
|
# DeliveryStreamDescription. This value is required, and helps the
|
927
|
-
# service to perform conditional operations. For example, if there is
|
1004
|
+
# service to perform conditional operations. For example, if there is an
|
928
1005
|
# interleaving update and this value is null, then the update
|
929
1006
|
# destination fails. After the update is successful, the **VersionId**
|
930
1007
|
# value is updated. The service then performs a merge of the old
|
@@ -1185,7 +1262,7 @@ module Aws::Firehose
|
|
1185
1262
|
params: params,
|
1186
1263
|
config: config)
|
1187
1264
|
context[:gem_name] = 'aws-sdk-firehose'
|
1188
|
-
context[:gem_version] = '1.0.0.
|
1265
|
+
context[:gem_version] = '1.0.0.rc14'
|
1189
1266
|
Seahorse::Client::Request.new(handlers, context)
|
1190
1267
|
end
|
1191
1268
|
|
@@ -12,6 +12,7 @@ module Aws::Firehose
|
|
12
12
|
include Seahorse::Model
|
13
13
|
|
14
14
|
AWSKMSKeyARN = Shapes::StringShape.new(name: 'AWSKMSKeyARN')
|
15
|
+
AccessKeyId = Shapes::StringShape.new(name: 'AccessKeyId')
|
15
16
|
BooleanObject = Shapes::BooleanShape.new(name: 'BooleanObject')
|
16
17
|
BucketARN = Shapes::StringShape.new(name: 'BucketARN')
|
17
18
|
BufferingHints = Shapes::StructureShape.new(name: 'BufferingHints')
|
@@ -28,11 +29,13 @@ module Aws::Firehose
|
|
28
29
|
DataTableName = Shapes::StringShape.new(name: 'DataTableName')
|
29
30
|
DeleteDeliveryStreamInput = Shapes::StructureShape.new(name: 'DeleteDeliveryStreamInput')
|
30
31
|
DeleteDeliveryStreamOutput = Shapes::StructureShape.new(name: 'DeleteDeliveryStreamOutput')
|
32
|
+
DeliveryStartTimestamp = Shapes::TimestampShape.new(name: 'DeliveryStartTimestamp')
|
31
33
|
DeliveryStreamARN = Shapes::StringShape.new(name: 'DeliveryStreamARN')
|
32
34
|
DeliveryStreamDescription = Shapes::StructureShape.new(name: 'DeliveryStreamDescription')
|
33
35
|
DeliveryStreamName = Shapes::StringShape.new(name: 'DeliveryStreamName')
|
34
36
|
DeliveryStreamNameList = Shapes::ListShape.new(name: 'DeliveryStreamNameList')
|
35
37
|
DeliveryStreamStatus = Shapes::StringShape.new(name: 'DeliveryStreamStatus')
|
38
|
+
DeliveryStreamType = Shapes::StringShape.new(name: 'DeliveryStreamType')
|
36
39
|
DeliveryStreamVersionId = Shapes::StringShape.new(name: 'DeliveryStreamVersionId')
|
37
40
|
DescribeDeliveryStreamInput = Shapes::StructureShape.new(name: 'DescribeDeliveryStreamInput')
|
38
41
|
DescribeDeliveryStreamInputLimit = Shapes::IntegerShape.new(name: 'DescribeDeliveryStreamInputLimit')
|
@@ -59,9 +62,16 @@ module Aws::Firehose
|
|
59
62
|
ExtendedS3DestinationConfiguration = Shapes::StructureShape.new(name: 'ExtendedS3DestinationConfiguration')
|
60
63
|
ExtendedS3DestinationDescription = Shapes::StructureShape.new(name: 'ExtendedS3DestinationDescription')
|
61
64
|
ExtendedS3DestinationUpdate = Shapes::StructureShape.new(name: 'ExtendedS3DestinationUpdate')
|
65
|
+
FirehoseSource = Shapes::StringShape.new(name: 'FirehoseSource')
|
66
|
+
GetKinesisStreamInput = Shapes::StructureShape.new(name: 'GetKinesisStreamInput')
|
67
|
+
GetKinesisStreamOutput = Shapes::StructureShape.new(name: 'GetKinesisStreamOutput')
|
62
68
|
IntervalInSeconds = Shapes::IntegerShape.new(name: 'IntervalInSeconds')
|
63
69
|
InvalidArgumentException = Shapes::StructureShape.new(name: 'InvalidArgumentException')
|
70
|
+
InvalidStreamTypeException = Shapes::StructureShape.new(name: 'InvalidStreamTypeException')
|
64
71
|
KMSEncryptionConfig = Shapes::StructureShape.new(name: 'KMSEncryptionConfig')
|
72
|
+
KinesisStreamARN = Shapes::StringShape.new(name: 'KinesisStreamARN')
|
73
|
+
KinesisStreamSourceConfiguration = Shapes::StructureShape.new(name: 'KinesisStreamSourceConfiguration')
|
74
|
+
KinesisStreamSourceDescription = Shapes::StructureShape.new(name: 'KinesisStreamSourceDescription')
|
65
75
|
LimitExceededException = Shapes::StructureShape.new(name: 'LimitExceededException')
|
66
76
|
ListDeliveryStreamsInput = Shapes::StructureShape.new(name: 'ListDeliveryStreamsInput')
|
67
77
|
ListDeliveryStreamsInputLimit = Shapes::IntegerShape.new(name: 'ListDeliveryStreamsInputLimit')
|
@@ -102,8 +112,12 @@ module Aws::Firehose
|
|
102
112
|
S3DestinationConfiguration = Shapes::StructureShape.new(name: 'S3DestinationConfiguration')
|
103
113
|
S3DestinationDescription = Shapes::StructureShape.new(name: 'S3DestinationDescription')
|
104
114
|
S3DestinationUpdate = Shapes::StructureShape.new(name: 'S3DestinationUpdate')
|
115
|
+
SecretAccessKey = Shapes::StringShape.new(name: 'SecretAccessKey')
|
105
116
|
ServiceUnavailableException = Shapes::StructureShape.new(name: 'ServiceUnavailableException')
|
117
|
+
SessionCredentials = Shapes::StructureShape.new(name: 'SessionCredentials')
|
118
|
+
SessionToken = Shapes::StringShape.new(name: 'SessionToken')
|
106
119
|
SizeInMBs = Shapes::IntegerShape.new(name: 'SizeInMBs')
|
120
|
+
SourceDescription = Shapes::StructureShape.new(name: 'SourceDescription')
|
107
121
|
Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
|
108
122
|
UpdateDestinationInput = Shapes::StructureShape.new(name: 'UpdateDestinationInput')
|
109
123
|
UpdateDestinationOutput = Shapes::StructureShape.new(name: 'UpdateDestinationOutput')
|
@@ -124,6 +138,8 @@ module Aws::Firehose
|
|
124
138
|
CopyCommand.struct_class = Types::CopyCommand
|
125
139
|
|
126
140
|
CreateDeliveryStreamInput.add_member(:delivery_stream_name, Shapes::ShapeRef.new(shape: DeliveryStreamName, required: true, location_name: "DeliveryStreamName"))
|
141
|
+
CreateDeliveryStreamInput.add_member(:delivery_stream_type, Shapes::ShapeRef.new(shape: DeliveryStreamType, location_name: "DeliveryStreamType"))
|
142
|
+
CreateDeliveryStreamInput.add_member(:kinesis_stream_source_configuration, Shapes::ShapeRef.new(shape: KinesisStreamSourceConfiguration, location_name: "KinesisStreamSourceConfiguration"))
|
127
143
|
CreateDeliveryStreamInput.add_member(:s3_destination_configuration, Shapes::ShapeRef.new(shape: S3DestinationConfiguration, deprecated: true, location_name: "S3DestinationConfiguration"))
|
128
144
|
CreateDeliveryStreamInput.add_member(:extended_s3_destination_configuration, Shapes::ShapeRef.new(shape: ExtendedS3DestinationConfiguration, location_name: "ExtendedS3DestinationConfiguration"))
|
129
145
|
CreateDeliveryStreamInput.add_member(:redshift_destination_configuration, Shapes::ShapeRef.new(shape: RedshiftDestinationConfiguration, location_name: "RedshiftDestinationConfiguration"))
|
@@ -141,9 +157,11 @@ module Aws::Firehose
|
|
141
157
|
DeliveryStreamDescription.add_member(:delivery_stream_name, Shapes::ShapeRef.new(shape: DeliveryStreamName, required: true, location_name: "DeliveryStreamName"))
|
142
158
|
DeliveryStreamDescription.add_member(:delivery_stream_arn, Shapes::ShapeRef.new(shape: DeliveryStreamARN, required: true, location_name: "DeliveryStreamARN"))
|
143
159
|
DeliveryStreamDescription.add_member(:delivery_stream_status, Shapes::ShapeRef.new(shape: DeliveryStreamStatus, required: true, location_name: "DeliveryStreamStatus"))
|
160
|
+
DeliveryStreamDescription.add_member(:delivery_stream_type, Shapes::ShapeRef.new(shape: DeliveryStreamType, required: true, location_name: "DeliveryStreamType"))
|
144
161
|
DeliveryStreamDescription.add_member(:version_id, Shapes::ShapeRef.new(shape: DeliveryStreamVersionId, required: true, location_name: "VersionId"))
|
145
162
|
DeliveryStreamDescription.add_member(:create_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreateTimestamp"))
|
146
163
|
DeliveryStreamDescription.add_member(:last_update_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LastUpdateTimestamp"))
|
164
|
+
DeliveryStreamDescription.add_member(:source, Shapes::ShapeRef.new(shape: SourceDescription, location_name: "Source"))
|
147
165
|
DeliveryStreamDescription.add_member(:destinations, Shapes::ShapeRef.new(shape: DestinationDescriptionList, required: true, location_name: "Destinations"))
|
148
166
|
DeliveryStreamDescription.add_member(:has_more_destinations, Shapes::ShapeRef.new(shape: BooleanObject, required: true, location_name: "HasMoreDestinations"))
|
149
167
|
DeliveryStreamDescription.struct_class = Types::DeliveryStreamDescription
|
@@ -252,10 +270,27 @@ module Aws::Firehose
|
|
252
270
|
ExtendedS3DestinationUpdate.add_member(:s3_backup_update, Shapes::ShapeRef.new(shape: S3DestinationUpdate, location_name: "S3BackupUpdate"))
|
253
271
|
ExtendedS3DestinationUpdate.struct_class = Types::ExtendedS3DestinationUpdate
|
254
272
|
|
273
|
+
GetKinesisStreamInput.add_member(:delivery_stream_arn, Shapes::ShapeRef.new(shape: DeliveryStreamARN, required: true, location_name: "DeliveryStreamARN"))
|
274
|
+
GetKinesisStreamInput.struct_class = Types::GetKinesisStreamInput
|
275
|
+
|
276
|
+
GetKinesisStreamOutput.add_member(:kinesis_stream_arn, Shapes::ShapeRef.new(shape: KinesisStreamARN, location_name: "KinesisStreamARN"))
|
277
|
+
GetKinesisStreamOutput.add_member(:credentials_for_reading_kinesis_stream, Shapes::ShapeRef.new(shape: SessionCredentials, location_name: "CredentialsForReadingKinesisStream"))
|
278
|
+
GetKinesisStreamOutput.struct_class = Types::GetKinesisStreamOutput
|
279
|
+
|
255
280
|
KMSEncryptionConfig.add_member(:awskms_key_arn, Shapes::ShapeRef.new(shape: AWSKMSKeyARN, required: true, location_name: "AWSKMSKeyARN"))
|
256
281
|
KMSEncryptionConfig.struct_class = Types::KMSEncryptionConfig
|
257
282
|
|
283
|
+
KinesisStreamSourceConfiguration.add_member(:kinesis_stream_arn, Shapes::ShapeRef.new(shape: KinesisStreamARN, required: true, location_name: "KinesisStreamARN"))
|
284
|
+
KinesisStreamSourceConfiguration.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleARN, required: true, location_name: "RoleARN"))
|
285
|
+
KinesisStreamSourceConfiguration.struct_class = Types::KinesisStreamSourceConfiguration
|
286
|
+
|
287
|
+
KinesisStreamSourceDescription.add_member(:kinesis_stream_arn, Shapes::ShapeRef.new(shape: KinesisStreamARN, location_name: "KinesisStreamARN"))
|
288
|
+
KinesisStreamSourceDescription.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleARN, location_name: "RoleARN"))
|
289
|
+
KinesisStreamSourceDescription.add_member(:delivery_start_timestamp, Shapes::ShapeRef.new(shape: DeliveryStartTimestamp, location_name: "DeliveryStartTimestamp"))
|
290
|
+
KinesisStreamSourceDescription.struct_class = Types::KinesisStreamSourceDescription
|
291
|
+
|
258
292
|
ListDeliveryStreamsInput.add_member(:limit, Shapes::ShapeRef.new(shape: ListDeliveryStreamsInputLimit, location_name: "Limit"))
|
293
|
+
ListDeliveryStreamsInput.add_member(:delivery_stream_type, Shapes::ShapeRef.new(shape: DeliveryStreamType, location_name: "DeliveryStreamType"))
|
259
294
|
ListDeliveryStreamsInput.add_member(:exclusive_start_delivery_stream_name, Shapes::ShapeRef.new(shape: DeliveryStreamName, location_name: "ExclusiveStartDeliveryStreamName"))
|
260
295
|
ListDeliveryStreamsInput.struct_class = Types::ListDeliveryStreamsInput
|
261
296
|
|
@@ -374,6 +409,15 @@ module Aws::Firehose
|
|
374
409
|
S3DestinationUpdate.add_member(:cloud_watch_logging_options, Shapes::ShapeRef.new(shape: CloudWatchLoggingOptions, location_name: "CloudWatchLoggingOptions"))
|
375
410
|
S3DestinationUpdate.struct_class = Types::S3DestinationUpdate
|
376
411
|
|
412
|
+
SessionCredentials.add_member(:access_key_id, Shapes::ShapeRef.new(shape: AccessKeyId, required: true, location_name: "AccessKeyId"))
|
413
|
+
SessionCredentials.add_member(:secret_access_key, Shapes::ShapeRef.new(shape: SecretAccessKey, required: true, location_name: "SecretAccessKey"))
|
414
|
+
SessionCredentials.add_member(:session_token, Shapes::ShapeRef.new(shape: SessionToken, required: true, location_name: "SessionToken"))
|
415
|
+
SessionCredentials.add_member(:expiration, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "Expiration"))
|
416
|
+
SessionCredentials.struct_class = Types::SessionCredentials
|
417
|
+
|
418
|
+
SourceDescription.add_member(:kinesis_stream_source_description, Shapes::ShapeRef.new(shape: KinesisStreamSourceDescription, location_name: "KinesisStreamSourceDescription"))
|
419
|
+
SourceDescription.struct_class = Types::SourceDescription
|
420
|
+
|
377
421
|
UpdateDestinationInput.add_member(:delivery_stream_name, Shapes::ShapeRef.new(shape: DeliveryStreamName, required: true, location_name: "DeliveryStreamName"))
|
378
422
|
UpdateDestinationInput.add_member(:current_delivery_stream_version_id, Shapes::ShapeRef.new(shape: DeliveryStreamVersionId, required: true, location_name: "CurrentDeliveryStreamVersionId"))
|
379
423
|
UpdateDestinationInput.add_member(:destination_id, Shapes::ShapeRef.new(shape: DestinationId, required: true, location_name: "DestinationId"))
|
@@ -430,6 +474,17 @@ module Aws::Firehose
|
|
430
474
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
431
475
|
end)
|
432
476
|
|
477
|
+
api.add_operation(:get_kinesis_stream, Seahorse::Model::Operation.new.tap do |o|
|
478
|
+
o.name = "GetKinesisStream"
|
479
|
+
o.http_method = "POST"
|
480
|
+
o.http_request_uri = "/"
|
481
|
+
o.input = Shapes::ShapeRef.new(shape: GetKinesisStreamInput)
|
482
|
+
o.output = Shapes::ShapeRef.new(shape: GetKinesisStreamOutput)
|
483
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
484
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidArgumentException)
|
485
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidStreamTypeException)
|
486
|
+
end)
|
487
|
+
|
433
488
|
api.add_operation(:list_delivery_streams, Seahorse::Model::Operation.new.tap do |o|
|
434
489
|
o.name = "ListDeliveryStreams"
|
435
490
|
o.http_method = "POST"
|
@@ -10,8 +10,8 @@ module Aws::Firehose
|
|
10
10
|
|
11
11
|
# Describes hints for the buffering to perform before delivering data to
|
12
12
|
# the destination. Please note that these options are treated as hints,
|
13
|
-
# and therefore Firehose may choose to use different values when
|
14
|
-
# optimal.
|
13
|
+
# and therefore Kinesis Firehose may choose to use different values when
|
14
|
+
# it is optimal.
|
15
15
|
#
|
16
16
|
# @note When making an API call, you may pass BufferingHints
|
17
17
|
# data as a hash:
|
@@ -44,7 +44,8 @@ module Aws::Firehose
|
|
44
44
|
include Aws::Structure
|
45
45
|
end
|
46
46
|
|
47
|
-
# Describes the CloudWatch logging options for your delivery
|
47
|
+
# Describes the Amazon CloudWatch logging options for your delivery
|
48
|
+
# stream.
|
48
49
|
#
|
49
50
|
# @note When making an API call, you may pass CloudWatchLoggingOptions
|
50
51
|
# data as a hash:
|
@@ -102,12 +103,12 @@ module Aws::Firehose
|
|
102
103
|
# Optional parameters to use with the Amazon Redshift `COPY` command.
|
103
104
|
# For more information, see the "Optional Parameters" section of
|
104
105
|
# [Amazon Redshift COPY command][1]. Some possible examples that would
|
105
|
-
# apply to Firehose are as follows:
|
106
|
+
# apply to Kinesis Firehose are as follows:
|
106
107
|
#
|
107
108
|
# `delimiter '\t' lzop;` - fields are delimited with "\\t" (TAB
|
108
109
|
# character) and compressed using lzop.
|
109
110
|
#
|
110
|
-
# `delimiter '
|
111
|
+
# `delimiter '|'` - fields are delimited with "\|" (this is the
|
111
112
|
# default delimiter).
|
112
113
|
#
|
113
114
|
# `delimiter '|' escape` - the delimiter should be escaped.
|
@@ -142,6 +143,11 @@ module Aws::Firehose
|
|
142
143
|
#
|
143
144
|
# {
|
144
145
|
# delivery_stream_name: "DeliveryStreamName", # required
|
146
|
+
# delivery_stream_type: "DirectPut", # accepts DirectPut, KinesisStreamAsSource
|
147
|
+
# kinesis_stream_source_configuration: {
|
148
|
+
# kinesis_stream_arn: "KinesisStreamARN", # required
|
149
|
+
# role_arn: "RoleARN", # required
|
150
|
+
# },
|
145
151
|
# s3_destination_configuration: {
|
146
152
|
# role_arn: "RoleARN", # required
|
147
153
|
# bucket_arn: "BucketARN", # required
|
@@ -355,11 +361,28 @@ module Aws::Firehose
|
|
355
361
|
#
|
356
362
|
# @!attribute [rw] delivery_stream_name
|
357
363
|
# The name of the delivery stream. This name must be unique per AWS
|
358
|
-
# account in the same region.
|
359
|
-
#
|
360
|
-
#
|
364
|
+
# account in the same region. If the delivery streams are in different
|
365
|
+
# accounts or different regions, you can have multiple delivery
|
366
|
+
# streams with the same name.
|
367
|
+
# @return [String]
|
368
|
+
#
|
369
|
+
# @!attribute [rw] delivery_stream_type
|
370
|
+
# The delivery stream type. This parameter can be one of the following
|
371
|
+
# values:
|
372
|
+
#
|
373
|
+
# * `DirectPut`\: Provider applications access the delivery stream
|
374
|
+
# directly.
|
375
|
+
#
|
376
|
+
# * `KinesisStreamAsSource`\: The delivery stream uses a Kinesis
|
377
|
+
# stream as a source.
|
361
378
|
# @return [String]
|
362
379
|
#
|
380
|
+
# @!attribute [rw] kinesis_stream_source_configuration
|
381
|
+
# When a Kinesis stream is used as the source for the delivery stream,
|
382
|
+
# a KinesisStreamSourceConfiguration containing the Kinesis stream ARN
|
383
|
+
# and the role ARN for the source stream.
|
384
|
+
# @return [Types::KinesisStreamSourceConfiguration]
|
385
|
+
#
|
363
386
|
# @!attribute [rw] s3_destination_configuration
|
364
387
|
# \[Deprecated\] The destination in Amazon S3. You can specify only
|
365
388
|
# one destination.
|
@@ -382,6 +405,8 @@ module Aws::Firehose
|
|
382
405
|
#
|
383
406
|
class CreateDeliveryStreamInput < Struct.new(
|
384
407
|
:delivery_stream_name,
|
408
|
+
:delivery_stream_type,
|
409
|
+
:kinesis_stream_source_configuration,
|
385
410
|
:s3_destination_configuration,
|
386
411
|
:extended_s3_destination_configuration,
|
387
412
|
:redshift_destination_configuration,
|
@@ -436,6 +461,16 @@ module Aws::Firehose
|
|
436
461
|
# The status of the delivery stream.
|
437
462
|
# @return [String]
|
438
463
|
#
|
464
|
+
# @!attribute [rw] delivery_stream_type
|
465
|
+
# The delivery stream type. This can be one of the following values:
|
466
|
+
#
|
467
|
+
# * `DirectPut`\: Provider applications access the delivery stream
|
468
|
+
# directly.
|
469
|
+
#
|
470
|
+
# * `KinesisStreamAsSource`\: The delivery stream uses a Kinesis
|
471
|
+
# stream as a source.
|
472
|
+
# @return [String]
|
473
|
+
#
|
439
474
|
# @!attribute [rw] version_id
|
440
475
|
# Each time the destination is updated for a delivery stream, the
|
441
476
|
# version ID is changed, and the current version ID is required when
|
@@ -451,6 +486,11 @@ module Aws::Firehose
|
|
451
486
|
# The date and time that the delivery stream was last updated.
|
452
487
|
# @return [Time]
|
453
488
|
#
|
489
|
+
# @!attribute [rw] source
|
490
|
+
# If the `DeliveryStreamType` parameter is `KinesisStreamAsSource`, a
|
491
|
+
# SourceDescription object describing the source Kinesis stream.
|
492
|
+
# @return [Types::SourceDescription]
|
493
|
+
#
|
454
494
|
# @!attribute [rw] destinations
|
455
495
|
# The destinations.
|
456
496
|
# @return [Array<Types::DestinationDescription>]
|
@@ -465,9 +505,11 @@ module Aws::Firehose
|
|
465
505
|
:delivery_stream_name,
|
466
506
|
:delivery_stream_arn,
|
467
507
|
:delivery_stream_status,
|
508
|
+
:delivery_stream_type,
|
468
509
|
:version_id,
|
469
510
|
:create_timestamp,
|
470
511
|
:last_update_timestamp,
|
512
|
+
:source,
|
471
513
|
:destinations,
|
472
514
|
:has_more_destinations)
|
473
515
|
include Aws::Structure
|
@@ -493,8 +535,8 @@ module Aws::Firehose
|
|
493
535
|
#
|
494
536
|
# @!attribute [rw] exclusive_start_destination_id
|
495
537
|
# The ID of the destination to start returning the destination
|
496
|
-
# information. Currently Firehose supports one destination
|
497
|
-
# delivery stream.
|
538
|
+
# information. Currently, Kinesis Firehose supports one destination
|
539
|
+
# per delivery stream.
|
498
540
|
# @return [String]
|
499
541
|
#
|
500
542
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/DescribeDeliveryStreamInput AWS API Documentation
|
@@ -647,9 +689,9 @@ module Aws::Firehose
|
|
647
689
|
# }
|
648
690
|
#
|
649
691
|
# @!attribute [rw] role_arn
|
650
|
-
# The ARN of the IAM role to be assumed by Firehose for
|
651
|
-
# Amazon ES Configuration API and for indexing documents.
|
652
|
-
# information, see [Amazon S3 Bucket Access][1].
|
692
|
+
# The ARN of the IAM role to be assumed by Kinesis Firehose for
|
693
|
+
# calling the Amazon ES Configuration API and for indexing documents.
|
694
|
+
# For more information, see [Amazon S3 Bucket Access][1].
|
653
695
|
#
|
654
696
|
#
|
655
697
|
#
|
@@ -673,9 +715,10 @@ module Aws::Firehose
|
|
673
715
|
#
|
674
716
|
# @!attribute [rw] index_rotation_period
|
675
717
|
# The Elasticsearch index rotation period. Index rotation appends a
|
676
|
-
#
|
677
|
-
# more information, see [Index Rotation for Amazon
|
678
|
-
# Service Destination][1]. The default value
|
718
|
+
# time stamp to the IndexName to facilitate the expiration of old
|
719
|
+
# data. For more information, see [Index Rotation for Amazon
|
720
|
+
# Elasticsearch Service Destination][1]. The default value
|
721
|
+
# is `OneDay`.
|
679
722
|
#
|
680
723
|
#
|
681
724
|
#
|
@@ -688,20 +731,20 @@ module Aws::Firehose
|
|
688
731
|
# @return [Types::ElasticsearchBufferingHints]
|
689
732
|
#
|
690
733
|
# @!attribute [rw] retry_options
|
691
|
-
# The retry behavior in
|
734
|
+
# The retry behavior in case Kinesis Firehose is unable to deliver
|
692
735
|
# documents to Amazon ES. The default value is 300 (5 minutes).
|
693
736
|
# @return [Types::ElasticsearchRetryOptions]
|
694
737
|
#
|
695
738
|
# @!attribute [rw] s3_backup_mode
|
696
739
|
# Defines how documents should be delivered to Amazon S3. When set to
|
697
|
-
# FailedDocumentsOnly, Firehose writes any documents that
|
698
|
-
# indexed to the configured Amazon S3 destination, with
|
740
|
+
# FailedDocumentsOnly, Kinesis Firehose writes any documents that
|
741
|
+
# could not be indexed to the configured Amazon S3 destination, with
|
699
742
|
# elasticsearch-failed/ appended to the key prefix. When set to
|
700
|
-
# AllDocuments, Firehose delivers all incoming records to
|
701
|
-
# and also writes failed documents with
|
702
|
-
# to the prefix. For more information,
|
703
|
-
# Amazon
|
704
|
-
# FailedDocumentsOnly.
|
743
|
+
# AllDocuments, Kinesis Firehose delivers all incoming records to
|
744
|
+
# Amazon S3, and also writes failed documents with
|
745
|
+
# elasticsearch-failed/ appended to the prefix. For more information,
|
746
|
+
# see [Amazon S3 Backup for Amazon Elasticsearch Service
|
747
|
+
# Destination][1]. Default value is FailedDocumentsOnly.
|
705
748
|
#
|
706
749
|
#
|
707
750
|
#
|
@@ -709,8 +752,7 @@ module Aws::Firehose
|
|
709
752
|
# @return [String]
|
710
753
|
#
|
711
754
|
# @!attribute [rw] s3_configuration
|
712
|
-
# The configuration for the
|
713
|
-
# Amazon ES obtains data.
|
755
|
+
# The configuration for the backup Amazon S3 location.
|
714
756
|
# @return [Types::S3DestinationConfiguration]
|
715
757
|
#
|
716
758
|
# @!attribute [rw] processing_configuration
|
@@ -862,9 +904,9 @@ module Aws::Firehose
|
|
862
904
|
# }
|
863
905
|
#
|
864
906
|
# @!attribute [rw] role_arn
|
865
|
-
# The ARN of the IAM role to be assumed by Firehose for
|
866
|
-
# Amazon ES Configuration API and for indexing documents.
|
867
|
-
# information, see [Amazon S3 Bucket Access][1].
|
907
|
+
# The ARN of the IAM role to be assumed by Kinesis Firehose for
|
908
|
+
# calling the Amazon ES Configuration API and for indexing documents.
|
909
|
+
# For more information, see [Amazon S3 Bucket Access][1].
|
868
910
|
#
|
869
911
|
#
|
870
912
|
#
|
@@ -888,8 +930,8 @@ module Aws::Firehose
|
|
888
930
|
#
|
889
931
|
# @!attribute [rw] index_rotation_period
|
890
932
|
# The Elasticsearch index rotation period. Index rotation appends a
|
891
|
-
#
|
892
|
-
# more information, see [Index Rotation for Amazon Elasticsearch
|
933
|
+
# time stamp to IndexName to facilitate the expiration of old data.
|
934
|
+
# For more information, see [Index Rotation for Amazon Elasticsearch
|
893
935
|
# Service Destination][1]. Default value is `OneDay`.
|
894
936
|
#
|
895
937
|
#
|
@@ -903,8 +945,8 @@ module Aws::Firehose
|
|
903
945
|
# @return [Types::ElasticsearchBufferingHints]
|
904
946
|
#
|
905
947
|
# @!attribute [rw] retry_options
|
906
|
-
# The retry behavior in
|
907
|
-
# documents to Amazon ES.
|
948
|
+
# The retry behavior in case Kinesis Firehose is unable to deliver
|
949
|
+
# documents to Amazon ES. The default value is 300 (5 minutes).
|
908
950
|
# @return [Types::ElasticsearchRetryOptions]
|
909
951
|
#
|
910
952
|
# @!attribute [rw] s3_update
|
@@ -935,7 +977,7 @@ module Aws::Firehose
|
|
935
977
|
include Aws::Structure
|
936
978
|
end
|
937
979
|
|
938
|
-
# Configures retry behavior in
|
980
|
+
# Configures retry behavior in case Kinesis Firehose is unable to
|
939
981
|
# deliver documents to Amazon ES.
|
940
982
|
#
|
941
983
|
# @note When making an API call, you may pass ElasticsearchRetryOptions
|
@@ -947,10 +989,10 @@ module Aws::Firehose
|
|
947
989
|
#
|
948
990
|
# @!attribute [rw] duration_in_seconds
|
949
991
|
# After an initial failure to deliver to Amazon ES, the total amount
|
950
|
-
# of time during which Firehose re-attempts delivery
|
951
|
-
# first attempt). After this time has elapsed, the
|
952
|
-
# are written to Amazon S3. Default value is 300
|
953
|
-
# A value of 0 (zero) results in no retries.
|
992
|
+
# of time during which Kinesis Firehose re-attempts delivery
|
993
|
+
# (including the first attempt). After this time has elapsed, the
|
994
|
+
# failed documents are written to Amazon S3. Default value is 300
|
995
|
+
# seconds (5 minutes). A value of 0 (zero) results in no retries.
|
954
996
|
# @return [Integer]
|
955
997
|
#
|
956
998
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/ElasticsearchRetryOptions AWS API Documentation
|
@@ -973,8 +1015,8 @@ module Aws::Firehose
|
|
973
1015
|
# }
|
974
1016
|
#
|
975
1017
|
# @!attribute [rw] no_encryption_config
|
976
|
-
# Specifically override existing encryption information to ensure
|
977
|
-
# encryption is used.
|
1018
|
+
# Specifically override existing encryption information to ensure that
|
1019
|
+
# no encryption is used.
|
978
1020
|
# @return [String]
|
979
1021
|
#
|
980
1022
|
# @!attribute [rw] kms_encryption_config
|
@@ -1063,10 +1105,10 @@ module Aws::Firehose
|
|
1063
1105
|
# @!attribute [rw] prefix
|
1064
1106
|
# The "YYYY/MM/DD/HH" time format prefix is automatically used for
|
1065
1107
|
# delivered S3 files. You can specify an extra prefix to be added in
|
1066
|
-
# front of the time format prefix.
|
1067
|
-
#
|
1068
|
-
#
|
1069
|
-
#
|
1108
|
+
# front of the time format prefix. If the prefix ends with a slash, it
|
1109
|
+
# appears as a folder in the S3 bucket. For more information, see
|
1110
|
+
# [Amazon S3 Object Name Format][1] in the *Amazon Kinesis Firehose
|
1111
|
+
# Developer Guide*.
|
1070
1112
|
#
|
1071
1113
|
#
|
1072
1114
|
#
|
@@ -1132,10 +1174,10 @@ module Aws::Firehose
|
|
1132
1174
|
# @!attribute [rw] prefix
|
1133
1175
|
# The "YYYY/MM/DD/HH" time format prefix is automatically used for
|
1134
1176
|
# delivered S3 files. You can specify an extra prefix to be added in
|
1135
|
-
# front of the time format prefix.
|
1136
|
-
#
|
1137
|
-
#
|
1138
|
-
#
|
1177
|
+
# front of the time format prefix. If the prefix ends with a slash, it
|
1178
|
+
# appears as a folder in the S3 bucket. For more information, see
|
1179
|
+
# [Amazon S3 Object Name Format][1] in the *Amazon Kinesis Firehose
|
1180
|
+
# Developer Guide*.
|
1139
1181
|
#
|
1140
1182
|
#
|
1141
1183
|
#
|
@@ -1262,10 +1304,10 @@ module Aws::Firehose
|
|
1262
1304
|
# @!attribute [rw] prefix
|
1263
1305
|
# The "YYYY/MM/DD/HH" time format prefix is automatically used for
|
1264
1306
|
# delivered S3 files. You can specify an extra prefix to be added in
|
1265
|
-
# front of the time format prefix.
|
1266
|
-
#
|
1267
|
-
#
|
1268
|
-
#
|
1307
|
+
# front of the time format prefix. If the prefix ends with a slash, it
|
1308
|
+
# appears as a folder in the S3 bucket. For more information, see
|
1309
|
+
# [Amazon S3 Object Name Format][1] in the *Amazon Kinesis Firehose
|
1310
|
+
# Developer Guide*.
|
1269
1311
|
#
|
1270
1312
|
#
|
1271
1313
|
#
|
@@ -1318,6 +1360,37 @@ module Aws::Firehose
|
|
1318
1360
|
include Aws::Structure
|
1319
1361
|
end
|
1320
1362
|
|
1363
|
+
# @note When making an API call, you may pass GetKinesisStreamInput
|
1364
|
+
# data as a hash:
|
1365
|
+
#
|
1366
|
+
# {
|
1367
|
+
# delivery_stream_arn: "DeliveryStreamARN", # required
|
1368
|
+
# }
|
1369
|
+
#
|
1370
|
+
# @!attribute [rw] delivery_stream_arn
|
1371
|
+
# @return [String]
|
1372
|
+
#
|
1373
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/GetKinesisStreamInput AWS API Documentation
|
1374
|
+
#
|
1375
|
+
class GetKinesisStreamInput < Struct.new(
|
1376
|
+
:delivery_stream_arn)
|
1377
|
+
include Aws::Structure
|
1378
|
+
end
|
1379
|
+
|
1380
|
+
# @!attribute [rw] kinesis_stream_arn
|
1381
|
+
# @return [String]
|
1382
|
+
#
|
1383
|
+
# @!attribute [rw] credentials_for_reading_kinesis_stream
|
1384
|
+
# @return [Types::SessionCredentials]
|
1385
|
+
#
|
1386
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/GetKinesisStreamOutput AWS API Documentation
|
1387
|
+
#
|
1388
|
+
class GetKinesisStreamOutput < Struct.new(
|
1389
|
+
:kinesis_stream_arn,
|
1390
|
+
:credentials_for_reading_kinesis_stream)
|
1391
|
+
include Aws::Structure
|
1392
|
+
end
|
1393
|
+
|
1321
1394
|
# Describes an encryption key for a destination in Amazon S3.
|
1322
1395
|
#
|
1323
1396
|
# @note When making an API call, you may pass KMSEncryptionConfig
|
@@ -1339,11 +1412,65 @@ module Aws::Firehose
|
|
1339
1412
|
include Aws::Structure
|
1340
1413
|
end
|
1341
1414
|
|
1415
|
+
# The stream and role ARNs for a Kinesis stream used as the source for a
|
1416
|
+
# delivery stream.
|
1417
|
+
#
|
1418
|
+
# @note When making an API call, you may pass KinesisStreamSourceConfiguration
|
1419
|
+
# data as a hash:
|
1420
|
+
#
|
1421
|
+
# {
|
1422
|
+
# kinesis_stream_arn: "KinesisStreamARN", # required
|
1423
|
+
# role_arn: "RoleARN", # required
|
1424
|
+
# }
|
1425
|
+
#
|
1426
|
+
# @!attribute [rw] kinesis_stream_arn
|
1427
|
+
# The ARN of the source Kinesis stream.
|
1428
|
+
# @return [String]
|
1429
|
+
#
|
1430
|
+
# @!attribute [rw] role_arn
|
1431
|
+
# The ARN of the role that provides access to the source Kinesis
|
1432
|
+
# stream.
|
1433
|
+
# @return [String]
|
1434
|
+
#
|
1435
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/KinesisStreamSourceConfiguration AWS API Documentation
|
1436
|
+
#
|
1437
|
+
class KinesisStreamSourceConfiguration < Struct.new(
|
1438
|
+
:kinesis_stream_arn,
|
1439
|
+
:role_arn)
|
1440
|
+
include Aws::Structure
|
1441
|
+
end
|
1442
|
+
|
1443
|
+
# Details about a Kinesis stream used as the source for a Kinesis
|
1444
|
+
# Firehose delivery stream.
|
1445
|
+
#
|
1446
|
+
# @!attribute [rw] kinesis_stream_arn
|
1447
|
+
# The ARN of the source Kinesis stream.
|
1448
|
+
# @return [String]
|
1449
|
+
#
|
1450
|
+
# @!attribute [rw] role_arn
|
1451
|
+
# The ARN of the role used by the source Kinesis stream.
|
1452
|
+
# @return [String]
|
1453
|
+
#
|
1454
|
+
# @!attribute [rw] delivery_start_timestamp
|
1455
|
+
# Kinesis Firehose starts retrieving records from the Kinesis stream
|
1456
|
+
# starting with this time stamp.
|
1457
|
+
# @return [Time]
|
1458
|
+
#
|
1459
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/KinesisStreamSourceDescription AWS API Documentation
|
1460
|
+
#
|
1461
|
+
class KinesisStreamSourceDescription < Struct.new(
|
1462
|
+
:kinesis_stream_arn,
|
1463
|
+
:role_arn,
|
1464
|
+
:delivery_start_timestamp)
|
1465
|
+
include Aws::Structure
|
1466
|
+
end
|
1467
|
+
|
1342
1468
|
# @note When making an API call, you may pass ListDeliveryStreamsInput
|
1343
1469
|
# data as a hash:
|
1344
1470
|
#
|
1345
1471
|
# {
|
1346
1472
|
# limit: 1,
|
1473
|
+
# delivery_stream_type: "DirectPut", # accepts DirectPut, KinesisStreamAsSource
|
1347
1474
|
# exclusive_start_delivery_stream_name: "DeliveryStreamName",
|
1348
1475
|
# }
|
1349
1476
|
#
|
@@ -1351,6 +1478,19 @@ module Aws::Firehose
|
|
1351
1478
|
# The maximum number of delivery streams to list.
|
1352
1479
|
# @return [Integer]
|
1353
1480
|
#
|
1481
|
+
# @!attribute [rw] delivery_stream_type
|
1482
|
+
# The delivery stream type. This can be one of the following values:
|
1483
|
+
#
|
1484
|
+
# * `DirectPut`\: Provider applications access the delivery stream
|
1485
|
+
# directly.
|
1486
|
+
#
|
1487
|
+
# * `KinesisStreamAsSource`\: The delivery stream uses a Kinesis
|
1488
|
+
# stream as a source.
|
1489
|
+
#
|
1490
|
+
# This parameter is optional. If this parameter is omitted, delivery
|
1491
|
+
# streams of all types are returned.
|
1492
|
+
# @return [String]
|
1493
|
+
#
|
1354
1494
|
# @!attribute [rw] exclusive_start_delivery_stream_name
|
1355
1495
|
# The name of the delivery stream to start the list with.
|
1356
1496
|
# @return [String]
|
@@ -1359,6 +1499,7 @@ module Aws::Firehose
|
|
1359
1499
|
#
|
1360
1500
|
class ListDeliveryStreamsInput < Struct.new(
|
1361
1501
|
:limit,
|
1502
|
+
:delivery_stream_type,
|
1362
1503
|
:exclusive_start_delivery_stream_name)
|
1363
1504
|
include Aws::Structure
|
1364
1505
|
end
|
@@ -1706,7 +1847,7 @@ module Aws::Firehose
|
|
1706
1847
|
# @return [String]
|
1707
1848
|
#
|
1708
1849
|
# @!attribute [rw] retry_options
|
1709
|
-
# The retry behavior in
|
1850
|
+
# The retry behavior in case Kinesis Firehose is unable to deliver
|
1710
1851
|
# documents to Amazon Redshift. Default value is 3600 (60 minutes).
|
1711
1852
|
# @return [Types::RedshiftRetryOptions]
|
1712
1853
|
#
|
@@ -1773,7 +1914,7 @@ module Aws::Firehose
|
|
1773
1914
|
# @return [String]
|
1774
1915
|
#
|
1775
1916
|
# @!attribute [rw] retry_options
|
1776
|
-
# The retry behavior in
|
1917
|
+
# The retry behavior in case Kinesis Firehose is unable to deliver
|
1777
1918
|
# documents to Amazon Redshift. Default value is 3600 (60 minutes).
|
1778
1919
|
# @return [Types::RedshiftRetryOptions]
|
1779
1920
|
#
|
@@ -1916,7 +2057,7 @@ module Aws::Firehose
|
|
1916
2057
|
# @return [String]
|
1917
2058
|
#
|
1918
2059
|
# @!attribute [rw] retry_options
|
1919
|
-
# The retry behavior in
|
2060
|
+
# The retry behavior in case Kinesis Firehose is unable to deliver
|
1920
2061
|
# documents to Amazon Redshift. Default value is 3600 (60 minutes).
|
1921
2062
|
# @return [Types::RedshiftRetryOptions]
|
1922
2063
|
#
|
@@ -1962,7 +2103,7 @@ module Aws::Firehose
|
|
1962
2103
|
include Aws::Structure
|
1963
2104
|
end
|
1964
2105
|
|
1965
|
-
# Configures retry behavior in
|
2106
|
+
# Configures retry behavior in case Kinesis Firehose is unable to
|
1966
2107
|
# deliver documents to Amazon Redshift.
|
1967
2108
|
#
|
1968
2109
|
# @note When making an API call, you may pass RedshiftRetryOptions
|
@@ -1973,11 +2114,12 @@ module Aws::Firehose
|
|
1973
2114
|
# }
|
1974
2115
|
#
|
1975
2116
|
# @!attribute [rw] duration_in_seconds
|
1976
|
-
# The length of time during which Firehose retries delivery
|
1977
|
-
# failure, starting from the initial request and including the
|
1978
|
-
# attempt. The default value is 3600 seconds (60 minutes).
|
1979
|
-
# does not retry if the value of `DurationInSeconds`
|
1980
|
-
# the first delivery attempt takes longer than the
|
2117
|
+
# The length of time during which Kinesis Firehose retries delivery
|
2118
|
+
# after a failure, starting from the initial request and including the
|
2119
|
+
# first attempt. The default value is 3600 seconds (60 minutes).
|
2120
|
+
# Kinesis Firehose does not retry if the value of `DurationInSeconds`
|
2121
|
+
# is 0 (zero) or if the first delivery attempt takes longer than the
|
2122
|
+
# current value.
|
1981
2123
|
# @return [Integer]
|
1982
2124
|
#
|
1983
2125
|
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/RedshiftRetryOptions AWS API Documentation
|
@@ -2025,10 +2167,10 @@ module Aws::Firehose
|
|
2025
2167
|
# @!attribute [rw] prefix
|
2026
2168
|
# The "YYYY/MM/DD/HH" time format prefix is automatically used for
|
2027
2169
|
# delivered S3 files. You can specify an extra prefix to be added in
|
2028
|
-
# front of the time format prefix.
|
2029
|
-
#
|
2030
|
-
#
|
2031
|
-
#
|
2170
|
+
# front of the time format prefix. If the prefix ends with a slash, it
|
2171
|
+
# appears as a folder in the S3 bucket. For more information, see
|
2172
|
+
# [Amazon S3 Object Name Format][1] in the *Amazon Kinesis Firehose
|
2173
|
+
# Developer Guide*.
|
2032
2174
|
#
|
2033
2175
|
#
|
2034
2176
|
#
|
@@ -2084,10 +2226,10 @@ module Aws::Firehose
|
|
2084
2226
|
# @!attribute [rw] prefix
|
2085
2227
|
# The "YYYY/MM/DD/HH" time format prefix is automatically used for
|
2086
2228
|
# delivered S3 files. You can specify an extra prefix to be added in
|
2087
|
-
# front of the time format prefix.
|
2088
|
-
#
|
2089
|
-
#
|
2090
|
-
#
|
2229
|
+
# front of the time format prefix. If the prefix ends with a slash, it
|
2230
|
+
# appears as a folder in the S3 bucket. For more information, see
|
2231
|
+
# [Amazon S3 Object Name Format][1] in the *Amazon Kinesis Firehose
|
2232
|
+
# Developer Guide*.
|
2091
2233
|
#
|
2092
2234
|
#
|
2093
2235
|
#
|
@@ -2164,10 +2306,10 @@ module Aws::Firehose
|
|
2164
2306
|
# @!attribute [rw] prefix
|
2165
2307
|
# The "YYYY/MM/DD/HH" time format prefix is automatically used for
|
2166
2308
|
# delivered S3 files. You can specify an extra prefix to be added in
|
2167
|
-
# front of the time format prefix.
|
2168
|
-
#
|
2169
|
-
#
|
2170
|
-
#
|
2309
|
+
# front of the time format prefix. If the prefix ends with a slash, it
|
2310
|
+
# appears as a folder in the S3 bucket. For more information, see
|
2311
|
+
# [Amazon S3 Object Name Format][1] in the *Amazon Kinesis Firehose
|
2312
|
+
# Developer Guide*.
|
2171
2313
|
#
|
2172
2314
|
#
|
2173
2315
|
#
|
@@ -2210,6 +2352,43 @@ module Aws::Firehose
|
|
2210
2352
|
include Aws::Structure
|
2211
2353
|
end
|
2212
2354
|
|
2355
|
+
# @!attribute [rw] access_key_id
|
2356
|
+
# @return [String]
|
2357
|
+
#
|
2358
|
+
# @!attribute [rw] secret_access_key
|
2359
|
+
# @return [String]
|
2360
|
+
#
|
2361
|
+
# @!attribute [rw] session_token
|
2362
|
+
# @return [String]
|
2363
|
+
#
|
2364
|
+
# @!attribute [rw] expiration
|
2365
|
+
# @return [Time]
|
2366
|
+
#
|
2367
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/SessionCredentials AWS API Documentation
|
2368
|
+
#
|
2369
|
+
class SessionCredentials < Struct.new(
|
2370
|
+
:access_key_id,
|
2371
|
+
:secret_access_key,
|
2372
|
+
:session_token,
|
2373
|
+
:expiration)
|
2374
|
+
include Aws::Structure
|
2375
|
+
end
|
2376
|
+
|
2377
|
+
# Details about a Kinesis stream used as the source for a Kinesis
|
2378
|
+
# Firehose delivery stream.
|
2379
|
+
#
|
2380
|
+
# @!attribute [rw] kinesis_stream_source_description
|
2381
|
+
# The KinesisStreamSourceDescription value for the source Kinesis
|
2382
|
+
# stream.
|
2383
|
+
# @return [Types::KinesisStreamSourceDescription]
|
2384
|
+
#
|
2385
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/SourceDescription AWS API Documentation
|
2386
|
+
#
|
2387
|
+
class SourceDescription < Struct.new(
|
2388
|
+
:kinesis_stream_source_description)
|
2389
|
+
include Aws::Structure
|
2390
|
+
end
|
2391
|
+
|
2213
2392
|
# @note When making an API call, you may pass UpdateDestinationInput
|
2214
2393
|
# data as a hash:
|
2215
2394
|
#
|
@@ -2435,7 +2614,7 @@ module Aws::Firehose
|
|
2435
2614
|
# Obtain this value from the **VersionId** result of
|
2436
2615
|
# DeliveryStreamDescription. This value is required, and helps the
|
2437
2616
|
# service to perform conditional operations. For example, if there is
|
2438
|
-
#
|
2617
|
+
# an interleaving update and this value is null, then the update
|
2439
2618
|
# destination fails. After the update is successful, the **VersionId**
|
2440
2619
|
# value is updated. The service then performs a merge of the old
|
2441
2620
|
# configuration with the new configuration.
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-firehose
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.0.0.
|
4
|
+
version: 1.0.0.rc14
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2017-08-
|
11
|
+
date: 2017-08-21 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|