Amazon Kinesis Data Streams Service API Reference
API Reference (API Version 2013-12-02)

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 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.

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: