AmazonSNS Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

IPWorksMQ_AmazonSNS

Procedural Interface

 ipworksmq_amazonsns_open();
 ipworksmq_amazonsns_close($res);
 ipworksmq_amazonsns_register_callback($res, $id, $function);
 ipworksmq_amazonsns_get_last_error($res);
 ipworksmq_amazonsns_get_last_error_code($res);
 ipworksmq_amazonsns_set($res, $id, $index, $value);
 ipworksmq_amazonsns_get($res, $id, $index);
 ipworksmq_amazonsns_do_addpermission($res, $topicarn, $policylabel, $awsaccountids, $actionnames);
 ipworksmq_amazonsns_do_config($res, $configurationstring);
 ipworksmq_amazonsns_do_confirmsubscription($res, $topicarn, $token);
 ipworksmq_amazonsns_do_createtopic($res, $name);
 ipworksmq_amazonsns_do_deletetopic($res, $topicarn);
 ipworksmq_amazonsns_do_doevents($res);
 ipworksmq_amazonsns_do_getsubscriptionattributes($res, $subscriptionarn);
 ipworksmq_amazonsns_do_gettopicattributes($res, $topicarn);
 ipworksmq_amazonsns_do_getxvalue($res, $xpath);
 ipworksmq_amazonsns_do_interrupt($res);
 ipworksmq_amazonsns_do_listsubscriptions($res);
 ipworksmq_amazonsns_do_listtopics($res);
 ipworksmq_amazonsns_do_listtopicsubscriptions($res, $topicarn);
 ipworksmq_amazonsns_do_publish($res, $topicarn, $subject, $message);
 ipworksmq_amazonsns_do_publishcustom($res, $topicarn, $subject, $defaultmessage, $emailmessage, $emailjsonmessage, $httpmessage, $httpsmessage, $smsmessage, $sqsmessage);
 ipworksmq_amazonsns_do_removepermission($res, $topicarn, $policylabel);
 ipworksmq_amazonsns_do_reset($res);
 ipworksmq_amazonsns_do_sendcustomrequest($res, $url, $requestdata, $otherheaders);
 ipworksmq_amazonsns_do_setsubscriptionattributes($res, $subscriptionarn, $attributevalue);
 ipworksmq_amazonsns_do_settopicattributes($res, $topicarn, $attributetype, $attributevalue);
 ipworksmq_amazonsns_do_subscribe($res, $topicarn, $endpoint, $endpointprotocol);
 ipworksmq_amazonsns_do_unsubscribe($res, $subscriptionarn);

Remarks

The AmazonSNS 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 its properties with 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.

Method List

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

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.

Config Settings

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

AccessKey Property (IPWorksMQ_AmazonSNS Class)

The Access Key Id for the Amazon Web Services account.

Object Oriented Interface

public function getAccessKey();
public function setAccessKey($value);

Procedural Interface

ipworksmq_amazonsns_get($res, 1 );
ipworksmq_amazonsns_set($res, 1, $value );

Default Value

''

Remarks

This is the username for the Amazon Web Services account. No two accounts may have the same Access Key. This is used along with the SecretKey to authenticate with Amazon servers.

Data Type

String

FirewallAutoDetect Property (IPWorksMQ_AmazonSNS Class)

Whether to automatically detect and use firewall system settings, if available.

Object Oriented Interface

public function getFirewallAutoDetect();
public function setFirewallAutoDetect($value);

Procedural Interface

ipworksmq_amazonsns_get($res, 2 );
ipworksmq_amazonsns_set($res, 2, $value );

Default Value

false

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (IPWorksMQ_AmazonSNS Class)

The type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();
public function setFirewallType($value);

Procedural Interface

ipworksmq_amazonsns_get($res, 3 );
ipworksmq_amazonsns_set($res, 3, $value );

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (IPWorksMQ_AmazonSNS Class)

The name or IP address of the firewall (optional).

Object Oriented Interface

public function getFirewallHost();
public function setFirewallHost($value);

Procedural Interface

ipworksmq_amazonsns_get($res, 4 );
ipworksmq_amazonsns_set($res, 4, $value );

Default Value

''

Remarks

The name or IP address of the firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (IPWorksMQ_AmazonSNS Class)

A password if authentication is to be used when connecting through the firewall.

Object Oriented Interface

public function getFirewallPassword();
public function setFirewallPassword($value);

Procedural Interface

ipworksmq_amazonsns_get($res, 5 );
ipworksmq_amazonsns_set($res, 5, $value );

Default Value

''

Remarks

A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (IPWorksMQ_AmazonSNS Class)

The Transmission Control Protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();
public function setFirewallPort($value);

Procedural Interface

ipworksmq_amazonsns_get($res, 6 );
ipworksmq_amazonsns_set($res, 6, $value );

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (IPWorksMQ_AmazonSNS Class)

A username if authentication is to be used when connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();
public function setFirewallUser($value);

Procedural Interface

ipworksmq_amazonsns_get($res, 7 );
ipworksmq_amazonsns_set($res, 7, $value );

Default Value

''

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

