AmazonSNS Class
Properties Methods Events Config Settings Errors
The AmazonSNS class provides a simple interface to Amazon's Simple Notification Service (SNS).
Syntax
class ipworksmq.AmazonSNS
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 access_key and secret_key.
To create a topic, call create_topic. You may manage the topic and its properties with get_topic_attributes, set_topic_attributes, and delete_topic.
To subscribe to a topic, call subscribe. To manage a subscription, use get_subscription_attributes, set_subscription_attributes, and unsubscribe.
Use list_subscriptions, list_topic_subscriptions, and list_topics to list existing topics and subscriptions.
Call publish or publish_custom 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.
| access_key | The Access Key Id for the Amazon Web Services account. |
| firewall_auto_detect | This property tells the class whether or not to automatically detect and use firewall system settings, if available. |
| firewall_type | This property determines the type of firewall to connect through. |
| firewall_host | This property contains the name or IP address of firewall (optional). |
| firewall_password | This property contains a password if authentication is to be used when connecting through the firewall. |
| firewall_port | This property contains the transmission control protocol (TCP) port for the firewall Host . |
| firewall_user | This property contains a user name if authentication is to be used connecting through a firewall. |
| idle | The current status of the class. |
| local_host | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| proxy_auth_scheme | This property is used to tell the class which type of authorization to perform when connecting to the proxy. |
| proxy_auto_detect | This property tells the class whether or not to automatically detect and use proxy system settings, if available. |
| proxy_password | This property contains a password if authentication is to be used for the proxy. |
| proxy_port | This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80). |
| proxy_server | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
| proxy_ssl | This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. |
| proxy_user | This property contains a user name, if authentication is to be used for the proxy. |
| secret_key | The Secret Access Key for the Amazon Web Services account. |
| ssl_accept_server_cert_encoded | This is the certificate (PEM/base64 encoded). |
| ssl_cert_encoded | This is the certificate (PEM/base64 encoded). |
| ssl_cert_store | This is the name of the certificate store for the client certificate. |
| ssl_cert_store_password | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| ssl_cert_store_type | This is the type of certificate store for this certificate. |
| ssl_cert_subject | This is the subject of the certificate used for client authentication. |
| ssl_provider | This specifies the SSL/TLS implementation to use. |
| ssl_server_cert_encoded | This is the certificate (PEM/base64 encoded). |
| subscription_marker | The token identifying the next page of results. |
| subscription_count | The number of records in the Subscription arrays. |
| subscription_confirmation_was_authenticated | This property reports whether or not the subscription was confirmed. |
| subscription_delivery_policy | This property holds the JSON serialization of the subscription's delivery policy. |
| subscription_effective_delivery_policy | This property holds the JSON serialization of the subscription's effective delivery policy. |
| subscription_endpoint | This property contains the subscription's endpoint. |
| subscription_has_attributes | This property returns true if the subscription attributes are available. |
| subscription_owner | The AWS account ID of the subscription's owner. |
| subscription_protocol | This property specifies the protocol used by the subscription. |
| subscription_arn | The subscription's Amazon Resource Name (ARN) used to identify the subscription. |
| subscription_topic_arn | The Amazon Resource Name (ARN) of the topic this subscription is associated with. |
| timeout | A timeout for the class. |
| topic_marker | The token identifying the next page of results. |
| topic_count | The number of records in the Topic arrays. |
| topic_access_policy | This property holds the JSON serialized access control policy for the topic. |
| topic_delivery_policy | The JSON serialized policy for the topic. |
| topic_display_name | This property holds the name used in the 'From' property for email based endpoints. |
| topic_effective_delivery_policy | This property holds the JSON serialization of the topic's effective delivery policy. |
| topic_has_attributes | This property returns true if the topic attributes are available. |
| topic_owner | The AWS account ID of the topic's owner. |
| topic_subscriptions_confirmed | The number of confirmed subscriptions to this topic. |
| topic_subscriptions_deleted | The number of deleted subscriptions on this topic. |
| topic_subscriptions_pending | The number of pending subscriptions on this topic. |
| topic_arn | The Amazon Resource Name (ARN) of the topic. |
| use_ssl | Determines if SSL is used when connecting to Amazon. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| add_permission | Adds permissions to the topic's access control policy. |
| config | Sets or retrieves a configuration setting. |
| confirm_subscription | Completes the subscription request. |
| create_topic | Creates a new topic. |
| delete_topic | Deletes the specified topic. |
| do_events | Processes events from the internal message queue. |
| get_subscription_attributes | Retrieves the subscription's attributes. |
| get_topic_attributes | Retrieves the topic's attributes. |
| get_x_value | Retrieves a valid XPath expression from the HTTP response after calling SendCustomRequest . |
| interrupt | Interrupt the current method. |
| list_subscriptions | Lists subscriptions for the current account. |
| list_topics | Lists all topics for the current account. |
| list_topic_subscriptions | Lists subscriptions to the specified topic. |
| publish | Publishes a message to the topic. |
| publish_custom | Publishes a message to the topic. |
| remove_permission | Removes permissions from a topic. |
| reset | Resets request-related properties. |
| send_custom_request | Allows the sending of a custom request to an Amazon web service. |
| set_subscription_attributes | Sets attributes of the subscription. |
| set_topic_attributes | Sets attributes on the specified topic. |
| subscribe | Request a subscription to the specific topic. |
| unsubscribe | Unsubscribes from the topic. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
| on_error | Information about errors during data delivery. |
| on_log | This event fires once for each log message. |
| on_ssl_server_authentication | Fired after the server presents its certificate to the client. |
| on_ssl_status | Shows the progress of the secure connection. |
| on_subscription_list | Fires with information about the subscription. |
| on_topic_list | Fires with information about the topic. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
| APIVersion | Service's API version. |
| HTTPMethod | Specifies the HTTP method to use when sending a custom request. |
| IsSubscriptionPaged | Whether or not all subscriptions were returned by the last listing. |
| IsTopicPaged | Whether or not all topics were returned by the last listing. |
| JSONMessage | A custom JSON message to be published. |
| MessageAttributeCount | The number of message attributes. |
| MessageAttributeDataType[i] | The data type of the message attribute. |
| MessageAttributeName[i] | The name of the message attribute. |
| MessageAttributeValue[i] | The value of the message attribute. |
| PhoneNumber | The phone number to which you want to deliver an SMS message. Use E.164 format. |
| SignatureVersion | The version of signature used. |
| SignCustomRequest | Tells the class to sign the outgoing request. |
| TargetArn | The TargetArn when publishing a message. |
| TransferredData | Returns the entire XML response received from the server. |
| URL | If set, the default URL will be overridden by this value. |
| AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
| AllowHTTPCompression | This property enables HTTP compression for receiving data. |
| AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
| Append | Whether to append data to LocalFile. |
| Authorization | The Authorization string to be sent to the server. |
| BytesTransferred | Contains the number of bytes transferred in the response data. |
| ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
| CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
| EncodeURL | If set to True the URL will be encoded by the class. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| GetOn302Redirect | If set to True the class will perform a GET on the new location. |
| HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
| HTTPVersion | The version of HTTP used by the class. |
| IfModifiedSince | A date determining the maximum age of the desired document. |
| KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
| KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
| LogLevel | The level of detail that is logged. |
| MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
| NegotiatedHTTPVersion | The negotiated HTTP version. |
| OtherHeaders | Other headers as determined by the user (optional). |
| ProxyAuthorization | The authorization string to be sent to the proxy server. |
| ProxyAuthScheme | The authorization scheme to be used for the proxy. |
| ProxyPassword | A password if authentication is to be used for the proxy. |
| ProxyPort | Port for the proxy server (default 80). |
| ProxyServer | Name or IP address of a proxy server (optional). |
| ProxyUser | A user name if authentication is to be used for the proxy. |
| SentHeaders | The full set of headers as sent by the client. |
| StatusCode | The status code of the last response from the server. |
| StatusLine | The first line of the last response from the server. |
| TransferredData | The contents of the last response from the server. |
| TransferredDataLimit | The maximum number of incoming bytes to be stored by the class. |
| TransferredHeaders | The full set of headers as received from the server. |
| TransferredRequest | The full request as sent by the client. |
| UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
| UseIDNs | Whether to encode hostnames to internationalized domain names. |
| UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
| UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
| UserAgent | Information about the user agent (browser). |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The port in the local host where the class binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| UseIPv6 | Whether to use IPv6. |
| LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
| OpenSSLCADir | The path to a directory containing CA certificates. |
| OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
| OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
| OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
| SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
| SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
| SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
| SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
| SSLNegotiatedCipher | Returns the negotiated cipher suite. |
| SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
| SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
| SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
| SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
| SSLNegotiatedVersion | Returns the negotiated protocol version. |
| SSLSecurityFlags | Flags that control certificate verification. |
| SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
| TLS12SupportedGroups | The supported groups for ECC. |
| TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
| TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
| TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
access_key Property
The Access Key Id for the Amazon Web Services account.
Syntax
def get_access_key() -> str: ... def set_access_key(value: str) -> None: ...
access_key = property(get_access_key, set_access_key)
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 secret_key to authenticate with Amazon servers.
firewall_auto_detect Property
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
Syntax
def get_firewall_auto_detect() -> bool: ... def set_firewall_auto_detect(value: bool) -> None: ...
firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)
Default Value
FALSE
Remarks
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
firewall_type Property
This property determines the type of firewall to connect through.
Syntax
def get_firewall_type() -> int: ... def set_firewall_type(value: int) -> None: ...
firewall_type = property(get_firewall_type, set_firewall_type)
Default Value
0
Remarks
This property determines the type of firewall to connect through. The applicable values are as follows:
| fwNone (0) | No firewall (default setting). |
| fwTunnel (1) | Connect through a tunneling proxy. firewall_port is set to 80. |
| fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. firewall_port is set to 1080. |
| fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. firewall_port is set to 1080. |
| fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. firewall_port is set to 1080. |
firewall_host Property
This property contains the name or IP address of firewall (optional).
Syntax
def get_firewall_host() -> str: ... def set_firewall_host(value: str) -> None: ...
firewall_host = property(get_firewall_host, set_firewall_host)
Default Value
""
Remarks
This property contains the name or IP address of firewall (optional). If a firewall_host 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.
firewall_password Property
This property contains a password if authentication is to be used when connecting through the firewall.
Syntax
def get_firewall_password() -> str: ... def set_firewall_password(value: str) -> None: ...
firewall_password = property(get_firewall_password, set_firewall_password)
Default Value
""
Remarks
This property contains a password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
firewall_port Property
This property contains the transmission control protocol (TCP) port for the firewall Host .
Syntax
def get_firewall_port() -> int: ... def set_firewall_port(value: int) -> None: ...
firewall_port = property(get_firewall_port, set_firewall_port)
Default Value
0
Remarks
This property contains the transmission control protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.
Note: This property is set automatically when firewall_type is set to a valid value. See the description of the firewall_type property for details.
firewall_user Property
This property contains a user name if authentication is to be used connecting through a firewall.
Syntax
def get_firewall_user() -> str: ... def set_firewall_user(value: str) -> None: ...
firewall_user = property(get_firewall_user, set_firewall_user)
Default Value
""
Remarks
This property contains a user name if authentication is to be used connecting through a firewall. If the firewall_host is specified, this property and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
idle Property
The current status of the class.
Syntax
def get_idle() -> bool: ...
idle = property(get_idle, None)
Default Value
TRUE
Remarks
idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.
This property is read-only.
local_host Property
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
def get_local_host() -> str: ... def set_local_host(value: str) -> None: ...
local_host = property(get_local_host, set_local_host)
Default Value
""
Remarks
The local_host 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the local_host 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 multi-homed hosts (machines with more than one IP interface).
NOTE: local_host is not persistent. You must always set it in code, and never in the property window.
proxy_auth_scheme Property
This property is used to tell the class which type of authorization to perform when connecting to the proxy.
Syntax
def get_proxy_auth_scheme() -> int: ... def set_proxy_auth_scheme(value: int) -> None: ...
proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)
Default Value
0
Remarks
This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the proxy_user and proxy_password properties are set.
proxy_auth_scheme should be set to authNone (3) when no authentication is expected.
By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the component will attempt basic authentication.
If proxy_auth_scheme is set to authDigest (1), digest authentication will be attempted instead.
If proxy_auth_scheme 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 proxy_auth_scheme is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this property will clear the values of proxy_user and proxy_password.
proxy_auto_detect Property
This property tells the class whether or not to automatically detect and use proxy system settings, if available.
Syntax
def get_proxy_auto_detect() -> bool: ... def set_proxy_auto_detect(value: bool) -> None: ...
proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)
Default Value
FALSE
Remarks
This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is False.
proxy_password Property
This property contains a password if authentication is to be used for the proxy.
Syntax
def get_proxy_password() -> str: ... def set_proxy_password(value: str) -> None: ...
proxy_password = property(get_proxy_password, set_proxy_password)
Default Value
""
Remarks
This property contains a password if authentication is to be used for the proxy.
If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.
If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.
proxy_port Property
This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
Syntax
def get_proxy_port() -> int: ... def set_proxy_port(value: int) -> None: ...
proxy_port = property(get_proxy_port, set_proxy_port)
Default Value
80
Remarks
This property contains the Transmission Control Protocol (TCP) port for the proxy proxy_server (default 80). See the description of the proxy_server property for details.
proxy_server Property
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
Syntax
def get_proxy_server() -> str: ... def set_proxy_server(value: str) -> None: ...
proxy_server = property(get_proxy_server, set_proxy_server)
Default Value
""
Remarks
If a proxy proxy_server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the proxy_server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the proxy_server property is set to the corresponding address. If the search is not successful, an error is returned.
proxy_ssl Property
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
Syntax
def get_proxy_ssl() -> int: ... def set_proxy_ssl(value: int) -> None: ...
proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)
Default Value
0
Remarks
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:
| psAutomatic (0) | Default setting. If the url is an https URL, the class will use the psTunnel option. If the url is an http URL, the class will use the psNever option. |
| psAlways (1) | The connection is always SSL enabled. |
| psNever (2) | The connection is not SSL enabled. |
| psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. |
proxy_user Property
This property contains a user name, if authentication is to be used for the proxy.
Syntax
def get_proxy_user() -> str: ... def set_proxy_user(value: str) -> None: ...
proxy_user = property(get_proxy_user, set_proxy_user)
Default Value
""
Remarks
This property contains a user name, if authentication is to be used for the proxy.
If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.
If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.
secret_key Property
The Secret Access Key for the Amazon Web Services account.
Syntax
def get_secret_key() -> str: ... def set_secret_key(value: str) -> None: ...
secret_key = property(get_secret_key, set_secret_key)
Default Value
""
Remarks
This property describes the secret key to the Amazon account. It should not be shared with others. The secret_key is used along with the access_key in the authentication process with Amazon servers.
ssl_accept_server_cert_encoded Property
This is the certificate (PEM/base64 encoded).
Syntax
def get_ssl_accept_server_cert_encoded() -> bytes: ... def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...
ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.
When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.
ssl_cert_encoded Property
This is the certificate (PEM/base64 encoded).
Syntax
def get_ssl_cert_encoded() -> bytes: ... def set_ssl_cert_encoded(value: bytes) -> None: ...
ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.
When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.
ssl_cert_store Property
This is the name of the certificate store for the client certificate.
Syntax
def get_ssl_cert_store() -> bytes: ... def set_ssl_cert_store(value: bytes) -> None: ...
ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password protected, specify the password in ssl_cert_store_password.
ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
ssl_cert_store_password Property
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
def get_ssl_cert_store_password() -> str: ... def set_ssl_cert_store_password(value: str) -> None: ...
ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)
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.
ssl_cert_store_type Property
This is the type of certificate store for this certificate.
Syntax
def get_ssl_cert_store_type() -> int: ... def set_ssl_cert_store_type(value: int) -> None: ...
ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)
Default Value
0
Remarks
This is 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:
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS11 interface.
To use a security key the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS11 dll. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the ssl_cert_store and set ssl_cert_store_password to the PIN. Code Example: SSH Authentication with Security Key
|
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
ssl_cert_subject Property
This is the subject of the certificate used for client authentication.
Syntax
def get_ssl_cert_subject() -> str: ... def set_ssl_cert_subject(value: str) -> None: ...
ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)
Default Value
""
Remarks
This is 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 displayed below.
| Field | Meaning |
| CN | Common Name. This is commonly a host name like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma it must be quoted.
ssl_provider Property
This specifies the SSL/TLS implementation to use.
Syntax
def get_ssl_provider() -> int: ... def set_ssl_provider(value: int) -> None: ...
ssl_provider = property(get_ssl_provider, set_ssl_provider)
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:
| 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
| 1 (sslpPlatform) | Uses the platform/system implementation. |
| 2 (sslpInternal) | Uses the internal implementation. |
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.
ssl_server_cert_encoded Property
This is the certificate (PEM/base64 encoded).
Syntax
def get_ssl_server_cert_encoded() -> bytes: ...
ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.
When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.
This property is read-only.
subscription_marker Property
The token identifying the next page of results.
Syntax
def get_subscription_marker() -> str: ... def set_subscription_marker(value: str) -> None: ...
subscription_marker = property(get_subscription_marker, set_subscription_marker)
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 list_subscriptions for more details.
subscription_count Property
The number of records in the Subscription arrays.
Syntax
def get_subscription_count() -> int: ...
subscription_count = property(get_subscription_count, None)
Default Value
0
Remarks
This property controls the size of the following arrays:
- subscription_arn
- subscription_confirmation_was_authenticated
- subscription_delivery_policy
- subscription_effective_delivery_policy
- subscription_endpoint
- subscription_has_attributes
- subscription_owner
- subscription_protocol
- subscription_topic_arn
This property is read-only.
subscription_confirmation_was_authenticated Property
This property reports whether or not the subscription was confirmed.
Syntax
def get_subscription_confirmation_was_authenticated(subscription_index: int) -> bool: ...
Default Value
FALSE
Remarks
This property reports whether or not the subscription was confirmed.
Note: This property is only applicable after calling get_subscription_attributes.
The subscription_index parameter specifies the index of the item in the array. The size of the array is controlled by the subscription_count property.
This property is read-only.
subscription_delivery_policy Property
This property holds the JSON serialization of the subscription's delivery policy.
Syntax
def get_subscription_delivery_policy(subscription_index: int) -> str: ...
Default Value
""
Remarks
This property holds the JSON serialization of the subscription's delivery policy.
Note: This property is only applicable after calling get_subscription_attributes.
The subscription_index parameter specifies the index of the item in the array. The size of the array is controlled by the subscription_count property.
This property is read-only.
subscription_effective_delivery_policy Property
This property holds the JSON serialization of the subscription's effective delivery policy.
Syntax
def get_subscription_effective_delivery_policy(subscription_index: int) -> str: ...
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 get_subscription_attributes.
The subscription_index parameter specifies the index of the item in the array. The size of the array is controlled by the subscription_count property.
This property is read-only.
subscription_endpoint Property
This property contains the subscription's endpoint.
Syntax
def get_subscription_endpoint(subscription_index: int) -> str: ...
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:
| A valid e-mail address | for use with the "email" protocol |
| A valid e-mail address | for use with the "email-json" protocol |
| A URL beginning with "http://" | for use with the "http" protocol |
| A URL beginning with "https://" | for use with the "https" protocol |
| A phone number (e.g. 19195447070) | for use with the "sms" protocol |
| A SQS queue ARN | for use with the "sqs" protocol |
Note: This property is only applicable after calling list_subscriptions or list_topic_subscriptions.
The subscription_index parameter specifies the index of the item in the array. The size of the array is controlled by the subscription_count property.
This property is read-only.
subscription_has_attributes Property
This property returns true if the subscription attributes are available.
Syntax
def get_subscription_has_attributes(subscription_index: int) -> bool: ...
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 get_subscription_attributes. This property serves as an easy way to determine if the subscription's attributes are available.
The following properties are applicable after calling get_subscription_attributes:
- subscription_confirmation_was_authenticated
- subscription_delivery_policy
- subscription_effective_delivery_policy
- subscription_owner
- subscription_arn
- subscription_topic_arn
The following properties are applicable after calling list_subscriptions or list_topic_subscriptions:
The subscription_index parameter specifies the index of the item in the array. The size of the array is controlled by the subscription_count property.
This property is read-only.
subscription_owner Property
The AWS account ID of the subscription's owner.
Syntax
def get_subscription_owner(subscription_index: int) -> str: ...
Default Value
""
Remarks
The AWS account ID of the subscription's owner.
The subscription_index parameter specifies the index of the item in the array. The size of the array is controlled by the subscription_count property.
This property is read-only.
subscription_protocol Property
This property specifies the protocol used by the subscription.
Syntax
def get_subscription_protocol(subscription_index: int) -> int: ...
Default Value
0
Remarks
This property specifies the protocol used by the subscription. Possible values are:
| 0 (email) | message via SMTP |
| 1 (email-json) | JSON-encoded message via SMTP |
| 2 (http) | JSON-encoded message via HTTP POST |
| 3 (https) | JSON-encoded message via HTTPS POST |
| 4 (sms) | message via SMS |
| 5 (sqs) | JSON-encoded message to an Amazon SQS queue |
Note: This property is only applicable after calling list_subscriptions or list_topic_subscriptions.
The subscription_index parameter specifies the index of the item in the array. The size of the array is controlled by the subscription_count property.
This property is read-only.
subscription_arn Property
The subscription's Amazon Resource Name (ARN) used to identify the subscription.
Syntax
def get_subscription_arn(subscription_index: int) -> str: ...
Default Value
""
Remarks
The subscription's Amazon Resource Name (ARN) used to identify the subscription.
The subscription_index parameter specifies the index of the item in the array. The size of the array is controlled by the subscription_count property.
This property is read-only.
subscription_topic_arn Property
The Amazon Resource Name (ARN) of the topic this subscription is associated with.
Syntax
def get_subscription_topic_arn(subscription_index: int) -> str: ...
Default Value
""
Remarks
The Amazon Resource Name (ARN) of the topic this subscription is associated with.
The subscription_index parameter specifies the index of the item in the array. The size of the array is controlled by the subscription_count property.
This property is read-only.
timeout Property
A timeout for the class.
Syntax
def get_timeout() -> int: ... def set_timeout(value: int) -> None: ...
timeout = property(get_timeout, set_timeout)
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 do_events 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.
Please note that by default, all timeouts are inactivity timeouts, i.e. 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.
topic_marker Property
The token identifying the next page of results.
Syntax
def get_topic_marker() -> str: ... def set_topic_marker(value: str) -> None: ...
topic_marker = property(get_topic_marker, set_topic_marker)
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 list_topics for more details.
topic_count Property
The number of records in the Topic arrays.
Syntax
def get_topic_count() -> int: ...
topic_count = property(get_topic_count, None)
Default Value
0
Remarks
This property controls the size of the following arrays:
- topic_access_policy
- topic_arn
- topic_delivery_policy
- topic_display_name
- topic_effective_delivery_policy
- topic_has_attributes
- topic_owner
- topic_subscriptions_confirmed
- topic_subscriptions_deleted
- topic_subscriptions_pending
This property is read-only.
topic_access_policy Property
This property holds the JSON serialized access control policy for the topic.
Syntax
def get_topic_access_policy(topic_index: int) -> str: ...
Default Value
""
Remarks
This property holds the JSON serialized access control policy for the topic.
Note: This property is only applicable after calling get_topic_attributes.
The topic_index parameter specifies the index of the item in the array. The size of the array is controlled by the topic_count property.
This property is read-only.
topic_delivery_policy Property
The JSON serialized policy for the topic.
Syntax
def get_topic_delivery_policy(topic_index: int) -> str: ...
Default Value
""
Remarks
The JSON serialized policy for the topic.
Note: This property is only applicable after calling get_topic_attributes.
The topic_index parameter specifies the index of the item in the array. The size of the array is controlled by the topic_count property.
This property is read-only.
topic_display_name Property
This property holds the name used in the 'From' property for email based endpoints.
Syntax
def get_topic_display_name(topic_index: int) -> str: ...
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 get_topic_attributes.
The topic_index parameter specifies the index of the item in the array. The size of the array is controlled by the topic_count property.
This property is read-only.
topic_effective_delivery_policy Property
This property holds the JSON serialization of the topic's effective delivery policy.
Syntax
def get_topic_effective_delivery_policy(topic_index: int) -> str: ...
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 get_topic_attributes.
The topic_index parameter specifies the index of the item in the array. The size of the array is controlled by the topic_count property.
This property is read-only.
topic_has_attributes Property
This property returns true if the topic attributes are available.
Syntax
def get_topic_has_attributes(topic_index: int) -> bool: ...
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 get_topic_attributes. This property serves as an easy way to determine if the topic's attributes are available.
The following properties are applicable after calling get_topic_attributes:
- topic_delivery_policy
- topic_display_name
- topic_effective_delivery_policy
- topic_owner
- topic_access_policy
- topic_subscriptions_confirmed
- topic_subscriptions_deleted
- topic_subscriptions_pending
- topic_arn
The following properties are applicable after calling list_topics:
The topic_index parameter specifies the index of the item in the array. The size of the array is controlled by the topic_count property.
This property is read-only.
topic_owner Property
The AWS account ID of the topic's owner.
Syntax
def get_topic_owner(topic_index: int) -> str: ...
Default Value
""
Remarks
The AWS account ID of the topic's owner.
Note: This property is only applicable after calling get_topic_attributes.
The topic_index parameter specifies the index of the item in the array. The size of the array is controlled by the topic_count property.
This property is read-only.
topic_subscriptions_confirmed Property
The number of confirmed subscriptions to this topic.
Syntax
def get_topic_subscriptions_confirmed(topic_index: int) -> int: ...
Default Value
0
Remarks
The number of confirmed subscriptions to this topic.
Note: This property is only applicable after calling get_topic_attributes.
The topic_index parameter specifies the index of the item in the array. The size of the array is controlled by the topic_count property.
This property is read-only.
topic_subscriptions_deleted Property
The number of deleted subscriptions on this topic.
Syntax
def get_topic_subscriptions_deleted(topic_index: int) -> int: ...
Default Value
0
Remarks
The number of deleted subscriptions on this topic.
Note: This property is only applicable after calling get_topic_attributes.
The topic_index parameter specifies the index of the item in the array. The size of the array is controlled by the topic_count property.
This property is read-only.
topic_subscriptions_pending Property
The number of pending subscriptions on this topic.
Syntax
def get_topic_subscriptions_pending(topic_index: int) -> int: ...
Default Value
0
Remarks
The number of pending subscriptions on this topic.
Note: This property is only applicable after calling get_topic_attributes.
The topic_index parameter specifies the index of the item in the array. The size of the array is controlled by the topic_count property.
This property is read-only.
topic_arn Property
The Amazon Resource Name (ARN) of the topic.
Syntax
def get_topic_arn(topic_index: int) -> str: ...
Default Value
""
Remarks
The Amazon Resource Name (ARN) of the topic.
The topic_index parameter specifies the index of the item in the array. The size of the array is controlled by the topic_count property.
This property is read-only.
use_ssl Property
Determines if SSL is used when connecting to Amazon.
Syntax
def get_use_ssl() -> bool: ... def set_use_ssl(value: bool) -> None: ...
use_ssl = property(get_use_ssl, set_use_ssl)
Default Value
FALSE
Remarks
Use this property to specify whether or not the component uses SSL to connect with Amazon SNS servers.
add_permission Method
Adds permissions to the topic's access control policy.
Syntax
def add_permission(topic_arn: str, policy_label: str, aws_account_ids: str, action_names: str) -> None: ...
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
Sets or retrieves a configuration setting.
Syntax
def config(configuration_string: str) -> str: ...
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.
confirm_subscription Method
Completes the subscription request.
Syntax
def confirm_subscription(topic_arn: str, token: str) -> str: ...
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:
create_topic Method
Creates a new topic.
Syntax
def create_topic(name: str) -> str: ...
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:
- delete_topic
- get_topic_attributes
- list_topic_subscriptions
- publish
- publish_custom
- remove_permission
- set_topic_attributes
- subscribe
delete_topic Method
Deletes the specified topic.
Syntax
def delete_topic(topic_arn: str) -> None: ...
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.
do_events Method
Processes events from the internal message queue.
Syntax
def do_events() -> None: ...
Remarks
When do_events is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.
get_subscription_attributes Method
Retrieves the subscription's attributes.
Syntax
def get_subscription_attributes(subscription_arn: str) -> None: ...
Remarks
This method retrieves the subscription's attributes. The attributes are available through the Subscription* properties.
get_topic_attributes Method
Retrieves the topic's attributes.
Syntax
def get_topic_attributes(topic_arn: str) -> None: ...
Remarks
This method topic the subscription's attributes. The topic are available through the Topic* properties.
get_x_value Method
Retrieves a valid XPath expression from the HTTP response after calling SendCustomRequest .
Syntax
def get_x_value(xpath: str) -> str: ...
Remarks
This method allows a user to retrieve a valid XPath expression from the HTTP response after calling send_custom_request.
interrupt Method
Interrupt the current method.
Syntax
def interrupt() -> None: ...
Remarks
If there is no method in progress, interrupt simply returns, doing nothing.
list_subscriptions Method
Lists subscriptions for the current account.
Syntax
def list_subscriptions() -> None: ...
Remarks
This method lists the subscriptions for the current AWS account.
When calling this method all subscriptions for the current AWS account identified by access_key and secret_key will be listed. The on_subscription_list event will fire once for each subscription and the Subscription* properties will be populated with information about the subscriptions.
If the results are paged the IsSubscriptionPaged setting will return the value "True" and subscription_marker will be populated. You may continue to call this method until IsSubscriptionPaged returns "False" and subscription_marker is empty to retrieve all results.
list_topics Method
Lists all topics for the current account.
Syntax
def list_topics() -> None: ...
Remarks
This method lists all topics for the AWS account specified by access_key and secret_key.
When this method is called the on_topic_list event will fire once for each topic and the Topic* properties will be populated with information about the topics.
If the results are paged the IsTopicPaged setting will return the value "True" and topic_marker will be populated. You may continue to call this method until IsTopicPaged returns "False" and topic_marker is empty to retrieve all results.
list_topic_subscriptions Method
Lists subscriptions to the specified topic.
Syntax
def list_topic_subscriptions(topic_arn: str) -> None: ...
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 on_subscription_list event will fire once for each subscription and the Subscription* properties will be populated with information about the subscriptions.
If the results are paged the IsSubscriptionPaged setting will return the value "True" and subscription_marker will be populated. You may continue to call this method until IsSubscriptionPaged returns "False" and subscription_marker is empty to retrieve all results.
publish Method
Publishes a message to the topic.
Syntax
def publish(topic_arn: str, subject: str, message: str) -> str: ...
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 publish_custom instead.
The method returns the unique MessageId assigned to the published message. It will be at most 100 characters in length.
publish_custom Method
Publishes a message to the topic.
Syntax
def publish_custom(topic_arn: str, subject: str, default_message: str, email_message: str, email_json_message: str, http_message: str, https_message: str, sms_message: str, sqs_message: str) -> str: ...
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.
remove_permission Method
Removes permissions from a topic.
Syntax
def remove_permission(topic_arn: str, policy_label: str) -> None: ...
Remarks
This method removes permissions specified by the PolicyLabel from the access control policy of the topic specified by TopicArn.
reset Method
Resets request-related properties.
Syntax
def reset() -> None: ...
Remarks
Calling this method will reset the component to the original state.
send_custom_request Method
Allows the sending of a custom request to an Amazon web service.
Syntax
def send_custom_request(url: str, request_data: str, other_headers: str) -> str: ...
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.
set_subscription_attributes Method
Sets attributes of the subscription.
Syntax
def set_subscription_attributes(subscription_arn: str, attribute_value: str) -> None: ...
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"}}
set_topic_attributes Method
Sets attributes on the specified topic.
Syntax
def set_topic_attributes(topic_arn: str, attribute_type: int, attribute_value: str) -> None: ...
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:
| AttributeType | AttributeValue |
| 0 (DisplayName) | A human readable name to be used in the "From" field for email based endpoints |
| 1 (AccessPolicy) | A JSON serialized access policy for the topic |
| 2 (DeliveryPolicy) | A JSON serialized delivery policy for the topic |
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
Request a subscription to the specific topic.
Syntax
def subscribe(topic_arn: str, endpoint: str, endpoint_protocol: int) -> str: ...
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:
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:
| 0 (email) | message via SMTP |
| 1 (email-json) | JSON-encoded message via SMTP |
| 2 (http) | JSON-encoded message via HTTP POST |
| 3 (https) | JSON-encoded message via HTTPS POST |
| 4 (sms) | message via SMS |
| 5 (sqs) | JSON-encoded message to an Amazon SQS queue |
The Endpoint parameter format depends on the chosen EndpointProtocol. Possible formats are:
| A valid e-mail address | for use with the "email" protocol |
| A valid e-mail address | for use with the "email-json" protocol |
| A URL beginning with "http://" | for use with the "http" protocol |
| A URL beginning with "https://" | for use with the "https" protocol |
| A phone number (e.g. 19195447070) | for use with the "sms" protocol |
| A SQS queue ARN | for use with the "sqs" protocol |
Once the subscription confirmation is received by the endpoint owner the confirm_subscription method must be called with the confirmation token to complete the subscription.
Note: Confirmation tokens are valid for 3 days.
unsubscribe Method
Unsubscribes from the topic.
Syntax
def unsubscribe(subscription_arn: str) -> None: ...
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.
on_error Event
Information about errors during data delivery.
Syntax
class AmazonSNSErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class AmazonSNS: @property def on_error() -> Callable[[AmazonSNSErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[AmazonSNSErrorEventParams], None]) -> None: ...
Remarks
The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
on_log Event
This event fires once for each log message.
Syntax
class AmazonSNSLogEventParams(object): @property def log_level() -> int: ... @property def message() -> str: ... @property def log_type() -> str: ... # In class AmazonSNS: @property def on_log() -> Callable[[AmazonSNSLogEventParams], None]: ... @on_log.setter def on_log(event_hook: Callable[[AmazonSNSLogEventParams], None]) -> None: ...
Remarks
This event fires 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:
| 0 (None) | No events are logged. |
| 1 (Info - default) | Informational events are logged. |
| 2 (Verbose) | Detailed data are logged. |
| 3 (Debug) | Debug data are logged. |
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"
on_ssl_server_authentication Event
Fired after the server presents its certificate to the client.
Syntax
class AmazonSNSSSLServerAuthenticationEventParams(object): @property def cert_encoded() -> bytes: ... @property def cert_subject() -> str: ... @property def cert_issuer() -> str: ... @property def status() -> str: ... @property def accept() -> bool: ... @accept.setter def accept(value) -> None: ... # In class AmazonSNS: @property def on_ssl_server_authentication() -> Callable[[AmazonSNSSSLServerAuthenticationEventParams], None]: ... @on_ssl_server_authentication.setter def on_ssl_server_authentication(event_hook: Callable[[AmazonSNSSSLServerAuthenticationEventParams], None]) -> None: ...
Remarks
This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.
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.
on_ssl_status Event
Shows the progress of the secure connection.
Syntax
class AmazonSNSSSLStatusEventParams(object): @property def message() -> str: ... # In class AmazonSNS: @property def on_ssl_status() -> Callable[[AmazonSNSSSLStatusEventParams], None]: ... @on_ssl_status.setter def on_ssl_status(event_hook: Callable[[AmazonSNSSSLStatusEventParams], None]) -> None: ...
Remarks
The event is fired for informational and logging purposes only. Used to track the progress of the connection.
on_subscription_list Event
Fires with information about the subscription.
Syntax
class AmazonSNSSubscriptionListEventParams(object): @property def subscription_arn() -> str: ... @property def topic_arn() -> str: ... @property def owner() -> str: ... @property def endpoint() -> str: ... @property def protocol() -> int: ... # In class AmazonSNS: @property def on_subscription_list() -> Callable[[AmazonSNSSubscriptionListEventParams], None]: ... @on_subscription_list.setter def on_subscription_list(event_hook: Callable[[AmazonSNSSubscriptionListEventParams], None]) -> None: ...
Remarks
This event fires once for each subscription returned from a call to list_subscriptions or list_topic_subscriptions.
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:
| 0 (email) | message via SMTP |
| 1 (email-json) | JSON-encoded message via SMTP |
| 2 (http) | JSON-encoded message via HTTP POST |
| 3 (https) | JSON-encoded message via HTTPS POST |
| 4 (sms) | message via SMS |
| 5 (sqs) | JSON-encoded message to an Amazon SQS queue |
Endpoint is the subscription's endpoint. Possible formats are:
| A valid e-mail address | for use with the "email" protocol |
| A valid e-mail address | for use with the "email-json" protocol |
| A URL beginning with "http://" | for use with the "http" protocol |
| A URL beginning with "https://" | for use with the "https" protocol |
| A phone number (e.g. 19195447070) | for use with the "sms" protocol |
| A SQS queue ARN | for use with the "sqs" protocol |
on_topic_list Event
Fires with information about the topic.
Syntax
class AmazonSNSTopicListEventParams(object): @property def topic_arn() -> str: ... # In class AmazonSNS: @property def on_topic_list() -> Callable[[AmazonSNSTopicListEventParams], None]: ... @on_topic_list.setter def on_topic_list(event_hook: Callable[[AmazonSNSTopicListEventParams], None]) -> None: ...
Remarks
This event fires once for each topic returned from a call to list_topics.
TopicARN identifies the current topic.
AmazonSNS Config Settings
The class accepts one or more of the following configuration settings. Configuration 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.SNS Config Settings
Amazon defines each version as the date it was released. An example is: "2009-07-15".
Possible values are:
- 0 (string - default)
- 1 (number)
- 2 (binary)
Valid array indices are from 0 to MessageAttributeCount - 1.
Valid array indices are from 0 to MessageAttributeCount - 1.
Valid array indices are from 0 to MessageAttributeCount - 1.
sns1.Config("PhoneNumber=+19191234567");
sns1.Publish("","","message");
sns1.Config("TargetArn=myArn");
sns1.Publish("","subject","message");
HTTP Config Settings
When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".
The default value is True.
If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class fails with an error if the server does not support HTTP/2.
The default value is True.
This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.
The auth_scheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time user and password are set, they are Base64 encoded, and the result is put in the authorization property in the form "Basic [encoded-user-password]".
The default value is False.
If this property is set to 2 (Same Scheme), the new url is retrieved automatically only if the URL Scheme is the same; otherwise, the class fails with an error.
Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.
Furthermore, if either the new URL server or port are different from the existing one, user and password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.
A on_redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the on_redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).
The default value is 0 (Never). In this case, redirects are never followed, and the class fails with an error instead.
Following are the valid options:
- 0 - Never
- 1 - Always
- 2 - Same Scheme
- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"
When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.
HTTP/2 Notes
When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.
If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.
HTTP/3 Notes
HTTP/3 is supported only in .NET and Java.
When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
The default value for KeepAlive is False.
| 0 (None) | No events are logged. |
| 1 (Info - default) | Informational events are logged. |
| 2 (Verbose) | Detailed data are logged. |
| 3 (Debug) | Debug data are logged. |
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).
The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .
Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.
This configuration setting is useful for extending the functionality of the class beyond what is provided.
.NET
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
C++
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001. In the C++ Edition for Windows, the *W version of the class must be used. For instance, DNSW or HTTPW.
Note: This setting is applicable only to Mac/iOS editions.
When True (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.
Override the default with the name and version of your software.
TCPClient Config Settings
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.
| 0 | No firewall (default setting). |
| 1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
| 2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
| 3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
| 10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the local_host setting 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 multi-homed hosts (machines with more than one IP interface).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by local_port after the connection is established.
local_port cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.
If an eol string is found in the input stream before MaxLineLength bytes are received, the on_data_in event is fired with the EOL parameter set to True, and the buffer is reset.
If no eol is found, and MaxLineLength bytes are accumulated in the buffer, the on_data_in event is fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this config is set to false.
| 0 | IPv4 Only |
| 1 | IPv6 Only |
| 2 | IPv6 with IPv4 fallback |
SSL Config Settings
When enabled, SSL packet logs are output using the on_ssl_status event, which will fire each time an SSL packet is sent or received.
Enabling this setting has no effect if ssl_provider is set to Platform.
The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".
By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.
If set to true, the class will reuse the context if and only if the following criteria are met:
- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the class is the same.
The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.
The default value is:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When set to 0 (default) the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.
This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.
When set to 0 (default) the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.
This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.
Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the on_ssl_status event.
Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Example values when ssl_provider is set to Platform:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when ssl_provider is set to Platform include:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA");
Possible values when ssl_provider is set to Internal include:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
- TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:
| TLS1.3 | 12288 (Hex 3000) |
| TLS1.2 | 3072 (Hex C00) (Default) |
| TLS1.1 | 768 (Hex 300) (Default) |
| TLS1 | 192 (Hex C0) (Default) |
| SSL3 | 48 (Hex 30) |
| SSL2 | 12 (Hex 0C) |
SSLEnabledProtocols - TLS 1.3 Notes
By default when TLS 1.3 is enabled the class will use the internal TLS implementation when the ssl_provider is set to Automatic for all editions.
In editions which are designed to run on Windows ssl_provider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider) please be aware of the following notes:
- The platform provider is only available on Windows 11 / Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
This setting is only applicable when ssl_provider is set to Internal.
If set to True all certificates returned by the server will be present in the Encoded parameter of the on_ssl_server_authentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values.
Note: This setting is only applicable when ssl_provider is set to Internal.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
| 0x00000001 | Ignore time validity status of certificate. |
| 0x00000002 | Ignore time validity status of CTL. |
| 0x00000004 | Ignore non-nested certificate times. |
| 0x00000010 | Allow unknown Certificate Authority. |
| 0x00000020 | Ignore wrong certificate usage. |
| 0x00000100 | Ignore unknown certificate revocation status. |
| 0x00000200 | Ignore unknown CTL signer revocation status. |
| 0x00000400 | Ignore unknown Certificate Authority revocation status. |
| 0x00000800 | Ignore unknown Root revocation status. |
| 0x00008000 | Allow test Root certificate. |
| 0x00004000 | Trust test Root certificate. |
| 0x80000000 | Ignore non-matching CN (certificate CN not-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
The value of this setting is a newline (CrLf) separated list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class fails with an error.
The format of this value is a comma separated list of hash-signature combinations. For instance:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and ssl_provider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.
In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
Socket Config Settings
Note: This option is not valid for UDP ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
AmazonSNS Errors
SNS Errors
| 601 An error was returned from the server. Please refer to the error message for additional information. | |
| 602 The cryptographic operation failed. Please see the error message for additional information. | |
| 603 Invalid Topic index. | |
| 604 Invalid Subscription index. | |
| 605 Invalid topic attribute type. | |
| 606 Invalid subscription attribute type. | |
| 607 Invalid subscription protocol value. |
The class may also return one of the following error codes, which are inherited from other classes.
HTTP Errors
| 118 Firewall Error. Error description contains detailed message. | |
| 143 Busy executing current method. | |
| 151 HTTP protocol error. The error message has the server response. | |
| 152 No server specified in url | |
| 153 Specified url_scheme is invalid. | |
| 155 Range operation is not supported by server. | |
| 156 Invalid cookie index (out of range). | |
| 301 Interrupted. | |
| 302 Can't open attached_file. |
The class may also return one of the following error codes, which are inherited from other classes.
TCPClient Errors
| 100 You cannot change the remote_port at this time. A connection is in progress. | |
| 101 You cannot change the remote_host (Server) at this time. A connection is in progress. | |
| 102 The remote_host address is invalid (0.0.0.0). | |
| 104 Already connected. If you want to reconnect, close the current connection first. | |
| 106 You cannot change the local_port at this time. A connection is in progress. | |
| 107 You cannot change the local_host at this time. A connection is in progress. | |
| 112 You cannot change MaxLineLength at this time. A connection is in progress. | |
| 116 remote_port cannot be zero. Please specify a valid service port number. | |
| 117 You cannot change the UseConnection option while the class is active. | |
| 135 Operation would block. | |
| 201 Timeout. | |
| 211 Action impossible in control's present state. | |
| 212 Action impossible while not connected. | |
| 213 Action impossible while listening. | |
| 301 Timeout. | |
| 302 Could not open file. | |
| 434 Unable to convert string to selected CodePage. | |
| 1105 Already connecting. If you want to reconnect, close the current connection first. | |
| 1117 You need to connect first. | |
| 1119 You cannot change the LocalHost at this time. A connection is in progress. | |
| 1120 Connection dropped by remote host. |
SSL Errors
| 270 Cannot load specified security library. | |
| 271 Cannot open certificate store. | |
| 272 Cannot find specified certificate. | |
| 273 Cannot acquire security credentials. | |
| 274 Cannot find certificate chain. | |
| 275 Cannot verify certificate chain. | |
| 276 Error during handshake. | |
| 280 Error verifying certificate. | |
| 281 Could not find client certificate. | |
| 282 Could not find server certificate. | |
| 283 Error encrypting data. | |
| 284 Error decrypting data. |
TCP/IP Errors
| 10004 [10004] Interrupted system call. | |
| 10009 [10009] Bad file number. | |
| 10013 [10013] Access denied. | |
| 10014 [10014] Bad address. | |
| 10022 [10022] Invalid argument. | |
| 10024 [10024] Too many open files. | |
| 10035 [10035] Operation would block. | |
| 10036 [10036] Operation now in progress. | |
| 10037 [10037] Operation already in progress. | |
| 10038 [10038] Socket operation on non-socket. | |
| 10039 [10039] Destination address required. | |
| 10040 [10040] Message too long. | |
| 10041 [10041] Protocol wrong type for socket. | |
| 10042 [10042] Bad protocol option. | |
| 10043 [10043] Protocol not supported. | |
| 10044 [10044] Socket type not supported. | |
| 10045 [10045] Operation not supported on socket. | |
| 10046 [10046] Protocol family not supported. | |
| 10047 [10047] Address family not supported by protocol family. | |
| 10048 [10048] Address already in use. | |
| 10049 [10049] Can't assign requested address. | |
| 10050 [10050] Network is down. | |
| 10051 [10051] Network is unreachable. | |
| 10052 [10052] Net dropped connection or reset. | |
| 10053 [10053] Software caused connection abort. | |
| 10054 [10054] Connection reset by peer. | |
| 10055 [10055] No buffer space available. | |
| 10056 [10056] Socket is already connected. | |
| 10057 [10057] Socket is not connected. | |
| 10058 [10058] Can't send after socket shutdown. | |
| 10059 [10059] Too many references, can't splice. | |
| 10060 [10060] Connection timed out. | |
| 10061 [10061] Connection refused. | |
| 10062 [10062] Too many levels of symbolic links. | |
| 10063 [10063] File name too long. | |
| 10064 [10064] Host is down. | |
| 10065 [10065] No route to host. | |
| 10066 [10066] Directory not empty | |
| 10067 [10067] Too many processes. | |
| 10068 [10068] Too many users. | |
| 10069 [10069] Disc Quota Exceeded. | |
| 10070 [10070] Stale NFS file handle. | |
| 10071 [10071] Too many levels of remote in path. | |
| 10091 [10091] Network subsystem is unavailable. | |
| 10092 [10092] WINSOCK DLL Version out of range. | |
| 10093 [10093] Winsock not loaded yet. | |
| 11001 [11001] Host not found. | |
| 11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
| 11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
| 11004 [11004] Valid name, no data record (check DNS setup). |