AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a
phone number, or a message to a mobile platform endpoint (when you specify the TargetArn).
If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint.
When a messageId is returned, the message is saved and Amazon SNS immediately
delivers it to subscribers.
To use the Publish action for publishing 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.
You can publish messages only to topics and endpoints in the same Amazon Web Services Region.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginPublish and EndPublish.
Namespace: Amazon.SimpleNotificationService
Assembly: AWSSDK.SimpleNotificationService.dll
Version: 3.x.y.z
public abstract Task<PublishResponse> PublishAsync( String topicArn, String message, CancellationToken cancellationToken )
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.
The message you want to send. If you are publishing to a topic and 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: With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters). For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters. If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries. The total size limit for a single SMS Publish action is 1,600 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).
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| AuthorizationErrorException | Indicates that the user has been denied access to the requested resource. |
| EndpointDisabledException | Exception error indicating endpoint disabled. |
| InternalErrorException | Indicates an internal service error. |
| InvalidParameterException | Indicates that a request parameter does not comply with the associated constraints. |
| InvalidParameterValueException | Indicates that a request parameter does not comply with the associated constraints. |
| InvalidSecurityException | The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. |
| KMSAccessDeniedException | The ciphertext references a key that doesn't exist or that you don't have access to. |
| KMSDisabledException | The request was rejected because the specified Amazon Web Services KMS key isn't enabled. |
| KMSInvalidStateException | The request was rejected because the state of the specified resource isn't valid for this request. For more information, see Key states of Amazon Web Services KMS keys in the Key Management Service Developer Guide. |
| KMSNotFoundException | The request was rejected because the specified entity or resource can't be found. |
| KMSOptInRequiredException | The Amazon Web Services access key ID needs a subscription for the service. |
| KMSThrottlingException | The request was denied due to request throttling. For more information about throttling, see Limits in the Key Management Service Developer Guide. |
| NotFoundException | Indicates that the requested resource does not exist. |
| PlatformApplicationDisabledException | Exception error indicating platform application disabled. |
| ValidationException | Indicates that a parameter in the request is invalid. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5