Safe Haskell	None
Language	Haskell2010

Antiope.SQS

Contents

Re-exports

Synopsis

newtype QueueUrl = QueueUrl Text
data SQSError = DeleteMessageBatchError
class HasReceiptHandle a
data ConsumerMode
- = Drain
- | Forever
data ConsumerResult
- = Ack
- | Nack
readQueue :: MonadAWS m => QueueUrl -> m [Message]
drainQueue :: MonadAWS m => QueueUrl -> m [Message]
ackMessage :: (MonadAWS m, HasReceiptHandle msg) => QueueUrl -> msg -> m (Either SQSError ())
ackMessages :: (MonadAWS m, HasReceiptHandle msg) => QueueUrl -> [msg] -> m (Either SQSError ())
queueSource :: MonadAWS m => QueueUrl -> ConduitT () Message m ()
forAllMessages :: (MonadUnliftIO m, HasEnv env) => env -> QueueUrl -> ConsumerMode -> (Message -> m ConsumerResult) -> m ()
data Message
mBody :: Lens' Message (Maybe Text)
mMD5OfBody :: Lens' Message (Maybe Text)
mMessageId :: Lens' Message (Maybe Text)
mReceiptHandle :: Lens' Message (Maybe Text)
mAttributes :: Lens' Message (HashMap MessageAttribute Text)

Documentation

newtype QueueUrl Source #

Constructors

QueueUrl Text

Instances

