Network.AWS.SQS.DeleteMessageBatch

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 .

Creating a Request

deleteMessageBatch

Arguments

:: Text

dmbQueueURL

-> DeleteMessageBatch

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

See: deleteMessageBatch smart constructor.

Instances

Eq DeleteMessageBatch

Methods

(==) :: DeleteMessageBatch -> DeleteMessageBatch -> Bool

(/=) :: DeleteMessageBatch -> DeleteMessageBatch -> Bool

Data 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

Methods

readsPrec :: Int -> ReadS DeleteMessageBatch

readList :: ReadS [DeleteMessageBatch]

readPrec :: ReadPrec DeleteMessageBatch

readListPrec :: ReadPrec [DeleteMessageBatch]

Show DeleteMessageBatch

Methods

showsPrec :: Int -> DeleteMessageBatch -> ShowS

show :: DeleteMessageBatch -> String

showList :: [DeleteMessageBatch] -> ShowS

Generic DeleteMessageBatch

Associated Types

type Rep DeleteMessageBatch :: * -> *

Methods

from :: DeleteMessageBatch -> Rep DeleteMessageBatch x

to :: Rep DeleteMessageBatch x -> DeleteMessageBatch

Hashable DeleteMessageBatch

Methods

hashWithSalt :: Int -> DeleteMessageBatch -> Int

hash :: DeleteMessageBatch -> Int

NFData DeleteMessageBatch

Methods

rnf :: DeleteMessageBatch -> ()

AWSRequest DeleteMessageBatch

Associated Types

type Rs DeleteMessageBatch :: *

Methods

request :: DeleteMessageBatch -> Request DeleteMessageBatch

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DeleteMessageBatch -> ClientResponse -> m (Response DeleteMessageBatch)

ToHeaders DeleteMessageBatch

Methods

toHeaders :: DeleteMessageBatch -> [Header]

ToPath DeleteMessageBatch

Methods

toPath :: DeleteMessageBatch -> ByteString

ToQuery DeleteMessageBatch

Methods

toQuery :: DeleteMessageBatch -> QueryString

type Rep DeleteMessageBatch

type Rep DeleteMessageBatch = D1 * (MetaData "DeleteMessageBatch" "Network.AWS.SQS.DeleteMessageBatch" "amazonka-sqs-1.6.0-DuRwgQrS7rECvw8esNFZsJ" False) (C1 * (MetaCons "DeleteMessageBatch'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dmbQueueURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_dmbEntries") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [DeleteMessageBatchRequestEntry]))))

type Rs DeleteMessageBatch

type Rs DeleteMessageBatch = DeleteMessageBatchResponse

Request Lenses

dmbQueueURL :: Lens' DeleteMessageBatch Text

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

dmbEntries :: Lens' DeleteMessageBatch [DeleteMessageBatchRequestEntry]

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

Destructuring the Response

deleteMessageBatchResponse

Arguments

:: Int

dmbrsResponseStatus

-> DeleteMessageBatchResponse

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:

• dmbrsResponseStatus - -- | The response status code.
• dmbrsSuccessful - A list of DeleteMessageBatchResultEntry items.
• dmbrsFailed - A list of BatchResultErrorEntry items.

data DeleteMessageBatchResponse

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

Methods

(==) :: DeleteMessageBatchResponse -> DeleteMessageBatchResponse -> Bool

(/=) :: DeleteMessageBatchResponse -> DeleteMessageBatchResponse -> Bool

Data DeleteMessageBatchResponse

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

Methods

readsPrec :: Int -> ReadS DeleteMessageBatchResponse

readList :: ReadS [DeleteMessageBatchResponse]

readPrec :: ReadPrec DeleteMessageBatchResponse

readListPrec :: ReadPrec [DeleteMessageBatchResponse]

Show DeleteMessageBatchResponse

Methods

showsPrec :: Int -> DeleteMessageBatchResponse -> ShowS

show :: DeleteMessageBatchResponse -> String

showList :: [DeleteMessageBatchResponse] -> ShowS

Generic DeleteMessageBatchResponse

Associated Types

type Rep DeleteMessageBatchResponse :: * -> *

Methods

from :: DeleteMessageBatchResponse -> Rep DeleteMessageBatchResponse x

to :: Rep DeleteMessageBatchResponse x -> DeleteMessageBatchResponse

NFData DeleteMessageBatchResponse

Methods

rnf :: DeleteMessageBatchResponse -> ()

type Rep DeleteMessageBatchResponse

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

Response Lenses

dmbrsResponseStatus :: Lens' DeleteMessageBatchResponse Int

• - | The response status code.

dmbrsSuccessful :: Lens' DeleteMessageBatchResponse [DeleteMessageBatchResultEntry]

A list of DeleteMessageBatchResultEntry items.

dmbrsFailed :: Lens' DeleteMessageBatchResponse [BatchResultErrorEntry]

A list of BatchResultErrorEntry items.