aws-sdk-kinesis 1.26.0 → 1.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d48234542712cc8262bc84a6e99d5fc63718dc73b10d9d26ae94163fbfdd287
-  data.tar.gz: 12b02c7cdf294a802f3ee54a953e6af4cffcaf1b4b347426cc8e9d5dbdfa7af2
+  metadata.gz: 402a2a96aba832c9e8b4df7f5619665770e471603260951ddcca0be5c4ecddad
+  data.tar.gz: dfa0a56f52c7e5ff3b8992c608b70bf2f0bbfe8e51bfd34ba5c6bcdfc4513734
 SHA512:
-  metadata.gz: b08a5649b563e496585c8e43c76ded5ecbbe01e1102439a23b21971be70c51c2fc3a4087b60d3ec2eb3f6013762886d5275b0bba8123ada45a94937a0783f071
-  data.tar.gz: be1f5a8d907a3ac3003ace463494cec2d5e46274dc1613ff0094f38f53b60bad083f3c58470a716b085c4f9cc7d8abf0fddeb08c9d7dfe96a964632f50b01a45
+  metadata.gz: fc909f9743f05544980d2ec71883265543b26e28c9cbf0ed0e6d2930f1734ee3f44f3063f808c550f4f99add4c7872f06c2b363d7357d629c48de220fcb28506
+  data.tar.gz: c7da65816c05722c6d6d25234cdc67df1f4f03075cfc17622c35378a493baf4c065103da2b62244fa9a99c6825bab0fa8a9fc51a908be32616b52507c97d72c6

data/lib/aws-sdk-kinesis.rb

@@ -50,6 +50,6 @@ require_relative 'aws-sdk-kinesis/event_streams'
 # @service
 module Aws::Kinesis
 
-  GEM_VERSION = '1.26.0'
+  GEM_VERSION = '1.27.0'
 
 end

data/lib/aws-sdk-kinesis/async_client.rb

@@ -232,19 +232,36 @@ module Aws::Kinesis
 
     # @!group API Operations
 
-    # Call this operation from your consumer after you call
+    # This operation establishes an HTTP/2 connection between the consumer
+    # you specify in the `ConsumerARN` parameter and the shard you specify
+    # in the `ShardId` parameter. After the connection is successfully
+    # established, Kinesis Data Streams pushes records from the shard to the
+    # consumer over this connection. Before you call this operation, call
     # RegisterStreamConsumer to register the consumer with Kinesis Data
-    # Streams. If the call succeeds, your consumer starts receiving events
-    # of type SubscribeToShardEvent for up to 5 minutes, after which time
-    # you need to call `SubscribeToShard` again to renew the subscription if
-    # you want to continue to receive records.
-    #
-    # You can make one call to `SubscribeToShard` per second per
-    # `ConsumerARN`. If your call succeeds, and then you call the operation
-    # again less than 5 seconds later, the second call generates a
-    # ResourceInUseException. If you call the operation a second time more
-    # than 5 seconds after the first call succeeds, the second call succeeds
-    # and the first connection gets shut down.
+    # Streams.
+    #
+    # When the `SubscribeToShard` call succeeds, your consumer starts
+    # receiving events of type SubscribeToShardEvent over the HTTP/2
+    # connection for up to 5 minutes, after which time you need to call
+    # `SubscribeToShard` again to renew the subscription if you want to
+    # continue to receive records.
+    #
+    # You can make one call to `SubscribeToShard` per second per registered
+    # consumer per shard. For example, if you have a 4000 shard stream and
+    # two registered stream consumers, you can make one `SubscribeToShard`
+    # request per second for each combination of shard and registered
+    # consumer, allowing you to subscribe both consumers to all 4000 shards
+    # in one second.
+    #
+    # If you call `SubscribeToShard` again with the same `ConsumerARN` and
+    # `ShardId` within 5 seconds of a successful call, you'll get a
+    # `ResourceInUseException`. If you call `SubscribeToShard` 5 seconds or
+    # more after a successful call, the first connection will expire and the
+    # second call will take over the subscription.
+    #
+    # For an example of how to use this operations, see [Enhanced Fan-Out
+    # Using the Kinesis Data Streams
+    # API](/streams/latest/dev/building-enhanced-consumers-api.html).
     #
     # @option params [required, String] :consumer_arn
     #   For this parameter, use the value you obtained when you called
@@ -456,6 +473,12 @@ module Aws::Kinesis
     #   event.records[0].encryption_type #=> String, one of "NONE", "KMS"
     #   event.continuation_sequence_number #=> String
     #   event.millis_behind_latest #=> Integer
+    #   event.child_shards #=> Array
+    #   event.child_shards[0].shard_id #=> String
+    #   event.child_shards[0].parent_shards #=> Array
+    #   event.child_shards[0].parent_shards[0] #=> String
+    #   event.child_shards[0].hash_key_range.starting_hash_key #=> String
+    #   event.child_shards[0].hash_key_range.ending_hash_key #=> String
     #
     #   For :resource_not_found_exception event available at #on_resource_not_found_exception_event callback and response eventstream enumerator:
     #   event.message #=> String
@@ -520,7 +543,7 @@ module Aws::Kinesis
         http_response: Seahorse::Client::Http::AsyncResponse.new,
         config: config)
       context[:gem_name] = 'aws-sdk-kinesis'
