Amazonka.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).

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.

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 SendMessageBatch

See: newSendMessageBatch smart constructor.

Constructors

SendMessageBatch'

Fields

• queueUrl :: Text

  The URL of the Amazon SQS queue to which batched messages are sent.

  Queue URLs and names are case-sensitive.

• entries :: [SendMessageBatchRequestEntry]

  A list of SendMessageBatchRequestEntry items.

Instances

ToHeaders SendMessageBatch

Defined in Amazonka.SQS.SendMessageBatch

Methods

toHeaders :: SendMessageBatch -> [Header]

ToPath SendMessageBatch

Defined in Amazonka.SQS.SendMessageBatch

Methods

toPath :: SendMessageBatch -> ByteString

ToQuery SendMessageBatch

Defined in Amazonka.SQS.SendMessageBatch

Methods

toQuery :: SendMessageBatch -> QueryString

AWSRequest SendMessageBatch

Defined in Amazonka.SQS.SendMessageBatch

Associated Types

type AWSResponse SendMessageBatch

Methods

request :: (Service -> Service) -> SendMessageBatch -> Request SendMessageBatch

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SendMessageBatch -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SendMessageBatch)))

Generic SendMessageBatch

Defined in Amazonka.SQS.SendMessageBatch

Associated Types

type Rep SendMessageBatch :: Type -> Type

Methods

from :: SendMessageBatch -> Rep SendMessageBatch x

to :: Rep SendMessageBatch x -> SendMessageBatch

Read SendMessageBatch

Defined in Amazonka.SQS.SendMessageBatch

Methods

readsPrec :: Int -> ReadS SendMessageBatch

readList :: ReadS [SendMessageBatch]

readPrec :: ReadPrec SendMessageBatch

readListPrec :: ReadPrec [SendMessageBatch]

Show SendMessageBatch

Defined in Amazonka.SQS.SendMessageBatch

Methods

showsPrec :: Int -> SendMessageBatch -> ShowS

show :: SendMessageBatch -> String

showList :: [SendMessageBatch] -> ShowS

NFData SendMessageBatch

Defined in Amazonka.SQS.SendMessageBatch

Methods

rnf :: SendMessageBatch -> ()

Eq SendMessageBatch

Defined in Amazonka.SQS.SendMessageBatch

Methods

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

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

Hashable SendMessageBatch

Defined in Amazonka.SQS.SendMessageBatch

Methods

hashWithSalt :: Int -> SendMessageBatch -> Int

hash :: SendMessageBatch -> Int

type AWSResponse SendMessageBatch

Defined in Amazonka.SQS.SendMessageBatch

type AWSResponse SendMessageBatch = SendMessageBatchResponse

type Rep SendMessageBatch

Defined in Amazonka.SQS.SendMessageBatch

type Rep SendMessageBatch = D1 ('MetaData "SendMessageBatch" "Amazonka.SQS.SendMessageBatch" "amazonka-sqs-2.0-8jRKm0MCN6JIBFunCpUxaV" 'False) (C1 ('MetaCons "SendMessageBatch'" 'PrefixI 'True) (S1 ('MetaSel ('Just "queueUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "entries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [SendMessageBatchRequestEntry])))

newSendMessageBatch

Arguments

:: Text

$sel:queueUrl:SendMessageBatch'

-> SendMessageBatch

Create a value of SendMessageBatch 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:SendMessageBatch', sendMessageBatch_queueUrl - The URL of the Amazon SQS queue to which batched messages are sent.

Queue URLs and names are case-sensitive.

$sel:entries:SendMessageBatch', sendMessageBatch_entries - A list of SendMessageBatchRequestEntry items.

Request Lenses

sendMessageBatch_queueUrl :: Lens' SendMessageBatch Text

The URL of the Amazon SQS queue to which batched messages are sent.

Queue URLs and names are case-sensitive.

sendMessageBatch_entries :: Lens' SendMessageBatch [SendMessageBatchRequestEntry]

A list of SendMessageBatchRequestEntry items.

Destructuring the Response

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

Constructors

SendMessageBatchResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• successful :: [SendMessageBatchResultEntry]

  A list of SendMessageBatchResultEntry items.

• failed :: [BatchResultErrorEntry]

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

Instances

Generic SendMessageBatchResponse

Defined in Amazonka.SQS.SendMessageBatch

Associated Types

type Rep SendMessageBatchResponse :: Type -> Type

Methods

from :: SendMessageBatchResponse -> Rep SendMessageBatchResponse x

to :: Rep SendMessageBatchResponse x -> SendMessageBatchResponse

Read SendMessageBatchResponse

Defined in Amazonka.SQS.SendMessageBatch

Methods

readsPrec :: Int -> ReadS SendMessageBatchResponse

readList :: ReadS [SendMessageBatchResponse]

readPrec :: ReadPrec SendMessageBatchResponse

readListPrec :: ReadPrec [SendMessageBatchResponse]

Show SendMessageBatchResponse

Defined in Amazonka.SQS.SendMessageBatch

Methods

showsPrec :: Int -> SendMessageBatchResponse -> ShowS

show :: SendMessageBatchResponse -> String

showList :: [SendMessageBatchResponse] -> ShowS

NFData SendMessageBatchResponse

Defined in Amazonka.SQS.SendMessageBatch

Methods

rnf :: SendMessageBatchResponse -> ()

Eq SendMessageBatchResponse

Defined in Amazonka.SQS.SendMessageBatch

Methods

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

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

type Rep SendMessageBatchResponse

Defined in Amazonka.SQS.SendMessageBatch

type Rep SendMessageBatchResponse = D1 ('MetaData "SendMessageBatchResponse" "Amazonka.SQS.SendMessageBatch" "amazonka-sqs-2.0-8jRKm0MCN6JIBFunCpUxaV" 'False) (C1 ('MetaCons "SendMessageBatchResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "successful") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [SendMessageBatchResultEntry]) :*: S1 ('MetaSel ('Just "failed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [BatchResultErrorEntry]))))

newSendMessageBatchResponse

Arguments

:: Int

$sel:httpStatus:SendMessageBatchResponse'

-> SendMessageBatchResponse

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

$sel:successful:SendMessageBatchResponse', sendMessageBatchResponse_successful - A list of SendMessageBatchResultEntry items.

$sel:failed:SendMessageBatchResponse', sendMessageBatchResponse_failed - A list of BatchResultErrorEntry items with error details about each message that can't be enqueued.

Response Lenses

sendMessageBatchResponse_httpStatus :: Lens' SendMessageBatchResponse Int

The response's http status code.

sendMessageBatchResponse_successful :: Lens' SendMessageBatchResponse [SendMessageBatchResultEntry]

A list of SendMessageBatchResultEntry items.

sendMessageBatchResponse_failed :: Lens' SendMessageBatchResponse [BatchResultErrorEntry]

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