| CARVIEW |
SubscribeToShardEvent
After you call SubscribeToShard, Kinesis Data Streams sends events of this type over an HTTP/2 connection to your consumer.
Contents
- ContinuationSequenceNumber
-
Use this as
SequenceNumberin the next call to SubscribeToShard, withStartingPositionset toAT_SEQUENCE_NUMBERorAFTER_SEQUENCE_NUMBER. UseContinuationSequenceNumberfor checkpointing because it captures your shard progress even when no data is written to the shard.Type: String
Pattern:
0|([1-9]\d{0,128})Required: Yes
- MillisBehindLatest
-
The number of milliseconds the read records are from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates that record processing is caught up, and there are no new records to process at this moment.
Type: Long
Valid Range: Minimum value of 0.
Required: Yes
- Records
-
Type: Array of Record objects
Required: Yes
- ChildShards
-
The list of the child shards of the current shard, returned only at the end of the current shard.
Type: Array of ChildShard objects
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
Thanks for letting us know we're doing a good job!
If you've got a moment, please tell us what we did right so we can do more of it.
Thanks for letting us know this page needs work. We're sorry we let you down.
If you've got a moment, please tell us how we can make the documentation better.