-      context[:gem_version] = '1.26.0'
+      context[:gem_version] = '1.27.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-kinesis/client.rb

@@ -379,9 +379,9 @@ module Aws::Kinesis
     #
     # You specify and control the number of shards that a stream is composed
     # of. Each shard can support reads up to five transactions per second,
-    # up to a maximum data read total of 2 MB per second. Each shard can
+    # up to a maximum data read total of 2 MiB per second. Each shard can
     # support writes up to 1,000 records per second, up to a maximum data
-    # write total of 1 MB per second. If the amount of data input increases
+    # write total of 1 MiB per second. If the amount of data input increases
     # or decreases, you can add or remove shards.
     #
     # The stream name identifies the stream. The name is scoped to the AWS
@@ -415,8 +415,8 @@ module Aws::Kinesis
     #
     #
     #
-    # [1]: http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
-    # [2]: http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html
+    # [1]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
+    # [2]: https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html
     #
     # @option params [required, String] :stream_name
     #   A name to identify the stream. The stream name is scoped to the AWS
@@ -430,8 +430,6 @@ module Aws::Kinesis
     #   stream is a function of the number of shards; more shards are required
     #   for greater provisioned throughput.
     #
-    #   DefaultShardLimit;
-    #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
     # @example Request syntax with placeholder values
@@ -539,8 +537,7 @@ module Aws::Kinesis
     # all the consumers that are currently registered with a given data
     # stream. The description of a consumer contains its name and ARN.
     #
-    # This operation has a limit of five transactions per second per
-    # account.
+    # This operation has a limit of five transactions per second per stream.
     #
     # @option params [String] :stream_arn
     #   The ARN of the Kinesis data stream that the consumer is registered
@@ -630,7 +627,7 @@ module Aws::Kinesis
     #
     #
     #
-    # [1]: http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-retrieve-shards.html
+    # [1]: https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-retrieve-shards.html
     #
     # @option params [required, String] :stream_name
     #   The name of the stream to describe.
@@ -703,7 +700,7 @@ module Aws::Kinesis
     # operation to get a list of the descriptions of all the consumers that
     # are currently registered with a given data stream.
     #
-    # This operation has a limit of 20 transactions per second per account.
+    # This operation has a limit of 20 transactions per second per stream.
     #
     # @option params [String] :stream_arn
     #   The ARN of the Kinesis data stream that the consumer is registered
@@ -757,6 +754,9 @@ module Aws::Kinesis
     # Name (ARN), status, record retention period, approximate creation
     # time, monitoring, encryption details, and open shard count.
     #
+    # DescribeStreamSummary has a limit of 20 transactions per second per
+    # account.
+    #
     # @option params [required, String] :stream_name
     #   The name of the stream to describe.
     #
@@ -828,7 +828,7 @@ module Aws::Kinesis
     #
     #
     #
-    #   [1]: http://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html
+    #   [1]: https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html
     #
     # @return [Types::EnhancedMonitoringOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -894,7 +894,7 @@ module Aws::Kinesis
     #
     #
     #
-    #   [1]: http://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html
+    #   [1]: https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html
     #
     # @return [Types::EnhancedMonitoringOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -985,13 +985,12 @@ module Aws::Kinesis
     # always increasing. For example, records in a shard or across a stream
     # might have time stamps that are out of order.
     #
-    # This operation has a limit of five transactions per second per
-    # account.
+    # This operation has a limit of five transactions per second per shard.
     #
     #
     #
-    # [1]: http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
-    # [2]: http://docs.aws.amazon.com/kinesis/latest/dev/monitoring.html
+    # [1]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
+    # [2]: https://docs.aws.amazon.com/kinesis/latest/dev/monitoring.html
     #
     # @option params [required, String] :shard_iterator
     #   The position in the shard from which you want to start sequentially
@@ -1001,13 +1000,14 @@ module Aws::Kinesis
     # @option params [Integer] :limit
     #   The maximum number of records to return. Specify a value of up to
     #   10,000. If you specify a value that is greater than 10,000, GetRecords
-    #   throws `InvalidArgumentException`.
+    #   throws `InvalidArgumentException`. The default value is 10,000.
     #
     # @return [Types::GetRecordsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::GetRecordsOutput#records #records} => Array<Types::Record>
     #   * {Types::GetRecordsOutput#next_shard_iterator #next_shard_iterator} => String
     #   * {Types::GetRecordsOutput#millis_behind_latest #millis_behind_latest} => Integer
+    #   * {Types::GetRecordsOutput#child_shards #child_shards} => Array<Types::ChildShard>
     #
     # @example Request syntax with placeholder values
     #
@@ -1026,6 +1026,12 @@ module Aws::Kinesis
     #   resp.records[0].encryption_type #=> String, one of "NONE", "KMS"
     #   resp.next_shard_iterator #=> String
     #   resp.millis_behind_latest #=> Integer
+    #   resp.child_shards #=> Array
+    #   resp.child_shards[0].shard_id #=> String
+    #   resp.child_shards[0].parent_shards #=> Array
+    #   resp.child_shards[0].parent_shards[0] #=> String
+    #   resp.child_shards[0].hash_key_range.starting_hash_key #=> String
+    #   resp.child_shards[0].hash_key_range.ending_hash_key #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/GetRecords AWS API Documentation
     #
