Amazonka.SNS.PublishBatch

Publishes up to ten messages to the specified topic. This is a batch version of Publish. For FIFO topics, multiple messages within a single batch are published in the order they are sent, and messages are deduplicated within the batch and across batches for 5 minutes.

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

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

If you send a batch message to a topic, Amazon SNS publishes the batch message to each endpoint that is subscribed to the topic. The format of the batch message depends on the notification protocol for each subscribed endpoint.

When a messageId is returned, the batch message is saved and Amazon SNS immediately delivers the message to subscribers.

Creating a Request

data PublishBatch

See: newPublishBatch smart constructor.

Constructors

PublishBatch'

Fields

• topicArn :: Text

  The Amazon resource name (ARN) of the topic you want to batch publish to.

• publishBatchRequestEntries :: [PublishBatchRequestEntry]

  A list of PublishBatch request entries to be sent to the SNS topic.

Instances

ToHeaders PublishBatch

Defined in Amazonka.SNS.PublishBatch

Methods

toHeaders :: PublishBatch -> [Header]

ToPath PublishBatch

Defined in Amazonka.SNS.PublishBatch

Methods

toPath :: PublishBatch -> ByteString

ToQuery PublishBatch

Defined in Amazonka.SNS.PublishBatch

Methods

toQuery :: PublishBatch -> QueryString

AWSRequest PublishBatch

Defined in Amazonka.SNS.PublishBatch

Associated Types

type AWSResponse PublishBatch

Methods

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

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

Generic PublishBatch

Defined in Amazonka.SNS.PublishBatch

Associated Types

type Rep PublishBatch :: Type -> Type

Methods

from :: PublishBatch -> Rep PublishBatch x

to :: Rep PublishBatch x -> PublishBatch

Read PublishBatch

Defined in Amazonka.SNS.PublishBatch

Methods

readsPrec :: Int -> ReadS PublishBatch

readList :: ReadS [PublishBatch]

readPrec :: ReadPrec PublishBatch

readListPrec :: ReadPrec [PublishBatch]

Show PublishBatch

Defined in Amazonka.SNS.PublishBatch

Methods

showsPrec :: Int -> PublishBatch -> ShowS

show :: PublishBatch -> String

showList :: [PublishBatch] -> ShowS

NFData PublishBatch

Defined in Amazonka.SNS.PublishBatch

Methods

rnf :: PublishBatch -> ()

Eq PublishBatch

Defined in Amazonka.SNS.PublishBatch

Methods

(==) :: PublishBatch -> PublishBatch -> Bool

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

Hashable PublishBatch

Defined in Amazonka.SNS.PublishBatch

Methods

hashWithSalt :: Int -> PublishBatch -> Int

hash :: PublishBatch -> Int

type AWSResponse PublishBatch

Defined in Amazonka.SNS.PublishBatch

type AWSResponse PublishBatch = PublishBatchResponse

type Rep PublishBatch

Defined in Amazonka.SNS.PublishBatch

type Rep PublishBatch = D1 ('MetaData "PublishBatch" "Amazonka.SNS.PublishBatch" "amazonka-sns-2.0-4k7AiJI7DyqhOUy5o4qb9" 'False) (C1 ('MetaCons "PublishBatch'" 'PrefixI 'True) (S1 ('MetaSel ('Just "topicArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "publishBatchRequestEntries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [PublishBatchRequestEntry])))

newPublishBatch

Arguments

:: Text

PublishBatch

-> PublishBatch

Create a value of PublishBatch 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:

PublishBatch, publishBatch_topicArn - The Amazon resource name (ARN) of the topic you want to batch publish to.

$sel:publishBatchRequestEntries:PublishBatch', publishBatch_publishBatchRequestEntries - A list of PublishBatch request entries to be sent to the SNS topic.

Request Lenses

publishBatch_topicArn :: Lens' PublishBatch Text

The Amazon resource name (ARN) of the topic you want to batch publish to.

publishBatch_publishBatchRequestEntries :: Lens' PublishBatch [PublishBatchRequestEntry]

A list of PublishBatch request entries to be sent to the SNS topic.

Destructuring the Response

data PublishBatchResponse

See: newPublishBatchResponse smart constructor.

Constructors

PublishBatchResponse'

Fields

• failed :: Maybe [BatchResultErrorEntry]

  A list of failed PublishBatch responses.

• successful :: Maybe [PublishBatchResultEntry]

  A list of successful PublishBatch responses.

• httpStatus :: Int

  The response's http status code.

Instances

Generic PublishBatchResponse

Defined in Amazonka.SNS.PublishBatch

Associated Types

type Rep PublishBatchResponse :: Type -> Type

Methods

from :: PublishBatchResponse -> Rep PublishBatchResponse x

to :: Rep PublishBatchResponse x -> PublishBatchResponse

Read PublishBatchResponse

Defined in Amazonka.SNS.PublishBatch

Methods

readsPrec :: Int -> ReadS PublishBatchResponse

readList :: ReadS [PublishBatchResponse]

readPrec :: ReadPrec PublishBatchResponse

readListPrec :: ReadPrec [PublishBatchResponse]

Show PublishBatchResponse

Defined in Amazonka.SNS.PublishBatch

Methods

showsPrec :: Int -> PublishBatchResponse -> ShowS

show :: PublishBatchResponse -> String

showList :: [PublishBatchResponse] -> ShowS

NFData PublishBatchResponse

Defined in Amazonka.SNS.PublishBatch

Methods

rnf :: PublishBatchResponse -> ()

Eq PublishBatchResponse

Defined in Amazonka.SNS.PublishBatch

Methods

(==) :: PublishBatchResponse -> PublishBatchResponse -> Bool

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

type Rep PublishBatchResponse

Defined in Amazonka.SNS.PublishBatch

type Rep PublishBatchResponse = D1 ('MetaData "PublishBatchResponse" "Amazonka.SNS.PublishBatch" "amazonka-sns-2.0-4k7AiJI7DyqhOUy5o4qb9" 'False) (C1 ('MetaCons "PublishBatchResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "failed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BatchResultErrorEntry])) :*: (S1 ('MetaSel ('Just "successful") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PublishBatchResultEntry])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newPublishBatchResponse

Arguments

:: Int

$sel:httpStatus:PublishBatchResponse'

-> PublishBatchResponse

Create a value of PublishBatchResponse 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:failed:PublishBatchResponse', publishBatchResponse_failed - A list of failed PublishBatch responses.

$sel:successful:PublishBatchResponse', publishBatchResponse_successful - A list of successful PublishBatch responses.

$sel:httpStatus:PublishBatchResponse', publishBatchResponse_httpStatus - The response's http status code.

Response Lenses

publishBatchResponse_failed :: Lens' PublishBatchResponse (Maybe [BatchResultErrorEntry])

A list of failed PublishBatch responses.

publishBatchResponse_successful :: Lens' PublishBatchResponse (Maybe [PublishBatchResultEntry])

A list of successful PublishBatch responses.

publishBatchResponse_httpStatus :: Lens' PublishBatchResponse Int

The response's http status code.