Aws.Kinesis.Client.Consumer

The Consumer

data KinesisConsumer

The KinesisConsumer maintains state about which shards to pull from.

managedKinesisConsumer :: MonadConsumer 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 :: MonadConsumer m => ConsumerKit -> (KinesisConsumer -> m α) -> m α

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

Commands

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

A conduit for getting records.

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

Await and read a single record from the consumer.

tryReadConsumer :: MonadConsumer 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.

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 :: !Int

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

_ckIteratorType :: !ShardIteratorType

The type of iterator to consume.

ckKinesisKit :: Lens' ConsumerKit KinesisKit

A lens for _ckKinesisKit.

ckStreamName :: Lens' ConsumerKit StreamName

A lens for _ckStreamName.

ckBatchSize :: Lens' ConsumerKit Int

A lens for _ckBatchSize.

data ConsumerError

Constructors

NoShards

A stream must always have at least one open shard.

KinesisError !SomeException

An error which derives from a request made to Kinesis.

Instances

Show ConsumerError

type MonadConsumer m = (MonadIO m, MonadBaseControl IO m, MonadError ConsumerError m)

The basic effect modality required for operating the consumer.