aws-sdk-kinesis 1.0.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 302c90c4772eaf64d22025d43b5f847d6887fdf4
4
- data.tar.gz: 2a2e7bed713e188a5e4c09d5d43ff09dfbf9665c
3
+ metadata.gz: 0703474365d77d6d410a2f32d54596213aa6e001
4
+ data.tar.gz: 72702598dd7e98b900ea43f2d7caaa32bf19999c
5
5
  SHA512:
6
- metadata.gz: 26202fcf3f38d3c7286dc42876c5ed3c6eaed5d71b37d28c9733f9a6aba2ad22146883552b4634830230f75cd092a98ed6065891c85af6cd7f76b2cb9d31fc4f
7
- data.tar.gz: d9b95846817ab384d98bff0831d5c29ce803f39f22c57f2fda04ae0d46cf54a3a04cce49ff718bfd5018a1d7e8410b55aebc50d4f27d056274a2f83175555d81
6
+ metadata.gz: cdb93e177e37786836f446f38b9c41ecd2a12724a92619a0b5b7ff143257789669a74cecaa73f59189f83567a4f0711b6e4800b14000d4ccd92a8e2f85527995
7
+ data.tar.gz: 15ad0753a8298759e9611e56f85c5a5873f8fd291863c88e92dc23f8f7dd416f4ed516b2f2d4903bffce8e2f6e0e2ee8a53a1fb556b9d15250b8b682aa9714bb
@@ -43,6 +43,6 @@ require_relative 'aws-sdk-kinesis/customizations'
43
43
  # @service
44
44
  module Aws::Kinesis
45
45
 
46
- GEM_VERSION = '1.0.0'
46
+ GEM_VERSION = '1.1.0'
47
47
 
48
48
  end
@@ -155,8 +155,8 @@ module Aws::Kinesis
155
155
 
156
156
  # @!group API Operations
157
157
 
158
- # Adds or updates tags for the specified Amazon Kinesis stream. Each
159
- # stream can have up to 10 tags.
158
+ # Adds or updates tags for the specified Kinesis stream. Each stream can
159
+ # have up to 10 tags.
160
160
  #
161
161
  # If tags have already been assigned to the stream, `AddTagsToStream`
162
162
  # overwrites any existing tags that correspond to the specified tag
@@ -188,9 +188,9 @@ module Aws::Kinesis
188
188
  req.send_request(options)
189
189
  end
190
190
 
191
- # Creates an Amazon Kinesis stream. A stream captures and transports
192
- # data records that are continuously emitted from different data sources
193
- # or *producers*. Scale-out within a stream is explicitly supported by
191
+ # Creates a Kinesis stream. A stream captures and transports data
192
+ # records that are continuously emitted from different data sources or
193
+ # *producers*. Scale-out within a stream is explicitly supported by
194
194
  # means of shards, which are uniquely identified groups of data records
195
195
  # in a stream.
196
196
  #
@@ -198,9 +198,8 @@ module Aws::Kinesis
198
198
  # of. Each shard can support reads up to 5 transactions per second, up
199
199
  # to a maximum data read total of 2 MB per second. Each shard can
200
200
  # support writes up to 1,000 records per second, up to a maximum data
201
- # write total of 1 MB per second. You can add shards to a stream if the
202
- # amount of data input increases and you can remove shards if the amount
203
- # of data input decreases.
201
+ # write total of 1 MB per second. I the amount of data input increases
202
+ # or decreases, you can add or remove shards.
204
203
  #
205
204
  # The stream name identifies the stream. The name is scoped to the AWS
206
205
  # account used by the application. It is also scoped by region. That is,
@@ -209,13 +208,13 @@ module Aws::Kinesis
209
208
  # the same name.
210
209
  #
211
210
  # `CreateStream` is an asynchronous operation. Upon receiving a
212
- # `CreateStream` request, Amazon Kinesis immediately returns and sets
213
- # the stream status to `CREATING`. After the stream is created, Amazon
214
- # Kinesis sets the stream status to `ACTIVE`. You should perform read
211
+ # `CreateStream` request, Kinesis Streams immediately returns and sets
212
+ # the stream status to `CREATING`. After the stream is created, Kinesis
213
+ # Streams sets the stream status to `ACTIVE`. You should perform read
215
214
  # and write operations only on an `ACTIVE` stream.
216
215
  #
217
216
  # You receive a `LimitExceededException` when making a `CreateStream`
218
- # request if you try to do one of the following:
217
+ # request when you try to do one of the following:
219
218
  #
220
219
  # * Have more than five streams in the `CREATING` state at any point in
221
220
  # time.
@@ -223,8 +222,8 @@ module Aws::Kinesis
223
222
  # * Create more shards than are authorized for your account.
224
223
  #
225
224
  # For the default shard limit for an AWS account, see [Streams
226
- # Limits][1] in the *Amazon Kinesis Streams Developer Guide*. If you
227
- # need to increase this limit, [contact AWS Support][2].
225
+ # Limits][1] in the *Amazon Kinesis Streams Developer Guide*. To
226
+ # increase this limit, [contact AWS Support][2].
228
227
  #
229
228
  # You can use `DescribeStream` to check the stream status, which is
230
229
  # returned in `StreamStatus`.
@@ -240,8 +239,8 @@ module Aws::Kinesis
240
239
  # A name to identify the stream. The stream name is scoped to the AWS
241
240
  # account used by the application that creates the stream. It is also
242
241
  # scoped by region. That is, two streams in two different AWS accounts
243
- # can have the same name, and two streams in the same AWS account but in
244
- # two different regions can have the same name.
242
+ # can have the same name. Two streams in the same AWS account but in two
243
+ # different regions can also have the same name.
245
244
  #
246
245
  # @option params [required, Integer] :shard_count
247
246
  # The number of shards that the stream will use. The throughput of the
@@ -268,8 +267,8 @@ module Aws::Kinesis
268
267
  req.send_request(options)
269
268
  end
270
269
 
271
- # Decreases the Amazon Kinesis stream's retention period, which is the
272
- # length of time data records are accessible after they are added to the
270
+ # Decreases the Kinesis stream's retention period, which is the length
271
+ # of time data records are accessible after they are added to the
273
272
  # stream. The minimum value of a stream's retention period is 24 hours.
274
273
  #
275
274
  # This operation may result in lost data. For example, if the stream's
@@ -301,16 +300,16 @@ module Aws::Kinesis
301
300
  req.send_request(options)
302
301
  end
303
302
 
304
- # Deletes an Amazon Kinesis stream and all its shards and data. You must
305
- # shut down any applications that are operating on the stream before you
303
+ # Deletes a Kinesis stream and all its shards and data. You must shut
304
+ # down any applications that are operating on the stream before you
306
305
  # delete the stream. If an application attempts to operate on a deleted
307
- # stream, it will receive the exception `ResourceNotFoundException`.
306
+ # stream, it receives the exception `ResourceNotFoundException`.
308
307
  #
309
308
  # If the stream is in the `ACTIVE` state, you can delete it. After a
310
309
  # `DeleteStream` request, the specified stream is in the `DELETING`
311
- # state until Amazon Kinesis completes the deletion.
310
+ # state until Kinesis Streams completes the deletion.
312
311
  #
313
- # **Note:** Amazon Kinesis might continue to accept data read and write
312
+ # **Note:** Kinesis Streams might continue to accept data read and write
314
313
  # operations, such as PutRecord, PutRecords, and GetRecords, on a stream
315
314
  # in the `DELETING` state until the stream deletion is complete.
316
315
  #
@@ -368,7 +367,7 @@ module Aws::Kinesis
368
367
  req.send_request(options)
369
368
  end
370
369
 
371
- # Describes the specified Amazon Kinesis stream.
370
+ # Describes the specified Kinesis stream.
372
371
  #
373
372
  # The information returned includes the stream name, Amazon Resource
374
373
  # Name (ARN), creation time, enhanced metric configuration, and shard
@@ -447,10 +446,53 @@ module Aws::Kinesis
447
446
  req.send_request(options)
448
447
  end
449
448
 
