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.
Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. Applications can use Amazon SNS to easily push real-time notification messages to interested subscribers over multiple delivery protocols. For more information about this product see http://aws.amazon.com/sns. For detailed information about Amazon SNS features and their associated API calls, see the Amazon SNS Developer Guide.
We also provide SDKs that enable you to access Amazon SNS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as: cryptographically signing your service requests, retrying requests, and handling error responses. For a list of available SDKs, go to Tools for Amazon Web Services.
Namespace: Amazon.SimpleNotificationService
Assembly: AWSSDK.dll
Version: (assembly version)
public class AmazonSimpleNotificationServiceClient : AmazonServiceClient IAmazonSimpleNotificationService, IDisposable
The AmazonSimpleNotificationServiceClient type exposes the following members
Name | Description | |
---|---|---|
AmazonSimpleNotificationServiceClient() |
Constructs AmazonSimpleNotificationServiceClient with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonSimpleNotificationServiceClient(RegionEndpoint) |
Constructs AmazonSimpleNotificationServiceClient with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonSimpleNotificationServiceClient(AmazonSimpleNotificationServiceConfig) |
Constructs AmazonSimpleNotificationServiceClient with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonSimpleNotificationServiceClient(AWSCredentials) | Constructs AmazonSimpleNotificationServiceClient with AWS Credentials | |
AmazonSimpleNotificationServiceClient(AWSCredentials, RegionEndpoint) | Constructs AmazonSimpleNotificationServiceClient with AWS Credentials | |
AmazonSimpleNotificationServiceClient(AWSCredentials, AmazonSimpleNotificationServiceConfig) | Constructs AmazonSimpleNotificationServiceClient with AWS Credentials and an AmazonSimpleNotificationServiceClient Configuration object. | |
AmazonSimpleNotificationServiceClient(string, string) | Constructs AmazonSimpleNotificationServiceClient with AWS Access Key ID and AWS Secret Key | |
AmazonSimpleNotificationServiceClient(string, string, RegionEndpoint) | Constructs AmazonSimpleNotificationServiceClient with AWS Access Key ID and AWS Secret Key | |
AmazonSimpleNotificationServiceClient(string, string, AmazonSimpleNotificationServiceConfig) | Constructs AmazonSimpleNotificationServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonSimpleNotificationServiceClient Configuration object. | |
AmazonSimpleNotificationServiceClient(string, string, string) | Constructs AmazonSimpleNotificationServiceClient with AWS Access Key ID and AWS Secret Key | |
AmazonSimpleNotificationServiceClient(string, string, string, RegionEndpoint) | Constructs AmazonSimpleNotificationServiceClient with AWS Access Key ID and AWS Secret Key | |
AmazonSimpleNotificationServiceClient(string, string, string, AmazonSimpleNotificationServiceConfig) | Constructs AmazonSimpleNotificationServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonSimpleNotificationServiceClient Configuration object. |
Name | Description | |
---|---|---|
AddPermission(string, string, List<String>, List<String>) | Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions. | |
AddPermission(AddPermissionRequest) | Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions. | |
AddPermissionAsync(AddPermissionRequest, CancellationToken) | Initiates the asynchronous execution of the AddPermission operation. | |
AuthorizeS3ToPublish(string, string) | This is a utility method which updates the policy of a topic to allow the S3 bucket to publish events to it. | |
ConfirmSubscription(string, string, string) |
Verifies an endpoint owner's intent to receive messages by validating the token
sent to the endpoint by an earlier Subscribe action. If the token
is valid, the action creates a new subscription and returns its Amazon Resource
Name (ARN). This call requires an AWS signature only when the AuthenticateOnUnsubscribe
flag is set to "true".
|
|
ConfirmSubscription(string, string) |
Verifies an endpoint owner's intent to receive messages by validating the token
sent to the endpoint by an earlier Subscribe action. If the token
is valid, the action creates a new subscription and returns its Amazon Resource
Name (ARN). This call requires an AWS signature only when the AuthenticateOnUnsubscribe
flag is set to "true".
|
|
ConfirmSubscription(ConfirmSubscriptionRequest) |
Verifies an endpoint owner's intent to receive messages by validating the token
sent to the endpoint by an earlier Subscribe action. If the token
is valid, the action creates a new subscription and returns its Amazon Resource
Name (ARN). This call requires an AWS signature only when the AuthenticateOnUnsubscribe
flag is set to "true".
|
|
ConfirmSubscriptionAsync(ConfirmSubscriptionRequest, CancellationToken) | Initiates the asynchronous execution of the ConfirmSubscription operation. | |
CreatePlatformApplication(CreatePlatformApplicationRequest) |
Creates a platform application object for one of the supported push notification services,
such as APNS and GCM, to which devices and mobile apps may register. You must
specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication
action. The PlatformPrincipal is received from the notification service. For APNS/APNS_SANDBOX,
PlatformPrincipal is "SSL certificate". For GCM, PlatformPrincipal is not applicable.
For ADM, PlatformPrincipal is "client id". The PlatformCredential is also received
from the notification service. For APNS/APNS_SANDBOX, PlatformCredential is
"private key". For GCM, PlatformCredential is "API key". For ADM, PlatformCredential
is "client secret". The PlatformApplicationArn that is returned when using
CreatePlatformApplication is then used as an attribute for the CreatePlatformEndpoint
action. For more information, see Using
Amazon SNS Mobile Push Notifications.
|
|
CreatePlatformApplicationAsync(CreatePlatformApplicationRequest, CancellationToken) | Initiates the asynchronous execution of the CreatePlatformApplication operation. | |
CreatePlatformEndpoint(CreatePlatformEndpointRequest) |
Creates an endpoint for a device and mobile app on one of the supported push notification
services, such as GCM and APNS. CreatePlatformEndpoint requires
the PlatformApplicationArn that is returned from CreatePlatformApplication .
The EndpointArn that is returned when using CreatePlatformEndpoint
can then be used by the Publish action to send a message to a mobile
app or by the Subscribe action for subscription to a topic. The
CreatePlatformEndpoint action is idempotent, so if the requester already
owns an endpoint with the same device token and attributes, that endpoint's
ARN is returned without creating a new endpoint. For more information, see Using Amazon SNS
Mobile Push Notifications.
When using |
|
CreatePlatformEndpointAsync(CreatePlatformEndpointRequest, CancellationToken) | Initiates the asynchronous execution of the CreatePlatformEndpoint operation. | |
CreateTopic(string) | Creates a topic to which notifications can be published. Users can create at most 3000 topics. For more information, see http://aws.amazon.com/sns. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic. | |
CreateTopic(CreateTopicRequest) | Creates a topic to which notifications can be published. Users can create at most 3000 topics. For more information, see http://aws.amazon.com/sns. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic. | |
CreateTopicAsync(CreateTopicRequest, CancellationToken) | Initiates the asynchronous execution of the CreateTopic operation. | |
DeleteEndpoint(DeleteEndpointRequest) | Deletes the endpoint from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications. | |
DeleteEndpointAsync(DeleteEndpointRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteEndpoint operation. | |
DeletePlatformApplication(DeletePlatformApplicationRequest) | Deletes a platform application object for one of the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications. | |
DeletePlatformApplicationAsync(DeletePlatformApplicationRequest, CancellationToken) | Initiates the asynchronous execution of the DeletePlatformApplication operation. | |
DeleteTopic(string) | Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error. | |
DeleteTopic(DeleteTopicRequest) | Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error. | |
DeleteTopicAsync(DeleteTopicRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteTopic operation. | |
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. | |
FindTopic(string) |
Finds an existing Amazon SNS topic by iterating all SNS topics until a match is found.
The ListTopics method is used to fetch upto 100 SNS topics at a time until a SNS topic
with an TopicArn that matches |
|
GetEndpointAttributes(GetEndpointAttributesRequest) | Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications. | |
GetEndpointAttributesAsync(GetEndpointAttributesRequest, CancellationToken) | Initiates the asynchronous execution of the GetEndpointAttributes operation. | |
GetPlatformApplicationAttributes(GetPlatformApplicationAttributesRequest) | Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications. | |
GetPlatformApplicationAttributesAsync(GetPlatformApplicationAttributesRequest, CancellationToken) | Initiates the asynchronous execution of the GetPlatformApplicationAttributes operation. | |
GetSubscriptionAttributes(string) | Returns all of the properties of a subscription. | |
GetSubscriptionAttributes(GetSubscriptionAttributesRequest) | Returns all of the properties of a subscription. | |
GetSubscriptionAttributesAsync(GetSubscriptionAttributesRequest, CancellationToken) | Initiates the asynchronous execution of the GetSubscriptionAttributes operation. | |
GetTopicAttributes(string) | Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user. | |
GetTopicAttributes(GetTopicAttributesRequest) | Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user. | |
GetTopicAttributesAsync(GetTopicAttributesRequest, CancellationToken) | Initiates the asynchronous execution of the GetTopicAttributes operation. | |
ListEndpointsByPlatformApplication(ListEndpointsByPlatformApplicationRequest) |
Lists the endpoints and endpoint attributes for devices in a supported push notification
service, such as GCM and APNS. The results for ListEndpointsByPlatformApplication
are paginated and return a limited list of endpoints, up to 100. If additional
records are available after the first page results, then a NextToken string will be
returned. To receive the next page, you call ListEndpointsByPlatformApplication
again using the NextToken string received from the previous call. When there
are no more records to return, NextToken will be null. For more information,
see Using Amazon
SNS Mobile Push Notifications.
|
|
ListEndpointsByPlatformApplicationAsync(ListEndpointsByPlatformApplicationRequest, CancellationToken) | Initiates the asynchronous execution of the ListEndpointsByPlatformApplication operation. | |
ListPlatformApplications() |
Lists the platform application objects for the supported push notification services,
such as APNS and GCM. The results for ListPlatformApplications
are paginated and return a limited list of applications, up to 100. If additional
records are available after the first page results, then a NextToken string will be
returned. To receive the next page, you call ListPlatformApplications
using the NextToken string received from the previous call. When there are no
more records to return, NextToken will be null. For more information, see
Using Amazon
SNS Mobile Push Notifications.
|
|
ListPlatformApplications(ListPlatformApplicationsRequest) |
Lists the platform application objects for the supported push notification services,
such as APNS and GCM. The results for ListPlatformApplications
are paginated and return a limited list of applications, up to 100. If additional
records are available after the first page results, then a NextToken string will be
returned. To receive the next page, you call ListPlatformApplications
using the NextToken string received from the previous call. When there are no
more records to return, NextToken will be null. For more information, see
Using Amazon
SNS Mobile Push Notifications.
|
|
ListPlatformApplicationsAsync(ListPlatformApplicationsRequest, CancellationToken) | Initiates the asynchronous execution of the ListPlatformApplications operation. | |
ListSubscriptions() |
Returns a list of the requester's subscriptions. Each call returns a limited list
of subscriptions, up to 100. If there are more subscriptions, a NextToken
is also returned. Use the NextToken parameter in a new ListSubscriptions
call to get further results.
|
|
ListSubscriptions(string) |
Returns a list of the requester's subscriptions. Each call returns a limited list
of subscriptions, up to 100. If there are more subscriptions, a NextToken
is also returned. Use the NextToken parameter in a new ListSubscriptions
call to get further results.
|
|
ListSubscriptions(ListSubscriptionsRequest) |
Returns a list of the requester's subscriptions. Each call returns a limited list
of subscriptions, up to 100. If there are more subscriptions, a NextToken
is also returned. Use the NextToken parameter in a new ListSubscriptions
call to get further results.
|
|
ListSubscriptionsAsync(ListSubscriptionsRequest, CancellationToken) | Initiates the asynchronous execution of the ListSubscriptions operation. | |
ListSubscriptionsByTopic(string, string) |
Returns a list of the subscriptions to a specific topic. Each call returns a
limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken
is also returned. Use the NextToken parameter in a new ListSubscriptionsByTopic
call to get further results.
|
|
ListSubscriptionsByTopic(string) |
Returns a list of the subscriptions to a specific topic. Each call returns a
limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken
is also returned. Use the NextToken parameter in a new ListSubscriptionsByTopic
call to get further results.
|
|
ListSubscriptionsByTopic(ListSubscriptionsByTopicRequest) |
Returns a list of the subscriptions to a specific topic. Each call returns a
limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken
is also returned. Use the NextToken parameter in a new ListSubscriptionsByTopic
call to get further results.
|
|
ListSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest, CancellationToken) | Initiates the asynchronous execution of the ListSubscriptionsByTopic operation. | |
ListTopics() |
Returns a list of the requester's topics. Each call returns a limited list of topics,
up to 100. If there are more topics, a NextToken is also returned.
Use the NextToken parameter in a new ListTopics call to
get further results.
|
|
ListTopics(string) |
Returns a list of the requester's topics. Each call returns a limited list of topics,
up to 100. If there are more topics, a NextToken is also returned.
Use the NextToken parameter in a new ListTopics call to
get further results.
|
|
ListTopics(ListTopicsRequest) |
Returns a list of the requester's topics. Each call returns a limited list of topics,
up to 100. If there are more topics, a NextToken is also returned.
Use the NextToken parameter in a new ListTopics call to
get further results.
|
|
ListTopicsAsync(ListTopicsRequest, CancellationToken) | Initiates the asynchronous execution of the ListTopics operation. | |
Publish(string, string) |
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 selected.
To use the |
|
Publish(string, string, string) |
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 selected.
To use the |
|
Publish(PublishRequest) |
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 selected.
To use the |
|
PublishAsync(PublishRequest, CancellationToken) | Initiates the asynchronous execution of the Publish operation. | |
RemovePermission(string, string) | Removes a statement from a topic's access control policy. | |
RemovePermission(RemovePermissionRequest) | Removes a statement from a topic's access control policy. | |
RemovePermissionAsync(RemovePermissionRequest, CancellationToken) | Initiates the asynchronous execution of the RemovePermission operation. | |
SetEndpointAttributes(SetEndpointAttributesRequest) | Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications. | |
SetEndpointAttributesAsync(SetEndpointAttributesRequest, CancellationToken) | Initiates the asynchronous execution of the SetEndpointAttributes operation. | |
SetPlatformApplicationAttributes(SetPlatformApplicationAttributesRequest) | Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications. | |
SetPlatformApplicationAttributesAsync(SetPlatformApplicationAttributesRequest, CancellationToken) | Initiates the asynchronous execution of the SetPlatformApplicationAttributes operation. | |
SetSubscriptionAttributes(string, string, string) | Allows a subscription owner to set an attribute of the topic to a new value. | |
SetSubscriptionAttributes(SetSubscriptionAttributesRequest) | Allows a subscription owner to set an attribute of the topic to a new value. | |
SetSubscriptionAttributesAsync(SetSubscriptionAttributesRequest, CancellationToken) | Initiates the asynchronous execution of the SetSubscriptionAttributes operation. | |
SetTopicAttributes(string, string, string) | Allows a topic owner to set an attribute of the topic to a new value. | |
SetTopicAttributes(SetTopicAttributesRequest) | Allows a topic owner to set an attribute of the topic to a new value. | |
SetTopicAttributesAsync(SetTopicAttributesRequest, CancellationToken) | Initiates the asynchronous execution of the SetTopicAttributes operation. | |
Subscribe(string, string, string) |
Prepares to subscribe an endpoint by sending the endpoint a confirmation message.
To actually create a subscription, the endpoint owner must call the ConfirmSubscription
action with the token from the confirmation message. Confirmation tokens are
valid for three days.
|
|
Subscribe(SubscribeRequest) |
Prepares to subscribe an endpoint by sending the endpoint a confirmation message.
To actually create a subscription, the endpoint owner must call the ConfirmSubscription
action with the token from the confirmation message. Confirmation tokens are
valid for three days.
|
|
SubscribeAsync(SubscribeRequest, CancellationToken) | Initiates the asynchronous execution of the Subscribe operation. | |
SubscribeQueue(string, IAmazonSQS, string) |
Subscribes an existing Amazon SQS queue to an existing Amazon SNS topic.
The policy applied to the SQS queue is similar to this: { "Version" : "2008-10-17", "Statement" : [{ "Sid" : "topic-subscription-arn:aws:sns:us-west-2:599109622955:myTopic", "Effect" : "Allow", "Principal" : "*", "Action" : ["sqs:SendMessage"], "Resource":["arn:aws:sqs:us-west-2:599109622955:myQueue"], "Condition" : { "ArnLike":{ "aws:SourceArn":["arn:aws:sns:us-west-2:599109622955:myTopic"] } } }] } There might be a small time period immediately after subscribing the SQS queue to the SNS topic and updating the SQS queue's policy, where messages are not able to be delivered to the queue. After a moment, the new queue policy will propagate and the queue will be able to receive messages. This delay only occurs immediately after initially subscribing the queue. |
|
SubscribeQueueToTopics(IList<String>, IAmazonSQS, string) |
Subscribes an existing Amazon SQS queue to existing Amazon SNS topics.
The policy applied to the SQS queue is similar to this: { "Version" : "2008-10-17", "Statement" : [{ "Sid" : "topic-subscription-arn:aws:sns:us-west-2:599109622955:myTopic", "Effect" : "Allow", "Principal" : "*", "Action" : ["sqs:SendMessage"], "Resource":["arn:aws:sqs:us-west-2:599109622955:myQueue"], "Condition" : { "ArnLike":{ "aws:SourceArn":["arn:aws:sns:us-west-2:599109622955:myTopic"] } } }] } There might be a small time period immediately after subscribing the SQS queue to the SNS topic and updating the SQS queue's policy, where messages are not able to be delivered to the queue. After a moment, the new queue policy will propagate and the queue will be able to receive messages. This delay only occurs immediately after initially subscribing the queue. |
|
Unsubscribe(string) |
Deletes a subscription. If the subscription requires authentication for deletion,
only the owner of the subscription or the topic's owner can unsubscribe, and
an AWS signature is required. If the Unsubscribe call does not
require authentication and the requester is not the subscription owner, a final
cancellation message is delivered to the endpoint, so that the endpoint owner
can easily resubscribe to the topic if the Unsubscribe request
was unintended.
|
|
Unsubscribe(UnsubscribeRequest) |
Deletes a subscription. If the subscription requires authentication for deletion,
only the owner of the subscription or the topic's owner can unsubscribe, and
an AWS signature is required. If the Unsubscribe call does not
require authentication and the requester is not the subscription owner, a final
cancellation message is delivered to the endpoint, so that the endpoint owner
can easily resubscribe to the topic if the Unsubscribe request
was unintended.
|
|
UnsubscribeAsync(UnsubscribeRequest, CancellationToken) | Initiates the asynchronous execution of the Unsubscribe operation. |
Name | Description | |
---|---|---|
AfterResponseEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
BeforeRequestEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
ExceptionEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
This example shows how to create, subscribe to, and publish a topic.
var snsClient = new AmazonSimpleNotificationServiceClient(); var topicRequest = new CreateTopicRequest { Name = "CodingTestResults" }; var topicResponse = snsClient.CreateTopic(topicRequest); var topicAttrRequest = new SetTopicAttributesRequest { TopicArn = topicResponse.TopicArn, AttributeName = "DisplayName", AttributeValue = "Coding Test Results" }; snsClient.SetTopicAttributes(topicAttrRequest); snsClient.Subscribe(new SubscribeRequest { Endpoint = "johndoe@example.com", Protocol = "email", TopicArn = topicResponse.TopicArn }); // Wait for up to 2 minutes for the user to confirm the subscription. DateTime latest = DateTime.Now + TimeSpan.FromMinutes(2); while (DateTime.Now < latest) { var subsRequest = new ListSubscriptionsByTopicRequest { TopicArn = topicResponse.TopicArn }; var subs = snsClient.ListSubscriptionsByTopic(subsRequest).Subscriptions; var sub = subs[0]; if (!string.Equals(sub.SubscriptionArn, "PendingConfirmation", StringComparison.Ordinal)) { break; } // Wait 15 seconds before trying again. System.Threading.Thread.Sleep(TimeSpan.FromSeconds(15)); } snsClient.Publish(new PublishRequest { Subject = "Coding Test Results for " + DateTime.Today.ToShortDateString(), Message = "All of today's coding tests passed.", TopicArn = topicResponse.TopicArn });
.NET Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8
.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8