Amazon Integrator V6 - Online Help
Amazon Integrator V6
Questions / Feedback?

SubscriptionProtocol Property

This property specifies the protocol used by the subscription.

Syntax

 sns.getSubscriptionProtocol(index, [callback])

Default Value

0


Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getSubscriptionProtocol([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setSubscriptionProtocol([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

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 ListSubscriptions or ListTopicSubscriptions.

The size of the array is controlled by the SubscriptionCount property.

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

Data Type

Integer

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 6.0.6240.0