Network.AWS.SNS.Publish

Sends a message to all of a topic's subscribed endpoints. When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it to the topic's subscribers shortly. The format of the outgoing message to each subscribed endpoint depends on the notification protocol.

To use the Publish action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action.

For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices .

Creating a Request

publish

Arguments

:: Text

pMessage

-> Publish

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

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

• pSubject - Optional parameter to be used as the Subject line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints. Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
• pTargetARN - Either TopicArn or EndpointArn, but not both. If you don't specify a value for the TargetArn parameter, you must specify a value for the PhoneNumber or TopicArn parameters.
• pMessageAttributes - Message attributes for Publish action.
• pTopicARN - The topic you want to publish to. If you don't specify a value for the TopicArn parameter, you must specify a value for the PhoneNumber or TargetArn parameters.
• pPhoneNumber - The phone number to which you want to deliver an SMS message. Use E.164 format. If you don't specify a value for the PhoneNumber parameter, you must specify a value for the TargetArn or TopicArn parameters.
• pMessageStructure - Set MessageStructure to json if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set MessageStructure to json , the value of the Message parameter must: * be a syntactically valid JSON object; and * contain at least a top-level JSON key of "default" with a value that is a string. You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http"). For information about sending different messages for each protocol using the AWS Management Console, go to Create Different Messages for Each Protocol in the Amazon Simple Notification Service Getting Started Guide . Valid value: json
• pMessage - The message you want to send to the topic. If you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the MessageStructure parameter to json and use a JSON object for the Message parameter. Constraints: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 characters). JSON-specific constraints: * Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values. * The values will be parsed (unescaped) before they are used in outgoing messages. * Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending). * Values have a minimum length of 0 (the empty string, "", is allowed). * Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes). * Non-string values will cause the key to be ignored. * Keys that do not correspond to supported transport protocols are ignored. * Duplicate keys are not allowed. * Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).

data Publish

Input for Publish action.

See: publish smart constructor.

Instances

Eq Publish

Methods

(==) :: Publish -> Publish -> Bool

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

Data Publish

Methods

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

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

toConstr :: Publish -> Constr

dataTypeOf :: Publish -> DataType

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

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

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

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

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

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

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

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

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

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

Read Publish

Methods

readsPrec :: Int -> ReadS Publish

readList :: ReadS [Publish]

readPrec :: ReadPrec Publish

readListPrec :: ReadPrec [Publish]

Show Publish

Methods

showsPrec :: Int -> Publish -> ShowS

show :: Publish -> String

showList :: [Publish] -> ShowS

Generic Publish

Associated Types

type Rep Publish :: * -> *

Methods

from :: Publish -> Rep Publish x

to :: Rep Publish x -> Publish

Hashable Publish

Methods

hashWithSalt :: Int -> Publish -> Int

hash :: Publish -> Int

NFData Publish

Methods

rnf :: Publish -> ()

AWSRequest Publish

Associated Types

type Rs Publish :: *

Methods

request :: Publish -> Request Publish

response :: MonadResource m => Logger -> Service -> Proxy * Publish -> ClientResponse -> m (Response Publish)

ToPath Publish

Methods

toPath :: Publish -> ByteString

ToHeaders Publish

Methods

toHeaders :: Publish -> [Header]

ToQuery Publish

Methods

toQuery :: Publish -> QueryString

type Rep Publish

type Rep Publish = D1 (MetaData "Publish" "Network.AWS.SNS.Publish" "amazonka-sns-1.4.5-7z1IKGgp5pQiBwmhfc0Yz" False) (C1 (MetaCons "Publish'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_pSubject") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_pTargetARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_pMessageAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text MessageAttributeValue)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_pTopicARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_pPhoneNumber") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_pMessageStructure") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_pMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs Publish

type Rs Publish = PublishResponse

Request Lenses

pSubject :: Lens' Publish (Maybe Text)

Optional parameter to be used as the Subject line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints. Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.

pTargetARN :: Lens' Publish (Maybe Text)

Either TopicArn or EndpointArn, but not both. If you don't specify a value for the TargetArn parameter, you must specify a value for the PhoneNumber or TopicArn parameters.

pMessageAttributes :: Lens' Publish (HashMap Text MessageAttributeValue)

Message attributes for Publish action.

pTopicARN :: Lens' Publish (Maybe Text)

The topic you want to publish to. If you don't specify a value for the TopicArn parameter, you must specify a value for the PhoneNumber or TargetArn parameters.

pPhoneNumber :: Lens' Publish (Maybe Text)

The phone number to which you want to deliver an SMS message. Use E.164 format. If you don't specify a value for the PhoneNumber parameter, you must specify a value for the TargetArn or TopicArn parameters.

pMessageStructure :: Lens' Publish (Maybe Text)

Set MessageStructure to json if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set MessageStructure to json , the value of the Message parameter must: * be a syntactically valid JSON object; and * contain at least a top-level JSON key of "default" with a value that is a string. You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http"). For information about sending different messages for each protocol using the AWS Management Console, go to Create Different Messages for Each Protocol in the Amazon Simple Notification Service Getting Started Guide . Valid value: json

pMessage :: Lens' Publish Text

The message you want to send to the topic. If you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the MessageStructure parameter to json and use a JSON object for the Message parameter. Constraints: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 characters). JSON-specific constraints: * Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values. * The values will be parsed (unescaped) before they are used in outgoing messages. * Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending). * Values have a minimum length of 0 (the empty string, "", is allowed). * Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes). * Non-string values will cause the key to be ignored. * Keys that do not correspond to supported transport protocols are ignored. * Duplicate keys are not allowed. * Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).

Destructuring the Response

publishResponse

Arguments

:: Int

prsResponseStatus

-> PublishResponse

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

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

• prsMessageId - Unique identifier assigned to the published message. Length Constraint: Maximum 100 characters
• prsResponseStatus - -- | The response status code.

data PublishResponse

Response for Publish action.

See: publishResponse smart constructor.

Instances

Eq PublishResponse

Methods

(==) :: PublishResponse -> PublishResponse -> Bool

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

Data PublishResponse

Methods

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

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

toConstr :: PublishResponse -> Constr

dataTypeOf :: PublishResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read PublishResponse

Methods

readsPrec :: Int -> ReadS PublishResponse

readList :: ReadS [PublishResponse]

readPrec :: ReadPrec PublishResponse

readListPrec :: ReadPrec [PublishResponse]

Show PublishResponse

Methods

showsPrec :: Int -> PublishResponse -> ShowS

show :: PublishResponse -> String

showList :: [PublishResponse] -> ShowS

Generic PublishResponse

Associated Types

type Rep PublishResponse :: * -> *

Methods

from :: PublishResponse -> Rep PublishResponse x

to :: Rep PublishResponse x -> PublishResponse

NFData PublishResponse

Methods

rnf :: PublishResponse -> ()

type Rep PublishResponse

type Rep PublishResponse = D1 (MetaData "PublishResponse" "Network.AWS.SNS.Publish" "amazonka-sns-1.4.5-7z1IKGgp5pQiBwmhfc0Yz" False) (C1 (MetaCons "PublishResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_prsMessageId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_prsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

prsMessageId :: Lens' PublishResponse (Maybe Text)

Unique identifier assigned to the published message. Length Constraint: Maximum 100 characters

prsResponseStatus :: Lens' PublishResponse Int

• - | The response status code.