449
+ # Provides a summarized description of the specified Kinesis stream
450
+ # without the shard list.
451
+ #
452
+ # The information returned includes the stream name, Amazon Resource
453
+ # Name (ARN), status, record retention period, approximate creation
454
+ # time, monitoring, encryption details, and open shard count.
455
+ #
456
+ # @option params [required, String] :stream_name
457
+ # The name of the stream to describe.
458
+ #
459
+ # @return [Types::DescribeStreamSummaryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
460
+ #
461
+ # * {Types::DescribeStreamSummaryOutput#stream_description_summary #stream_description_summary} => Types::StreamDescriptionSummary
462
+ #
463
+ # @example Request syntax with placeholder values
464
+ #
465
+ # resp = client.describe_stream_summary({
466
+ # stream_name: "StreamName", # required
467
+ # })
468
+ #
469
+ # @example Response structure
470
+ #
471
+ # resp.stream_description_summary.stream_name #=> String
472
+ # resp.stream_description_summary.stream_arn #=> String
473
+ # resp.stream_description_summary.stream_status #=> String, one of "CREATING", "DELETING", "ACTIVE", "UPDATING"
474
+ # resp.stream_description_summary.retention_period_hours #=> Integer
475
+ # resp.stream_description_summary.stream_creation_timestamp #=> Time
476
+ # resp.stream_description_summary.enhanced_monitoring #=> Array
477
+ # resp.stream_description_summary.enhanced_monitoring[0].shard_level_metrics #=> Array
478
+ # resp.stream_description_summary.enhanced_monitoring[0].shard_level_metrics[0] #=> String, one of "IncomingBytes", "IncomingRecords", "OutgoingBytes", "OutgoingRecords", "WriteProvisionedThroughputExceeded", "ReadProvisionedThroughputExceeded", "IteratorAgeMilliseconds", "ALL"
479
+ # resp.stream_description_summary.encryption_type #=> String, one of "NONE", "KMS"
480
+ # resp.stream_description_summary.key_id #=> String
481
+ # resp.stream_description_summary.open_shard_count #=> Integer
482
+ #
483
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DescribeStreamSummary AWS API Documentation
484
+ #
485
+ # @overload describe_stream_summary(params = {})
486
+ # @param [Hash] params ({})
487
+ def describe_stream_summary(params = {}, options = {})
488
+ req = build_request(:describe_stream_summary, params)
489
+ req.send_request(options)
490
+ end
491
+
450
492
  # Disables enhanced monitoring.
451
493
  #
452
494
  # @option params [required, String] :stream_name
453
- # The name of the Amazon Kinesis stream for which to disable enhanced
495
+ # The name of the Kinesis stream for which to disable enhanced
454
496
  # monitoring.
455
497
  #
456
498
  # @option params [required, Array<String>] :shard_level_metrics
@@ -513,8 +555,7 @@ module Aws::Kinesis
513
555
  req.send_request(options)
514
556
  end
515
557
 
516
- # Enables enhanced Amazon Kinesis stream monitoring for shard-level
517
- # metrics.
558
+ # Enables enhanced Kinesis stream monitoring for shard-level metrics.
518
559
  #
519
560
  # @option params [required, String] :stream_name
520
561
  # The name of the stream for which to enable enhanced monitoring.
@@ -579,14 +620,14 @@ module Aws::Kinesis
579
620
  req.send_request(options)
580
621
  end
581
622
 
582
- # Gets data records from an Amazon Kinesis stream's shard.
623
+ # Gets data records from a Kinesis stream's shard.
583
624
  #
584
625
  # Specify a shard iterator using the `ShardIterator` parameter. The
585
626
  # shard iterator specifies the position in the shard from which you want
586
627
  # to start reading data records sequentially. If there are no records
587
628
  # available in the portion of the shard that the iterator points to,
588
- # GetRecords returns an empty list. Note that it might take multiple
589
- # calls to get to a portion of the shard that contains records.
629
+ # GetRecords returns an empty list. It might take multiple calls to get
630
+ # to a portion of the shard that contains records.
590
631
  #
591
632
  # You can scale by provisioning multiple shards per stream while
592
633
  # considering service limits (for more information, see [Streams
@@ -596,10 +637,10 @@ module Aws::Kinesis
596
637
  # GetRecords in a loop. Use GetShardIterator to get the shard iterator
597
638
  # to specify in the first GetRecords call. GetRecords returns a new
598
639
  # shard iterator in `NextShardIterator`. Specify the shard iterator
599
- # returned in `NextShardIterator` in subsequent calls to GetRecords.
600
- # Note that if the shard has been closed, the shard iterator can't
601
- # return more data and GetRecords returns `null` in `NextShardIterator`.
602
- # You can terminate the loop when the shard is closed, or when the shard
640
+ # returned in `NextShardIterator` in subsequent calls to GetRecords. If
641
+ # the shard has been closed, the shard iterator can't return more data
642
+ # and GetRecords returns `null` in `NextShardIterator`. You can
643
+ # terminate the loop when the shard is closed, or when the shard
603
644
  # iterator reaches the record with the sequence number or other
604
645
  # attribute that marks it as the last record to process.
605
646
  #
@@ -615,10 +656,10 @@ module Aws::Kinesis
615
656
  # calls made within the next 5 seconds throw
616
657
  # `ProvisionedThroughputExceededException`. If there is insufficient
617
658
  # provisioned throughput on the shard, subsequent calls made within the
618
- # next 1 second throw `ProvisionedThroughputExceededException`. Note
619
- # that GetRecords won't return any data when it throws an exception.
620
- # For this reason, we recommend that you wait one second between calls
621
- # to GetRecords; however, it's possible that the application will get
659
+ # next 1 second throw `ProvisionedThroughputExceededException`.
660
+ # GetRecords won't return any data when it throws an exception. For
661
+ # this reason, we recommend that you wait one second between calls to
662
+ # GetRecords; however, it's possible that the application will get
622
663
  # exceptions for longer than 1 second.
623
664
  #
624
665
  # To detect whether the application is falling behind in processing, you
@@ -629,13 +670,13 @@ module Aws::Kinesis
629
670
  # Each Amazon Kinesis record includes a value,
630
671
  # `ApproximateArrivalTimestamp`, that is set when a stream successfully
631
672
  # receives and stores a record. This is commonly referred to as a
632
- # server-side timestamp, whereas a client-side timestamp is set when a
673
+ # server-side time stamp, whereas a client-side time stamp is set when a
633
674
  # data producer creates or sends the record to a stream (a data producer
634
675
  # is any data source putting data records into a stream, for example
635
- # with PutRecords). The timestamp has millisecond precision. There are
636
- # no guarantees about the timestamp accuracy, or that the timestamp is
676
+ # with PutRecords). The time stamp has millisecond precision. There are
677
+ # no guarantees about the time stamp accuracy, or that the time stamp is
637
678
  # always increasing. For example, records in a shard or across a stream
638
- # might have timestamps that are out of order.
679
+ # might have time stamps that are out of order.
639
680
  #
640
681
  #
641
682
  #
@@ -698,15 +739,16 @@ module Aws::Kinesis
698
739
  # You must specify the shard iterator type. For example, you can set the
699
740
  # `ShardIteratorType` parameter to read exactly from the position
700
741
  # denoted by a specific sequence number by using the
701
- # `AT_SEQUENCE_NUMBER` shard iterator type, or right after the sequence
702
- # number by using the `AFTER_SEQUENCE_NUMBER` shard iterator type, using
703
- # sequence numbers returned by earlier calls to PutRecord, PutRecords,
704
- # GetRecords, or DescribeStream. In the request, you can specify the
705
- # shard iterator type `AT_TIMESTAMP` to read records from an arbitrary
706
- # point in time, `TRIM_HORIZON` to cause `ShardIterator` to point to the
707
- # last untrimmed record in the shard in the system (the oldest data
708
- # record in the shard), or `LATEST` so that you always read the most
709
- # recent data in the shard.
742
+ # `AT_SEQUENCE_NUMBER` shard iterator type. Alternatively, the parameter
743
+ # can read right after the sequence number by using the
744
+ # `AFTER_SEQUENCE_NUMBER` shard iterator type, using sequence numbers
745
+ # returned by earlier calls to PutRecord, PutRecords, GetRecords, or
746
+ # DescribeStream. In the request, you can specify the shard iterator
747
+ # type `AT_TIMESTAMP` to read records from an arbitrary point in time,
748
+ # `TRIM_HORIZON` to cause `ShardIterator` to point to the last untrimmed
749
+ # record in the shard in the system (the oldest data record in the
750
+ # shard), or `LATEST` so that you always read the most recent data in
751
+ # the shard.
710
752
  #
