Copyright | (c) 2013-2021 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 |
Amazonka.SQS.PurgeQueue
Description
Deletes the messages in a queue specified by the QueueURL
parameter.
When you use the PurgeQueue
action, you can't retrieve any messages
deleted from a queue.
The message deletion process takes up to 60 seconds. We recommend waiting for 60 seconds regardless of your queue's size.
Messages sent to the queue before you call PurgeQueue
might be
received but are deleted within the next minute.
Messages sent to the queue after you call PurgeQueue
might be
deleted while the queue is being purged.
Synopsis
Creating a Request
data PurgeQueue Source #
See: newPurgeQueue
smart constructor.
Constructors
PurgeQueue' | |
Instances
Arguments
:: Text | |
-> PurgeQueue |
Create a value of PurgeQueue
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:queueUrl:PurgeQueue'
, purgeQueue_queueUrl
- The URL of the queue from which the PurgeQueue
action deletes
messages.
Queue URLs and names are case-sensitive.
Request Lenses
purgeQueue_queueUrl :: Lens' PurgeQueue Text Source #
The URL of the queue from which the PurgeQueue
action deletes
messages.
Queue URLs and names are case-sensitive.
Destructuring the Response
data PurgeQueueResponse Source #
See: newPurgeQueueResponse
smart constructor.
Constructors
PurgeQueueResponse' | |
Instances
Eq PurgeQueueResponse Source # | |
Defined in Amazonka.SQS.PurgeQueue Methods (==) :: PurgeQueueResponse -> PurgeQueueResponse -> Bool # (/=) :: PurgeQueueResponse -> PurgeQueueResponse -> Bool # | |
Read PurgeQueueResponse Source # | |
Defined in Amazonka.SQS.PurgeQueue Methods readsPrec :: Int -> ReadS PurgeQueueResponse # readList :: ReadS [PurgeQueueResponse] # | |
Show PurgeQueueResponse Source # | |
Defined in Amazonka.SQS.PurgeQueue Methods showsPrec :: Int -> PurgeQueueResponse -> ShowS # show :: PurgeQueueResponse -> String # showList :: [PurgeQueueResponse] -> ShowS # | |
Generic PurgeQueueResponse Source # | |
Defined in Amazonka.SQS.PurgeQueue Associated Types type Rep PurgeQueueResponse :: Type -> Type # Methods from :: PurgeQueueResponse -> Rep PurgeQueueResponse x # to :: Rep PurgeQueueResponse x -> PurgeQueueResponse # | |
NFData PurgeQueueResponse Source # | |
Defined in Amazonka.SQS.PurgeQueue Methods rnf :: PurgeQueueResponse -> () # | |
type Rep PurgeQueueResponse Source # | |
newPurgeQueueResponse :: PurgeQueueResponse Source #
Create a value of PurgeQueueResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.