Skip to content

/AWS1/CL_KNSSUBTOSHARDEVENT

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

CONSTRUCTOR

IMPORTING

Required arguments:

it_records TYPE /AWS1/CL_KNSRECORD=>TT_RECORDLIST TT_RECORDLIST

iv_continuationsequencenum TYPE /AWS1/KNSSEQUENCENUMBER /AWS1/KNSSEQUENCENUMBER

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.

iv_millisbehindlatest TYPE /AWS1/KNSMILLISBEHINDLATEST /AWS1/KNSMILLISBEHINDLATEST

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.

Optional arguments:

it_childshards TYPE /AWS1/CL_KNSCHILDSHARD=>TT_CHILDSHARDLIST TT_CHILDSHARDLIST

The list of the child shards of the current shard, returned only at the end of the current shard.


Queryable Attributes

Records

Accessible with the following methods

Method Description
GET_RECORDS() Getter for RECORDS, with configurable default
ASK_RECORDS() Getter for RECORDS w/ exceptions if field has no value
HAS_RECORDS() Determine if RECORDS has a value

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.

Accessible with the following methods

Method Description
GET_CONTINUATIONSEQUENCENUM() Getter for CONTINUATIONSEQUENCENUMBER, with configurable def
ASK_CONTINUATIONSEQUENCENUM() Getter for CONTINUATIONSEQUENCENUMBER w/ exceptions if field
HAS_CONTINUATIONSEQUENCENUM() Determine if CONTINUATIONSEQUENCENUMBER has a value

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.

Accessible with the following methods

Method Description
GET_MILLISBEHINDLATEST() Getter for MILLISBEHINDLATEST, with configurable default
ASK_MILLISBEHINDLATEST() Getter for MILLISBEHINDLATEST w/ exceptions if field has no
HAS_MILLISBEHINDLATEST() Determine if MILLISBEHINDLATEST has a value

ChildShards

The list of the child shards of the current shard, returned only at the end of the current shard.

Accessible with the following methods

Method Description
GET_CHILDSHARDS() Getter for CHILDSHARDS, with configurable default
ASK_CHILDSHARDS() Getter for CHILDSHARDS w/ exceptions if field has no value
HAS_CHILDSHARDS() Determine if CHILDSHARDS has a value