711
753
  # When you read repeatedly from a stream, use a GetShardIterator request
712
754
  # to get the first shard iterator for use in your first GetRecords
@@ -721,8 +763,8 @@ module Aws::Kinesis
721
763
  # *Amazon Kinesis Streams Developer Guide*.
722
764
  #
723
765
  # If the shard is closed, GetShardIterator returns a valid iterator for
724
- # the last sequence number of the shard. Note that a shard can be closed
725
- # as a result of using SplitShard or MergeShards.
766
+ # the last sequence number of the shard. A shard can be closed as a
767
+ # result of using SplitShard or MergeShards.
726
768
  #
727
769
  # GetShardIterator has a limit of 5 transactions per second per account
728
770
  # per open shard.
@@ -735,7 +777,7 @@ module Aws::Kinesis
735
777
  # The name of the Amazon Kinesis stream.
736
778
  #
737
779
  # @option params [required, String] :shard_id
738
- # The shard ID of the Amazon Kinesis shard to get the iterator for.
780
+ # The shard ID of the Kinesis Streams shard to get the iterator for.
739
781
  #
740
782
  # @option params [required, String] :shard_iterator_type
741
783
  # Determines how the shard iterator is used to start reading data
@@ -752,7 +794,7 @@ module Aws::Kinesis
752
794
  # `StartingSequenceNumber`.
753
795
  #
754
796
  # * AT\_TIMESTAMP - Start reading from the position denoted by a
755
- # specific timestamp, provided in the value `Timestamp`.
797
+ # specific time stamp, provided in the value `Timestamp`.
756
798
  #
757
799
  # * TRIM\_HORIZON - Start reading at the last untrimmed record in the
758
800
  # shard in the system, which is the oldest data record in the shard.
@@ -766,12 +808,12 @@ module Aws::Kinesis
766
808
  # AFTER\_SEQUENCE\_NUMBER.
767
809
  #
768
810
  # @option params [Time,DateTime,Date,Integer,String] :timestamp
769
- # The timestamp of the data record from which to start reading. Used
770
- # with shard iterator type AT\_TIMESTAMP. A timestamp is the Unix epoch
811
+ # The time stamp of the data record from which to start reading. Used
812
+ # with shard iterator type AT\_TIMESTAMP. A time stamp is the Unix epoch
771
813
  # date with precision in milliseconds. For example,
772
814
  # `2016-04-04T19:58:46.480-00:00` or `1459799926.480`. If a record with
773
- # this exact timestamp does not exist, the iterator returned is for the
774
- # next (later) record. If the timestamp is older than the current trim
815
+ # this exact time stamp does not exist, the iterator returned is for the
816
+ # next (later) record. If the time stamp is older than the current trim
775
817
  # horizon, the iterator returned is for the oldest untrimmed data record
776
818
  # (TRIM\_HORIZON).
777
819
  #
@@ -807,13 +849,13 @@ module Aws::Kinesis
807
849
  # stream. The maximum value of a stream's retention period is 168 hours
808
850
  # (7 days).
809
851
  #
810
- # Upon choosing a longer stream retention period, this operation will
811
- # increase the time period records are accessible that have not yet
812
- # expired. However, it will not make previous data that has expired
813
- # (older than the stream's previous retention period) accessible after
814
- # the operation has been called. For example, if a stream's retention
815
- # period is set to 24 hours and is increased to 168 hours, any data that
816
- # is older than 24 hours will remain inaccessible to consumer
852
+ # If you choose a longer stream retention period, this operation
853
+ # increases the time period during which records that have not yet
854
+ # expired are accessible. However, it does not make previous, expired
855
+ # data (older than the stream's previous retention period) accessible
856
+ # after the operation has been called. For example, if a stream's
857
+ # retention period is set to 24 hours and is increased to 168 hours, any
858
+ # data that is older than 24 hours remains inaccessible to consumer
817
859
  # applications.
818
860
  #
819
861
  # @option params [required, String] :stream_name
@@ -841,12 +883,12 @@ module Aws::Kinesis
841
883
  req.send_request(options)
842
884
  end
843
885
 
844
- # Lists your Amazon Kinesis streams.
886
+ # Lists your Kinesis streams.
845
887
  #
846
888
  # The number of streams may be too large to return from a single call to
847
889
  # `ListStreams`. You can limit the number of returned streams using the
848
890
  # `Limit` parameter. If you do not specify a value for the `Limit`
849
- # parameter, Amazon Kinesis uses the default limit, which is currently
891
+ # parameter, Kinesis Streams uses the default limit, which is currently
850
892
  # 10.
851
893
  #
852
894
  # You can detect if there are more streams available to list by using
@@ -893,7 +935,7 @@ module Aws::Kinesis
893
935
  req.send_request(options)
894
936
  end
895
937
 
896
- # Lists the tags for the specified Amazon Kinesis stream.
938
+ # Lists the tags for the specified Kinesis stream.
897
939
  #
898
940
  # @option params [required, String] :stream_name
899
941
  # The name of the stream.
@@ -938,13 +980,13 @@ module Aws::Kinesis
938
980
  req.send_request(options)
939
981
  end
940
982
 
941
- # Merges two adjacent shards in an Amazon Kinesis stream and combines
942
- # them into a single shard to reduce the stream's capacity to ingest
943
- # and transport data. Two shards are considered adjacent if the union of
944
- # the hash key ranges for the two shards form a contiguous set with no
945
- # gaps. For example, if you have two shards, one with a hash key range
946
- # of 276...381 and the other with a hash key range of 382...454, then
947
- # you could merge these two shards into a single shard that would have a
983
+ # Merges two adjacent shards in a Kinesis stream and combines them into
984
+ # a single shard to reduce the stream's capacity to ingest and
985
+ # transport data. Two shards are considered adjacent if the union of the
986
+ # hash key ranges for the two shards form a contiguous set with no gaps.
987
+ # For example, if you have two shards, one with a hash key range of
988
+ # 276...381 and the other with a hash key range of 382...454, then you
989
+ # could merge these two shards into a single shard that would have a
948
990
  # hash key range of 276...454. After the merge, the single child shard
949
991
  # receives data for all hash key values covered by the two parent
950
992
  # shards.
@@ -978,7 +1020,7 @@ module Aws::Kinesis
978
1020
  # CreateStream, DeleteStream, `MergeShards` or SplitShard, you will
979
1021
  # receive a `LimitExceededException`.
980
1022
  #
981
- # `MergeShards` has limit of 5 transactions per second per account.
1023
+ # `MergeShards` has a limit of 5 transactions per second per account.
982
1024
  #
983
1025
  #
984
1026
  #
@@ -1026,11 +1068,11 @@ module Aws::Kinesis
1026
1068
  # log file, geographic/location data, website clickstream data, and so
1027
1069
  # on.
1028
1070
  #
1029
- # The partition key is used by Amazon Kinesis to distribute data across
1030
- # shards. Amazon Kinesis segregates the data records that belong to a
1071
+ # The partition key is used by Kinesis Streams to distribute data across
1072
+ # shards. Kinesis Streams segregates the data records that belong to a
1031
1073
  # stream into multiple shards, using the partition key associated with
1032
- # each data record to determine which shard a given data record belongs
1033
- # to.
1074
+ # each data record to determine the shard to which a given data record
1075
+ # belongs.
1034
1076
  #
1035
1077
  # Partition keys are Unicode strings, with a maximum length limit of 256
1036
1078
  # characters for each key. An MD5 hash function is used to map partition
@@ -1093,7 +1135,7 @@ module Aws::Kinesis
1093
1135
  # same client and to the same partition key. Usage: set the
1094
1136
  # `SequenceNumberForOrdering` of record *n* to the sequence number of
1095
1137
  # record *n-1* (as returned in the result when putting record *n-1*). If
1096
- # this parameter is not set, records will be coarsely ordered based on
1138
+ # this parameter is not set, records are coarsely ordered based on
1097
1139
  # arrival time.
1098
1140
  #
1099
1141
  # @return [Types::PutRecordOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -1127,9 +1169,9 @@ module Aws::Kinesis
1127
1169
  req.send_request(options)
1128
1170
  end
1129
1171
 
