SNS Class

Properties Methods Events Configuration Settings Errors

The SNS component provides a simple interface to Amazon's Simple Notification Service (SNS).

Syntax

SNS

Remarks

The SNS class allows you to quickly and easily access Amazon's Simple Notification Service (SNS). SNS allows you to create topics and subscriptions for notification purposes.

Before using the class you must first have an AWS account and sign up for the SNS service. To use the class first set AccessKey and SecretKey.

To create a topic call CreateTopic. You may manage the topic and it's properties through GetTopicAttributes, SetTopicAttributes, and DeleteTopic.

To subscribe to a topic call Subscribe. To manage a subscription use GetSubscriptionAttributes, SetSubscriptionAttributes, and Unsubscribe.

Use ListSubscriptions, ListTopicSubscriptions, and ListTopics to list existing topics and subscriptions.

Call Publish or PublishCustom to send a notification on a topic.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.


AccessKey	The Access Key Id for the Amazon Web Services account.
FirewallAutoDetect	This property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallType	This property determines the type of firewall to connect through.
FirewallHost	This property contains the name or IP address of firewall (optional).
FirewallPassword	This property contains a password if authentication is to be used when connecting through the firewall.
FirewallPort	This property contains the TCP port for the firewall Host .
FirewallUser	This property contains a user name if authentication is to be used connecting through a firewall.
Idle	The current status of the component.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
ProxyAuthScheme	This property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetect	This property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPassword	This property contains a password if authentication is to be used for the proxy.
ProxyPort	This property contains the TCP port for the proxy Server (default 80).
ProxyServer	If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSL	This property determines when to use SSL for the connection to the proxy.
ProxyUser	This property contains a user name, if authentication is to be used for the proxy.
SecretKey	The Secret Access Key for the Amazon Web Services account.
SSLAcceptServerCertEncoded	The certificate (PEM/base64 encoded).
SSLCertEncoded	The certificate (PEM/base64 encoded).
SSLCertStore	The name of the certificate store for the client certificate.
SSLCertStorePassword	If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSLCertStoreType	The type of certificate store for this certificate.
SSLCertSubject	The subject of the certificate used for client authentication.
SSLServerCertEncoded	The certificate (PEM/base64 encoded).
SubscriptionMarker	The token identifying the next page of results.
SubscriptionCount	The number of records in the Subscription arrays.
SubscriptionConfirmationWasAuthenticated	This property reports whether or not the subscription was confirmed.
SubscriptionDeliveryPolicy	This property holds the JSON serialization of the subscription's delivery policy.
SubscriptionEffectiveDeliveryPolicy	This property holds the JSON serialization of the subscription's effective delivery policy.
SubscriptionEndpoint	This property contains the subscription's endpoint.
SubscriptionHasAttributes	This property returns true if the subscription attributes are available.
SubscriptionOwner	The AWS account ID of the subscription's owner.
SubscriptionProtocol	This property specifies the protocol used by the subscription.
SubscriptionArn	The subscription's Amazon Resource Name (ARN) used to identify the subscription.
SubscriptionTopicArn	The Amazon Resource Name (ARN) of the topic this subscription is associated with.
Timeout	A timeout for the component.
TopicMarker	The token identifying the next page of results.
TopicCount	The number of records in the Topic arrays.
TopicAccessPolicy	This property holds the JSON serialized access control policy for the topic.
TopicDeliveryPolicy	The JSON serialized policy for the topic.
TopicDisplayName	This property holds the name used in the 'From' property for email based endpoints.
TopicEffectiveDeliveryPolicy	This property holds the JSON serialization of the topic's effective delivery policy.
TopicHasAttributes	This property returns true if the topic attributes are available.
TopicOwner	The AWS account ID of the topic's owner.
TopicSubscriptionsConfirmed	The number of confirmed subscriptions to this topic.
TopicSubscriptionsDeleted	The number of deleted subscriptions on this topic.
TopicSubscriptionsPending	The number of pending subscriptions on this topic.
TopicArn	The Amazon Resource Name (ARN) of the topic.
UseSSL	Determines if SSL is used when connecting to Amazon.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.


AddPermission	Adds permissions to the topic's access control policy.
Config	Sets or retrieves a configuration setting .
ConfirmSubscription	Completes the subscription request.
CreateTopic	Creates a new topic.
DeleteTopic	Deletes the specified topic.
DoEvents	Processes events from the internal message queue.
GetSubscriptionAttributes	Retrieves the subscription's attributes.
GetTopicAttributes	Retrieves the topic's attributes.
GetXValue	Retrieves a valid XPath expression from the HTTP response after calling SendCustomRequest .
Interrupt	Interrupt the current method.
ListSubscriptions	Lists subscriptions for the current account.
ListTopics	Lists all topics for the current account.
ListTopicSubscriptions	Lists subscriptions to the specified topic.
Publish	Publishes a message to the topic.
PublishCustom	Publishes a message to the topic.
RemovePermission	Removes permissions from a topic.
Reset	Resets request-related properties.
SendCustomRequest	Allows the sending of a custom request to an Amazon web service.
SetSubscriptionAttributes	Sets attributes of the subscription.
SetTopicAttributes	Sets attributes on the specified topic.
Subscribe	Request a subscription to the specific topic.
Unsubscribe	Unsubscribes from the topic.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.


Error	Information about errors during data delivery.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.
SubscriptionList	Fires with information about the subscription.
TopicList	Fires with information about the topic.

Configuration Settings

The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.


APIVersion	Amazon's API version.
HTTPMethod	Specifies the HTTP method to use when sending a custom request.
SignCustomRequest	Tells the component to sign the outgoing request.
TransferredData	Returns the entire XML response received from Amazon.
URL	If set, the default URL will be overridden by this value.
MessageAttributeCount	The number of message attributes.
MessageAttributeName[i]	The name of the message attribute.
MessageAttributeDataType[i]	The data type of the message attribute.
MessageAttributeValue[i]	The value of the message attribute.
IsTopicPaged	Whether or not all topics were returned by the last listing.
IsSubscriptionPaged	Whether or not all subscriptions were returned by the last listing.
JSONMessage	A custom JSON message to be published.
SignatureVersion	The version of signature used.
TargetArn	The TargetArn when publishing a message.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
AllowIdenticalRedirectURL	Allow redirects to the same URL.
Append	Whether to append data to LocalFile.
Authorization	The Authorization string to be sent to the server.
BytesTransferred	Contains the number of bytes transferred in the response data.
EncodeURL	If set to true the URL will be encoded by the component.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to true the component will perform a GET on the new location.
HTTPVersion	The version of HTTP used by the component.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttempts	Limits the number of redirects that are followed in a request.
OtherHeaders	Other headers as determined by the user (optional).
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if authentication is to be used for the proxy.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the component.
TransferredHeaders	The full set of headers as received from the server.
UseChunkedEncoding	Enables or Disables HTTP chunked encoding for transfers.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
UserAgent	Information about the user agent (browser).
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The TCP port in the local host where the component binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
RecordLength	The length of received data records.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
UseIPv6	Whether to use IPv6.
TcpNoDelay	Whether or not to delay when sending packets.
ReuseSSLSession	Determines if the SSL session is reused.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLProvider	The name of the security provider to use.
SSLSecurityFlags	Flags that control certificate verification.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
CodePage	The system code page used for Unicode to Multibyte translations.