amazonka-sqs-1.4.5: Amazon Simple Queue Service SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.SQS.PurgeQueue

Contents

Description

Deletes the messages in a queue specified by the queue URL .

Important: When you use the PurgeQueue API, the deleted messages in the queue can't be retrieved.

When you purge a queue, the message deletion process takes up to 60 seconds. All messages sent to the queue before calling PurgeQueue will be 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 was called might be received, but will be deleted within the next minute.

Synopsis

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 queue URL of the queue to delete the messages from when using the PurgeQueue API. Queue URLs are case-sensitive.

data PurgeQueue #

See: purgeQueue smart constructor.

Instances

Eq PurgeQueue # 
Data 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 # 
Show PurgeQueue # 
Generic PurgeQueue # 

Associated Types

type Rep PurgeQueue :: * -> * #

Hashable PurgeQueue # 
NFData PurgeQueue # 

Methods

rnf :: PurgeQueue -> () #

AWSRequest PurgeQueue # 
ToQuery PurgeQueue # 
ToPath PurgeQueue # 
ToHeaders PurgeQueue # 

Methods

toHeaders :: PurgeQueue -> [Header] #

type Rep PurgeQueue # 
type Rep PurgeQueue = D1 (MetaData "PurgeQueue" "Network.AWS.SQS.PurgeQueue" "amazonka-sqs-1.4.5-AjHrg8hmhlvBQXJ3tK3BFF" True) (C1 (MetaCons "PurgeQueue'" PrefixI True) (S1 (MetaSel (Just Symbol "_pqQueueURL") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))
type Rs PurgeQueue # 

Request Lenses

pqQueueURL :: Lens' PurgeQueue Text #

The queue URL of the queue to delete the messages from when using the PurgeQueue API. 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 # 
Data PurgeQueueResponse # 

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 # 
Show PurgeQueueResponse # 
Generic PurgeQueueResponse # 
NFData PurgeQueueResponse # 

Methods

rnf :: PurgeQueueResponse -> () #

type Rep PurgeQueueResponse # 
type Rep PurgeQueueResponse = D1 (MetaData "PurgeQueueResponse" "Network.AWS.SQS.PurgeQueue" "amazonka-sqs-1.4.5-AjHrg8hmhlvBQXJ3tK3BFF" False) (C1 (MetaCons "PurgeQueueResponse'" PrefixI False) U1)