@@ -1081,7 +1087,7 @@ module Aws::Kinesis
     #
     #
     #
-    # [1]: http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
+    # [1]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
     #
     # @option params [required, String] :stream_name
     #   The name of the Amazon Kinesis data stream.
@@ -1252,7 +1258,7 @@ module Aws::Kinesis
     # @option params [Integer] :max_results
     #   The maximum number of shards to return in a single call to
     #   `ListShards`. The minimum value you can specify for this parameter is
-    #   1, and the maximum is 1,000, which is also the default.
+    #   1, and the maximum is 10,000, which is also the default.
     #
     #   When the number of shards to be listed is greater than the value of
     #   `MaxResults`, the response contains a `NextToken` value that you can
@@ -1269,6 +1275,8 @@ module Aws::Kinesis
     #   You cannot specify this parameter if you specify the `NextToken`
     #   parameter.
     #
+    # @option params [Types::ShardFilter] :shard_filter
+    #
     # @return [Types::ListShardsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::ListShardsOutput#shards #shards} => Array<Types::Shard>
@@ -1282,6 +1290,11 @@ module Aws::Kinesis
     #     exclusive_start_shard_id: "ShardId",
     #     max_results: 1,
     #     stream_creation_timestamp: Time.now,
+    #     shard_filter: {
+    #       type: "AFTER_SHARD_ID", # required, accepts AFTER_SHARD_ID, AT_TRIM_HORIZON, FROM_TRIM_HORIZON, AT_LATEST, AT_TIMESTAMP, FROM_TIMESTAMP
+    #       shard_id: "ShardId",
+    #       timestamp: Time.now,
+    #     },
     #   })
     #
     # @example Response structure
@@ -1308,7 +1321,7 @@ module Aws::Kinesis
     # Lists the consumers registered to receive data from a stream using
     # enhanced fan-out, and provides information about each consumer.
     #
-    # This operation has a limit of 10 transactions per second per account.
+    # This operation has a limit of 5 transactions per second per stream.
     #
     # @option params [required, String] :stream_arn
     #   The ARN of the Kinesis data stream for which you want to list the
@@ -1537,7 +1550,7 @@ module Aws::Kinesis
     #
     #
     #
-    # [1]: http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-merge.html
+    # [1]: https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-merge.html
     #
     # @option params [required, String] :stream_name
     #   The name of the stream for the merge.
@@ -1572,7 +1585,7 @@ module Aws::Kinesis
     # `PutRecord` to send data into the stream for real-time ingestion and
     # subsequent processing, one record at a time. Each shard can support
     # writes up to 1,000 records per second, up to a maximum data write
-    # total of 1 MB per second.
+    # total of 1 MiB per second.
     #
     # You must specify the name of the stream that captures, stores, and
     # transports the data; a partition key; and the data blob itself.
@@ -1606,6 +1619,9 @@ module Aws::Kinesis
     # [Adding Data to a Stream][1] in the *Amazon Kinesis Data Streams
     # Developer Guide*.
     #
+    # After you write a record to a stream, you cannot modify that record or
+    # its order within the stream.
+    #
     # If a `PutRecord` request cannot be processed because of insufficient
     # provisioned throughput on the shard involved in the request,
     # `PutRecord` throws `ProvisionedThroughputExceededException`.
@@ -1617,16 +1633,16 @@ module Aws::Kinesis
     #
     #
     #
-    # [1]: http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream
+    # [1]: https://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream
     #
     # @option params [required, String] :stream_name
     #   The name of the stream to put the data record into.
     #
-    # @option params [required, String, IO] :data
+    # @option params [required, String, StringIO, File] :data
     #   The data blob to put into the record, which is base64-encoded when the
     #   blob is serialized. When the data blob (the payload before
     #   base64-encoding) is added to the partition key size, the total size
-    #   must not exceed the maximum record size (1 MB).
+    #   must not exceed the maximum record size (1 MiB).
     #
     # @option params [required, String] :partition_key
     #   Determines which shard in the stream the data record is assigned to.
@@ -1687,10 +1703,10 @@ module Aws::Kinesis
     # to send data into the stream for data ingestion and processing.
     #
     # Each `PutRecords` request can support up to 500 records. Each record
-    # in the request can be as large as 1 MB, up to a limit of 5 MB for the
-    # entire request, including partition keys. Each shard can support
+    # in the request can be as large as 1 MiB, up to a limit of 5 MiB for
+    # the entire request, including partition keys. Each shard can support
     # writes up to 1,000 records per second, up to a maximum data write
-    # total of 1 MB per second.
+    # total of 1 MiB per second.
     #
     # You must specify the name of the stream that captures, stores, and
     # transports the data; and an array of request `Records`, with each
@@ -1727,7 +1743,10 @@ module Aws::Kinesis
     # The response `Records` array includes both successfully and
     # unsuccessfully processed records. Kinesis Data Streams attempts to
     # process all records in each `PutRecords` request. A single record
-    # failure does not stop the processing of subsequent records.
+    # failure does not stop the processing of subsequent records. As a
+    # result, PutRecords doesn't guarantee the ordering of records. If you
+    # need to read records in the same order they are written to the stream,
+    # use PutRecord instead of `PutRecords`, and write to the same shard.
     #
     # A successfully processed record includes `ShardId` and
     # `SequenceNumber` values. The `ShardId` parameter identifies the shard
