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

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' 

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
Eq PurgeQueue Source # 
Instance details

Defined in Amazonka.SQS.PurgeQueue

Read PurgeQueue Source # 
Instance details

Defined in Amazonka.SQS.PurgeQueue

Show PurgeQueue Source # 
Instance details

Defined in Amazonka.SQS.PurgeQueue

Generic PurgeQueue Source # 
Instance details

Defined in Amazonka.SQS.PurgeQueue

Associated Types

type Rep PurgeQueue :: Type -> Type #

NFData PurgeQueue Source # 
Instance details

Defined in Amazonka.SQS.PurgeQueue

Methods

rnf :: PurgeQueue -> () #

Hashable PurgeQueue Source # 
Instance details

Defined in Amazonka.SQS.PurgeQueue

AWSRequest PurgeQueue Source # 
Instance details

Defined in Amazonka.SQS.PurgeQueue

Associated Types

type AWSResponse PurgeQueue #

ToHeaders PurgeQueue Source # 
Instance details

Defined in Amazonka.SQS.PurgeQueue

Methods

toHeaders :: PurgeQueue -> [Header] #

ToPath PurgeQueue Source # 
Instance details

Defined in Amazonka.SQS.PurgeQueue

ToQuery PurgeQueue Source # 
Instance details

Defined in Amazonka.SQS.PurgeQueue

type Rep PurgeQueue Source # 
Instance details

Defined in Amazonka.SQS.PurgeQueue

type Rep PurgeQueue = D1 ('MetaData "PurgeQueue" "Amazonka.SQS.PurgeQueue" "libZSservicesZSamazonka-sqsZSamazonka-sqs" 'False) (C1 ('MetaCons "PurgeQueue'" 'PrefixI 'True) (S1 ('MetaSel ('Just "queueUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse PurgeQueue Source # 
Instance details

Defined in Amazonka.SQS.PurgeQueue

newPurgeQueue Source #

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
Eq PurgeQueueResponse Source # 
Instance details

Defined in Amazonka.SQS.PurgeQueue

Read PurgeQueueResponse Source # 
Instance details

Defined in Amazonka.SQS.PurgeQueue

Show PurgeQueueResponse Source # 
Instance details

Defined in Amazonka.SQS.PurgeQueue

Generic PurgeQueueResponse Source # 
Instance details

Defined in Amazonka.SQS.PurgeQueue

Associated Types

type Rep PurgeQueueResponse :: Type -> Type #

NFData PurgeQueueResponse Source # 
Instance details

Defined in Amazonka.SQS.PurgeQueue

Methods

rnf :: PurgeQueueResponse -> () #

type Rep PurgeQueueResponse Source # 
Instance details

Defined in Amazonka.SQS.PurgeQueue

type Rep PurgeQueueResponse = D1 ('MetaData "PurgeQueueResponse" "Amazonka.SQS.PurgeQueue" "libZSservicesZSamazonka-sqsZSamazonka-sqs" '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.