1130
- # Writes multiple data records into an Amazon Kinesis stream in a single
1131
- # call (also referred to as a `PutRecords` request). Use this operation
1132
- # to send data into the stream for data ingestion and processing.
1172
+ # Writes multiple data records into a Kinesis stream in a single call
1173
+ # (also referred to as a `PutRecords` request). Use this operation to
1174
+ # send data into the stream for data ingestion and processing.
1133
1175
  #
1134
1176
  # Each `PutRecords` request can support up to 500 records. Each record
1135
1177
  # in the request can be as large as 1 MB, up to a limit of 5 MB for the
@@ -1147,7 +1189,7 @@ module Aws::Kinesis
1147
1189
  # log file, geographic/location data, website clickstream data, and so
1148
1190
  # on.
1149
1191
  #
1150
- # The partition key is used by Amazon Kinesis as input to a hash
1192
+ # The partition key is used by Kinesis Streams as input to a hash
1151
1193
  # function that maps the partition key and associated data to a specific
1152
1194
  # shard. An MD5 hash function is used to map partition keys to 128-bit
1153
1195
  # integer values and to map associated data records to shards. As a
@@ -1174,13 +1216,13 @@ module Aws::Kinesis
1174
1216
  # all records in each `PutRecords` request. A single record failure does
1175
1217
  # not stop the processing of subsequent records.
1176
1218
  #
1177
- # A successfully-processed record includes `ShardId` and
1219
+ # A successfully processed record includes `ShardId` and
1178
1220
  # `SequenceNumber` values. The `ShardId` parameter identifies the shard
1179
1221
  # in the stream where the record is stored. The `SequenceNumber`
1180
1222
  # parameter is an identifier assigned to the put record, unique to all
1181
1223
  # records in the stream.
1182
1224
  #
1183
- # An unsuccessfully-processed record includes `ErrorCode` and
1225
+ # An unsuccessfully processed record includes `ErrorCode` and
1184
1226
  # `ErrorMessage` values. `ErrorCode` reflects the type of error and can
1185
1227
  # be one of the following values:
1186
1228
  # `ProvisionedThroughputExceededException` or `InternalFailure`.
@@ -1246,8 +1288,8 @@ module Aws::Kinesis
1246
1288
  req.send_request(options)
1247
1289
  end
1248
1290
 
1249
- # Removes tags from the specified Amazon Kinesis stream. Removed tags
1250
- # are deleted and cannot be recovered after this operation successfully
1291
+ # Removes tags from the specified Kinesis stream. Removed tags are
1292
+ # deleted and cannot be recovered after this operation successfully
1251
1293
  # completes.
1252
1294
  #
1253
1295
  # If you specify a tag that does not exist, it is ignored.
@@ -1276,36 +1318,35 @@ module Aws::Kinesis
1276
1318
  req.send_request(options)
1277
1319
  end
1278
1320
 
1279
- # Splits a shard into two new shards in the Amazon Kinesis stream to
1280
- # increase the stream's capacity to ingest and transport data.
1281
- # `SplitShard` is called when there is a need to increase the overall
1282
- # capacity of a stream because of an expected increase in the volume of
1283
- # data records being ingested.
1321
+ # Splits a shard into two new shards in the Kinesis stream, to increase
1322
+ # the stream's capacity to ingest and transport data. `SplitShard` is
1323
+ # called when there is a need to increase the overall capacity of a
1324
+ # stream because of an expected increase in the volume of data records
1325
+ # being ingested.
1284
1326
  #
1285
1327
  # You can also use `SplitShard` when a shard appears to be approaching
1286
1328
  # its maximum utilization; for example, the producers sending data into
1287
1329
  # the specific shard are suddenly sending more than previously
1288
1330
  # anticipated. You can also call `SplitShard` to increase stream
1289
- # capacity, so that more Amazon Kinesis applications can simultaneously
1331
+ # capacity, so that more Kinesis Streams applications can simultaneously
1290
1332
  # read data from the stream for real-time processing.
1291
1333
  #
1292
1334
  # You must specify the shard to be split and the new hash key, which is
1293
1335
  # the position in the shard where the shard gets split in two. In many
1294
- # cases, the new hash key might simply be the average of the beginning
1295
- # and ending hash key, but it can be any hash key value in the range
1296
- # being mapped into the shard. For more information about splitting
1297
- # shards, see [Split a Shard][1] in the *Amazon Kinesis Streams
1298
- # Developer Guide*.
1336
+ # cases, the new hash key might be the average of the beginning and
1337
+ # ending hash key, but it can be any hash key value in the range being
1338
+ # mapped into the shard. For more information, see [Split a Shard][1] in
1339
+ # the *Amazon Kinesis Streams Developer Guide*.
1299
1340
  #
1300
1341
  # You can use DescribeStream to determine the shard ID and hash key
1301
1342
  # values for the `ShardToSplit` and `NewStartingHashKey` parameters that
1302
1343
  # are specified in the `SplitShard` request.
1303
1344
  #
1304
1345
  # `SplitShard` is an asynchronous operation. Upon receiving a
1305
- # `SplitShard` request, Amazon Kinesis immediately returns a response
1346
+ # `SplitShard` request, Kinesis Streams immediately returns a response
1306
1347
  # and sets the stream status to `UPDATING`. After the operation is
1307
- # completed, Amazon Kinesis sets the stream status to `ACTIVE`. Read and
1308
- # write operations continue to work while the stream is in the
1348
+ # completed, Kinesis Streams sets the stream status to `ACTIVE`. Read
1349
+ # and write operations continue to work while the stream is in the
1309
1350
  # `UPDATING` state.
1310
1351
  #
1311
1352
  # You can use `DescribeStream` to check the status of the stream, which
@@ -1319,14 +1360,14 @@ module Aws::Kinesis
1319
1360
  # authorized for your account, you receive a `LimitExceededException`.
1320
1361
  #
1321
1362
  # For the default shard limit for an AWS account, see [Streams
1322
- # Limits][2] in the *Amazon Kinesis Streams Developer Guide*. If you
1323
- # need to increase this limit, [contact AWS Support][3].
1363
+ # Limits][2] in the *Amazon Kinesis Streams Developer Guide*. To
1364
+ # increase this limit, [contact AWS Support][3].
1324
1365
  #
1325
1366
  # If you try to operate on too many streams simultaneously using
1326
1367
  # CreateStream, DeleteStream, MergeShards, and/or SplitShard, you
1327
1368
  # receive a `LimitExceededException`.
1328
1369
  #
1329
- # `SplitShard` has limit of 5 transactions per second per account.
1370
+ # `SplitShard` has a limit of 5 transactions per second per account.
1330
1371
  #
1331
1372
  #
1332
1373
  #
@@ -1373,39 +1414,48 @@ module Aws::Kinesis
1373
1414
  # specified stream.
1374
1415
  #
1375
1416
  # Starting encryption is an asynchronous operation. Upon receiving the
1376
- # request, Amazon Kinesis returns immediately and sets the status of the
1377
- # stream to `UPDATING`. After the update is complete, Amazon Kinesis
1378
- # sets the status of the stream back to `ACTIVE`. Updating or applying
1379
- # encryption normally takes a few seconds to complete but it can take
1380
- # minutes. You can continue to read and write data to your stream while
1381
- # its status is `UPDATING`. Once the status of the stream is `ACTIVE`,
1382
- # records written to the stream will begin to be encrypted.
1417
+ # request, Kinesis Streams returns immediately and sets the status of
1418
+ # the stream to `UPDATING`. After the update is complete, Kinesis
1419
+ # Streams sets the status of the stream back to `ACTIVE`. Updating or
1420
+ # applying encryption normally takes a few seconds to complete, but it
1421
+ # can take minutes. You can continue to read and write data to your
1422
+ # stream while its status is `UPDATING`. Once the status of the stream
1423
+ # is `ACTIVE`, encryption begins for records written to the stream.
1383
1424
  #
1384
1425
  # API Limits: You can successfully apply a new AWS KMS key for
1385
- # server-side encryption 25 times in a rolling 24 hour period.
1426
+ # server-side encryption 25 times in a rolling 24-hour period.
1386
1427
  #
1387
- # Note: It can take up to 5 seconds after the stream is in an `ACTIVE`
1388
- # status before all records written to the stream are encrypted. After
1389
- # you’ve enabled encryption, you can verify encryption was applied by
1390
- # inspecting the API response from `PutRecord` or `PutRecords`.
1428
+ # Note: It can take up to five seconds after the stream is in an
1429
+ # `ACTIVE` status before all records written to the stream are
1430
+ # encrypted. After you enable encryption, you can verify that encryption
1431
+ # is applied by inspecting the API response from `PutRecord` or
1432
+ # `PutRecords`.
1391
1433
  #
