Network.AWS.SNS.ConfirmSubscription

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

Creating a Request

confirmSubscription

Arguments

:: Text

csTopicARN

-> Text

csToken

-> ConfirmSubscription

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:

• csAuthenticateOnUnsubscribe - 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 - The ARN of the topic for which you wish to confirm a subscription.
• csToken - Short-lived token sent to an endpoint during the Subscribe action.

data ConfirmSubscription

Input for ConfirmSubscription action.

See: confirmSubscription smart constructor.

Instances

Eq ConfirmSubscription

Methods

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

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

Data ConfirmSubscription

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ConfirmSubscription -> c ConfirmSubscription

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ConfirmSubscription

toConstr :: ConfirmSubscription -> Constr

dataTypeOf :: ConfirmSubscription -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ConfirmSubscription)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ConfirmSubscription)

gmapT :: (forall b. Data b => b -> b) -> ConfirmSubscription -> ConfirmSubscription

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ConfirmSubscription -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ConfirmSubscription -> r

gmapQ :: (forall d. Data d => d -> u) -> ConfirmSubscription -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ConfirmSubscription -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ConfirmSubscription -> m ConfirmSubscription

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ConfirmSubscription -> m ConfirmSubscription

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ConfirmSubscription -> m ConfirmSubscription

Read ConfirmSubscription

Methods

readsPrec :: Int -> ReadS ConfirmSubscription

readList :: ReadS [ConfirmSubscription]

readPrec :: ReadPrec ConfirmSubscription

readListPrec :: ReadPrec [ConfirmSubscription]

Show ConfirmSubscription

Methods

showsPrec :: Int -> ConfirmSubscription -> ShowS

show :: ConfirmSubscription -> String

showList :: [ConfirmSubscription] -> ShowS

Generic ConfirmSubscription

Associated Types

type Rep ConfirmSubscription :: * -> *

Methods

from :: ConfirmSubscription -> Rep ConfirmSubscription x

to :: Rep ConfirmSubscription x -> ConfirmSubscription

Hashable ConfirmSubscription

Methods

hashWithSalt :: Int -> ConfirmSubscription -> Int

hash :: ConfirmSubscription -> Int

NFData ConfirmSubscription

Methods

rnf :: ConfirmSubscription -> ()

AWSRequest ConfirmSubscription

Associated Types

type Rs ConfirmSubscription :: *

Methods

request :: ConfirmSubscription -> Request ConfirmSubscription

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * ConfirmSubscription -> ClientResponse -> m (Response ConfirmSubscription)

ToHeaders ConfirmSubscription

Methods

toHeaders :: ConfirmSubscription -> [Header]

ToPath ConfirmSubscription

Methods

toPath :: ConfirmSubscription -> ByteString

ToQuery ConfirmSubscription

Methods

toQuery :: ConfirmSubscription -> QueryString

type Rep ConfirmSubscription

type Rep ConfirmSubscription = D1 * (MetaData "ConfirmSubscription" "Network.AWS.SNS.ConfirmSubscription" "amazonka-sns-1.6.0-9aFI2fxVFLPtYIjs5ltfP" False) (C1 * (MetaCons "ConfirmSubscription'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_csAuthenticateOnUnsubscribe") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_csTopicARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_csToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))

type Rs ConfirmSubscription

type Rs ConfirmSubscription = ConfirmSubscriptionResponse

Request Lenses

csAuthenticateOnUnsubscribe :: Lens' ConfirmSubscription (Maybe Text)

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

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

csToken :: Lens' ConfirmSubscription Text

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

Destructuring the Response

confirmSubscriptionResponse

Arguments

:: Int

csrsResponseStatus

-> ConfirmSubscriptionResponse

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:

• csrsSubscriptionARN - The ARN of the created subscription.
• csrsResponseStatus - -- | The response status code.

data ConfirmSubscriptionResponse

Response for ConfirmSubscriptions action.

See: confirmSubscriptionResponse smart constructor.

Instances

Eq ConfirmSubscriptionResponse

Methods

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

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

Data ConfirmSubscriptionResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ConfirmSubscriptionResponse -> c ConfirmSubscriptionResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ConfirmSubscriptionResponse

toConstr :: ConfirmSubscriptionResponse -> Constr

dataTypeOf :: ConfirmSubscriptionResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ConfirmSubscriptionResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ConfirmSubscriptionResponse)

gmapT :: (forall b. Data b => b -> b) -> ConfirmSubscriptionResponse -> ConfirmSubscriptionResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ConfirmSubscriptionResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ConfirmSubscriptionResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> ConfirmSubscriptionResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ConfirmSubscriptionResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ConfirmSubscriptionResponse -> m ConfirmSubscriptionResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ConfirmSubscriptionResponse -> m ConfirmSubscriptionResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ConfirmSubscriptionResponse -> m ConfirmSubscriptionResponse

Read ConfirmSubscriptionResponse

Methods

readsPrec :: Int -> ReadS ConfirmSubscriptionResponse

readList :: ReadS [ConfirmSubscriptionResponse]

readPrec :: ReadPrec ConfirmSubscriptionResponse

readListPrec :: ReadPrec [ConfirmSubscriptionResponse]

Show ConfirmSubscriptionResponse

Methods

showsPrec :: Int -> ConfirmSubscriptionResponse -> ShowS

show :: ConfirmSubscriptionResponse -> String

showList :: [ConfirmSubscriptionResponse] -> ShowS

Generic ConfirmSubscriptionResponse

Associated Types

type Rep ConfirmSubscriptionResponse :: * -> *

Methods

from :: ConfirmSubscriptionResponse -> Rep ConfirmSubscriptionResponse x

to :: Rep ConfirmSubscriptionResponse x -> ConfirmSubscriptionResponse

NFData ConfirmSubscriptionResponse

Methods

rnf :: ConfirmSubscriptionResponse -> ()

type Rep ConfirmSubscriptionResponse

type Rep ConfirmSubscriptionResponse = D1 * (MetaData "ConfirmSubscriptionResponse" "Network.AWS.SNS.ConfirmSubscription" "amazonka-sns-1.6.0-9aFI2fxVFLPtYIjs5ltfP" False) (C1 * (MetaCons "ConfirmSubscriptionResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_csrsSubscriptionARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_csrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

csrsSubscriptionARN :: Lens' ConfirmSubscriptionResponse (Maybe Text)

The ARN of the created subscription.

csrsResponseStatus :: Lens' ConfirmSubscriptionResponse Int

• - | The response status code.