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.DeleteMessage

Contents

Description

Deletes the specified message from the specified queue. You specify the message by using the message's receipt handle and not the message ID you received when you sent the message. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue. If you leave a message in the queue for longer than the queue's configured retention period, Amazon SQS automatically deletes it.

Important: It is possible you will receive a message even after you have deleted it. This might happen on rare occasions if one of the servers storing a copy of the message is unavailable when you request to delete the message. The copy remains on the server and might be returned to you again on a subsequent receive request. You should create your system to be idempotent so that receiving a particular message more than once is not a problem.

Synopsis

Creating a Request

deleteMessage #

Creates a value of DeleteMessage with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • dmQueueURL - The URL of the Amazon SQS queue to take action on. Queue URLs are case-sensitive.
  • dmReceiptHandle - The receipt handle associated with the message to delete.

data DeleteMessage #

See: deleteMessage smart constructor.

Instances

Eq DeleteMessage # 
Data DeleteMessage # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteMessage -> c DeleteMessage #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteMessage #

toConstr :: DeleteMessage -> Constr #

dataTypeOf :: DeleteMessage -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DeleteMessage) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteMessage) #

gmapT :: (forall b. Data b => b -> b) -> DeleteMessage -> DeleteMessage #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteMessage -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteMessage -> r #

gmapQ :: (forall d. Data d => d -> u) -> DeleteMessage -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteMessage -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteMessage -> m DeleteMessage #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteMessage -> m DeleteMessage #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteMessage -> m DeleteMessage #

Read DeleteMessage # 
Show DeleteMessage # 
Generic DeleteMessage # 

Associated Types

type Rep DeleteMessage :: * -> * #

Hashable DeleteMessage # 
NFData DeleteMessage # 

Methods

rnf :: DeleteMessage -> () #

AWSRequest DeleteMessage # 
ToQuery DeleteMessage # 
ToPath DeleteMessage # 
ToHeaders DeleteMessage # 
type Rep DeleteMessage # 
type Rep DeleteMessage = D1 (MetaData "DeleteMessage" "Network.AWS.SQS.DeleteMessage" "amazonka-sqs-1.4.5-AjHrg8hmhlvBQXJ3tK3BFF" False) (C1 (MetaCons "DeleteMessage'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dmQueueURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_dmReceiptHandle") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs DeleteMessage # 

Request Lenses

dmQueueURL :: Lens' DeleteMessage Text #

The URL of the Amazon SQS queue to take action on. Queue URLs are case-sensitive.

dmReceiptHandle :: Lens' DeleteMessage Text #

The receipt handle associated with the message to delete.

Destructuring the Response

deleteMessageResponse :: DeleteMessageResponse #

Creates a value of DeleteMessageResponse with the minimum fields required to make a request.

data DeleteMessageResponse #

See: deleteMessageResponse smart constructor.

Instances

Eq DeleteMessageResponse # 
Data DeleteMessageResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteMessageResponse -> c DeleteMessageResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteMessageResponse #

toConstr :: DeleteMessageResponse -> Constr #

dataTypeOf :: DeleteMessageResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DeleteMessageResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteMessageResponse) #

gmapT :: (forall b. Data b => b -> b) -> DeleteMessageResponse -> DeleteMessageResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteMessageResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteMessageResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> DeleteMessageResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteMessageResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteMessageResponse -> m DeleteMessageResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteMessageResponse -> m DeleteMessageResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteMessageResponse -> m DeleteMessageResponse #

Read DeleteMessageResponse # 
Show DeleteMessageResponse # 
Generic DeleteMessageResponse # 
NFData DeleteMessageResponse # 

Methods

rnf :: DeleteMessageResponse -> () #

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