Network.AWS.SNS.Subscribe

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.

See: AWS API Reference for Subscribe.

Creating a Request

subscribe

Arguments

:: Text

subTopicARN

-> Text

subProtocol

-> Subscribe

Creates a value of Subscribe with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• subEndpoint
• subTopicARN
• subProtocol

data Subscribe

Input for Subscribe action.

See: subscribe smart constructor.

Instances

Eq Subscribe

Data Subscribe

Read Subscribe

Show Subscribe

Generic Subscribe

AWSRequest Subscribe

ToPath Subscribe

ToHeaders Subscribe

ToQuery Subscribe

type Rep Subscribe

type Rs Subscribe = SubscribeResponse

Request Lenses

subEndpoint :: Lens' Subscribe (Maybe Text)

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.

subTopicARN :: Lens' Subscribe Text

The ARN of the topic you want to subscribe to.

subProtocol :: Lens' Subscribe Text

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.

Destructuring the Response

subscribeResponse

Arguments

:: Int

srsResponseStatus

-> SubscribeResponse

Creates a value of SubscribeResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• srsSubscriptionARN
• srsResponseStatus

data SubscribeResponse

Response for Subscribe action.

See: subscribeResponse smart constructor.

Instances

Eq SubscribeResponse

Data SubscribeResponse

Read SubscribeResponse

Show SubscribeResponse

Generic SubscribeResponse

type Rep SubscribeResponse

Response Lenses

srsSubscriptionARN :: Lens' SubscribeResponse (Maybe Text)

The ARN of the subscription, if the service was able to create a subscription immediately (without requiring endpoint owner confirmation).

srsResponseStatus :: Lens' SubscribeResponse Int

The response status code.