libZSservicesZSamazonka-snsZSamazonka-sns
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SNS.ConfirmSubscription

Description

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".

Synopsis

Creating a Request

data ConfirmSubscription Source #

Input for ConfirmSubscription action.

See: newConfirmSubscription smart constructor.

Constructors

ConfirmSubscription' 

Fields

  • authenticateOnUnsubscribe :: Maybe Text

    Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an Amazon Web Services signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires Amazon Web Services authentication.

  • topicArn :: Text

    The ARN of the topic for which you wish to confirm a subscription.

  • token :: Text

    Short-lived token sent to an endpoint during the Subscribe action.

Instances

Instances details
Eq ConfirmSubscription Source # 
Instance details

Defined in Amazonka.SNS.ConfirmSubscription

Methods

(==) :: ConfirmSubscription -> ConfirmSubscription -> Bool #

(/=) :: ConfirmSubscription -> ConfirmSubscription -> Bool #

Read ConfirmSubscription Source # 
Instance details

Defined in Amazonka.SNS.ConfirmSubscription

Methods

readsPrec :: Int -> ReadS ConfirmSubscription #

readList :: ReadS [ConfirmSubscription] #

readPrec :: ReadPrec ConfirmSubscription #

readListPrec :: ReadPrec [ConfirmSubscription] #

Show ConfirmSubscription Source # 
Instance details

Defined in Amazonka.SNS.ConfirmSubscription

Methods

showsPrec :: Int -> ConfirmSubscription -> ShowS #

show :: ConfirmSubscription -> String #

showList :: [ConfirmSubscription] -> ShowS #

Generic ConfirmSubscription Source # 
Instance details

Defined in Amazonka.SNS.ConfirmSubscription

Associated Types

type Rep ConfirmSubscription :: Type -> Type #

Methods

from :: ConfirmSubscription -> Rep ConfirmSubscription x #

to :: Rep ConfirmSubscription x -> ConfirmSubscription #

NFData ConfirmSubscription Source # 
Instance details

Defined in Amazonka.SNS.ConfirmSubscription

Methods

rnf :: ConfirmSubscription -> () #

Hashable ConfirmSubscription Source # 
Instance details

Defined in Amazonka.SNS.ConfirmSubscription

Methods

hashWithSalt :: Int -> ConfirmSubscription -> Int #

hash :: ConfirmSubscription -> Int #

AWSRequest ConfirmSubscription Source # 
Instance details

Defined in Amazonka.SNS.ConfirmSubscription

Associated Types

type AWSResponse ConfirmSubscription #

Methods

request :: ConfirmSubscription -> Request ConfirmSubscription #

response :: MonadResource m => Logger -> Service -> Proxy ConfirmSubscription -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ConfirmSubscription))) #

ToHeaders ConfirmSubscription Source # 
Instance details

Defined in Amazonka.SNS.ConfirmSubscription

Methods

toHeaders :: ConfirmSubscription -> [Header] #

ToPath ConfirmSubscription Source # 
Instance details

Defined in Amazonka.SNS.ConfirmSubscription

Methods

toPath :: ConfirmSubscription -> ByteString #

ToQuery ConfirmSubscription Source # 
Instance details

Defined in Amazonka.SNS.ConfirmSubscription

Methods

toQuery :: ConfirmSubscription -> QueryString #

type Rep ConfirmSubscription Source # 
Instance details

Defined in Amazonka.SNS.ConfirmSubscription