Idle Property (IPWorksMQ_AmazonSNS Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

ipworksmq_amazonsns_get($res, 8 );

Default Value

true

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

LocalHost Property (IPWorksMQ_AmazonSNS Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Object Oriented Interface

public function getLocalHost();
public function setLocalHost($value);

Procedural Interface

ipworksmq_amazonsns_get($res, 9 );
ipworksmq_amazonsns_set($res, 9, $value );

Default Value

''

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

ProxyAuthScheme Property (IPWorksMQ_AmazonSNS Class)

The type of authorization to perform when connecting to the proxy.

Object Oriented Interface

public function getProxyAuthScheme();
public function setProxyAuthScheme($value);

Procedural Interface

ipworksmq_amazonsns_get($res, 10 );
ipworksmq_amazonsns_set($res, 10, $value );

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the class will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (IPWorksMQ_AmazonSNS Class)

Whether to automatically detect and use proxy system settings, if available.

Object Oriented Interface

public function getProxyAutoDetect();
public function setProxyAutoDetect($value);

Procedural Interface

ipworksmq_amazonsns_get($res, 11 );
ipworksmq_amazonsns_set($res, 11, $value );

Default Value

false

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (IPWorksMQ_AmazonSNS Class)

A password if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyPassword();
public function setProxyPassword($value);

Procedural Interface

ipworksmq_amazonsns_get($res, 12 );
ipworksmq_amazonsns_set($res, 12, $value );

Default Value

''

Remarks

A password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (IPWorksMQ_AmazonSNS Class)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Object Oriented Interface

public function getProxyPort();
public function setProxyPort($value);

Procedural Interface

ipworksmq_amazonsns_get($res, 13 );
ipworksmq_amazonsns_set($res, 13, $value );

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (IPWorksMQ_AmazonSNS Class)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Object Oriented Interface

public function getProxyServer();
public function setProxyServer($value);

Procedural Interface

ipworksmq_amazonsns_get($res, 14 );
ipworksmq_amazonsns_set($res, 14, $value );

Default Value

''

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (IPWorksMQ_AmazonSNS Class)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Object Oriented Interface

public function getProxySSL();
public function setProxySSL($value);

Procedural Interface

ipworksmq_amazonsns_get($res, 15 );
ipworksmq_amazonsns_set($res, 15, $value );

Default Value

0

Remarks

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (IPWorksMQ_AmazonSNS Class)

A username if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyUser();
public function setProxyUser($value);

Procedural Interface

ipworksmq_amazonsns_get($res, 16 );
ipworksmq_amazonsns_set($res, 16, $value );

Default Value

''

Remarks

A username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

SecretKey Property (IPWorksMQ_AmazonSNS Class)

The Secret Access Key for the Amazon Web Services account.

Object Oriented Interface

public function getSecretKey();
public function setSecretKey($value);

Procedural Interface

ipworksmq_amazonsns_get($res, 17 );
ipworksmq_amazonsns_set($res, 17, $value );

Default Value

''

Remarks

This property describes the secret key to the Amazon account. It should not be shared with others. The SecretKey is used along with the AccessKey in the authentication process with Amazon servers.

Data Type

String

SSLAcceptServerCertEffectiveDate Property (IPWorksMQ_AmazonSNS Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

ipworksmq_amazonsns_get($res, 18 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (IPWorksMQ_AmazonSNS Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

ipworksmq_amazonsns_get($res, 19 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (IPWorksMQ_AmazonSNS Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

ipworksmq_amazonsns_get($res, 20 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (IPWorksMQ_AmazonSNS Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

ipworksmq_amazonsns_get($res, 21 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (IPWorksMQ_AmazonSNS Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

ipworksmq_amazonsns_get($res, 22 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (IPWorksMQ_AmazonSNS Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

ipworksmq_amazonsns_get($res, 23 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (IPWorksMQ_AmazonSNS Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

ipworksmq_amazonsns_get($res, 24 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (IPWorksMQ_AmazonSNS Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

ipworksmq_amazonsns_get($res, 25 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (IPWorksMQ_AmazonSNS Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

ipworksmq_amazonsns_get($res, 26 );

Default Value

false

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (IPWorksMQ_AmazonSNS Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

ipworksmq_amazonsns_get($res, 27 );

Default Value

''

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (IPWorksMQ_AmazonSNS Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

ipworksmq_amazonsns_get($res, 28 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (IPWorksMQ_AmazonSNS Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

ipworksmq_amazonsns_get($res, 29 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (IPWorksMQ_AmazonSNS Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

ipworksmq_amazonsns_get($res, 30 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (IPWorksMQ_AmazonSNS Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

ipworksmq_amazonsns_get($res, 31 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (IPWorksMQ_AmazonSNS Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

ipworksmq_amazonsns_get($res, 32 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (IPWorksMQ_AmazonSNS Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

ipworksmq_amazonsns_get($res, 33 );
ipworksmq_amazonsns_set($res, 33, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (IPWorksMQ_AmazonSNS Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

ipworksmq_amazonsns_get($res, 34 );
ipworksmq_amazonsns_set($res, 34, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLAcceptServerCertStoreType Property (IPWorksMQ_AmazonSNS Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

ipworksmq_amazonsns_get($res, 35 );
ipworksmq_amazonsns_set($res, 35, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (IPWorksMQ_AmazonSNS Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

ipworksmq_amazonsns_get($res, 36 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (IPWorksMQ_AmazonSNS Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

ipworksmq_amazonsns_get($res, 37 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (IPWorksMQ_AmazonSNS Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

ipworksmq_amazonsns_get($res, 38 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (IPWorksMQ_AmazonSNS Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

ipworksmq_amazonsns_get($res, 39 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (IPWorksMQ_AmazonSNS Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

ipworksmq_amazonsns_get($res, 40 );

Default Value

''

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (IPWorksMQ_AmazonSNS Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

ipworksmq_amazonsns_get($res, 41 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (IPWorksMQ_AmazonSNS Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

ipworksmq_amazonsns_get($res, 42 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (IPWorksMQ_AmazonSNS Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

ipworksmq_amazonsns_get($res, 43 );
ipworksmq_amazonsns_set($res, 43, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLAcceptServerCertEncoded Property (IPWorksMQ_AmazonSNS Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

ipworksmq_amazonsns_get($res, 44 );
ipworksmq_amazonsns_set($res, 44, $value );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (IPWorksMQ_AmazonSNS Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

ipworksmq_amazonsns_get($res, 45 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (IPWorksMQ_AmazonSNS Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

ipworksmq_amazonsns_get($res, 46 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (IPWorksMQ_AmazonSNS Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

ipworksmq_amazonsns_get($res, 47 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (IPWorksMQ_AmazonSNS Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

ipworksmq_amazonsns_get($res, 48 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (IPWorksMQ_AmazonSNS Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

ipworksmq_amazonsns_get($res, 49 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (IPWorksMQ_AmazonSNS Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

ipworksmq_amazonsns_get($res, 50 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (IPWorksMQ_AmazonSNS Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

ipworksmq_amazonsns_get($res, 51 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (IPWorksMQ_AmazonSNS Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

ipworksmq_amazonsns_get($res, 52 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (IPWorksMQ_AmazonSNS Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

ipworksmq_amazonsns_get($res, 53 );

Default Value

false

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (IPWorksMQ_AmazonSNS Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

ipworksmq_amazonsns_get($res, 54 );

Default Value

''

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (IPWorksMQ_AmazonSNS Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

ipworksmq_amazonsns_get($res, 55 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (IPWorksMQ_AmazonSNS Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

ipworksmq_amazonsns_get($res, 56 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (IPWorksMQ_AmazonSNS Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

ipworksmq_amazonsns_get($res, 57 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (IPWorksMQ_AmazonSNS Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

ipworksmq_amazonsns_get($res, 58 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (IPWorksMQ_AmazonSNS Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

ipworksmq_amazonsns_get($res, 59 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (IPWorksMQ_AmazonSNS Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

ipworksmq_amazonsns_get($res, 60 );
ipworksmq_amazonsns_set($res, 60, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password-protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (IPWorksMQ_AmazonSNS Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLCertStorePassword();
public function setSSLCertStorePassword($value);

Procedural Interface

ipworksmq_amazonsns_get($res, 61 );
ipworksmq_amazonsns_set($res, 61, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (IPWorksMQ_AmazonSNS Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

ipworksmq_amazonsns_get($res, 62 );
ipworksmq_amazonsns_set($res, 62, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubjectAltNames Property (IPWorksMQ_AmazonSNS Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

ipworksmq_amazonsns_get($res, 63 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (IPWorksMQ_AmazonSNS Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

ipworksmq_amazonsns_get($res, 64 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (IPWorksMQ_AmazonSNS Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

ipworksmq_amazonsns_get($res, 65 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (IPWorksMQ_AmazonSNS Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

ipworksmq_amazonsns_get($res, 66 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (IPWorksMQ_AmazonSNS Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

ipworksmq_amazonsns_get($res, 67 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (IPWorksMQ_AmazonSNS Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

ipworksmq_amazonsns_get($res, 68 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (IPWorksMQ_AmazonSNS Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

ipworksmq_amazonsns_get($res, 69 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (IPWorksMQ_AmazonSNS Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

ipworksmq_amazonsns_get($res, 70 );
ipworksmq_amazonsns_set($res, 70, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLCertEncoded Property (IPWorksMQ_AmazonSNS Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

ipworksmq_amazonsns_get($res, 71 );
ipworksmq_amazonsns_set($res, 71, $value );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLProvider Property (IPWorksMQ_AmazonSNS Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Object Oriented Interface

public function getSSLProvider();
public function setSSLProvider($value);

Procedural Interface

ipworksmq_amazonsns_get($res, 72 );
ipworksmq_amazonsns_set($res, 72, $value );

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEffectiveDate Property (IPWorksMQ_AmazonSNS Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

ipworksmq_amazonsns_get($res, 73 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (IPWorksMQ_AmazonSNS Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

ipworksmq_amazonsns_get($res, 74 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (IPWorksMQ_AmazonSNS Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

ipworksmq_amazonsns_get($res, 75 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (IPWorksMQ_AmazonSNS Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

ipworksmq_amazonsns_get($res, 76 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (IPWorksMQ_AmazonSNS Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

ipworksmq_amazonsns_get($res, 77 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (IPWorksMQ_AmazonSNS Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

ipworksmq_amazonsns_get($res, 78 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (IPWorksMQ_AmazonSNS Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

ipworksmq_amazonsns_get($res, 79 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (IPWorksMQ_AmazonSNS Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

ipworksmq_amazonsns_get($res, 80 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (IPWorksMQ_AmazonSNS Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

ipworksmq_amazonsns_get($res, 81 );

Default Value

false

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (IPWorksMQ_AmazonSNS Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

ipworksmq_amazonsns_get($res, 82 );

Default Value

''

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (IPWorksMQ_AmazonSNS Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

ipworksmq_amazonsns_get($res, 83 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (IPWorksMQ_AmazonSNS Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

ipworksmq_amazonsns_get($res, 84 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (IPWorksMQ_AmazonSNS Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

ipworksmq_amazonsns_get($res, 85 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (IPWorksMQ_AmazonSNS Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

ipworksmq_amazonsns_get($res, 86 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (IPWorksMQ_AmazonSNS Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

ipworksmq_amazonsns_get($res, 87 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertStore Property (IPWorksMQ_AmazonSNS Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

ipworksmq_amazonsns_get($res, 88 );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (IPWorksMQ_AmazonSNS Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLServerCertStorePassword();

Procedural Interface

ipworksmq_amazonsns_get($res, 89 );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (IPWorksMQ_AmazonSNS Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

ipworksmq_amazonsns_get($res, 90 );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (IPWorksMQ_AmazonSNS Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

ipworksmq_amazonsns_get($res, 91 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (IPWorksMQ_AmazonSNS Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

ipworksmq_amazonsns_get($res, 92 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (IPWorksMQ_AmazonSNS Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

ipworksmq_amazonsns_get($res, 93 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (IPWorksMQ_AmazonSNS Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

ipworksmq_amazonsns_get($res, 94 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (IPWorksMQ_AmazonSNS Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

ipworksmq_amazonsns_get($res, 95 );

Default Value

''

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (IPWorksMQ_AmazonSNS Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

ipworksmq_amazonsns_get($res, 96 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (IPWorksMQ_AmazonSNS Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

ipworksmq_amazonsns_get($res, 97 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (IPWorksMQ_AmazonSNS Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

ipworksmq_amazonsns_get($res, 98 );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (IPWorksMQ_AmazonSNS Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

ipworksmq_amazonsns_get($res, 99 );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is read-only and not available at design time.

Data Type

Binary String

SubscriptionMarker Property (IPWorksMQ_AmazonSNS Class)

The token identifying the next page of results.

Object Oriented Interface

public function getSubscriptionMarker();
public function setSubscriptionMarker($value);

Procedural Interface

ipworksmq_amazonsns_get($res, 100 );
ipworksmq_amazonsns_set($res, 100, $value );

Default Value

''

Remarks

This token identifies the next set of results to retrieve. This is populated automatically when the results are paged. When the results are not paged, or the last page of results is retrieved, this is automatically set to empty string. See ListSubscriptions for more details.

This property is not available at design time.

Data Type

String

SubscriptionCount Property (IPWorksMQ_AmazonSNS Class)

The number of records in the Subscription arrays.

Object Oriented Interface

public function getSubscriptionCount();

Procedural Interface

ipworksmq_amazonsns_get($res, 101 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SubscriptionArn
• SubscriptionConfirmationWasAuthenticated
• SubscriptionDeliveryPolicy
• SubscriptionEffectiveDeliveryPolicy
• SubscriptionEndpoint
• SubscriptionHasAttributes
• SubscriptionOwner
• SubscriptionProtocol
• SubscriptionTopicArn

The array indices start at 0 and end at SubscriptionCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

SubscriptionConfirmationWasAuthenticated Property (IPWorksMQ_AmazonSNS Class)

This property reports whether or not the subscription was confirmed.

Object Oriented Interface

public function getSubscriptionConfirmationWasAuthenticated($subscriptionindex);

Procedural Interface

ipworksmq_amazonsns_get($res, 102 , $subscriptionindex);

Default Value

false

Remarks

This property reports whether or not the subscription was confirmed.

Note: This property is only applicable after calling GetSubscriptionAttributes.

The $subscriptionindex parameter specifies the index of the item in the array. The size of the array is controlled by the SubscriptionCount property.

This property is read-only and not available at design time.

Data Type

Boolean

SubscriptionDeliveryPolicy Property (IPWorksMQ_AmazonSNS Class)

This property holds the JSON serialization of the subscription's delivery policy.

Object Oriented Interface

public function getSubscriptionDeliveryPolicy($subscriptionindex);

Procedural Interface

ipworksmq_amazonsns_get($res, 103 , $subscriptionindex);

Default Value

''

Remarks

This property holds the JSON serialization of the subscription's delivery policy.

Note: This property is only applicable after calling GetSubscriptionAttributes.

The $subscriptionindex parameter specifies the index of the item in the array. The size of the array is controlled by the SubscriptionCount property.

This property is read-only and not available at design time.

Data Type

String

SubscriptionEffectiveDeliveryPolicy Property (IPWorksMQ_AmazonSNS Class)

This property holds the JSON serialization of the subscription's effective delivery policy.

Object Oriented Interface

public function getSubscriptionEffectiveDeliveryPolicy($subscriptionindex);

Procedural Interface

ipworksmq_amazonsns_get($res, 104 , $subscriptionindex);

Default Value

''

Remarks

This property holds the JSON serialization of the subscription's effective delivery policy. This policy takes into account the topic and account defaults.

Note: This property is only applicable after calling GetSubscriptionAttributes.

The $subscriptionindex parameter specifies the index of the item in the array. The size of the array is controlled by the SubscriptionCount property.

This property is read-only and not available at design time.

Data Type

String

SubscriptionEndpoint Property (IPWorksMQ_AmazonSNS Class)

This property contains the subscription's endpoint.

Object Oriented Interface

public function getSubscriptionEndpoint($subscriptionindex);

Procedural Interface

ipworksmq_amazonsns_get($res, 105 , $subscriptionindex);

Default Value

''

Remarks

This property contains the subscription's endpoint.

The format of the endpoint depends on the protocol used for the subscription. Possible formats are:

Note: This property is only applicable after calling ListSubscriptions or ListTopicSubscriptions.

The $subscriptionindex parameter specifies the index of the item in the array. The size of the array is controlled by the SubscriptionCount property.

This property is read-only and not available at design time.

Data Type

String

SubscriptionHasAttributes Property (IPWorksMQ_AmazonSNS Class)

This property returns true if the subscription attributes are available.

Object Oriented Interface

public function getSubscriptionHasAttributes($subscriptionindex);

Procedural Interface

ipworksmq_amazonsns_get($res, 106 , $subscriptionindex);

Default Value

false

Remarks

This property returns true if the subscription attributes are available. A subscription's attributes are only returned and parsed after calling GetSubscriptionAttributes. This property serves as an easy way to determine if the subscription's attributes are available.

The following properties are applicable after calling GetSubscriptionAttributes:

• SubscriptionConfirmationWasAuthenticated
• SubscriptionDeliveryPolicy
• SubscriptionEffectiveDeliveryPolicy
• SubscriptionOwner
• SubscriptionArn
• SubscriptionTopicArn

The following properties are applicable after calling ListSubscriptions or ListTopicSubscriptions:

• SubscriptionEndpoint
• SubscriptionOwner
• SubscriptionProtocol
• SubscriptionArn
• SubscriptionTopicArn

The $subscriptionindex parameter specifies the index of the item in the array. The size of the array is controlled by the SubscriptionCount property.

This property is read-only and not available at design time.

Data Type

Boolean

SubscriptionOwner Property (IPWorksMQ_AmazonSNS Class)

The AWS account ID of the subscription's owner.

Object Oriented Interface

public function getSubscriptionOwner($subscriptionindex);

Procedural Interface

ipworksmq_amazonsns_get($res, 107 , $subscriptionindex);

Default Value

''

Remarks

The AWS account ID of the subscription's owner.

The $subscriptionindex parameter specifies the index of the item in the array. The size of the array is controlled by the SubscriptionCount property.

This property is read-only and not available at design time.

Data Type

String

SubscriptionProtocol Property (IPWorksMQ_AmazonSNS Class)

This property specifies the protocol used by the subscription.

Object Oriented Interface

public function getSubscriptionProtocol($subscriptionindex);

Procedural Interface

ipworksmq_amazonsns_get($res, 108 , $subscriptionindex);

Default Value

0

Remarks

This property specifies the protocol used by the subscription. Possible values are:

Note: This property is only applicable after calling ListSubscriptions or ListTopicSubscriptions.

The $subscriptionindex parameter specifies the index of the item in the array. The size of the array is controlled by the SubscriptionCount property.

This property is read-only and not available at design time.

Data Type

Integer

SubscriptionArn Property (IPWorksMQ_AmazonSNS Class)

The subscription's Amazon Resource Name (ARN) used to identify the subscription.

Object Oriented Interface

public function getSubscriptionArn($subscriptionindex);

Procedural Interface

ipworksmq_amazonsns_get($res, 109 , $subscriptionindex);

Default Value

''

Remarks

The subscription's Amazon Resource Name (ARN) used to identify the subscription.

The $subscriptionindex parameter specifies the index of the item in the array. The size of the array is controlled by the SubscriptionCount property.

This property is read-only and not available at design time.

Data Type

String

SubscriptionTopicArn Property (IPWorksMQ_AmazonSNS Class)

The Amazon Resource Name (ARN) of the topic this subscription is associated with.

Object Oriented Interface

public function getSubscriptionTopicArn($subscriptionindex);

Procedural Interface

ipworksmq_amazonsns_get($res, 110 , $subscriptionindex);

Default Value

''

Remarks

The Amazon Resource Name (ARN) of the topic this subscription is associated with.

The $subscriptionindex parameter specifies the index of the item in the array. The size of the array is controlled by the SubscriptionCount property.

This property is read-only and not available at design time.

Data Type

String

Timeout Property (IPWorksMQ_AmazonSNS Class)

The timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

ipworksmq_amazonsns_get($res, 111 );
ipworksmq_amazonsns_set($res, 111, $value );

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

TopicMarker Property (IPWorksMQ_AmazonSNS Class)

The token identifying the next page of results.

Object Oriented Interface

public function getTopicMarker();
public function setTopicMarker($value);

Procedural Interface

ipworksmq_amazonsns_get($res, 112 );
ipworksmq_amazonsns_set($res, 112, $value );

Default Value

''

Remarks

This token identifies the next set of results to retrieve. This is populated automatically when the results are paged. When the results are not paged, or the last page of results is retrieved, this is automatically set to empty string. See ListTopics for more details.

This property is not available at design time.

Data Type

String

TopicCount Property (IPWorksMQ_AmazonSNS Class)

The number of records in the Topic arrays.

Object Oriented Interface

public function getTopicCount();

Procedural Interface

ipworksmq_amazonsns_get($res, 113 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• TopicAccessPolicy
• TopicArn
• TopicDeliveryPolicy
• TopicDisplayName
• TopicEffectiveDeliveryPolicy
• TopicHasAttributes
• TopicOwner
• TopicSubscriptionsConfirmed
• TopicSubscriptionsDeleted
• TopicSubscriptionsPending

The array indices start at 0 and end at TopicCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

TopicAccessPolicy Property (IPWorksMQ_AmazonSNS Class)

This property holds the JSON serialized access control policy for the topic.

Object Oriented Interface

public function getTopicAccessPolicy($topicindex);

Procedural Interface

ipworksmq_amazonsns_get($res, 114 , $topicindex);

Default Value

''

Remarks

This property holds the JSON serialized access control policy for the topic.

Note: This property is only applicable after calling GetTopicAttributes.

The $topicindex parameter specifies the index of the item in the array. The size of the array is controlled by the TopicCount property.

This property is read-only and not available at design time.

Data Type

String

TopicDeliveryPolicy Property (IPWorksMQ_AmazonSNS Class)

The JSON serialized policy for the topic.

Object Oriented Interface

public function getTopicDeliveryPolicy($topicindex);

Procedural Interface

ipworksmq_amazonsns_get($res, 115 , $topicindex);

Default Value

''

Remarks

The JSON serialized policy for the topic.

Note: This property is only applicable after calling GetTopicAttributes.

The $topicindex parameter specifies the index of the item in the array. The size of the array is controlled by the TopicCount property.

This property is read-only and not available at design time.

Data Type

String

TopicDisplayName Property (IPWorksMQ_AmazonSNS Class)

This property holds the name used in the 'From' property for email based endpoints.

Object Oriented Interface

public function getTopicDisplayName($topicindex);

Procedural Interface

ipworksmq_amazonsns_get($res, 116 , $topicindex);

Default Value

''

Remarks

This property holds the name used in the 'From' field for email based endpoints.

Note: This property is only applicable after calling GetTopicAttributes.

The $topicindex parameter specifies the index of the item in the array. The size of the array is controlled by the TopicCount property.

This property is read-only and not available at design time.

Data Type

String

TopicEffectiveDeliveryPolicy Property (IPWorksMQ_AmazonSNS Class)

This property holds the JSON serialization of the topic's effective delivery policy.

Object Oriented Interface

public function getTopicEffectiveDeliveryPolicy($topicindex);

Procedural Interface

ipworksmq_amazonsns_get($res, 117 , $topicindex);

Default Value

''

Remarks

This property holds the JSON serialization of the topic's effective delivery policy. This policy takes into account the topic and account defaults.

Note: This property is only applicable after calling GetTopicAttributes.

The $topicindex parameter specifies the index of the item in the array. The size of the array is controlled by the TopicCount property.

This property is read-only and not available at design time.

Data Type

String

TopicHasAttributes Property (IPWorksMQ_AmazonSNS Class)

This property returns true if the topic attributes are available.

Object Oriented Interface

public function getTopicHasAttributes($topicindex);

Procedural Interface

ipworksmq_amazonsns_get($res, 118 , $topicindex);

Default Value

false

Remarks

This property returns true if the topic attributes are available. A topic's attributes are only returned and parsed after calling GetTopicAttributes. This property serves as an easy way to determine if the topic's attributes are available.

The following properties are applicable after calling GetTopicAttributes:

• TopicDeliveryPolicy
• TopicDisplayName
• TopicEffectiveDeliveryPolicy
• TopicOwner
• TopicAccessPolicy
• TopicSubscriptionsConfirmed
• TopicSubscriptionsDeleted
• TopicSubscriptionsPending
• TopicArn

The following properties are applicable after calling ListTopics:

• TopicArn

The $topicindex parameter specifies the index of the item in the array. The size of the array is controlled by the TopicCount property.

This property is read-only and not available at design time.

Data Type

Boolean

TopicOwner Property (IPWorksMQ_AmazonSNS Class)

The AWS account ID of the topic's owner.

Object Oriented Interface

public function getTopicOwner($topicindex);

Procedural Interface

ipworksmq_amazonsns_get($res, 119 , $topicindex);

Default Value

''

Remarks

The AWS account ID of the topic's owner.

Note: This property is only applicable after calling GetTopicAttributes.

The $topicindex parameter specifies the index of the item in the array. The size of the array is controlled by the TopicCount property.

This property is read-only and not available at design time.

Data Type

String

TopicSubscriptionsConfirmed Property (IPWorksMQ_AmazonSNS Class)

The number of confirmed subscriptions to this topic.

Object Oriented Interface

public function getTopicSubscriptionsConfirmed($topicindex);

Procedural Interface

ipworksmq_amazonsns_get($res, 120 , $topicindex);

Default Value

0

Remarks

The number of confirmed subscriptions to this topic.

Note: This property is only applicable after calling GetTopicAttributes.

The $topicindex parameter specifies the index of the item in the array. The size of the array is controlled by the TopicCount property.

This property is read-only and not available at design time.

Data Type

Integer

TopicSubscriptionsDeleted Property (IPWorksMQ_AmazonSNS Class)

The number of deleted subscriptions on this topic.

Object Oriented Interface

public function getTopicSubscriptionsDeleted($topicindex);

Procedural Interface

ipworksmq_amazonsns_get($res, 121 , $topicindex);

Default Value

0

Remarks

The number of deleted subscriptions on this topic.

Note: This property is only applicable after calling GetTopicAttributes.

The $topicindex parameter specifies the index of the item in the array. The size of the array is controlled by the TopicCount property.

This property is read-only and not available at design time.

Data Type

Integer

TopicSubscriptionsPending Property (IPWorksMQ_AmazonSNS Class)

The number of pending subscriptions on this topic.

Object Oriented Interface

public function getTopicSubscriptionsPending($topicindex);

Procedural Interface

ipworksmq_amazonsns_get($res, 122 , $topicindex);

Default Value

0

Remarks

The number of pending subscriptions on this topic.

Note: This property is only applicable after calling GetTopicAttributes.

The $topicindex parameter specifies the index of the item in the array. The size of the array is controlled by the TopicCount property.

This property is read-only and not available at design time.

Data Type

Integer

TopicArn Property (IPWorksMQ_AmazonSNS Class)

The Amazon Resource Name (ARN) of the topic.

Object Oriented Interface

public function getTopicArn($topicindex);

Procedural Interface

ipworksmq_amazonsns_get($res, 123 , $topicindex);

Default Value

''

Remarks

The Amazon Resource Name (ARN) of the topic.

The $topicindex parameter specifies the index of the item in the array. The size of the array is controlled by the TopicCount property.

This property is read-only and not available at design time.

Data Type

String

UseSSL Property (IPWorksMQ_AmazonSNS Class)

Determines if SSL is used when connecting to Amazon.

Object Oriented Interface

public function getUseSSL();
public function setUseSSL($value);

Procedural Interface

ipworksmq_amazonsns_get($res, 124 );
ipworksmq_amazonsns_set($res, 124, $value );

Default Value

false

Remarks

Use this property to specify whether or not the component uses SSL to connect with Amazon SNS servers.

This property is not available at design time.

Data Type

Boolean

AddPermission Method (IPWorksMQ_AmazonSNS Class)

Adds permissions to the topic's access control policy.

Object Oriented Interface

public function doAddPermission($topicarn, $policylabel, $awsaccountids, $actionnames);

Procedural Interface

ipworksmq_amazonsns_do_addpermission($res, $topicarn, $policylabel, $awsaccountids, $actionnames);

Remarks

This method may be used to add a statement to the topic's access control policy.

TopicArn specifies the topic.

PolicyLabel should be set to a unique identifier for the new policy statement.

AWSAccountIds is a comma separated list of AWS account IDs of users who will be granted access to the specified actions. The users must have an AWS account, but do not need to be signed up for the SNS service.

ActionNames is a comma separated list of actions that corresponds to the AWS account IDs specified in AWSAccountIds. Possible values are:

• AddPermission
• CreateTopic
• DeleteTopic
• GetSubscriptionAttributes
• GetTopicAttributes
• ListSubscriptions
• ListSubscriptionsByTopic
• ListTopics
• Publish
• RemovePermission
• SetSubscriptionAttributes
• SetTopicAttributes
• Subscribe
• Unsubscribe

The AWSAccountIds and ActionNames parameters must have the same number of values. The actions correspond to the account IDs and only one action may be set for one account ID at a time. For instance: component.AddPermission("myTopicArn", "myLabel", "1234567,7654321", "Publish,GetTopicAttributes");

Config Method (IPWorksMQ_AmazonSNS Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworksmq_amazonsns_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

ConfirmSubscription Method (IPWorksMQ_AmazonSNS Class)

Completes the subscription request.

Object Oriented Interface

public function doConfirmSubscription($topicarn, $token);

Procedural Interface

ipworksmq_amazonsns_do_confirmsubscription($res, $topicarn, $token);

Remarks

This method completes the subscription request. After calling the Subscribe method this method must be used to complete the subscription request (if it could not be completed immediately when Subscribe was called).

Set Token to the confirmation token delivered to the endpoint specified in the call to Subscribe. The TopicArn parameter specifies the topic of the subscription.

This method returns the SubscriptionArn which may be used in further subscription related operation. SubscriptionArn may be used with the following methods:

• GetSubscriptionAttributes
• SetSubscriptionAttributes
• Unsubscribe

CreateTopic Method (IPWorksMQ_AmazonSNS Class)

Creates a new topic.

Object Oriented Interface

public function doCreateTopic($name);

Procedural Interface

ipworksmq_amazonsns_do_createtopic($res, $name);

Remarks

This method creates a new topic specified by the Name parameter. Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.

The TopicArn is returned by this method an identifier that is used in other operations on the topic. The TopicArn is required for these methods:

• DeleteTopic
• GetTopicAttributes
• ListTopicSubscriptions
• Publish
• PublishCustom
• RemovePermission
• SetTopicAttributes
• Subscribe

DeleteTopic Method (IPWorksMQ_AmazonSNS Class)

Deletes the specified topic.

Object Oriented Interface

public function doDeleteTopic($topicarn);

Procedural Interface

ipworksmq_amazonsns_do_deletetopic($res, $topicarn);

Remarks

This method deletes the topic specified by the TopicArn parameter. All subscriptions to this topic will also be deleted. If the topic does not exist, no error is returned by Amazon.

DoEvents Method (IPWorksMQ_AmazonSNS Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworksmq_amazonsns_do_doevents($res);

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

GetSubscriptionAttributes Method (IPWorksMQ_AmazonSNS Class)

Retrieves the subscription's attributes.

Object Oriented Interface

public function doGetSubscriptionAttributes($subscriptionarn);

Procedural Interface

ipworksmq_amazonsns_do_getsubscriptionattributes($res, $subscriptionarn);

Remarks

This method retrieves the subscription's attributes. The attributes are available through the Subscriptions collection.

GetTopicAttributes Method (IPWorksMQ_AmazonSNS Class)

Retrieves the topic's attributes.

Object Oriented Interface

public function doGetTopicAttributes($topicarn);

Procedural Interface

ipworksmq_amazonsns_do_gettopicattributes($res, $topicarn);

Remarks

This method topic the subscription's attributes. The topic are available through the Topics collection.

GetXValue Method (IPWorksMQ_AmazonSNS Class)

Retrieves a valid XPath expression from the HTTP response after calling SendCustomRequest .

Object Oriented Interface

public function doGetXValue($xpath);

Procedural Interface

ipworksmq_amazonsns_do_getxvalue($res, $xpath);

Remarks

This method allows a user to retrieve a valid XPath expression from the HTTP response after calling SendCustomRequest.

Interrupt Method (IPWorksMQ_AmazonSNS Class)

This method interrupts the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

ipworksmq_amazonsns_do_interrupt($res);

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

ListSubscriptions Method (IPWorksMQ_AmazonSNS Class)

Lists subscriptions for the current account.

Object Oriented Interface

public function doListSubscriptions();

Procedural Interface

ipworksmq_amazonsns_do_listsubscriptions($res);

Remarks

This method lists the subscriptions for the current AWS account.

When calling this method all subscriptions for the current AWS account identified by AccessKey and SecretKey will be listed. The SubscriptionList event will fire once for each subscription and the Subscriptions collection will be populated with information about the subscriptions.

If the results are paged the IsSubscriptionPaged setting will return the value "True" and SubscriptionMarker will be populated. You may continue to call this method until IsSubscriptionPaged returns "False" and SubscriptionMarker is empty to retrieve all results.

ListTopics Method (IPWorksMQ_AmazonSNS Class)

Lists all topics for the current account.

Object Oriented Interface

public function doListTopics();

Procedural Interface

ipworksmq_amazonsns_do_listtopics($res);

Remarks

This method lists all topics for the AWS account specified by AccessKey and SecretKey.

When this method is called the TopicList event will fire once for each topic and the Topics collection will be populated with information about the topics.

If the results are paged the IsTopicPaged setting will return the value "True" and TopicMarker will be populated. You may continue to call this method until IsTopicPaged returns "False" and TopicMarker is empty to retrieve all results.

ListTopicSubscriptions Method (IPWorksMQ_AmazonSNS Class)

Lists subscriptions to the specified topic.

Object Oriented Interface

public function doListTopicSubscriptions($topicarn);

Procedural Interface

ipworksmq_amazonsns_do_listtopicsubscriptions($res, $topicarn);

Remarks

This method lists the subscriptions to the specified topic.

When calling this method the subscriptions to the topic specified by TopicARN will be listed. The SubscriptionList event will fire once for each subscription and the Subscriptions collection will be populated with information about the subscriptions.

If the results are paged the IsSubscriptionPaged setting will return the value "True" and SubscriptionMarker will be populated. You may continue to call this method until IsSubscriptionPaged returns "False" and SubscriptionMarker is empty to retrieve all results.

Publish Method (IPWorksMQ_AmazonSNS Class)

Publishes a message to the topic.

Object Oriented Interface

public function doPublish($topicarn, $subject, $message);

Procedural Interface

ipworksmq_amazonsns_do_publish($res, $topicarn, $subject, $message);

Remarks

This method publishes a message to the topic specified by TopicArn.

The Subject parameter is optional and specifies the "Subject" line of the message delivered to e-mail endpoints. 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.

The Message parameter is the text to send. Messages must be UTF-8 encoded strings at most 64 KB in size (65536 bytes, not 65536 characters).

The same message will be delivered to all subscribers. To send different messages based on the protocol used by the subscription call PublishCustom instead.

The method returns the unique MessageId assigned to the published message. It will be at most 100 characters in length.

PublishCustom Method (IPWorksMQ_AmazonSNS Class)

Publishes a message to the topic.

Object Oriented Interface

public function doPublishCustom($topicarn, $subject, $defaultmessage, $emailmessage, $emailjsonmessage, $httpmessage, $httpsmessage, $smsmessage, $sqsmessage);

Procedural Interface

ipworksmq_amazonsns_do_publishcustom($res, $topicarn, $subject, $defaultmessage, $emailmessage, $emailjsonmessage, $httpmessage, $httpsmessage, $smsmessage, $sqsmessage);

Remarks

This method may be used instead of Publish to specify different messages depending on the protocol used by the subscription.

TopicArn specifies the topic.

The Subject parameter is optional and specifies the "Subject" line of the message delivered to e-mail endpoints. 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.

DefaultMessage will be used for any protocol that is not specifically assigned a message. If empty string is specified for any other message parameter this value will be used.

EmailMessage, EmailJsonMessage, HttpMessage, HttpsMessage, SmsMessage, and SqsMessage specify messages for the respective protocol. These parameters are all optional. If empty string is specified the DefaultMessage will be used.

The method returns the unique MessageId assigned to the published message. It will be at most 100 characters in length.

RemovePermission Method (IPWorksMQ_AmazonSNS Class)

Removes permissions from a topic.

Object Oriented Interface

public function doRemovePermission($topicarn, $policylabel);

Procedural Interface

ipworksmq_amazonsns_do_removepermission($res, $topicarn, $policylabel);

Remarks

This method removes permissions specified by the PolicyLabel from the access control policy of the topic specified by TopicArn.

Reset Method (IPWorksMQ_AmazonSNS Class)

Resets request-related properties.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksmq_amazonsns_do_reset($res);

Remarks

Calling this method will reset the component to the original state.

SendCustomRequest Method (IPWorksMQ_AmazonSNS Class)

Allows the sending of a custom request to an Amazon web service.

Object Oriented Interface

public function doSendCustomRequest($url, $requestdata, $otherheaders);

Procedural Interface

ipworksmq_amazonsns_do_sendcustomrequest($res, $url, $requestdata, $otherheaders);

Remarks

Allows the sending of a custom request to the Amazon web service. The URL parameter describes the endpoint that is being targeted. The RequestData is set to any data required for the request. The OtherHeaders parameter is used to set any additional headers that should be set for the request.

SetSubscriptionAttributes Method (IPWorksMQ_AmazonSNS Class)

Sets attributes of the subscription.

Object Oriented Interface

public function doSetSubscriptionAttributes($subscriptionarn, $attributevalue);

Procedural Interface

ipworksmq_amazonsns_do_setsubscriptionattributes($res, $subscriptionarn, $attributevalue);

Remarks

This method is used to set an attribute of the subscription. Currently only the delivery policy may be set.

The SubscriptionArn parameter specifies the Amazon Resource Name (ARN) of the subscription.

The AttributeValue specifies the value to be set. Since the only currently valid attribute is the delivery policy, this is the value of the delivery policy in JSON format, for instance:

{"healthyRetryPolicy": {"minDelayTarget": 1, "maxDelayTarget": 5, "numRetries": 5, "numMaxDelayRetries": 5, "backoffFunction": "linear"}}

SetTopicAttributes Method (IPWorksMQ_AmazonSNS Class)

Sets attributes on the specified topic.

Object Oriented Interface

public function doSetTopicAttributes($topicarn, $attributetype, $attributevalue);

Procedural Interface

ipworksmq_amazonsns_do_settopicattributes($res, $topicarn, $attributetype, $attributevalue);

Remarks

This method may be used to specify attributes on the specified topic.

TopicArn specifies the topic.

AttributeType determines which attribute is set and AttributeValue specifies the value. The following table provides more information:

An example access policy is:

{"Version":"2008-10-17","Id":"__default_policy_ID","Statement":[{"Sid":"__default_statement_ID","Effect":"Allow","Principal":{"AWS":"*"},"Action":["SNS:Publish","SNS:RemovePermission","SNS:SetTopicAttributes","SNS:DeleteTopic","SNS:ListSubscriptionsByTopic","SNS:GetTopicAttributes","SNS:Receive","SNS:AddPermission","SNS:Subscribe"],"Resource":"arn:aws:sns:us-east-1:120151960619:TestTopic","Condition":{"StringEquals":{"AWS:SourceOwner":"120151960619"}}},{"Sid":"__console_pub_0","Effect":"Allow","Principal":{"AWS":"*"},"Action":"SNS:Publish","Resource":"arn:aws:sns:us-east-1:120151960619:TestTopic"}]}

An example delivery policy is:

{"http":{"defaultHealthyRetryPolicy": {"minDelayTarget": 1, "maxDelayTarget": 5, "numRetries": 5, "numMaxDelayRetries": 5, "backoffFunction": "linear"}}}

Subscribe Method (IPWorksMQ_AmazonSNS Class)

Request a subscription to the specific topic.

Object Oriented Interface

public function doSubscribe($topicarn, $endpoint, $endpointprotocol);

Procedural Interface

ipworksmq_amazonsns_do_subscribe($res, $topicarn, $endpoint, $endpointprotocol);

Remarks

This method requests a subscription to the topic specified by TopicArn. If the subscription was created immediately without requiring confirmation the SubscriptionArn will be returned by this method. The SubscriptionArn will begin with "arn:aws:sns". SubscriptionArn may be used with the following methods:

• GetSubscriptionAttributes
• SetSubscriptionAttributes
• Unsubscribe

If the subscription requires confirmation this method returns the subscription status such as "pending confirmation".

The Endpoint and EndpointProtocol parameters specify how the subscription confirmation message is delivered. Possible values for EndpointProtocol are:

The Endpoint parameter format depends on the chosen EndpointProtocol. Possible formats are:

Once the subscription confirmation is received by the endpoint owner the ConfirmSubscription method must be called with the confirmation token to complete the subscription.

Note: Confirmation tokens are valid for 3 days.

Unsubscribe Method (IPWorksMQ_AmazonSNS Class)

Unsubscribes from the topic.

Object Oriented Interface

public function doUnsubscribe($subscriptionarn);

Procedural Interface

ipworksmq_amazonsns_do_unsubscribe($res, $subscriptionarn);

Remarks

This method deletes a subscription to a topic. The subscription is identified by the SubscriptionArn parameter.

If the subscription requires authentication for deletion, only the subscription owner or topic owner can unsubscribe. If authentication is not required a cancellation notice is sent to the endpoint, so that the endpoint owner can re-subscribe if the unsubscribe request was unintentional.

Error Event (IPWorksMQ_AmazonSNS Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworksmq_amazonsns_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Log Event (IPWorksMQ_AmazonSNS Class)

Fired once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

ipworksmq_amazonsns_register_callback($res, 2, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'
 'logtype'

Remarks

This event is fired once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

SSLServerAuthentication Event (IPWorksMQ_AmazonSNS Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

ipworksmq_amazonsns_register_callback($res, 3, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (IPWorksMQ_AmazonSNS Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

ipworksmq_amazonsns_register_callback($res, 4, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

SubscriptionList Event (IPWorksMQ_AmazonSNS Class)

Fires with information about the subscription.

Object Oriented Interface

public function fireSubscriptionList($param);

Procedural Interface

ipworksmq_amazonsns_register_callback($res, 5, array($this, 'fireSubscriptionList'));

Parameter List

 'subscriptionarn'
 'topicarn'
 'owner'
 'endpoint'
 'protocol'

Remarks

This event fires once for each subscription returned from a call to ListSubscriptions or ListTopicSubscriptions.

SubscriptionArn is the ARN of the subscription.

TopicArn is the ARN of the subscription's topic.

Owner is the subscription's owner.

Protocol is the subscription's protocol. Possible values are:

Endpoint is the subscription's endpoint. Possible formats are:

TopicList Event (IPWorksMQ_AmazonSNS Class)

Fires with information about the topic.

Object Oriented Interface

public function fireTopicList($param);

Procedural Interface

ipworksmq_amazonsns_register_callback($res, 6, array($this, 'fireTopicList'));

Parameter List

 'topicarn'

Remarks

This event fires once for each topic returned from a call to ListTopics.

TopicARN identifies the current topic.

Config Settings (AmazonSNS Class)

SNS Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Trappable Errors (AmazonSNS Class)

SNS Errors

The class may also return one of the following error codes, which are inherited from other classes.

HTTP Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

SSL Errors

TCP/IP Errors