@@ -1746,6 +1765,9 @@ module Aws::Kinesis
     # see [Adding Multiple Records with PutRecords][3] in the *Amazon
     # Kinesis Data Streams Developer Guide*.
     #
+    # After you write a record to a stream, you cannot modify that record or
+    # its order within the stream.
+    #
     # By default, data records are accessible for 24 hours from the time
     # that they are added to a stream. You can use
     # IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to
@@ -1753,9 +1775,9 @@ module Aws::Kinesis
     #
     #
     #
-    # [1]: http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream
-    # [2]: http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-putrecords
-    # [3]: http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-add-data-to-stream.html#kinesis-using-sdk-java-putrecords
+    # [1]: https://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream
+    # [2]: https://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-putrecords
+    # [3]: https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-add-data-to-stream.html#kinesis-using-sdk-java-putrecords
     #
     # @option params [required, Array<Types::PutRecordsRequestEntry>] :records
     #   The records associated with the request.
@@ -1802,15 +1824,24 @@ module Aws::Kinesis
     end
 
     # Registers a consumer with a Kinesis data stream. When you use this
-    # operation, the consumer you register can read data from the stream at
-    # a rate of up to 2 MiB per second. This rate is unaffected by the total
-    # number of consumers that read from the same stream.
+    # operation, the consumer you register can then call SubscribeToShard to
+    # receive data from the stream using enhanced fan-out, at a rate of up
+    # to 2 MiB per second for every shard you subscribe to. This rate is
+    # unaffected by the total number of consumers that read from the same
+    # stream.
     #
-    # You can register up to 5 consumers per stream. A given consumer can
-    # only be registered with one stream.
+    # You can register up to 20 consumers per stream. A given consumer can
+    # only be registered with one stream at a time.
     #
-    # This operation has a limit of five transactions per second per
-    # account.
+    # For an example of how to use this operations, see [Enhanced Fan-Out
+    # Using the Kinesis Data Streams
+    # API](/streams/latest/dev/building-enhanced-consumers-api.html).
+    #
+    # The use of this operation has a limit of five transactions per second
+    # per account. Also, only 5 consumers can be created simultaneously. In
+    # other words, you cannot have more than 5 consumers in a `CREATING`
+    # status at the same time. Registering a 6th consumer while there are 5
+    # in a `CREATING` status results in a `LimitExceededException`.
     #
     # @option params [required, String] :stream_arn
     #   The ARN of the Kinesis data stream that you want to register the
@@ -1939,9 +1970,9 @@ module Aws::Kinesis
     #
     #
     #
-    # [1]: http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-split.html
-    # [2]: http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
-    # [3]: http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html
+    # [1]: https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-split.html
+    # [2]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
+    # [3]: https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html
     #
     # @option params [required, String] :stream_name
     #   The name of the stream for the shard split.
@@ -2122,14 +2153,19 @@ module Aws::Kinesis
     #
     # To update the shard count, Kinesis Data Streams performs splits or
     # merges on individual shards. This can cause short-lived shards to be
-    # created, in addition to the final shards. We recommend that you double
-    # or halve the shard count, as this results in the fewest number of
-    # splits or merges.
+    # created, in addition to the final shards. These short-lived shards
+    # count towards your total shard limit for your account in the Region.
+    #
+    # When using this operation, we recommend that you specify a target
+    # shard count that is a multiple of 25% (25%, 50%, 75%, 100%). You can
+    # specify any target value within your shard limit. However, if you
+    # specify a target that isn't a multiple of 25%, the scaling action
+    # might take longer to complete.
     #
     # This operation has the following default limits. By default, you
     # cannot do the following:
     #
-    # * Scale more than twice per rolling 24-hour period per stream
+    # * Scale more than ten times per rolling 24-hour period per stream
     #
     # * Scale up to more than double your current shard count for a stream
     #
@@ -2149,14 +2185,27 @@ module Aws::Kinesis
     #
     #
     #
-    # [1]: http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
+    # [1]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
     # [2]: https://console.aws.amazon.com/support/v1#/case/create?issueType=service-limit-increase&amp;limitType=service-code-kinesis
     #
     # @option params [required, String] :stream_name
     #   The name of the stream.
     #
     # @option params [required, Integer] :target_shard_count
-    #   The new number of shards.
+    #   The new number of shards. This value has the following default limits.
+    #   By default, you cannot do the following:
+    #
+    #   * Set this value to more than double your current shard count for a
+    #     stream.
+    #
+    #   * Set this value below half your current shard count for a stream.
+    #
+    #   * Set this value to more than 500 shards in a stream (the default
+    #     limit for shard count per stream is 500 per account per region),
+    #     unless you request a limit increase.
+    #
+    #   * Scale a stream with more than 500 shards down unless you set this
+    #     value to less than 500 shards.
     #
     # @option params [required, String] :scaling_type
     #   The scaling type. Uniform scaling creates shards of equal size.
@@ -2203,7 +2252,7 @@ module Aws::Kinesis
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-kinesis'
-      context[:gem_version] = '1.26.0'
+      context[:gem_version] = '1.27.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-kinesis/client_api.rb

@@ -15,6 +15,8 @@ module Aws::Kinesis
 
     AddTagsToStreamInput = Shapes::StructureShape.new(name: 'AddTagsToStreamInput')
     BooleanObject = Shapes::BooleanShape.new(name: 'BooleanObject')