1392
1434
  # @option params [required, String] :stream_name
1393
1435
  # The name of the stream for which to start encrypting records.
1394
1436
  #
1395
1437
  # @option params [required, String] :encryption_type
1396
- # The encryption type to use. This parameter can be one of the following
1397
- # values:
1438
+ # The encryption type to use. The only valid value is `KMS`.
1439
+ #
1440
+ # @option params [required, String] :key_id
1441
+ # The GUID for the customer-managed KMS key to use for encryption. This
1442
+ # value can be a globally unique identifier, a fully specified ARN to
1443
+ # either an alias or a key, or an alias name prefixed by "alias/".You
1444
+ # can also use a master key owned by Kinesis Streams by specifying the
1445
+ # alias `aws/kinesis`.
1398
1446
  #
1399
- # * `NONE`\: Not valid for this operation. An
1400
- # `InvalidOperationException` will be thrown.
1447
+ # * Key ARN example:
1448
+ # `arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012`
1401
1449
  #
1402
- # * `KMS`\: Use server-side encryption on the records in the stream
1403
- # using a customer-managed KMS key.
1450
+ # * Alias ARN example:
1451
+ # `arn:aws:kms:us-east-1:123456789012:alias/MyAliasName`
1404
1452
  #
1405
- # @option params [required, String] :key_id
1406
- # The GUID for the customer-managed KMS key to use for encryption. You
1407
- # can also use a Kinesis-owned master key by specifying the alias
1408
- # `aws/kinesis`.
1453
+ # * Globally unique key ID example:
1454
+ # `12345678-1234-1234-1234-123456789012`
1455
+ #
1456
+ # * Alias name example: `alias/MyAliasName`
1457
+ #
1458
+ # * Master key owned by Kinesis Streams: `alias/aws/kinesis`
1409
1459
  #
1410
1460
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1411
1461
  #
@@ -1429,39 +1479,49 @@ module Aws::Kinesis
1429
1479
  # Disables server-side encryption for a specified stream.
1430
1480
  #
1431
1481
  # Stopping encryption is an asynchronous operation. Upon receiving the
1432
- # request, Amazon Kinesis returns immediately and sets the status of the
1433
- # stream to `UPDATING`. After the update is complete, Amazon Kinesis
1434
- # sets the status of the stream back to `ACTIVE`. Stopping encryption
1435
- # normally takes a few seconds to complete but it can take minutes. You
1436
- # can continue to read and write data to your stream while its status is
1437
- # `UPDATING`. Once the status of the stream is `ACTIVE` records written
1438
- # to the stream will no longer be encrypted by the Amazon Kinesis
1439
- # Streams service.
1482
+ # request, Kinesis Streams returns immediately and sets the status of
1483
+ # the stream to `UPDATING`. After the update is complete, Kinesis
1484
+ # Streams sets the status of the stream back to `ACTIVE`. Stopping
1485
+ # encryption normally takes a few seconds to complete, but it can take
1486
+ # minutes. You can continue to read and write data to your stream while
1487
+ # its status is `UPDATING`. Once the status of the stream is `ACTIVE`,
1488
+ # records written to the stream are no longer encrypted by Kinesis
1489
+ # Streams.
1440
1490
  #
1441
1491
  # API Limits: You can successfully disable server-side encryption 25
1442
- # times in a rolling 24 hour period.
1492
+ # times in a rolling 24-hour period.
1443
1493
  #
1444
- # Note: It can take up to 5 seconds after the stream is in an `ACTIVE`
1445
- # status before all records written to the stream are no longer subject
1446
- # to encryption. After you’ve disabled encryption, you can verify
1447
- # encryption was not applied by inspecting the API response from
1494
+ # Note: It can take up to five seconds after the stream is in an
1495
+ # `ACTIVE` status before all records written to the stream are no longer
1496
+ # subject to encryption. After you disabled encryption, you can verify
1497
+ # that encryption is not applied by inspecting the API response from
1448
1498
  # `PutRecord` or `PutRecords`.
1449
1499
  #
1450
1500
  # @option params [required, String] :stream_name
1451
1501
  # The name of the stream on which to stop encrypting records.
1452
1502
  #
1453
1503
  # @option params [required, String] :encryption_type
1454
- # The encryption type. This parameter can be one of the following
1455
- # values:
1504
+ # The encryption type. The only valid value is `KMS`.
1456
1505
  #
1457
- # * `NONE`\: Not valid for this operation. An
1458
- # `InvalidOperationException` will be thrown.
1506
+ # @option params [required, String] :key_id
1507
+ # The GUID for the customer-managed KMS key to use for encryption. This
1508
+ # value can be a globally unique identifier, a fully specified ARN to
1509
+ # either an alias or a key, or an alias name prefixed by "alias/".You
1510
+ # can also use a master key owned by Kinesis Streams by specifying the
1511
+ # alias `aws/kinesis`.
1459
1512
  #
1460
- # * `KMS`\: Use server-side encryption on the records in the stream
1461
- # using a customer-managed KMS key.
1513
+ # * Key ARN example:
1514
+ # `arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012`
1462
1515
  #
1463
- # @option params [required, String] :key_id
1464
- # The GUID for the customer-managed key that was used for encryption.
1516
+ # * Alias ARN example:
1517
+ # `arn:aws:kms:us-east-1:123456789012:alias/MyAliasName`
1518
+ #
1519
+ # * Globally unique key ID example:
1520
+ # `12345678-1234-1234-1234-123456789012`
1521
+ #
1522
+ # * Alias name example: `alias/MyAliasName`
1523
+ #
1524
+ # * Master key owned by Kinesis Streams: `alias/aws/kinesis`
1465
1525
  #
1466
1526
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1467
1527
  #
@@ -1486,40 +1546,40 @@ module Aws::Kinesis
1486
1546
  # number of shards.
1487
1547
  #
1488
1548
  # Updating the shard count is an asynchronous operation. Upon receiving
1489
- # the request, Amazon Kinesis returns immediately and sets the status of
1490
- # the stream to `UPDATING`. After the update is complete, Amazon Kinesis
1491
- # sets the status of the stream back to `ACTIVE`. Depending on the size
1492
- # of the stream, the scaling action could take a few minutes to
1549
+ # the request, Kinesis Streams returns immediately and sets the status
1550
+ # of the stream to `UPDATING`. After the update is complete, Kinesis
1551
+ # Streams sets the status of the stream back to `ACTIVE`. Depending on
1552
+ # the size of the stream, the scaling action could take a few minutes to
1493
1553
  # complete. You can continue to read and write data to your stream while
1494
1554
  # its status is `UPDATING`.
1495
1555
  #
1496
- # To update the shard count, Amazon Kinesis performs splits or merges on
1497
- # individual shards. This can cause short-lived shards to be created, in
1498
- # addition to the final shards. We recommend that you double or halve
1556
+ # To update the shard count, Kinesis Streams performs splits or merges
1557
+ # on individual shards. This can cause short-lived shards to be created,
1558
+ # in addition to the final shards. We recommend that you double or halve
1499
1559
  # the shard count, as this results in the fewest number of splits or
1500
1560
  # merges.
1501
1561
  #
1502
1562
  # This operation has the following limits, which are per region per
1503
- # account unless otherwise noted:
1563
+ # account unless otherwise noted. You cannot:
1504
1564
  #
1505
- # * scale more than twice per rolling 24 hour period
1565
+ # * Scale more than twice per rolling 24 hour period
1506
1566
  #
1507
- # * scale up above double your current shard count
1567
+ # * Scale up to double your current shard count
1508
1568
  #
1509
- # * scale down below half your current shard count
1569
+ # * Scale down below half your current shard count
1510
1570
  #
1511
- # * scale up above 200 shards in a stream
1571
+ # * Scale up to more 500 shards in a stream
1512
1572
  #
1513
- # * scale a stream with more than 200 shards down unless the result is
1514
- # less than 200 shards
1573
+ # * Scale a stream with more than 500 shards down unless the result is
1574
+ # less than 500 shards
1515
1575
  #
