Network.AWS.SQS.PurgeQueue

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.

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

Methods

(==) :: PurgeQueue -> PurgeQueue -> Bool

(/=) :: PurgeQueue -> PurgeQueue -> Bool

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

Methods

readsPrec :: Int -> ReadS PurgeQueue

readList :: ReadS [PurgeQueue]

readPrec :: ReadPrec PurgeQueue

readListPrec :: ReadPrec [PurgeQueue]

Show PurgeQueue

Methods

showsPrec :: Int -> PurgeQueue -> ShowS

show :: PurgeQueue -> String

showList :: [PurgeQueue] -> ShowS

Generic PurgeQueue

Associated Types

type Rep PurgeQueue :: * -> *

Methods

from :: PurgeQueue -> Rep PurgeQueue x

to :: Rep PurgeQueue x -> PurgeQueue

Hashable PurgeQueue

Methods

hashWithSalt :: Int -> PurgeQueue -> Int

hash :: PurgeQueue -> Int

NFData PurgeQueue

Methods

rnf :: PurgeQueue -> ()

AWSRequest PurgeQueue

Associated Types

type Rs PurgeQueue :: *

Methods

request :: PurgeQueue -> Request PurgeQueue

response :: MonadResource m => Logger -> Service -> Proxy * PurgeQueue -> ClientResponse -> m (Response PurgeQueue)

ToPath PurgeQueue

Methods

toPath :: PurgeQueue -> ByteString

ToHeaders PurgeQueue

Methods

toHeaders :: PurgeQueue -> [Header]

ToQuery PurgeQueue

Methods

toQuery :: PurgeQueue -> QueryString

type Rep PurgeQueue

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

type Rs PurgeQueue

type Rs PurgeQueue = PurgeQueueResponse

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

Methods

(==) :: PurgeQueueResponse -> PurgeQueueResponse -> Bool

(/=) :: PurgeQueueResponse -> PurgeQueueResponse -> Bool

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

Methods

readsPrec :: Int -> ReadS PurgeQueueResponse

readList :: ReadS [PurgeQueueResponse]

readPrec :: ReadPrec PurgeQueueResponse

readListPrec :: ReadPrec [PurgeQueueResponse]

Show PurgeQueueResponse

Methods

showsPrec :: Int -> PurgeQueueResponse -> ShowS

show :: PurgeQueueResponse -> String

showList :: [PurgeQueueResponse] -> ShowS

Generic PurgeQueueResponse

Associated Types

type Rep PurgeQueueResponse :: * -> *

Methods

from :: PurgeQueueResponse -> Rep PurgeQueueResponse x

to :: Rep PurgeQueueResponse x -> PurgeQueueResponse

NFData PurgeQueueResponse

Methods

rnf :: PurgeQueueResponse -> ()

type Rep PurgeQueueResponse

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