SNSSubscription Type
This provides details about the subscription.
Remarks
The fields below provide details about the subscription.
Fields
| |
ConfirmationWasAuthenticated
Boolean |
This field reports whether or not the subscription was confirmed.
Note: This field is only applicable after calling GetSubscriptionAttributes.
|
DeliveryPolicy
String |
This field holds the JSON serialization of the subscription's delivery policy.
Note: This field is only applicable after calling GetSubscriptionAttributes.
|
EffectiveDeliveryPolicy
String |
This field holds the JSON serialization of the subscription's effective delivery policy. This policy takes into account the topic and account defaults.
Note: This field is only applicable after calling GetSubscriptionAttributes.
|
Endpoint
String |
This field 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 field is only applicable after calling ListSubscriptions or ListTopicSubscriptions.
|
HasAttributes
Boolean |
This field returns true if the subscription attributes are available.
A subscription's attributes are only returned and parsed after calling GetSubscriptionAttributes.
This field serves as an easy way to determine if the subscription's attributes are available.
The following fields are applicable after calling GetSubscriptionAttributes:
- ConfirmationWasAuthenticated
- DeliveryPolicy
- EffectiveDeliveryPolicy
- Owner
- SubscriptionArn
- TopicArn
The following fields are applicable after calling ListSubscriptions or ListTopicSubscriptions:
- Endpoint
- Owner
- Protocol
- SubscriptionArn
- TopicArn
|
Owner
String |
The AWS account ID of the subscription's owner.
|
Protocol
Integer |
This field 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 field is only applicable after calling ListSubscriptions or ListTopicSubscriptions.
|
SubscriptionArn
String |
The subscription's Amazon Resource Name (ARN) used to identify the subscription.
|
TopicArn
String |
The Amazon Resource Name (ARN) of the topic this subscription is associated with.
|
Constructors
[VB.NET]
Public SNSSubscription()
[C#]
public SNSSubscription();
[VB.NET]
Public SNSSubscription(ByVal SubscriptionArn As String, ByVal TopicArn As String, ByVal Owner As String, ByVal Endpoint As String, ByVal Protocol As Integer, ByVal ConfirmationWasAuthenticated As Boolean, ByVal DeliveryPolicy As String, ByVal EffectiveDeliveryPolicy As String, ByVal HasAttributes As Boolean)
[C#]
public SNSSubscription(string subscriptionArn, string topicArn, string owner, string endpoint, int protocol, bool confirmationWasAuthenticated, string deliveryPolicy, string effectiveDeliveryPolicy, bool hasAttributes);