Class: Aws::Kinesis::Types::SubscribeToShardEvent

Inherits:

Struct

• Object
• Struct
• Aws::Kinesis::Types::SubscribeToShardEvent

Defined in:

(unknown)

Overview

After you call SubscribeToShard, Kinesis Data Streams sends events of this type over an HTTP/2 connection to your consumer.

Returned by:

• Aws::Kinesis::Types::SubscribeToShardEventStream#subscribe_to_shard_event

See Also:

• AWS API Documentation

Instance Attribute Summary

• #child_shards ⇒ Array<Types::ChildShard>
• #continuation_sequence_number ⇒ String

  Use this as SequenceNumber in the next call to SubscribeToShard, with StartingPosition set to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER.

• #millis_behind_latest ⇒ Integer

  The number of milliseconds the read records are from the tip of the stream, indicating how far behind current time the consumer is.

• #records ⇒ Array<Types::Record>

Instance Attribute Details

#child_shards ⇒ Array<Types::ChildShard>

Returns:

• (Array<Types::ChildShard>)

#continuation_sequence_number ⇒ String

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.

Returns:

• (String) —

  Use this as SequenceNumber in the next call to SubscribeToShard, with StartingPosition set to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER.

#millis_behind_latest ⇒ Integer

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.

Returns:

• (Integer) —

  The number of milliseconds the read records are from the tip of the stream, indicating how far behind current time the consumer is.

#records ⇒ Array<Types::Record>

Returns:

• (Array<Types::Record>)