Network.AWS.SQS.SendMessageBatch

Delivers up to ten messages to the specified queue. This is a batch version of SendMessage . For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent.

The result of sending 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 .

The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).

Important: A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:

#x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF

Any characters not included in this list will be rejected. For more information, see the W3C specification for characters .

If you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses the default value for the queue.

Creating a Request

sendMessageBatch

Arguments

:: Text

smbQueueURL

-> SendMessageBatch

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

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

• smbQueueURL - The URL of the Amazon SQS queue to which batched messages are sent. Queue URLs are case-sensitive.
• smbEntries - A list of SendMessageBatchRequestEntry items.

data SendMessageBatch

See: sendMessageBatch smart constructor.

Instances

Eq SendMessageBatch

Methods

(==) :: SendMessageBatch -> SendMessageBatch -> Bool

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

Data SendMessageBatch

Methods

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

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

toConstr :: SendMessageBatch -> Constr

dataTypeOf :: SendMessageBatch -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> SendMessageBatch -> SendMessageBatch

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

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

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

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

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

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

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

Read SendMessageBatch

Methods

readsPrec :: Int -> ReadS SendMessageBatch

readList :: ReadS [SendMessageBatch]

readPrec :: ReadPrec SendMessageBatch

readListPrec :: ReadPrec [SendMessageBatch]

Show SendMessageBatch

Methods

showsPrec :: Int -> SendMessageBatch -> ShowS

show :: SendMessageBatch -> String

showList :: [SendMessageBatch] -> ShowS

Generic SendMessageBatch

Associated Types

type Rep SendMessageBatch :: * -> *

Methods

from :: SendMessageBatch -> Rep SendMessageBatch x

to :: Rep SendMessageBatch x -> SendMessageBatch

Hashable SendMessageBatch

Methods

hashWithSalt :: Int -> SendMessageBatch -> Int

hash :: SendMessageBatch -> Int

NFData SendMessageBatch

Methods

rnf :: SendMessageBatch -> ()

AWSRequest SendMessageBatch

Associated Types

type Rs SendMessageBatch :: *

Methods

request :: SendMessageBatch -> Request SendMessageBatch

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

ToHeaders SendMessageBatch

Methods

toHeaders :: SendMessageBatch -> [Header]

ToPath SendMessageBatch

Methods

toPath :: SendMessageBatch -> ByteString

ToQuery SendMessageBatch

Methods

toQuery :: SendMessageBatch -> QueryString

type Rep SendMessageBatch

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

type Rs SendMessageBatch

type Rs SendMessageBatch = SendMessageBatchResponse

Request Lenses

smbQueueURL :: Lens' SendMessageBatch Text

The URL of the Amazon SQS queue to which batched messages are sent. Queue URLs are case-sensitive.

smbEntries :: Lens' SendMessageBatch [SendMessageBatchRequestEntry]

A list of SendMessageBatchRequestEntry items.

Destructuring the Response

sendMessageBatchResponse

Arguments

:: Int

smbrsResponseStatus

-> SendMessageBatchResponse

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

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

• smbrsResponseStatus - -- | The response status code.
• smbrsSuccessful - A list of SendMessageBatchResultEntry items.
• smbrsFailed - A list of BatchResultErrorEntry items with error details about each message that can't be enqueued.

data SendMessageBatchResponse

For each message in the batch, the response contains a SendMessageBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.

See: sendMessageBatchResponse smart constructor.

Instances

Eq SendMessageBatchResponse

Methods

(==) :: SendMessageBatchResponse -> SendMessageBatchResponse -> Bool

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

Data SendMessageBatchResponse

Methods

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

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

toConstr :: SendMessageBatchResponse -> Constr

dataTypeOf :: SendMessageBatchResponse -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> SendMessageBatchResponse -> SendMessageBatchResponse

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

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

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

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

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

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

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

Read SendMessageBatchResponse

Methods

readsPrec :: Int -> ReadS SendMessageBatchResponse

readList :: ReadS [SendMessageBatchResponse]

readPrec :: ReadPrec SendMessageBatchResponse

readListPrec :: ReadPrec [SendMessageBatchResponse]

Show SendMessageBatchResponse

Methods

showsPrec :: Int -> SendMessageBatchResponse -> ShowS

show :: SendMessageBatchResponse -> String

showList :: [SendMessageBatchResponse] -> ShowS

Generic SendMessageBatchResponse

Associated Types

type Rep SendMessageBatchResponse :: * -> *

Methods

from :: SendMessageBatchResponse -> Rep SendMessageBatchResponse x

to :: Rep SendMessageBatchResponse x -> SendMessageBatchResponse

NFData SendMessageBatchResponse

Methods

rnf :: SendMessageBatchResponse -> ()

type Rep SendMessageBatchResponse

type Rep SendMessageBatchResponse = D1 * (MetaData "SendMessageBatchResponse" "Network.AWS.SQS.SendMessageBatch" "amazonka-sqs-1.6.0-DuRwgQrS7rECvw8esNFZsJ" False) (C1 * (MetaCons "SendMessageBatchResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_smbrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) ((:*:) * (S1 * (MetaSel (Just Symbol "_smbrsSuccessful") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [SendMessageBatchResultEntry])) (S1 * (MetaSel (Just Symbol "_smbrsFailed") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [BatchResultErrorEntry])))))

Response Lenses

smbrsResponseStatus :: Lens' SendMessageBatchResponse Int

• - | The response status code.

smbrsSuccessful :: Lens' SendMessageBatchResponse [SendMessageBatchResultEntry]

A list of SendMessageBatchResultEntry items.

smbrsFailed :: Lens' SendMessageBatchResponse [BatchResultErrorEntry]

A list of BatchResultErrorEntry items with error details about each message that can't be enqueued.