C# Class Amazon.SimpleNotificationService.Model.SubscribeRequest

Container for the parameters to the Subscribe operation. Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the ConfirmSubscription action with the token from the confirmation message. Confirmation tokens are valid for three days.
Inheritance: AmazonSimpleNotificationServiceRequest
Show file Open project: aws/aws-sdk-net Class Usage Examples

Public Methods

Method Description
SubscribeRequest ( ) : System

Empty constructor used to set properties independently even when a simple constructor is available

SubscribeRequest ( string topicArn, string protocol, string endpoint ) : System

Instantiates SubscribeRequest with the parameterized properties

Private Methods

Method Description
IsSetEndpoint ( ) : bool
IsSetProtocol ( ) : bool
IsSetTopicArn ( ) : bool

Method Details

SubscribeRequest() public method

Empty constructor used to set properties independently even when a simple constructor is available
public SubscribeRequest ( ) : System
return System

SubscribeRequest() public method

Instantiates SubscribeRequest with the parameterized properties
public SubscribeRequest ( string topicArn, string protocol, string endpoint ) : System
topicArn string The ARN of the topic you want to subscribe to.
protocol string The protocol you want to use. Supported protocols include:
  • http -- delivery of JSON-encoded message via HTTP POST
  • https -- delivery of JSON-encoded message via HTTPS POST
  • email -- delivery of message via SMTP
  • email-json -- delivery of JSON-encoded message via SMTP
  • sms -- delivery of message via SMS
  • sqs -- delivery of JSON-encoded message to an Amazon SQS queue
  • application -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
  • lambda -- delivery of JSON-encoded message to an AWS Lambda function.
endpoint string The endpoint that you want to receive notifications. Endpoints vary by protocol:
  • For the http protocol, the endpoint is an URL beginning with "http://"
  • For the https protocol, the endpoint is a URL beginning with "https://"
  • For the email protocol, the endpoint is an email address
  • For the email-json protocol, the endpoint is an email address
  • For the sms protocol, the endpoint is a phone number of an SMS-enabled device
  • For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
  • For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
  • For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.
return System