Eq QueueUrl Source #
Instance details Defined in Antiope.SQS.Types Methods (==) :: QueueUrl -> QueueUrl -> Bool # (/=) :: QueueUrl -> QueueUrl -> Bool #
Show QueueUrl Source #
Instance details Defined in Antiope.SQS.Types Methods showsPrec :: Int -> QueueUrl -> ShowS # show :: QueueUrl -> String # showList :: [QueueUrl] -> ShowS #
IsString QueueUrl Source #
Instance details Defined in Antiope.SQS.Types Methods fromString :: String -> QueueUrl #
Generic QueueUrl Source #
Instance details Defined in Antiope.SQS.Types Associated Types type Rep QueueUrl :: Type -> Type # Methods from :: QueueUrl -> Rep QueueUrl x # to :: Rep QueueUrl x -> QueueUrl #
ToText QueueUrl Source #
Instance details Defined in Antiope.SQS.Types Methods toText :: QueueUrl -> Text #
FromText QueueUrl Source #
Instance details Defined in Antiope.SQS.Types Methods parser :: Parser QueueUrl #
type Rep QueueUrl Source #
Instance details Defined in Antiope.SQS.Types type Rep QueueUrl = D1 (MetaData "QueueUrl" "Antiope.SQS.Types" "antiope-sqs-7.0.4-CUAwcpPNuJs7QaMg15GlvT" True) (C1 (MetaCons "QueueUrl" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

data SQSError Source #

Constructors

DeleteMessageBatchError

Instances

Eq SQSError Source #
Instance details Defined in Antiope.SQS.Types Methods (==) :: SQSError -> SQSError -> Bool # (/=) :: SQSError -> SQSError -> Bool #
Show SQSError Source #
Instance details Defined in Antiope.SQS.Types Methods showsPrec :: Int -> SQSError -> ShowS # show :: SQSError -> String # showList :: [SQSError] -> ShowS #
Generic SQSError Source #
Instance details Defined in Antiope.SQS.Types Associated Types type Rep SQSError :: Type -> Type # Methods from :: SQSError -> Rep SQSError x # to :: Rep SQSError x -> SQSError #
type Rep SQSError Source #
Instance details Defined in Antiope.SQS.Types type Rep SQSError = D1 (MetaData "SQSError" "Antiope.SQS.Types" "antiope-sqs-7.0.4-CUAwcpPNuJs7QaMg15GlvT" False) (C1 (MetaCons "DeleteMessageBatchError" PrefixI False) (U1 :: Type -> Type))

class HasReceiptHandle a Source #

Minimal complete definition

getReceiptHandle

Instances

HasReceiptHandle Message Source #
Instance details Defined in Antiope.SQS.Types Methods getReceiptHandle :: Message -> Maybe ReceiptHandle Source #
HasReceiptHandle ReceiptHandle Source #
Instance details Defined in Antiope.SQS.Types Methods getReceiptHandle :: ReceiptHandle -> Maybe ReceiptHandle Source #
HasReceiptHandle (SqsMessage a) Source #
Instance details Defined in Antiope.SQS.Messages Methods getReceiptHandle :: SqsMessage a -> Maybe ReceiptHandle Source #

data ConsumerMode Source #

Queue consuming mode

Constructors

Drain	Keep consuming the queue until there are no messages
Forever	Keep consuming the queue forever

Instances

Eq ConsumerMode Source #
Instance details Defined in Antiope.SQS.Types Methods (==) :: ConsumerMode -> ConsumerMode -> Bool # (/=) :: ConsumerMode -> ConsumerMode -> Bool #
Show ConsumerMode Source #
Instance details Defined in Antiope.SQS.Types Methods showsPrec :: Int -> ConsumerMode -> ShowS # show :: ConsumerMode -> String # showList :: [ConsumerMode] -> ShowS #
Generic ConsumerMode Source #
Instance details Defined in Antiope.SQS.Types Associated Types type Rep ConsumerMode :: Type -> Type # Methods from :: ConsumerMode -> Rep ConsumerMode x # to :: Rep ConsumerMode x -> ConsumerMode #
type Rep ConsumerMode Source #
Instance details Defined in Antiope.SQS.Types type Rep ConsumerMode = D1 (MetaData "ConsumerMode" "Antiope.SQS.Types" "antiope-sqs-7.0.4-CUAwcpPNuJs7QaMg15GlvT" False) (C1 (MetaCons "Drain" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Forever" PrefixI False) (U1 :: Type -> Type))

data ConsumerResult Source #

Constructors

Ack
Nack

Instances

Eq ConsumerResult Source #
Instance details Defined in Antiope.SQS.Types Methods (==) :: ConsumerResult -> ConsumerResult -> Bool # (/=) :: ConsumerResult -> ConsumerResult -> Bool #
Show ConsumerResult Source #
Instance details Defined in Antiope.SQS.Types Methods showsPrec :: Int -> ConsumerResult -> ShowS # show :: ConsumerResult -> String # showList :: [ConsumerResult] -> ShowS #
Generic ConsumerResult Source #
Instance details Defined in Antiope.SQS.Types Associated Types type Rep ConsumerResult :: Type -> Type # Methods from :: ConsumerResult -> Rep ConsumerResult x # to :: Rep ConsumerResult x -> ConsumerResult #
type Rep ConsumerResult Source #
Instance details Defined in Antiope.SQS.Types type Rep ConsumerResult = D1 (MetaData "ConsumerResult" "Antiope.SQS.Types" "antiope-sqs-7.0.4-CUAwcpPNuJs7QaMg15GlvT" False) (C1 (MetaCons "Ack" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Nack" PrefixI False) (U1 :: Type -> Type))

readQueue :: MonadAWS m => QueueUrl -> m [Message] Source #

Reads the specified SQS queue once returning a bath of messages

drainQueue :: MonadAWS m => QueueUrl -> m [Message] Source #

Reads the specified SQS queue until it is empty and returns a list of messages

ackMessage :: (MonadAWS m, HasReceiptHandle msg) => QueueUrl -> msg -> m (Either SQSError ()) Source #

Acknowledges a single SQS message

ackMessages :: (MonadAWS m, HasReceiptHandle msg) => QueueUrl -> [msg] -> m (Either SQSError ()) Source #

Acknowledges a group of SQS messages

queueSource :: MonadAWS m => QueueUrl -> ConduitT () Message m () Source #

Reads from an SQS indefinitely, producing messages into a conduit

forAllMessages :: (MonadUnliftIO m, HasEnv env) => env -> QueueUrl -> ConsumerMode -> (Message -> m ConsumerResult) -> m () Source #

Re-exports

data Message #

An Amazon SQS message.

See: message smart constructor.

Instances

Eq Message
Instance details Defined in Network.AWS.SQS.Types.Product Methods (==) :: Message -> Message -> Bool # (/=) :: Message -> Message -> Bool #
Data Message
Instance details Defined in Network.AWS.SQS.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Message -> c Message # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Message # toConstr :: Message -> Constr # dataTypeOf :: Message -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Message) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Message) # gmapT :: (forall b. Data b => b -> b) -> Message -> Message # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Message -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Message -> r # gmapQ :: (forall d. Data d => d -> u) -> Message -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Message -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Message -> m Message # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Message -> m Message # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Message -> m Message #
Read Message
Instance details Defined in Network.AWS.SQS.Types.Product Methods readsPrec :: Int -> ReadS Message # readList :: ReadS [Message] # readPrec :: ReadPrec Message # readListPrec :: ReadPrec [Message] #
Show Message
Instance details Defined in Network.AWS.SQS.Types.Product Methods showsPrec :: Int -> Message -> ShowS # show :: Message -> String # showList :: [Message] -> ShowS #
Generic Message
Instance details Defined in Network.AWS.SQS.Types.Product Associated Types type Rep Message :: Type -> Type # Methods from :: Message -> Rep Message x # to :: Rep Message x -> Message #
Hashable Message
Instance details Defined in Network.AWS.SQS.Types.Product Methods hashWithSalt :: Int -> Message -> Int # hash :: Message -> Int #
FromXML Message
Instance details Defined in Network.AWS.SQS.Types.Product Methods parseXML :: [Node] -> Either String Message #
NFData Message
Instance details Defined in Network.AWS.SQS.Types.Product Methods rnf :: Message -> () #
HasReceiptHandle Message Source #
Instance details Defined in Antiope.SQS.Types Methods getReceiptHandle :: Message -> Maybe ReceiptHandle Source #
type Rep Message
Instance details Defined in Network.AWS.SQS.Types.Product type Rep Message = D1 (MetaData "Message" "Network.AWS.SQS.Types.Product" "amazonka-sqs-1.6.1-JX4vLCohCBJDUpBpm4ig5q" False) (C1 (MetaCons "Message'" PrefixI True) ((S1 (MetaSel (Just "_mMessageAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text MessageAttributeValue))) :: (S1 (MetaSel (Just "_mMD5OfBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_mBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_mAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map MessageAttribute Text))) :: S1 (MetaSel (Just "_mReceiptHandle") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_mMessageId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_mMD5OfMessageAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

mBody :: Lens' Message (Maybe Text) #

The message's contents (not URL-encoded).

mMD5OfBody :: Lens' Message (Maybe Text) #

An MD5 digest of the non-URL-encoded message body string.

mMessageId :: Lens' Message (Maybe Text) #

A unique identifier for the message. A MessageId is considered unique across all AWS accounts for an extended period of time.

mReceiptHandle :: Lens' Message (Maybe Text) #

An identifier associated with the act of receiving the message. A new receipt handle is returned every time you receive a message. When deleting a message, you provide the last received receipt handle to delete the message.

mAttributes :: Lens' Message (HashMap MessageAttribute Text) #

SenderId , SentTimestamp , ApproximateReceiveCount , andor ApproximateFirstReceiveTimestamp . SentTimestamp and ApproximateFirstReceiveTimestamp are each returned as an integer representing the <http:en.wikipedia.orgwiki/Unix_time epoch time> in milliseconds.