+    ChildShard = Shapes::StructureShape.new(name: 'ChildShard')
+    ChildShardList = Shapes::ListShape.new(name: 'ChildShardList')
     Consumer = Shapes::StructureShape.new(name: 'Consumer')
     ConsumerARN = Shapes::StringShape.new(name: 'ConsumerARN')
     ConsumerCountObject = Shapes::IntegerShape.new(name: 'ConsumerCountObject')
@@ -105,7 +107,10 @@ module Aws::Kinesis
     SequenceNumberRange = Shapes::StructureShape.new(name: 'SequenceNumberRange')
     Shard = Shapes::StructureShape.new(name: 'Shard')
     ShardCountObject = Shapes::IntegerShape.new(name: 'ShardCountObject')
+    ShardFilter = Shapes::StructureShape.new(name: 'ShardFilter')
+    ShardFilterType = Shapes::StringShape.new(name: 'ShardFilterType')
     ShardId = Shapes::StringShape.new(name: 'ShardId')
+    ShardIdList = Shapes::ListShape.new(name: 'ShardIdList')
     ShardIterator = Shapes::StringShape.new(name: 'ShardIterator')
     ShardIteratorType = Shapes::StringShape.new(name: 'ShardIteratorType')
     ShardList = Shapes::ListShape.new(name: 'ShardList')
@@ -137,6 +142,13 @@ module Aws::Kinesis
     AddTagsToStreamInput.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, required: true, location_name: "Tags"))
     AddTagsToStreamInput.struct_class = Types::AddTagsToStreamInput
 
+    ChildShard.add_member(:shard_id, Shapes::ShapeRef.new(shape: ShardId, required: true, location_name: "ShardId"))
+    ChildShard.add_member(:parent_shards, Shapes::ShapeRef.new(shape: ShardIdList, required: true, location_name: "ParentShards"))
+    ChildShard.add_member(:hash_key_range, Shapes::ShapeRef.new(shape: HashKeyRange, required: true, location_name: "HashKeyRange"))
+    ChildShard.struct_class = Types::ChildShard
+
+    ChildShardList.member = Shapes::ShapeRef.new(shape: ChildShard)
+
     Consumer.add_member(:consumer_name, Shapes::ShapeRef.new(shape: ConsumerName, required: true, location_name: "ConsumerName"))
     Consumer.add_member(:consumer_arn, Shapes::ShapeRef.new(shape: ConsumerARN, required: true, location_name: "ConsumerARN"))
     Consumer.add_member(:consumer_status, Shapes::ShapeRef.new(shape: ConsumerStatus, required: true, location_name: "ConsumerStatus"))
@@ -228,6 +240,7 @@ module Aws::Kinesis
     GetRecordsOutput.add_member(:records, Shapes::ShapeRef.new(shape: RecordList, required: true, location_name: "Records"))
     GetRecordsOutput.add_member(:next_shard_iterator, Shapes::ShapeRef.new(shape: ShardIterator, location_name: "NextShardIterator"))
     GetRecordsOutput.add_member(:millis_behind_latest, Shapes::ShapeRef.new(shape: MillisBehindLatest, location_name: "MillisBehindLatest"))
+    GetRecordsOutput.add_member(:child_shards, Shapes::ShapeRef.new(shape: ChildShardList, location_name: "ChildShards"))
     GetRecordsOutput.struct_class = Types::GetRecordsOutput
 
     GetShardIteratorInput.add_member(:stream_name, Shapes::ShapeRef.new(shape: StreamName, required: true, location_name: "StreamName"))
@@ -280,6 +293,7 @@ module Aws::Kinesis
     ListShardsInput.add_member(:exclusive_start_shard_id, Shapes::ShapeRef.new(shape: ShardId, location_name: "ExclusiveStartShardId"))
     ListShardsInput.add_member(:max_results, Shapes::ShapeRef.new(shape: ListShardsInputLimit, location_name: "MaxResults"))
     ListShardsInput.add_member(:stream_creation_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "StreamCreationTimestamp"))
+    ListShardsInput.add_member(:shard_filter, Shapes::ShapeRef.new(shape: ShardFilter, location_name: "ShardFilter"))
     ListShardsInput.struct_class = Types::ListShardsInput
 
     ListShardsOutput.add_member(:shards, Shapes::ShapeRef.new(shape: ShardList, location_name: "Shards"))
@@ -396,6 +410,13 @@ module Aws::Kinesis
     Shard.add_member(:sequence_number_range, Shapes::ShapeRef.new(shape: SequenceNumberRange, required: true, location_name: "SequenceNumberRange"))
     Shard.struct_class = Types::Shard
 
+    ShardFilter.add_member(:type, Shapes::ShapeRef.new(shape: ShardFilterType, required: true, location_name: "Type"))
+    ShardFilter.add_member(:shard_id, Shapes::ShapeRef.new(shape: ShardId, location_name: "ShardId"))
+    ShardFilter.add_member(:timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "Timestamp"))
+    ShardFilter.struct_class = Types::ShardFilter
+
+    ShardIdList.member = Shapes::ShapeRef.new(shape: ShardId)
+
     ShardList.member = Shapes::ShapeRef.new(shape: Shard)
 
     SplitShardInput.add_member(:stream_name, Shapes::ShapeRef.new(shape: StreamName, required: true, location_name: "StreamName"))
