Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SNS.Unsubscribe

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an Amazon Web Services signature is required. If the Unsubscribe call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the Unsubscribe request was unintended.

Amazon SQS queue subscriptions require authentication for deletion. Only the owner of the subscription, or the owner of the topic can unsubscribe using the required Amazon Web Services signature.

This action is throttled at 100 transactions per second (TPS).

Synopsis

data Unsubscribe = Unsubscribe' {
- subscriptionArn :: Text
}
newUnsubscribe :: Text -> Unsubscribe
unsubscribe_subscriptionArn :: Lens' Unsubscribe Text
data UnsubscribeResponse = UnsubscribeResponse' {
}
newUnsubscribeResponse :: UnsubscribeResponse

Creating a Request

data Unsubscribe Source #

Input for Unsubscribe action.

See: newUnsubscribe smart constructor.

Constructors

Unsubscribe'
Fields subscriptionArn :: Text The ARN of the subscription to be deleted.

Instances

Instances details

ToHeaders Unsubscribe Source #
Instance details Defined in Amazonka.SNS.Unsubscribe Methods toHeaders :: Unsubscribe -> [Header] #
ToPath Unsubscribe Source #
Instance details Defined in Amazonka.SNS.Unsubscribe Methods toPath :: Unsubscribe -> ByteString #
ToQuery Unsubscribe Source #
Instance details Defined in Amazonka.SNS.Unsubscribe Methods toQuery :: Unsubscribe -> QueryString #
AWSRequest Unsubscribe Source #
Instance details Defined in Amazonka.SNS.Unsubscribe Associated Types type AWSResponse Unsubscribe # Methods request :: (Service -> Service) -> Unsubscribe -> Request Unsubscribe # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy Unsubscribe -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse Unsubscribe))) #
Generic Unsubscribe Source #
Instance details Defined in Amazonka.SNS.Unsubscribe Associated Types type Rep Unsubscribe :: Type -> Type # Methods from :: Unsubscribe -> Rep Unsubscribe x # to :: Rep Unsubscribe x -> Unsubscribe #
Read Unsubscribe Source #
Instance details Defined in Amazonka.SNS.Unsubscribe Methods readsPrec :: Int -> ReadS Unsubscribe # readList :: ReadS [Unsubscribe] # readPrec :: ReadPrec Unsubscribe # readListPrec :: ReadPrec [Unsubscribe] #
Show Unsubscribe Source #
Instance details Defined in Amazonka.SNS.Unsubscribe Methods showsPrec :: Int -> Unsubscribe -> ShowS # show :: Unsubscribe -> String # showList :: [Unsubscribe] -> ShowS #
NFData Unsubscribe Source #
Instance details Defined in Amazonka.SNS.Unsubscribe Methods rnf :: Unsubscribe -> () #
Eq Unsubscribe Source #
Instance details Defined in Amazonka.SNS.Unsubscribe Methods (==) :: Unsubscribe -> Unsubscribe -> Bool # (/=) :: Unsubscribe -> Unsubscribe -> Bool #
Hashable Unsubscribe Source #
Instance details Defined in Amazonka.SNS.Unsubscribe Methods hashWithSalt :: Int -> Unsubscribe -> Int # hash :: Unsubscribe -> Int #
type AWSResponse Unsubscribe Source #
Instance details Defined in Amazonka.SNS.Unsubscribe type AWSResponse Unsubscribe = UnsubscribeResponse
type Rep Unsubscribe Source #
Instance details Defined in Amazonka.SNS.Unsubscribe type Rep Unsubscribe = D1 ('MetaData "Unsubscribe" "Amazonka.SNS.Unsubscribe" "amazonka-sns-2.0-4k7AiJI7DyqhOUy5o4qb9" 'False) (C1 ('MetaCons "Unsubscribe'" 'PrefixI 'True) (S1 ('MetaSel ('Just "subscriptionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newUnsubscribe Source #

Arguments

:: Text	`Unsubscribe`
-> Unsubscribe

Create a value of Unsubscribe 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:

Unsubscribe, unsubscribe_subscriptionArn - The ARN of the subscription to be deleted.

Request Lenses

unsubscribe_subscriptionArn :: Lens' Unsubscribe Text Source #

The ARN of the subscription to be deleted.

Destructuring the Response

data UnsubscribeResponse Source #

See: newUnsubscribeResponse smart constructor.

Constructors

UnsubscribeResponse'

Instances

Instances details

Generic UnsubscribeResponse Source #
Instance details Defined in Amazonka.SNS.Unsubscribe Associated Types type Rep UnsubscribeResponse :: Type -> Type # Methods from :: UnsubscribeResponse -> Rep UnsubscribeResponse x # to :: Rep UnsubscribeResponse x -> UnsubscribeResponse #
Read UnsubscribeResponse Source #
Instance details Defined in Amazonka.SNS.Unsubscribe Methods readsPrec :: Int -> ReadS UnsubscribeResponse # readList :: ReadS [UnsubscribeResponse] # readPrec :: ReadPrec UnsubscribeResponse # readListPrec :: ReadPrec [UnsubscribeResponse] #
Show UnsubscribeResponse Source #
Instance details Defined in Amazonka.SNS.Unsubscribe Methods showsPrec :: Int -> UnsubscribeResponse -> ShowS # show :: UnsubscribeResponse -> String # showList :: [UnsubscribeResponse] -> ShowS #
NFData UnsubscribeResponse Source #
Instance details Defined in Amazonka.SNS.Unsubscribe Methods rnf :: UnsubscribeResponse -> () #
Eq UnsubscribeResponse Source #
Instance details Defined in Amazonka.SNS.Unsubscribe Methods (==) :: UnsubscribeResponse -> UnsubscribeResponse -> Bool # (/=) :: UnsubscribeResponse -> UnsubscribeResponse -> Bool #
type Rep UnsubscribeResponse Source #
Instance details Defined in Amazonka.SNS.Unsubscribe type Rep UnsubscribeResponse = D1 ('MetaData "UnsubscribeResponse" "Amazonka.SNS.Unsubscribe" "amazonka-sns-2.0-4k7AiJI7DyqhOUy5o4qb9" 'False) (C1 ('MetaCons "UnsubscribeResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUnsubscribeResponse :: UnsubscribeResponse Source #

Create a value of UnsubscribeResponse with all optional fields omitted.

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