Aws.Kinesis.Client.Common

Documentation

data KinesisKit

The KinesisKit contains what is necessary to make a request to Kinesis.

Constructors

KinesisKit

Fields

_kkConfiguration :: !Configuration

_kkKinesisConfiguration :: !(KinesisConfiguration NormalQuery)

_kkManager :: !Manager

kkConfiguration :: Lens' KinesisKit Configuration

A lens for _kkConfiguration.

kkKinesisConfiguration :: Lens' KinesisKit (KinesisConfiguration NormalQuery)

A lens for _kkKinesisConfiguration.

kkManager :: Lens' KinesisKit Manager

A lens for _kkManager.

type MonadKinesis m = (MonadIO m, MonadReader KinesisKit m, MonadError SomeException m)

The minimal effect modality for running Kinesis commands.

runKinesis :: (MonadKinesis m, ServiceConfiguration req ~ KinesisConfiguration, Transaction req resp) => req -> m resp

Run a Kinesis request inside MonadKinesis.

Fetching Shards

streamShardSource :: MonadKinesis m => StreamName -> Source m Shard

A Source of shards for a stream.

streamOpenShardSource :: MonadKinesis m => StreamName -> Source m Shard

A Source of open shards for a stream.

shardIsOpen :: Shard -> Bool

Miscellaneous monad stuff

mapError :: MonadError e' m => (e -> e') -> EitherT e m a -> m a

This function may be used to transform a computation with errors in one type to one with errors in another type. Whilst the argument is fixed at EitherT, this may be used where the argument is in an arbitrary monad, since it will simply get instantiated at EitherT.

handleError :: MonadError e m => (e -> m α) -> m α -> m α

This is a verion of catchError with its arguments flipped.

mapEnvironment :: MonadReader r' m => Getter r' r -> ReaderT r m a -> m a

Analogous to withReader, but supports a result in MonadReader.