@@ -433,7 +454,7 @@ module Aws::Kinesis
     StreamDescriptionSummary.add_member(:stream_name, Shapes::ShapeRef.new(shape: StreamName, required: true, location_name: "StreamName"))
     StreamDescriptionSummary.add_member(:stream_arn, Shapes::ShapeRef.new(shape: StreamARN, required: true, location_name: "StreamARN"))
     StreamDescriptionSummary.add_member(:stream_status, Shapes::ShapeRef.new(shape: StreamStatus, required: true, location_name: "StreamStatus"))
-    StreamDescriptionSummary.add_member(:retention_period_hours, Shapes::ShapeRef.new(shape: PositiveIntegerObject, required: true, location_name: "RetentionPeriodHours"))
+    StreamDescriptionSummary.add_member(:retention_period_hours, Shapes::ShapeRef.new(shape: RetentionPeriodHours, required: true, location_name: "RetentionPeriodHours"))
     StreamDescriptionSummary.add_member(:stream_creation_timestamp, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "StreamCreationTimestamp"))
     StreamDescriptionSummary.add_member(:enhanced_monitoring, Shapes::ShapeRef.new(shape: EnhancedMonitoringList, required: true, location_name: "EnhancedMonitoring"))
     StreamDescriptionSummary.add_member(:encryption_type, Shapes::ShapeRef.new(shape: EncryptionType, location_name: "EncryptionType"))
@@ -447,6 +468,7 @@ module Aws::Kinesis
     SubscribeToShardEvent.add_member(:records, Shapes::ShapeRef.new(shape: RecordList, required: true, location_name: "Records"))
     SubscribeToShardEvent.add_member(:continuation_sequence_number, Shapes::ShapeRef.new(shape: SequenceNumber, required: true, location_name: "ContinuationSequenceNumber"))
     SubscribeToShardEvent.add_member(:millis_behind_latest, Shapes::ShapeRef.new(shape: MillisBehindLatest, required: true, location_name: "MillisBehindLatest"))
+    SubscribeToShardEvent.add_member(:child_shards, Shapes::ShapeRef.new(shape: ChildShardList, location_name: "ChildShards"))
     SubscribeToShardEvent.struct_class = Types::SubscribeToShardEvent
 
     SubscribeToShardEventStream.add_member(:subscribe_to_shard_event, Shapes::ShapeRef.new(shape: SubscribeToShardEvent, required: true, event: true, location_name: "SubscribeToShardEvent"))

data/lib/aws-sdk-kinesis/types.rb

@@ -39,7 +39,29 @@ module Aws::Kinesis
       include Aws::Structure
     end
 
+    # @!attribute [rw] shard_id
+    #   @return [String]
+    #
+    # @!attribute [rw] parent_shards
+    #   @return [Array<String>]
+    #
+    # @!attribute [rw] hash_key_range
+    #   The range of possible hash key values for the shard, which is a set
+    #   of ordered contiguous positive integers.
+    #   @return [Types::HashKeyRange]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/ChildShard AWS API Documentation
+    #
+    class ChildShard < Struct.new(
+      :shard_id,
+      :parent_shards,
+      :hash_key_range)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # An object that represents the details of the consumer you registered.
+    # This type of object is returned by RegisterStreamConsumer.
     #
     # @!attribute [rw] consumer_name
     #   The name of the consumer is something you choose when you register
@@ -75,7 +97,8 @@ module Aws::Kinesis
       include Aws::Structure
     end
 
-    # An object that represents the details of a registered consumer.
+    # An object that represents the details of a registered consumer. This
+    # type of object is returned by DescribeStreamConsumer.
     #
     # @!attribute [rw] consumer_name
     #   The name of the consumer is something you choose when you register
@@ -138,8 +161,6 @@ module Aws::Kinesis
     #   The number of shards that the stream will use. The throughput of the
     #   stream is a function of the number of shards; more shards are
     #   required for greater provisioned throughput.
-    #
-    #   DefaultShardLimit;
     #   @return [Integer]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/CreateStreamInput AWS API Documentation
@@ -448,7 +469,7 @@ module Aws::Kinesis
     #
     #
     #
-    #   [1]: http://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html
+    #   [1]: https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html
     #   @return [Array<String>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DisableEnhancedMonitoringInput AWS API Documentation
@@ -502,7 +523,7 @@ module Aws::Kinesis
     #
     #
     #
-    #   [1]: http://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html
+    #   [1]: https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html
     #   @return [Array<String>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/EnableEnhancedMonitoringInput AWS API Documentation
@@ -544,7 +565,7 @@ module Aws::Kinesis
     #
     #
     #
-    #   [1]: http://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html
+    #   [1]: https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html
     #   @return [Array<String>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/EnhancedMetrics AWS API Documentation
@@ -628,7 +649,8 @@ module Aws::Kinesis
     # @!attribute [rw] limit
     #   The maximum number of records to return. Specify a value of up to
     #   10,000. If you specify a value that is greater than 10,000,
-    #   GetRecords throws `InvalidArgumentException`.
+    #   GetRecords throws `InvalidArgumentException`. The default value is
+    #   10,000.
     #   @return [Integer]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/GetRecordsInput AWS API Documentation
