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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

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.

Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

&AttributeName.1=first

&AttributeName.2=second

Creating a Request

data DeleteMessageBatch Source #

See: newDeleteMessageBatch smart constructor.

Constructors

DeleteMessageBatch'
Fields queueUrl :: Text The URL of the Amazon SQS queue from which messages are deleted. Queue URLs and names are case-sensitive. entries :: [DeleteMessageBatchRequestEntry] A list of receipt handles for the messages to be deleted.

Instances

Instances details

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

newDeleteMessageBatch Source #

Arguments

:: Text	`$sel:queueUrl:DeleteMessageBatch'`
-> DeleteMessageBatch

Create a value of DeleteMessageBatch 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:DeleteMessageBatch', deleteMessageBatch_queueUrl - The URL of the Amazon SQS queue from which messages are deleted.

Queue URLs and names are case-sensitive.

$sel:entries:DeleteMessageBatch', deleteMessageBatch_entries - A list of receipt handles for the messages to be deleted.

Request Lenses

deleteMessageBatch_queueUrl :: Lens' DeleteMessageBatch Text Source #

The URL of the Amazon SQS queue from which messages are deleted.

Queue URLs and names are case-sensitive.

deleteMessageBatch_entries :: Lens' DeleteMessageBatch [DeleteMessageBatchRequestEntry] Source #

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

Destructuring the Response

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: newDeleteMessageBatchResponse smart constructor.

Constructors

DeleteMessageBatchResponse'
Fields httpStatus :: Int The response's http status code. successful :: [DeleteMessageBatchResultEntry] A list of `DeleteMessageBatchResultEntry` items. failed :: [BatchResultErrorEntry] A list of `BatchResultErrorEntry` items.

Instances

Instances details

Generic DeleteMessageBatchResponse Source #
Instance details Defined in Amazonka.SQS.DeleteMessageBatch Associated Types type Rep DeleteMessageBatchResponse :: Type -> Type # Methods from :: DeleteMessageBatchResponse -> Rep DeleteMessageBatchResponse x # to :: Rep DeleteMessageBatchResponse x -> DeleteMessageBatchResponse #
Read DeleteMessageBatchResponse Source #
Instance details Defined in Amazonka.SQS.DeleteMessageBatch Methods readsPrec :: Int -> ReadS DeleteMessageBatchResponse # readList :: ReadS [DeleteMessageBatchResponse] # readPrec :: ReadPrec DeleteMessageBatchResponse # readListPrec :: ReadPrec [DeleteMessageBatchResponse] #
Show DeleteMessageBatchResponse Source #
Instance details Defined in Amazonka.SQS.DeleteMessageBatch Methods showsPrec :: Int -> DeleteMessageBatchResponse -> ShowS # show :: DeleteMessageBatchResponse -> String # showList :: [DeleteMessageBatchResponse] -> ShowS #
NFData DeleteMessageBatchResponse Source #
Instance details Defined in Amazonka.SQS.DeleteMessageBatch Methods rnf :: DeleteMessageBatchResponse -> () #
Eq DeleteMessageBatchResponse Source #
Instance details Defined in Amazonka.SQS.DeleteMessageBatch Methods (==) :: DeleteMessageBatchResponse -> DeleteMessageBatchResponse -> Bool # (/=) :: DeleteMessageBatchResponse -> DeleteMessageBatchResponse -> Bool #
type Rep DeleteMessageBatchResponse Source #
Instance details Defined in Amazonka.SQS.DeleteMessageBatch type Rep DeleteMessageBatchResponse = D1 ('MetaData "DeleteMessageBatchResponse" "Amazonka.SQS.DeleteMessageBatch" "amazonka-sqs-2.0-8jRKm0MCN6JIBFunCpUxaV" 'False) (C1 ('MetaCons "DeleteMessageBatchResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "successful") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [DeleteMessageBatchResultEntry]) :: S1 ('MetaSel ('Just "failed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [BatchResultErrorEntry]))))

newDeleteMessageBatchResponse Source #

Arguments

:: Int	`$sel:httpStatus:DeleteMessageBatchResponse'`
-> DeleteMessageBatchResponse

Create a value of DeleteMessageBatchResponse 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:httpStatus:DeleteMessageBatchResponse', deleteMessageBatchResponse_httpStatus - The response's http status code.

$sel:successful:DeleteMessageBatchResponse', deleteMessageBatchResponse_successful - A list of DeleteMessageBatchResultEntry items.

$sel:failed:DeleteMessageBatchResponse', deleteMessageBatchResponse_failed - A list of BatchResultErrorEntry items.

Response Lenses

deleteMessageBatchResponse_httpStatus :: Lens' DeleteMessageBatchResponse Int Source #

The response's http status code.

deleteMessageBatchResponse_successful :: Lens' DeleteMessageBatchResponse [DeleteMessageBatchResultEntry] Source #

A list of DeleteMessageBatchResultEntry items.

deleteMessageBatchResponse_failed :: Lens' DeleteMessageBatchResponse [BatchResultErrorEntry] Source #

A list of BatchResultErrorEntry items.