amazonka-sqs-1.6.1: Amazon Simple Queue Service SDK.

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

Network.AWS.SQS.DeleteMessageBatch

Contents

Description

Deletes up to ten messages from the specified queue. This is a batch version of DeleteMessage . The result of the action on each message is reported individually in the response.

Important: Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200 .

Synopsis

Creating a Request

deleteMessageBatch Source #

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

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

  • dmbQueueURL - The URL of the Amazon SQS queue from which messages are deleted. Queue URLs are case-sensitive.
  • dmbEntries - A list of receipt handles for the messages to be deleted.

data DeleteMessageBatch Source #

See: deleteMessageBatch smart constructor.

Instances
Eq DeleteMessageBatch Source # 
Instance details

Defined in Network.AWS.SQS.DeleteMessageBatch

Data DeleteMessageBatch Source # 
Instance details

Defined in Network.AWS.SQS.DeleteMessageBatch

Methods

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

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

toConstr :: DeleteMessageBatch -> Constr #

dataTypeOf :: DeleteMessageBatch -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DeleteMessageBatch Source # 
Instance details

Defined in Network.AWS.SQS.DeleteMessageBatch

Show DeleteMessageBatch Source # 
Instance details

Defined in Network.AWS.SQS.DeleteMessageBatch

Generic DeleteMessageBatch Source # 
Instance details

Defined in Network.AWS.SQS.DeleteMessageBatch

Associated Types

type Rep DeleteMessageBatch :: Type -> Type #

Hashable DeleteMessageBatch Source # 
Instance details

Defined in Network.AWS.SQS.DeleteMessageBatch

AWSRequest DeleteMessageBatch Source # 
Instance details

Defined in Network.AWS.SQS.DeleteMessageBatch

Associated Types

type Rs DeleteMessageBatch :: Type #

ToHeaders DeleteMessageBatch Source # 
Instance details

Defined in Network.AWS.SQS.DeleteMessageBatch

ToPath DeleteMessageBatch Source # 
Instance details

Defined in Network.AWS.SQS.DeleteMessageBatch

ToQuery DeleteMessageBatch Source # 
Instance details

Defined in Network.AWS.SQS.DeleteMessageBatch

NFData DeleteMessageBatch Source # 
Instance details

Defined in Network.AWS.SQS.DeleteMessageBatch

Methods

rnf :: DeleteMessageBatch -> () #

type Rep DeleteMessageBatch Source # 
Instance details

Defined in Network.AWS.SQS.DeleteMessageBatch

type Rep DeleteMessageBatch = D1 (MetaData "DeleteMessageBatch" "Network.AWS.SQS.DeleteMessageBatch" "amazonka-sqs-1.6.1-4KwGv5jRSGR2noZdqwtyOA" False) (C1 (MetaCons "DeleteMessageBatch'" PrefixI True) (S1 (MetaSel (Just "_dmbQueueURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_dmbEntries") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [DeleteMessageBatchRequestEntry])))
type Rs DeleteMessageBatch Source # 
Instance details

Defined in Network.AWS.SQS.DeleteMessageBatch

Request Lenses

dmbQueueURL :: Lens' DeleteMessageBatch Text Source #

The URL of the Amazon SQS queue from which messages are deleted. Queue URLs are case-sensitive.

dmbEntries :: Lens' DeleteMessageBatch [DeleteMessageBatchRequestEntry] Source #

A list of receipt handles for the messages to be deleted.

Destructuring the Response

deleteMessageBatchResponse Source #

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

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

data DeleteMessageBatchResponse Source #

For each message in the batch, the response contains a DeleteMessageBatchResultEntry tag if the message is deleted or a BatchResultErrorEntry tag if the message can't be deleted.

See: deleteMessageBatchResponse smart constructor.

Instances
Eq DeleteMessageBatchResponse Source # 
Instance details

Defined in Network.AWS.SQS.DeleteMessageBatch

Data DeleteMessageBatchResponse Source # 
Instance details

Defined in Network.AWS.SQS.DeleteMessageBatch

Methods

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

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

toConstr :: DeleteMessageBatchResponse -> Constr #

dataTypeOf :: DeleteMessageBatchResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DeleteMessageBatchResponse Source # 
Instance details

Defined in Network.AWS.SQS.DeleteMessageBatch

Show DeleteMessageBatchResponse Source # 
Instance details

Defined in Network.AWS.SQS.DeleteMessageBatch

Generic DeleteMessageBatchResponse Source # 
Instance details

Defined in Network.AWS.SQS.DeleteMessageBatch

Associated Types

type Rep DeleteMessageBatchResponse :: Type -> Type #

NFData DeleteMessageBatchResponse Source # 
Instance details

Defined in Network.AWS.SQS.DeleteMessageBatch

type Rep DeleteMessageBatchResponse Source # 
Instance details

Defined in Network.AWS.SQS.DeleteMessageBatch

type Rep DeleteMessageBatchResponse = D1 (MetaData "DeleteMessageBatchResponse" "Network.AWS.SQS.DeleteMessageBatch" "amazonka-sqs-1.6.1-4KwGv5jRSGR2noZdqwtyOA" False) (C1 (MetaCons "DeleteMessageBatchResponse'" PrefixI True) (S1 (MetaSel (Just "_dmbrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: (S1 (MetaSel (Just "_dmbrsSuccessful") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [DeleteMessageBatchResultEntry]) :*: S1 (MetaSel (Just "_dmbrsFailed") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [BatchResultErrorEntry]))))

Response Lenses