@@ -659,12 +681,16 @@ module Aws::Kinesis
     #   and there are no new records to process at this moment.
     #   @return [Integer]
     #
+    # @!attribute [rw] child_shards
+    #   @return [Array<Types::ChildShard>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/GetRecordsOutput AWS API Documentation
     #
     class GetRecordsOutput < Struct.new(
       :records,
       :next_shard_iterator,
-      :millis_behind_latest)
+      :millis_behind_latest,
+      :child_shards)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -808,6 +834,9 @@ module Aws::Kinesis
       include Aws::Structure
     end
 
+    # The processing of the request failed because of an unknown error,
+    # exception, or failure.
+    #
     # @!attribute [rw] message
     #   @return [String]
     #
@@ -874,7 +903,7 @@ module Aws::Kinesis
     #
     #
     #
-    # [1]: http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
+    # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html
     #
     # @!attribute [rw] message
     #   A message that provides information about the error.
@@ -926,7 +955,7 @@ module Aws::Kinesis
     #
     #
     #
-    # [1]: http://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second
+    # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second
     #
     # @!attribute [rw] message
     #   A message that provides information about the error.
@@ -966,6 +995,11 @@ module Aws::Kinesis
     #         exclusive_start_shard_id: "ShardId",
     #         max_results: 1,
     #         stream_creation_timestamp: Time.now,
+    #         shard_filter: {
+    #           type: "AFTER_SHARD_ID", # required, accepts AFTER_SHARD_ID, AT_TRIM_HORIZON, FROM_TRIM_HORIZON, AT_LATEST, AT_TIMESTAMP, FROM_TIMESTAMP
+    #           shard_id: "ShardId",
+    #           timestamp: Time.now,
+    #         },
     #       }
     #
     # @!attribute [rw] stream_name
@@ -1015,7 +1049,7 @@ module Aws::Kinesis
     # @!attribute [rw] max_results
     #   The maximum number of shards to return in a single call to
     #   `ListShards`. The minimum value you can specify for this parameter
-    #   is 1, and the maximum is 1,000, which is also the default.
+    #   is 1, and the maximum is 10,000, which is also the default.
     #
     #   When the number of shards to be listed is greater than the value of
     #   `MaxResults`, the response contains a `NextToken` value that you can
@@ -1034,6 +1068,9 @@ module Aws::Kinesis
     #   parameter.
     #   @return [Time]
     #
+    # @!attribute [rw] shard_filter
+    #   @return [Types::ShardFilter]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/ListShardsInput AWS API Documentation
     #
     class ListShardsInput < Struct.new(
@@ -1041,7 +1078,8 @@ module Aws::Kinesis
       :next_token,
       :exclusive_start_shard_id,
       :max_results,
-      :stream_creation_timestamp)
+      :stream_creation_timestamp,
+      :shard_filter)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1337,8 +1375,8 @@ module Aws::Kinesis
     #
     #
     #
-    # [1]: http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
-    # [2]: http://docs.aws.amazon.com/general/latest/gr/api-retries.html
+    # [1]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html
+    # [2]: https://docs.aws.amazon.com/general/latest/gr/api-retries.html
     #
     # @!attribute [rw] message
     #   A message that provides information about the error.
@@ -1373,7 +1411,7 @@ module Aws::Kinesis
     #   The data blob to put into the record, which is base64-encoded when
     #   the blob is serialized. When the data blob (the payload before
     #   base64-encoding) is added to the partition key size, the total size
-    #   must not exceed the maximum record size (1 MB).
+    #   must not exceed the maximum record size (1 MiB).
     #   @return [String]
     #
     # @!attribute [rw] partition_key
@@ -1530,7 +1568,7 @@ module Aws::Kinesis
     #   The data blob to put into the record, which is base64-encoded when
     #   the blob is serialized. When the data blob (the payload before
     #   base64-encoding) is added to the partition key size, the total size
-    #   must not exceed the maximum record size (1 MB).
+    #   must not exceed the maximum record size (1 MiB).
     #   @return [String]
     #
     # @!attribute [rw] explicit_hash_key
@@ -1615,7 +1653,7 @@ module Aws::Kinesis
     #   Kinesis Data Streams, which does not inspect, interpret, or change
     #   the data in the blob in any way. When the data blob (the payload
     #   before base64-encoding) is added to the partition key size, the
-    #   total size must not exceed the maximum record size (1 MB).
+    #   total size must not exceed the maximum record size (1 MiB).
     #   @return [String]
     #
     # @!attribute [rw] partition_key
@@ -1806,6 +1844,34 @@ module Aws::Kinesis
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass ShardFilter
+    #   data as a hash:
+    #
+    #       {
+    #         type: "AFTER_SHARD_ID", # required, accepts AFTER_SHARD_ID, AT_TRIM_HORIZON, FROM_TRIM_HORIZON, AT_LATEST, AT_TIMESTAMP, FROM_TIMESTAMP
+    #         shard_id: "ShardId",
+    #         timestamp: Time.now,
+    #       }
+    #
+    # @!attribute [rw] type
+    #   @return [String]
+    #
+    # @!attribute [rw] shard_id
+    #   @return [String]
+    #
+    # @!attribute [rw] timestamp
+    #   @return [Time]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/ShardFilter AWS API Documentation
+    #
+    class ShardFilter < Struct.new(
+      :type,
+      :shard_id,
+      :timestamp)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Represents the input for `SplitShard`.
     #
     # @note When making an API call, you may pass SplitShardInput
