Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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 .
Synopsis
- publish :: Text -> Publish
- data Publish
- pSubject :: Lens' Publish (Maybe Text)
- pTargetARN :: Lens' Publish (Maybe Text)
- pMessageAttributes :: Lens' Publish (HashMap Text MessageAttributeValue)
- pTopicARN :: Lens' Publish (Maybe Text)
- pPhoneNumber :: Lens' Publish (Maybe Text)
- pMessageStructure :: Lens' Publish (Maybe Text)
- pMessage :: Lens' Publish Text
- publishResponse :: Int -> PublishResponse
- data PublishResponse
- prsMessageId :: Lens' PublishResponse (Maybe Text)
- prsResponseStatus :: Lens' PublishResponse Int
Creating a Request
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 theTargetArn
parameter, you must specify a value for thePhoneNumber
orTopicArn
parameters.pMessageAttributes
- Message attributes for Publish action.pTopicARN
- The topic you want to publish to. If you don't specify a value for theTopicArn
parameter, you must specify a value for thePhoneNumber
orTargetArn
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 thePhoneNumber
parameter, you must specify a value for theTargetArn
orTopicArn
parameters.pMessageStructure
- SetMessageStructure
tojson
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 setMessageStructure
tojson
, the value of theMessage
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 theMessageStructure
parameter tojson
and use a JSON object for theMessage
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 thePublish
call to return an error (no partial delivery).
Input for Publish action.
See: publish
smart constructor.
Instances
Request Lenses
pSubject :: Lens' Publish (Maybe Text) Source #
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) Source #
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) Source #
Message attributes for Publish action.
pTopicARN :: Lens' Publish (Maybe Text) Source #
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) Source #
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) Source #
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 Source #
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
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 charactersprsResponseStatus
- -- | The response status code.
data PublishResponse Source #
Response for Publish action.
See: publishResponse
smart constructor.
Instances
Response Lenses
prsMessageId :: Lens' PublishResponse (Maybe Text) Source #
Unique identifier assigned to the published message. Length Constraint: Maximum 100 characters
prsResponseStatus :: Lens' PublishResponse Int Source #
- - | The response status code.