Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.SQS.PurgeQueue

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Deletes the messages in a queue specified by the QueueURL parameter.

Important: When you use the PurgeQueue action, you can't retrieve a message deleted from a queue.

When you purge a queue, the message deletion process takes up to 60 seconds. All messages sent to the queue before calling the PurgeQueue action are deleted. Messages sent to the queue while it is being purged might be deleted. While the queue is being purged, messages sent to the queue before PurgeQueue is called might be received, but are deleted within the next minute.

Synopsis

purgeQueue :: Text -> PurgeQueue
data PurgeQueue
pqQueueURL :: Lens' PurgeQueue Text
purgeQueueResponse :: PurgeQueueResponse
data PurgeQueueResponse

Creating a Request

purgeQueue #

Arguments

:: Text	`pqQueueURL`
-> PurgeQueue

Creates a value of PurgeQueue with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

pqQueueURL - The URL of the queue from which the PurgeQueue action deletes messages. Queue URLs are case-sensitive.

data PurgeQueue #

See: purgeQueue smart constructor.

Instances

Eq PurgeQueue #
Instance details Defined in Network.AWS.SQS.PurgeQueue Methods (==) :: PurgeQueue -> PurgeQueue -> Bool # (/=) :: PurgeQueue -> PurgeQueue -> Bool #
Data PurgeQueue #
Instance details Defined in Network.AWS.SQS.PurgeQueue Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PurgeQueue -> c PurgeQueue # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PurgeQueue # toConstr :: PurgeQueue -> Constr # dataTypeOf :: PurgeQueue -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PurgeQueue) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PurgeQueue) # gmapT :: (forall b. Data b => b -> b) -> PurgeQueue -> PurgeQueue # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PurgeQueue -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PurgeQueue -> r # gmapQ :: (forall d. Data d => d -> u) -> PurgeQueue -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> PurgeQueue -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> PurgeQueue -> m PurgeQueue # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PurgeQueue -> m PurgeQueue # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PurgeQueue -> m PurgeQueue #
Read PurgeQueue #
Instance details Defined in Network.AWS.SQS.PurgeQueue Methods readsPrec :: Int -> ReadS PurgeQueue # readList :: ReadS [PurgeQueue] # readPrec :: ReadPrec PurgeQueue # readListPrec :: ReadPrec [PurgeQueue] #
Show PurgeQueue #
Instance details Defined in Network.AWS.SQS.PurgeQueue Methods showsPrec :: Int -> PurgeQueue -> ShowS # show :: PurgeQueue -> String # showList :: [PurgeQueue] -> ShowS #
Generic PurgeQueue #
Instance details Defined in Network.AWS.SQS.PurgeQueue Associated Types type Rep PurgeQueue :: * -> * # Methods from :: PurgeQueue -> Rep PurgeQueue x # to :: Rep PurgeQueue x -> PurgeQueue #
Hashable PurgeQueue #
Instance details Defined in Network.AWS.SQS.PurgeQueue Methods hashWithSalt :: Int -> PurgeQueue -> Int # hash :: PurgeQueue -> Int #
AWSRequest PurgeQueue #
Instance details Defined in Network.AWS.SQS.PurgeQueue Associated Types type Rs PurgeQueue :: * # Methods request :: PurgeQueue -> Request PurgeQueue # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy PurgeQueue -> ClientResponse -> m (Response PurgeQueue) #
ToHeaders PurgeQueue #
Instance details Defined in Network.AWS.SQS.PurgeQueue Methods toHeaders :: PurgeQueue -> [Header] #
ToPath PurgeQueue #
Instance details Defined in Network.AWS.SQS.PurgeQueue Methods toPath :: PurgeQueue -> ByteString #
ToQuery PurgeQueue #
Instance details Defined in Network.AWS.SQS.PurgeQueue Methods toQuery :: PurgeQueue -> QueryString #
NFData PurgeQueue #
Instance details Defined in Network.AWS.SQS.PurgeQueue Methods rnf :: PurgeQueue -> () #
type Rep PurgeQueue #
Instance details Defined in Network.AWS.SQS.PurgeQueue type Rep PurgeQueue = D1 (MetaData "PurgeQueue" "Network.AWS.SQS.PurgeQueue" "amazonka-sqs-1.6.0-6BfvsoMwFto2w6xsl91xQd" True) (C1 (MetaCons "PurgeQueue'" PrefixI True) (S1 (MetaSel (Just "_pqQueueURL") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))
type Rs PurgeQueue #
Instance details Defined in Network.AWS.SQS.PurgeQueue type Rs PurgeQueue = PurgeQueueResponse

Request Lenses

pqQueueURL :: Lens' PurgeQueue Text #

The URL of the queue from which the PurgeQueue action deletes messages. Queue URLs are case-sensitive.

Destructuring the Response

purgeQueueResponse :: PurgeQueueResponse #

Creates a value of PurgeQueueResponse with the minimum fields required to make a request.

data PurgeQueueResponse #

See: purgeQueueResponse smart constructor.

Instances

Eq PurgeQueueResponse #
Instance details Defined in Network.AWS.SQS.PurgeQueue Methods (==) :: PurgeQueueResponse -> PurgeQueueResponse -> Bool # (/=) :: PurgeQueueResponse -> PurgeQueueResponse -> Bool #
Data PurgeQueueResponse #
Instance details Defined in Network.AWS.SQS.PurgeQueue Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PurgeQueueResponse -> c PurgeQueueResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PurgeQueueResponse # toConstr :: PurgeQueueResponse -> Constr # dataTypeOf :: PurgeQueueResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PurgeQueueResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PurgeQueueResponse) # gmapT :: (forall b. Data b => b -> b) -> PurgeQueueResponse -> PurgeQueueResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PurgeQueueResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PurgeQueueResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> PurgeQueueResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> PurgeQueueResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> PurgeQueueResponse -> m PurgeQueueResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PurgeQueueResponse -> m PurgeQueueResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PurgeQueueResponse -> m PurgeQueueResponse #
Read PurgeQueueResponse #
Instance details Defined in Network.AWS.SQS.PurgeQueue Methods readsPrec :: Int -> ReadS PurgeQueueResponse # readList :: ReadS [PurgeQueueResponse] # readPrec :: ReadPrec PurgeQueueResponse # readListPrec :: ReadPrec [PurgeQueueResponse] #
Show PurgeQueueResponse #
Instance details Defined in Network.AWS.SQS.PurgeQueue Methods showsPrec :: Int -> PurgeQueueResponse -> ShowS # show :: PurgeQueueResponse -> String # showList :: [PurgeQueueResponse] -> ShowS #
Generic PurgeQueueResponse #
Instance details Defined in Network.AWS.SQS.PurgeQueue Associated Types type Rep PurgeQueueResponse :: * -> * # Methods from :: PurgeQueueResponse -> Rep PurgeQueueResponse x # to :: Rep PurgeQueueResponse x -> PurgeQueueResponse #
NFData PurgeQueueResponse #
Instance details Defined in Network.AWS.SQS.PurgeQueue Methods rnf :: PurgeQueueResponse -> () #
type Rep PurgeQueueResponse #
Instance details Defined in Network.AWS.SQS.PurgeQueue type Rep PurgeQueueResponse = D1 (MetaData "PurgeQueueResponse" "Network.AWS.SQS.PurgeQueue" "amazonka-sqs-1.6.0-6BfvsoMwFto2w6xsl91xQd" False) (C1 (MetaCons "PurgeQueueResponse'" PrefixI False) (U1 :: * -> *))