SubscriptionEndpoint Property
This property contains the subscription's endpoint.
Syntax
sns.getSubscriptionEndpoint(index, [callback])
Default Value
""
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 getSubscriptionEndpoint([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 setSubscriptionEndpoint([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 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 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
String