Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Verifies an endpoint owner's intent to receive messages by validating
the token sent to the endpoint by an earlier Subscribe
action. If the
token is valid, the action creates a new subscription and returns its
Amazon Resource Name (ARN). This call requires an AWS signature only
when the AuthenticateOnUnsubscribe
flag is set to "true".
- confirmSubscription :: Text -> Text -> ConfirmSubscription
- data ConfirmSubscription
- csAuthenticateOnUnsubscribe :: Lens' ConfirmSubscription (Maybe Text)
- csTopicARN :: Lens' ConfirmSubscription Text
- csToken :: Lens' ConfirmSubscription Text
- confirmSubscriptionResponse :: Int -> ConfirmSubscriptionResponse
- data ConfirmSubscriptionResponse
- csrsSubscriptionARN :: Lens' ConfirmSubscriptionResponse (Maybe Text)
- csrsResponseStatus :: Lens' ConfirmSubscriptionResponse Int
Creating a Request
Creates a value of ConfirmSubscription
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ConfirmSubscription Source #
Input for ConfirmSubscription action.
See: confirmSubscription
smart constructor.
Request Lenses
csAuthenticateOnUnsubscribe :: Lens' ConfirmSubscription (Maybe Text) Source #
Disallows unauthenticated unsubscribes of the subscription. If the value
of this parameter is true
and the request has an AWS signature, then
only the topic owner and the subscription owner can unsubscribe the
endpoint. The unsubscribe action requires AWS authentication.
csTopicARN :: Lens' ConfirmSubscription Text Source #
The ARN of the topic for which you wish to confirm a subscription.
csToken :: Lens' ConfirmSubscription Text Source #
Short-lived token sent to an endpoint during the Subscribe
action.
Destructuring the Response
confirmSubscriptionResponse Source #
Creates a value of ConfirmSubscriptionResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ConfirmSubscriptionResponse Source #
Response for ConfirmSubscriptions action.
See: confirmSubscriptionResponse
smart constructor.
Response Lenses
csrsSubscriptionARN :: Lens' ConfirmSubscriptionResponse (Maybe Text) Source #
The ARN of the created subscription.
csrsResponseStatus :: Lens' ConfirmSubscriptionResponse Int Source #
The response status code.