@@ -1904,12 +1970,41 @@ module Aws::Kinesis
     #       }
     #
     # @!attribute [rw] type
+    #   You can set the starting position to one of the following values:
+    #
+    #   `AT_SEQUENCE_NUMBER`\: Start streaming from the position denoted by
+    #   the sequence number specified in the `SequenceNumber` field.
+    #
+    #   `AFTER_SEQUENCE_NUMBER`\: Start streaming right after the position
+    #   denoted by the sequence number specified in the `SequenceNumber`
+    #   field.
+    #
+    #   `AT_TIMESTAMP`\: Start streaming from the position denoted by the
+    #   time stamp specified in the `Timestamp` field.
+    #
+    #   `TRIM_HORIZON`\: Start streaming at the last untrimmed record in the
+    #   shard, which is the oldest data record in the shard.
+    #
+    #   `LATEST`\: Start streaming just after the most recent record in the
+    #   shard, so that you always read the most recent data in the shard.
     #   @return [String]
     #
     # @!attribute [rw] sequence_number
+    #   The sequence number of the data record in the shard from which to
+    #   start streaming. To specify a sequence number, set
+    #   `StartingPosition` to `AT_SEQUENCE_NUMBER` or
+    #   `AFTER_SEQUENCE_NUMBER`.
     #   @return [String]
     #
     # @!attribute [rw] timestamp
+    #   The time stamp of the data record from which to start reading. To
+    #   specify a time stamp, set `StartingPosition` to `Type AT_TIMESTAMP`.
+    #   A time stamp is the Unix epoch date with precision in milliseconds.
+    #   For example, `2016-04-04T19:58:46.480-00:00` or `1459799926.480`. If
+    #   a record with this exact time stamp does not exist, records will be
+    #   streamed from the next (later) record. If the time stamp is older
+    #   than the current trim horizon, records will be streamed from the
+    #   oldest untrimmed data record (`TRIM_HORIZON`).
     #   @return [Time]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/StartingPosition AWS API Documentation
@@ -2010,7 +2105,8 @@ module Aws::Kinesis
     #   @return [Boolean]
     #
     # @!attribute [rw] retention_period_hours
-    #   The current retention period, in hours.
+    #   The current retention period, in hours. Minimum value of 24. Maximum
+    #   value of 168.
     #   @return [Integer]
     #
     # @!attribute [rw] stream_creation_timestamp
@@ -2166,14 +2262,17 @@ module Aws::Kinesis
     end
 
     # After you call SubscribeToShard, Kinesis Data Streams sends events of
-    # this type to your consumer.
+    # this type over an HTTP/2 connection to your consumer.
     #
     # @!attribute [rw] records
     #   @return [Array<Types::Record>]
     #
     # @!attribute [rw] continuation_sequence_number
-    #   Use this as `StartingSequenceNumber` in the next call to
-    #   SubscribeToShard.
+    #   Use this as `SequenceNumber` in the next call to SubscribeToShard,
+    #   with `StartingPosition` set to `AT_SEQUENCE_NUMBER` or
+    #   `AFTER_SEQUENCE_NUMBER`. Use `ContinuationSequenceNumber` for
+    #   checkpointing because it captures your shard progress even when no
+    #   data is written to the shard.
     #   @return [String]
     #
     # @!attribute [rw] millis_behind_latest
@@ -2183,12 +2282,16 @@ module Aws::Kinesis
     #   there are no new records to process at this moment.
     #   @return [Integer]
     #
+    # @!attribute [rw] child_shards
+    #   @return [Array<Types::ChildShard>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/SubscribeToShardEvent AWS API Documentation
     #
     class SubscribeToShardEvent < Struct.new(
       :records,
       :continuation_sequence_number,
       :millis_behind_latest,
+      :child_shards,
       :event_type)
       SENSITIVE = []
       include Aws::Structure
@@ -2280,7 +2383,20 @@ module Aws::Kinesis
     #   @return [String]
     #
     # @!attribute [rw] target_shard_count
-    #   The new number of shards.
+    #   The new number of shards. This value has the following default
+    #   limits. By default, you cannot do the following:
+    #
+    #   * Set this value to more than double your current shard count for a
+    #     stream.
+    #
+    #   * Set this value below half your current shard count for a stream.
+    #
+    #   * Set this value to more than 500 shards in a stream (the default
+    #     limit for shard count per stream is 500 per account per region),
+    #     unless you request a limit increase.
+    #
+    #   * Scale a stream with more than 500 shards down unless you set this
+    #     value to less than 500 shards.
     #   @return [Integer]
     #
     # @!attribute [rw] scaling_type
@@ -2319,6 +2435,10 @@ module Aws::Kinesis
       include Aws::Structure
     end
 
+    # This is a tagged union for all of the types of events an enhanced
+    # fan-out consumer can receive over HTTP/2 after a call to
+    # SubscribeToShard.
+    #
     # EventStream is an Enumerator of Events.
     #  #event_types #=> Array, returns all modeled event types in the stream
     #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-kinesis
 version: !ruby/object:Gem::Version
-  version: 1.26.0
+  version: 1.27.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-02 00:00:00.000000000 Z
+date: 2020-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core