1516
- # * scale up above the shard limits for your account
1576
+ # * Scale up more the shard limits for your account
1517
1577
  #
1518
1578
  # *
1519
1579
  #
1520
1580
  # For the default limits for an AWS account, see [Streams Limits][1] in
1521
- # the *Amazon Kinesis Streams Developer Guide*. If you need to increase
1522
- # a limit, [contact AWS Support][2].
1581
+ # the *Amazon Kinesis Streams Developer Guide*. To increase a limit,
1582
+ # [contact AWS Support][2].
1523
1583
  #
1524
1584
  #
1525
1585
  #
@@ -1577,7 +1637,7 @@ module Aws::Kinesis
1577
1637
  params: params,
1578
1638
  config: config)
1579
1639
  context[:gem_name] = 'aws-sdk-kinesis'
1580
- context[:gem_version] = '1.0.0'
1640
+ context[:gem_version] = '1.1.0'
1581
1641
  Seahorse::Client::Request.new(handlers, context)
1582
1642
  end
1583
1643
 
@@ -22,6 +22,8 @@ module Aws::Kinesis
22
22
  DescribeStreamInput = Shapes::StructureShape.new(name: 'DescribeStreamInput')
23
23
  DescribeStreamInputLimit = Shapes::IntegerShape.new(name: 'DescribeStreamInputLimit')
24
24
  DescribeStreamOutput = Shapes::StructureShape.new(name: 'DescribeStreamOutput')
25
+ DescribeStreamSummaryInput = Shapes::StructureShape.new(name: 'DescribeStreamSummaryInput')
26
+ DescribeStreamSummaryOutput = Shapes::StructureShape.new(name: 'DescribeStreamSummaryOutput')
25
27
  DisableEnhancedMonitoringInput = Shapes::StructureShape.new(name: 'DisableEnhancedMonitoringInput')
26
28
  EnableEnhancedMonitoringInput = Shapes::StructureShape.new(name: 'EnableEnhancedMonitoringInput')
27
29
  EncryptionType = Shapes::StringShape.new(name: 'EncryptionType')
@@ -88,6 +90,7 @@ module Aws::Kinesis
88
90
  StopStreamEncryptionInput = Shapes::StructureShape.new(name: 'StopStreamEncryptionInput')
89
91
  StreamARN = Shapes::StringShape.new(name: 'StreamARN')
90
92
  StreamDescription = Shapes::StructureShape.new(name: 'StreamDescription')
93
+ StreamDescriptionSummary = Shapes::StructureShape.new(name: 'StreamDescriptionSummary')
91
94
  StreamName = Shapes::StringShape.new(name: 'StreamName')
92
95
  StreamNameList = Shapes::ListShape.new(name: 'StreamNameList')
93
96
  StreamStatus = Shapes::StringShape.new(name: 'StreamStatus')
@@ -130,6 +133,12 @@ module Aws::Kinesis
130
133
  DescribeStreamOutput.add_member(:stream_description, Shapes::ShapeRef.new(shape: StreamDescription, required: true, location_name: "StreamDescription"))
131
134
  DescribeStreamOutput.struct_class = Types::DescribeStreamOutput
132
135
 
136
+ DescribeStreamSummaryInput.add_member(:stream_name, Shapes::ShapeRef.new(shape: StreamName, required: true, location_name: "StreamName"))
137
+ DescribeStreamSummaryInput.struct_class = Types::DescribeStreamSummaryInput
138
+
139
+ DescribeStreamSummaryOutput.add_member(:stream_description_summary, Shapes::ShapeRef.new(shape: StreamDescriptionSummary, required: true, location_name: "StreamDescriptionSummary"))
140
+ DescribeStreamSummaryOutput.struct_class = Types::DescribeStreamSummaryOutput
141
+
133
142
  DisableEnhancedMonitoringInput.add_member(:stream_name, Shapes::ShapeRef.new(shape: StreamName, required: true, location_name: "StreamName"))
134
143
  DisableEnhancedMonitoringInput.add_member(:shard_level_metrics, Shapes::ShapeRef.new(shape: MetricsNameList, required: true, location_name: "ShardLevelMetrics"))
135
144
  DisableEnhancedMonitoringInput.struct_class = Types::DisableEnhancedMonitoringInput
@@ -288,6 +297,17 @@ module Aws::Kinesis
288
297
  StreamDescription.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyId, location_name: "KeyId"))
289
298
  StreamDescription.struct_class = Types::StreamDescription
290
299
 
300
+ StreamDescriptionSummary.add_member(:stream_name, Shapes::ShapeRef.new(shape: StreamName, required: true, location_name: "StreamName"))
301
+ StreamDescriptionSummary.add_member(:stream_arn, Shapes::ShapeRef.new(shape: StreamARN, required: true, location_name: "StreamARN"))
302
+ StreamDescriptionSummary.add_member(:stream_status, Shapes::ShapeRef.new(shape: StreamStatus, required: true, location_name: "StreamStatus"))
303
+ StreamDescriptionSummary.add_member(:retention_period_hours, Shapes::ShapeRef.new(shape: PositiveIntegerObject, required: true, location_name: "RetentionPeriodHours"))
304
+ StreamDescriptionSummary.add_member(:stream_creation_timestamp, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "StreamCreationTimestamp"))
305
+ StreamDescriptionSummary.add_member(:enhanced_monitoring, Shapes::ShapeRef.new(shape: EnhancedMonitoringList, required: true, location_name: "EnhancedMonitoring"))
306
+ StreamDescriptionSummary.add_member(:encryption_type, Shapes::ShapeRef.new(shape: EncryptionType, location_name: "EncryptionType"))
307
+ StreamDescriptionSummary.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyId, location_name: "KeyId"))
308
+ StreamDescriptionSummary.add_member(:open_shard_count, Shapes::ShapeRef.new(shape: ShardCountObject, required: true, location_name: "OpenShardCount"))
309
+ StreamDescriptionSummary.struct_class = Types::StreamDescriptionSummary
310
+
291
311
  StreamNameList.member = Shapes::ShapeRef.new(shape: StreamName)
292
312
 
293
313
  Tag.add_member(:key, Shapes::ShapeRef.new(shape: TagKey, required: true, location_name: "Key"))
@@ -396,6 +416,16 @@ module Aws::Kinesis
396
416
  )
397
417
  end)
398
418
 
