Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SQS.PurgeQueue

Contents

Creating a Request
Request Lenses
Destructuring the Response

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

data PurgeQueue = PurgeQueue' {
- queueUrl :: Text
}
newPurgeQueue :: Text -> PurgeQueue
purgeQueue_queueUrl :: Lens' PurgeQueue Text
data PurgeQueueResponse = PurgeQueueResponse' {
}
newPurgeQueueResponse :: PurgeQueueResponse

Creating a Request

data PurgeQueue Source #

See: newPurgeQueue smart constructor.

Constructors

PurgeQueue'
Fields queueUrl :: Text The URL of the queue from which the `PurgeQueue` action deletes messages. Queue URLs and names are case-sensitive.

Instances

Instances details

ToHeaders PurgeQueue Source #
Instance details Defined in Amazonka.SQS.PurgeQueue Methods toHeaders :: PurgeQueue -> [Header] #
ToPath PurgeQueue Source #
Instance details Defined in Amazonka.SQS.PurgeQueue Methods toPath :: PurgeQueue -> ByteString #
ToQuery PurgeQueue Source #
Instance details Defined in Amazonka.SQS.PurgeQueue Methods toQuery :: PurgeQueue -> QueryString #
AWSRequest PurgeQueue Source #
Instance details Defined in Amazonka.SQS.PurgeQueue Associated Types type AWSResponse PurgeQueue # Methods request :: (Service -> Service) -> PurgeQueue -> Request PurgeQueue # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PurgeQueue -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PurgeQueue))) #
Generic PurgeQueue Source #
Instance details Defined in Amazonka.SQS.PurgeQueue Associated Types type Rep PurgeQueue :: Type -> Type # Methods from :: PurgeQueue -> Rep PurgeQueue x # to :: Rep PurgeQueue x -> PurgeQueue #
Read PurgeQueue Source #
Instance details Defined in Amazonka.SQS.PurgeQueue Methods readsPrec :: Int -> ReadS PurgeQueue # readList :: ReadS [PurgeQueue] # readPrec :: ReadPrec PurgeQueue # readListPrec :: ReadPrec [PurgeQueue] #
Show PurgeQueue Source #
Instance details Defined in Amazonka.SQS.PurgeQueue Methods showsPrec :: Int -> PurgeQueue -> ShowS # show :: PurgeQueue -> String # showList :: [PurgeQueue] -> ShowS #
NFData PurgeQueue Source #
Instance details Defined in Amazonka.SQS.PurgeQueue Methods rnf :: PurgeQueue -> () #
Eq PurgeQueue Source #
Instance details Defined in Amazonka.SQS.PurgeQueue Methods (==) :: PurgeQueue -> PurgeQueue -> Bool # (/=) :: PurgeQueue -> PurgeQueue -> Bool #
Hashable PurgeQueue Source #
Instance details Defined in Amazonka.SQS.PurgeQueue Methods hashWithSalt :: Int -> PurgeQueue -> Int # hash :: PurgeQueue -> Int #
type AWSResponse PurgeQueue Source #
Instance details Defined in Amazonka.SQS.PurgeQueue type AWSResponse PurgeQueue = PurgeQueueResponse
type Rep PurgeQueue Source #
Instance details Defined in Amazonka.SQS.PurgeQueue type Rep PurgeQueue = D1 ('MetaData "PurgeQueue" "Amazonka.SQS.PurgeQueue" "amazonka-sqs-2.0-8jRKm0MCN6JIBFunCpUxaV" 'False) (C1 ('MetaCons "PurgeQueue'" 'PrefixI 'True) (S1 ('MetaSel ('Just "queueUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newPurgeQueue Source #

Arguments

:: Text	`$sel:queueUrl:PurgeQueue'`
-> 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

Instances details

Generic PurgeQueueResponse Source #
Instance details Defined in Amazonka.SQS.PurgeQueue Associated Types type Rep PurgeQueueResponse :: Type -> Type # Methods from :: PurgeQueueResponse -> Rep PurgeQueueResponse x # to :: Rep PurgeQueueResponse x -> PurgeQueueResponse #
Read PurgeQueueResponse Source #
Instance details Defined in Amazonka.SQS.PurgeQueue Methods readsPrec :: Int -> ReadS PurgeQueueResponse # readList :: ReadS [PurgeQueueResponse] # readPrec :: ReadPrec PurgeQueueResponse # readListPrec :: ReadPrec [PurgeQueueResponse] #
Show PurgeQueueResponse Source #
Instance details Defined in Amazonka.SQS.PurgeQueue Methods showsPrec :: Int -> PurgeQueueResponse -> ShowS # show :: PurgeQueueResponse -> String # showList :: [PurgeQueueResponse] -> ShowS #
NFData PurgeQueueResponse Source #
Instance details Defined in Amazonka.SQS.PurgeQueue Methods rnf :: PurgeQueueResponse -> () #
Eq PurgeQueueResponse Source #
Instance details Defined in Amazonka.SQS.PurgeQueue Methods (==) :: PurgeQueueResponse -> PurgeQueueResponse -> Bool # (/=) :: PurgeQueueResponse -> PurgeQueueResponse -> Bool #
type Rep PurgeQueueResponse Source #
Instance details Defined in Amazonka.SQS.PurgeQueue type Rep PurgeQueueResponse = D1 ('MetaData "PurgeQueueResponse" "Amazonka.SQS.PurgeQueue" "amazonka-sqs-2.0-8jRKm0MCN6JIBFunCpUxaV" 'False) (C1 ('MetaCons "PurgeQueueResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newPurgeQueueResponse :: PurgeQueueResponse Source #

Create a value of PurgeQueueResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.