type Rep ConfirmSubscription = D1 ('MetaData "ConfirmSubscription" "Amazonka.SNS.ConfirmSubscription" "libZSservicesZSamazonka-snsZSamazonka-sns" 'False) (C1 ('MetaCons "ConfirmSubscription'" 'PrefixI 'True) (S1 ('MetaSel ('Just "authenticateOnUnsubscribe") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "topicArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ConfirmSubscription Source # 
Instance details

Defined in Amazonka.SNS.ConfirmSubscription

type AWSResponse ConfirmSubscription = ConfirmSubscriptionResponse

newConfirmSubscription Source #

Arguments

:: Text

$sel:topicArn:ConfirmSubscription'

-> Text

$sel:token:ConfirmSubscription'

-> ConfirmSubscription 

Create a value of ConfirmSubscription with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:authenticateOnUnsubscribe:ConfirmSubscription', confirmSubscription_authenticateOnUnsubscribe - Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an Amazon Web Services signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires Amazon Web Services authentication.

$sel:topicArn:ConfirmSubscription', confirmSubscription_topicArn - The ARN of the topic for which you wish to confirm a subscription.

$sel:token:ConfirmSubscription', confirmSubscription_token - Short-lived token sent to an endpoint during the Subscribe action.

Request Lenses

confirmSubscription_authenticateOnUnsubscribe :: Lens' ConfirmSubscription (Maybe Text) Source #

Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an Amazon Web Services signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires Amazon Web Services authentication.

confirmSubscription_topicArn :: Lens' ConfirmSubscription Text Source #

The ARN of the topic for which you wish to confirm a subscription.

confirmSubscription_token :: Lens' ConfirmSubscription Text Source #

Short-lived token sent to an endpoint during the Subscribe action.

Destructuring the Response

data ConfirmSubscriptionResponse Source #

Response for ConfirmSubscriptions action.

See: newConfirmSubscriptionResponse smart constructor.

Constructors

ConfirmSubscriptionResponse' 

Fields

Instances

Instances details
Eq ConfirmSubscriptionResponse Source # 
Instance details

Defined in Amazonka.SNS.ConfirmSubscription

Methods

(==) :: ConfirmSubscriptionResponse -> ConfirmSubscriptionResponse -> Bool #

(/=) :: ConfirmSubscriptionResponse -> ConfirmSubscriptionResponse -> Bool #

Read ConfirmSubscriptionResponse Source # 
Instance details

Defined in Amazonka.SNS.ConfirmSubscription

Methods

readsPrec :: Int -> ReadS ConfirmSubscriptionResponse #

readList :: ReadS [ConfirmSubscriptionResponse] #

readPrec :: ReadPrec ConfirmSubscriptionResponse #

readListPrec :: ReadPrec [ConfirmSubscriptionResponse] #

Show ConfirmSubscriptionResponse Source # 
Instance details

Defined in Amazonka.SNS.ConfirmSubscription

Methods

showsPrec :: Int -> ConfirmSubscriptionResponse -> ShowS #

show :: ConfirmSubscriptionResponse -> String #

showList :: [ConfirmSubscriptionResponse] -> ShowS #

Generic ConfirmSubscriptionResponse Source # 
Instance details

Defined in Amazonka.SNS.ConfirmSubscription

Associated Types

type Rep ConfirmSubscriptionResponse :: Type -> Type #

Methods

from :: ConfirmSubscriptionResponse -> Rep ConfirmSubscriptionResponse x #

to :: Rep ConfirmSubscriptionResponse x -> ConfirmSubscriptionResponse #

NFData ConfirmSubscriptionResponse Source # 
Instance details

Defined in Amazonka.SNS.ConfirmSubscription

Methods

rnf :: ConfirmSubscriptionResponse -> () #

type Rep ConfirmSubscriptionResponse Source # 
Instance details

Defined in Amazonka.SNS.ConfirmSubscription

type Rep ConfirmSubscriptionResponse = D1 ('MetaData "ConfirmSubscriptionResponse" "Amazonka.SNS.ConfirmSubscription" "libZSservicesZSamazonka-snsZSamazonka-sns" 'False) (C1 ('MetaCons "ConfirmSubscriptionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "subscriptionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newConfirmSubscriptionResponse Source #

Arguments

:: Int

$sel:httpStatus:ConfirmSubscriptionResponse'

-> ConfirmSubscriptionResponse 

Create a value of ConfirmSubscriptionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:subscriptionArn:ConfirmSubscriptionResponse', confirmSubscriptionResponse_subscriptionArn - The ARN of the created subscription.

$sel:httpStatus:ConfirmSubscriptionResponse', confirmSubscriptionResponse_httpStatus - The response's http status code.

Response Lenses

confirmSubscriptionResponse_subscriptionArn :: Lens' ConfirmSubscriptionResponse (Maybe Text) Source #

The ARN of the created subscription.

confirmSubscriptionResponse_httpStatus :: Lens' ConfirmSubscriptionResponse Int Source #

The response's http status code.