419
+ api.add_operation(:describe_stream_summary, Seahorse::Model::Operation.new.tap do |o|
420
+ o.name = "DescribeStreamSummary"
421
+ o.http_method = "POST"
422
+ o.http_request_uri = "/"
423
+ o.input = Shapes::ShapeRef.new(shape: DescribeStreamSummaryInput)
424
+ o.output = Shapes::ShapeRef.new(shape: DescribeStreamSummaryOutput)
425
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
426
+ o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
427
+ end)
428
+
399
429
  api.add_operation(:disable_enhanced_monitoring, Seahorse::Model::Operation.new.tap do |o|
400
430
  o.name = "DisableEnhancedMonitoring"
401
431
  o.http_method = "POST"
@@ -50,8 +50,8 @@ module Aws::Kinesis
50
50
  # A name to identify the stream. The stream name is scoped to the AWS
51
51
  # account used by the application that creates the stream. It is also
52
52
  # scoped by region. That is, two streams in two different AWS accounts
53
- # can have the same name, and two streams in the same AWS account but
54
- # in two different regions can have the same name.
53
+ # can have the same name. Two streams in the same AWS account but in
54
+ # two different regions can also have the same name.
55
55
  # @return [String]
56
56
  #
57
57
  # @!attribute [rw] shard_count
@@ -188,6 +188,35 @@ module Aws::Kinesis
188
188
  include Aws::Structure
189
189
  end
190
190
 
191
+ # @note When making an API call, you may pass DescribeStreamSummaryInput
192
+ # data as a hash:
193
+ #
194
+ # {
195
+ # stream_name: "StreamName", # required
196
+ # }
197
+ #
198
+ # @!attribute [rw] stream_name
199
+ # The name of the stream to describe.
200
+ # @return [String]
201
+ #
202
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DescribeStreamSummaryInput AWS API Documentation
203
+ #
204
+ class DescribeStreamSummaryInput < Struct.new(
205
+ :stream_name)
206
+ include Aws::Structure
207
+ end
208
+
209
+ # @!attribute [rw] stream_description_summary
210
+ # A StreamDescriptionSummary containing information about the stream.
211
+ # @return [Types::StreamDescriptionSummary]
212
+ #
213
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DescribeStreamSummaryOutput AWS API Documentation
214
+ #
215
+ class DescribeStreamSummaryOutput < Struct.new(
216
+ :stream_description_summary)
217
+ include Aws::Structure
218
+ end
219
+
191
220
  # Represents the input for DisableEnhancedMonitoring.
192
221
  #
193
222
  # @note When making an API call, you may pass DisableEnhancedMonitoringInput
@@ -199,7 +228,7 @@ module Aws::Kinesis
199
228
  # }
200
229
  #
201
230
  # @!attribute [rw] stream_name
202
- # The name of the Amazon Kinesis stream for which to disable enhanced
231
+ # The name of the Kinesis stream for which to disable enhanced
203
232
  # monitoring.
204
233
  # @return [String]
205
234
  #
@@ -339,7 +368,7 @@ module Aws::Kinesis
339
368
  # DisableEnhancedMonitoring.
340
369
  #
341
370
  # @!attribute [rw] stream_name
342
- # The name of the Amazon Kinesis stream.
371
+ # The name of the Kinesis stream.
343
372
  # @return [String]
344
373
  #
345
374
  # @!attribute [rw] current_shard_level_metrics
@@ -400,14 +429,14 @@ module Aws::Kinesis
400
429
  # @!attribute [rw] next_shard_iterator
401
430
  # The next position in the shard from which to start sequentially
402
431
  # reading data records. If set to `null`, the shard has been closed
403
- # and the requested iterator will not return any more data.
432
+ # and the requested iterator does not return any more data.
404
433
  # @return [String]
405
434
  #
406
435
  # @!attribute [rw] millis_behind_latest
407
436
  # The number of milliseconds the GetRecords response is from the tip
408
437
  # of the stream, indicating how far behind current time the consumer
409
- # is. A value of zero indicates record processing is caught up, and
410
- # there are no new records to process at this moment.
438
+ # is. A value of zero indicates that record processing is caught up,
439
+ # and there are no new records to process at this moment.
411
440
  # @return [Integer]
412
441
  #
413
442
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/GetRecordsOutput AWS API Documentation
@@ -437,7 +466,7 @@ module Aws::Kinesis
437
466
  # @return [String]
438
467
  #
439
468
  # @!attribute [rw] shard_id
440
- # The shard ID of the Amazon Kinesis shard to get the iterator for.
469
+ # The shard ID of the Kinesis Streams shard to get the iterator for.
441
470
  # @return [String]
442
471
  #
443
472
  # @!attribute [rw] shard_iterator_type
@@ -455,7 +484,7 @@ module Aws::Kinesis
455
484
  # `StartingSequenceNumber`.
456
485
  #
457
486
  # * AT\_TIMESTAMP - Start reading from the position denoted by a
458
- # specific timestamp, provided in the value `Timestamp`.
487
+ # specific time stamp, provided in the value `Timestamp`.
459
488
  #
460
489
  # * TRIM\_HORIZON - Start reading at the last untrimmed record in the
461
490
  # shard in the system, which is the oldest data record in the shard.
@@ -471,12 +500,12 @@ module Aws::Kinesis
471
500
  # @return [String]
472
501
  #
473
502
  # @!attribute [rw] timestamp
474
- # The timestamp of the data record from which to start reading. Used
475
- # with shard iterator type AT\_TIMESTAMP. A timestamp is the Unix
503
+ # The time stamp of the data record from which to start reading. Used
504
+ # with shard iterator type AT\_TIMESTAMP. A time stamp is the Unix
476
505
  # epoch date with precision in milliseconds. For example,
477
506
  # `2016-04-04T19:58:46.480-00:00` or `1459799926.480`. If a record
478
- # with this exact timestamp does not exist, the iterator returned is
479
- # for the next (later) record. If the timestamp is older than the
507
+ # with this exact time stamp does not exist, the iterator returned is
508
+ # for the next (later) record. If the time stamp is older than the
480
509
  # current trim horizon, the iterator returned is for the oldest
481
510
  # untrimmed data record (TRIM\_HORIZON).
482
511
  # @return [Time]
@@ -735,8 +764,8 @@ module Aws::Kinesis
735
764
  # same client and to the same partition key. Usage: set the
736
765
  # `SequenceNumberForOrdering` of record *n* to the sequence number of
737
766
  # record *n-1* (as returned in the result when putting record *n-1*).
738
- # If this parameter is not set, records will be coarsely ordered based
739
- # on arrival time.
767
+ # If this parameter is not set, records are coarsely ordered based on
768
+ # arrival time.
740
769
  # @return [String]
741
770
  #
742
771
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/PutRecordInput AWS API Documentation
@@ -930,7 +959,7 @@ module Aws::Kinesis
930
959
  include Aws::Structure
931
960
  end
932
961
 
933
- # The unit of data of the Amazon Kinesis stream, which is composed of a
962
+ # The unit of data of the Kinesis stream, which is composed of a
934
963
  # sequence number, a partition key, and a data blob.
935
964
  #
936
965
  # @!attribute [rw] sequence_number
@@ -943,10 +972,10 @@ module Aws::Kinesis
943
972
  #
944
973
  # @!attribute [rw] data
945
974
  # The data blob. The data in the blob is both opaque and immutable to
946
- # the Amazon Kinesis service, which does not inspect, interpret, or
947
- # change the data in the blob in any way. When the data blob (the
948
- # payload before base64-encoding) is added to the partition key size,
949
- # the total size must not exceed the maximum record size (1 MB).
975
+ # Kinesis Streams, which does not inspect, interpret, or change the
976
+ # data in the blob in any way. When the data blob (the payload before
977
+ # base64-encoding) is added to the partition key size, the total size
978
+ # must not exceed the maximum record size (1 MB).
950
979
  # @return [String]
951
980
  #
952
981
  # @!attribute [rw] partition_key
@@ -1020,8 +1049,7 @@ module Aws::Kinesis
1020
1049
  include Aws::Structure
1021
1050
  end
1022
1051
 
1023
- # A uniquely identified group of data records in an Amazon Kinesis
1024
- # stream.
1052
+ # A uniquely identified group of data records in a Kinesis stream.
1025
1053
  #
1026
1054
  # @!attribute [rw] shard_id
1027
1055
  # The unique identifier of the shard within the stream.
@@ -1108,20 +1136,28 @@ module Aws::Kinesis
1108
1136
  # @return [String]
1109
1137
  #
1110
1138
  # @!attribute [rw] encryption_type
1111
- # The encryption type to use. This parameter can be one of the
1112
- # following values:
1113
- #
1114
- # * `NONE`\: Not valid for this operation. An
1115
- # `InvalidOperationException` will be thrown.
1116
- #
1117
- # * `KMS`\: Use server-side encryption on the records in the stream
1118
- # using a customer-managed KMS key.
1139
+ # The encryption type to use. The only valid value is `KMS`.
1119
1140
  # @return [String]
1120
1141
  #
1121
1142
  # @!attribute [rw] key_id
1122
- # The GUID for the customer-managed KMS key to use for encryption. You
1123
- # can also use a Kinesis-owned master key by specifying the alias
1124
- # `aws/kinesis`.
1143
+ # The GUID for the customer-managed KMS key to use for encryption.
1144
+ # This value can be a globally unique identifier, a fully specified
1145
+ # ARN to either an alias or a key, or an alias name prefixed by
1146
+ # "alias/".You can also use a master key owned by Kinesis Streams by
1147
+ # specifying the alias `aws/kinesis`.
1148
+ #
1149
+ # * Key ARN example:
1150
+ # `arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012`
1151
+ #
1152
+ # * Alias ARN example:
1153
+ # `arn:aws:kms:us-east-1:123456789012:alias/MyAliasName`
1154
+ #
1155
+ # * Globally unique key ID example:
1156
+ # `12345678-1234-1234-1234-123456789012`
1157
+ #
1158
+ # * Alias name example: `alias/MyAliasName`
1159
+ #
1160
+ # * Master key owned by Kinesis Streams: `alias/aws/kinesis`
1125
1161
  # @return [String]
1126
1162
  #
1127
1163
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/StartStreamEncryptionInput AWS API Documentation
@@ -1147,18 +1183,28 @@ module Aws::Kinesis
1147
1183
  # @return [String]
1148
1184
  #
1149
1185
  # @!attribute [rw] encryption_type
1150
- # The encryption type. This parameter can be one of the following
1151
- # values:
1152
- #
1153
- # * `NONE`\: Not valid for this operation. An
1154
- # `InvalidOperationException` will be thrown.
1155
- #
1156
- # * `KMS`\: Use server-side encryption on the records in the stream
1157
- # using a customer-managed KMS key.
1186
+ # The encryption type. The only valid value is `KMS`.
1158
1187
  # @return [String]
1159
1188
  #
1160
1189
  # @!attribute [rw] key_id
1161
- # The GUID for the customer-managed key that was used for encryption.
1190
+ # The GUID for the customer-managed KMS key to use for encryption.
1191
+ # This value can be a globally unique identifier, a fully specified
1192
+ # ARN to either an alias or a key, or an alias name prefixed by
1193
+ # "alias/".You can also use a master key owned by Kinesis Streams by
1194
+ # specifying the alias `aws/kinesis`.
1195
+ #
1196
+ # * Key ARN example:
1197
+ # `arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012`
1198
+ #
1199
+ # * Alias ARN example:
1200
+ # `arn:aws:kms:us-east-1:123456789012:alias/MyAliasName`
1201
+ #
1202
+ # * Globally unique key ID example:
1203
+ # `12345678-1234-1234-1234-123456789012`
1204
+ #
1205
+ # * Alias name example: `alias/MyAliasName`
1206
+ #
1207
+ # * Master key owned by Kinesis Streams: `alias/aws/kinesis`
1162
1208
  # @return [String]
1163
1209
  #
1164
1210
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/StopStreamEncryptionInput AWS API Documentation
@@ -1184,11 +1230,11 @@ module Aws::Kinesis
1184
1230
  # The current status of the stream being described. The stream status
1185
1231
  # is one of the following states:
1186
1232
  #
1187
- # * `CREATING` - The stream is being created. Amazon Kinesis
1233
+ # * `CREATING` - The stream is being created. Kinesis Streams
1188
1234
  # immediately returns and sets `StreamStatus` to `CREATING`.
1189
1235
  #
1190
1236
  # * `DELETING` - The stream is being deleted. The specified stream is
1191
- # in the `DELETING` state until Amazon Kinesis completes the
1237
+ # in the `DELETING` state until Kinesis Streams completes the
1192
1238
  # deletion.
1193
1239
  #
1194
1240
  # * `ACTIVE` - The stream exists and is ready for read and write
@@ -1232,8 +1278,24 @@ module Aws::Kinesis
1232
1278
  # @return [String]
1233
1279
  #
1234
1280
  # @!attribute [rw] key_id
1235
- # The GUID for the customer-managed KMS key used for encryption on the
1236
- # stream.
1281
+ # The GUID for the customer-managed KMS key to use for encryption.
1282
+ # This value can be a globally unique identifier, a fully specified
1283
+ # ARN to either an alias or a key, or an alias name prefixed by
1284
+ # "alias/".You can also use a master key owned by Kinesis Streams by
1285
+ # specifying the alias `aws/kinesis`.
1286
+ #
1287
+ # * Key ARN example:
1288
+ # `arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012`
1289
+ #
1290
+ # * Alias ARN example:
1291
+ # `arn:aws:kms:us-east-1:123456789012:alias/MyAliasName`
1292
+ #
1293
+ # * Globally unique key ID example:
1294
+ # `12345678-1234-1234-1234-123456789012`
1295
+ #
1296
+ # * Alias name example: `alias/MyAliasName`
1297
+ #
1298
+ # * Master key owned by Kinesis Streams: `alias/aws/kinesis`
1237
1299
  # @return [String]
1238
1300
  #
1239
1301
  # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/StreamDescription AWS API Documentation
@@ -1252,6 +1314,96 @@ module Aws::Kinesis
1252
1314
  include Aws::Structure
1253
1315
  end
1254
1316
 
1317
+ # Represents the output for DescribeStreamSummary
1318
+ #
1319
+ # @!attribute [rw] stream_name
1320
+ # The name of the stream being described.
1321
+ # @return [String]
1322
+ #
1323
+ # @!attribute [rw] stream_arn
1324
+ # The Amazon Resource Name (ARN) for the stream being described.
1325
+ # @return [String]
1326
+ #
1327
+ # @!attribute [rw] stream_status
1328
+ # The current status of the stream being described. The stream status
1329
+ # is one of the following states:
1330
+ #
1331
+ # * `CREATING` - The stream is being created. Kinesis Streams
1332
+ # immediately returns and sets `StreamStatus` to `CREATING`.
1333
+ #
1334
+ # * `DELETING` - The stream is being deleted. The specified stream is
1335
+ # in the `DELETING` state until Kinesis Streams completes the
1336
+ # deletion.
1337
+ #
1338
+ # * `ACTIVE` - The stream exists and is ready for read and write
1339
+ # operations or deletion. You should perform read and write
1340
+ # operations only on an `ACTIVE` stream.
1341
+ #
1342
+ # * `UPDATING` - Shards in the stream are being merged or split. Read
1343
+ # and write operations continue to work while the stream is in the
1344
+ # `UPDATING` state.
1345
+ # @return [String]
1346
+ #
1347
+ # @!attribute [rw] retention_period_hours
1348
+ # The current retention period, in hours.
1349
+ # @return [Integer]
1350
+ #
1351
+ # @!attribute [rw] stream_creation_timestamp
1352
+ # The approximate time that the stream was created.
1353
+ # @return [Time]
1354
+ #
1355
+ # @!attribute [rw] enhanced_monitoring
1356
+ # Represents the current enhanced monitoring settings of the stream.
1357
+ # @return [Array<Types::EnhancedMetrics>]
1358
+ #
1359
+ # @!attribute [rw] encryption_type
1360
+ # The encryption type used. This value is one of the following:
1361
+ #
1362
+ # * `KMS`
1363
+ #
1364
+ # * `NONE`
1365
+ # @return [String]
1366
+ #
1367
+ # @!attribute [rw] key_id
1368
+ # The GUID for the customer-managed KMS key to use for encryption.
1369
+ # This value can be a globally unique identifier, a fully specified
1370
+ # ARN to either an alias or a key, or an alias name prefixed by
1371
+ # "alias/".You can also use a master key owned by Kinesis Streams by
1372
+ # specifying the alias `aws/kinesis`.
1373
+ #
1374
+ # * Key ARN example:
1375
+ # `arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012`
1376
+ #
1377
+ # * Alias ARN example: `
1378
+ # arn:aws:kms:us-east-1:123456789012:alias/MyAliasName`
1379
+ #
1380
+ # * Globally unique key ID example:
1381
+ # `12345678-1234-1234-1234-123456789012`
1382
+ #
1383
+ # * Alias name example: `alias/MyAliasName`
1384
+ #
1385
+ # * Master key owned by Kinesis: `alias/aws/kinesis`
1386
+ # @return [String]
1387
+ #
1388
+ # @!attribute [rw] open_shard_count
1389
+ # The number of open shards in the stream.
1390
+ # @return [Integer]
1391
+ #
1392
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/StreamDescriptionSummary AWS API Documentation
1393
+ #
1394
+ class StreamDescriptionSummary < Struct.new(
1395
+ :stream_name,
1396
+ :stream_arn,
1397
+ :stream_status,
1398
+ :retention_period_hours,
1399
+ :stream_creation_timestamp,
1400
+ :enhanced_monitoring,
1401
+ :encryption_type,
1402
+ :key_id,
1403
+ :open_shard_count)
1404
+ include Aws::Structure
1405
+ end
1406
+
1255
1407
  # Metadata assigned to the stream, consisting of a key-value pair.
1256
1408
  #
1257
1409
  # @!attribute [rw] key
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-kinesis
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.1.0
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-29 00:00:00.000000000 Z
11
+ date: 2017-11-20 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -57,7 +57,9 @@ files:
57
57
  homepage: http://github.com/aws/aws-sdk-ruby
58
58
  licenses:
59
59
  - Apache-2.0
60
- metadata: {}
60
+ metadata:
61
+ source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-kinesis
62
+ changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-kinesis/CHANGELOG.md
61
63
  post_install_message:
62
64
  rdoc_options: []
63
65
  require_paths: