Aws.Kinesis.Client.Consumer

The Consumer

data KinesisConsumer

The KinesisConsumer maintains state about which shards to pull from.

managedKinesisConsumer :: (MonadIO m, MonadBaseControl IO m) => ConsumerKit -> Codensity m KinesisConsumer

This constructs a KinesisConsumer and closes it when you have done with it; this is equivalent to withKinesisConsumer, except that the continuation is replaced with returning the consumer in Codensity.

withKinesisConsumer :: (MonadIO m, MonadBaseControl IO m) => ConsumerKit -> (KinesisConsumer -> m α) -> m α

This constructs a KinesisConsumer and closes it when you have done with it.

Commands

consumerSource :: MonadIO m => KinesisConsumer -> Source m Record

A conduit for getting records.

readConsumer :: MonadIO m => KinesisConsumer -> m Record

Await and read a single record from the consumer.

tryReadConsumer :: MonadIO m => KinesisConsumer -> m (Maybe Record)

Try to read a single record from the consumer; if there is non queued up, then Nothing will be returned.

consumerStreamState :: MonadIO m => KinesisConsumer -> m SavedStreamState

Get the last read sequence number at each shard.

Consumer Environment

data ConsumerKit

The ConsumerKit contains what is needed to initialize a KinesisConsumer.

Constructors

ConsumerKit

Fields

_ckKinesisKit :: !KinesisKit

The credentials and configuration for making requests to AWS Kinesis.

_ckStreamName :: !StreamName

The name of the stream to consume from.

_ckBatchSize :: !Natural

The number of records to fetch at once from the stream.

_ckIteratorType :: !ShardIteratorType

The type of iterator to consume.

_ckSavedStreamState :: !(Maybe SavedStreamState)

Optionally, an initial stream state. The iterator type in _ckIteratorType will be used for any shards not present in the saved stream state; otherwise, AfterSequenceNumber will be used.

makeConsumerKit :: KinesisKit -> StreamName -> ConsumerKit

Create a ConsumerKit with default settings (using iterator type Latest and a batch size of 200).

data SavedStreamState

Instances

ToJSON SavedStreamState

FromJSON SavedStreamState

Lenses

ckKinesisKit :: Lens' ConsumerKit KinesisKit

A lens for _ckKinesisKit.

ckStreamName :: Lens' ConsumerKit StreamName

A lens for _ckStreamName.

ckBatchSize :: Lens' ConsumerKit Natural

A lens for _ckBatchSize.

ckIteratorType :: Lens' ConsumerKit ShardIteratorType

A lens for _ckIteratorType.

ckSavedStreamState :: Lens' ConsumerKit (Maybe SavedStreamState)

A lens for _ckSavedStreamState.