Amazonka.SNS.Unsubscribe

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

Creating a Request

data Unsubscribe

Input for Unsubscribe action.

See: newUnsubscribe smart constructor.

Constructors

Unsubscribe'

Fields

• subscriptionArn :: Text

  The ARN of the subscription to be deleted.

Instances

ToHeaders Unsubscribe

Defined in Amazonka.SNS.Unsubscribe

Methods

toHeaders :: Unsubscribe -> [Header]

ToPath Unsubscribe

Defined in Amazonka.SNS.Unsubscribe

Methods

toPath :: Unsubscribe -> ByteString

ToQuery Unsubscribe

Defined in Amazonka.SNS.Unsubscribe

Methods

toQuery :: Unsubscribe -> QueryString

AWSRequest Unsubscribe

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

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

Defined in Amazonka.SNS.Unsubscribe

Methods

readsPrec :: Int -> ReadS Unsubscribe

readList :: ReadS [Unsubscribe]

readPrec :: ReadPrec Unsubscribe

readListPrec :: ReadPrec [Unsubscribe]

Show Unsubscribe

Defined in Amazonka.SNS.Unsubscribe

Methods

showsPrec :: Int -> Unsubscribe -> ShowS

show :: Unsubscribe -> String

showList :: [Unsubscribe] -> ShowS

NFData Unsubscribe

Defined in Amazonka.SNS.Unsubscribe

Methods

rnf :: Unsubscribe -> ()

Eq Unsubscribe

Defined in Amazonka.SNS.Unsubscribe

Methods

(==) :: Unsubscribe -> Unsubscribe -> Bool

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

Hashable Unsubscribe

Defined in Amazonka.SNS.Unsubscribe

Methods

hashWithSalt :: Int -> Unsubscribe -> Int

hash :: Unsubscribe -> Int

type AWSResponse Unsubscribe

Defined in Amazonka.SNS.Unsubscribe

type AWSResponse Unsubscribe = UnsubscribeResponse

type Rep Unsubscribe

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

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

The ARN of the subscription to be deleted.

Destructuring the Response

data UnsubscribeResponse

See: newUnsubscribeResponse smart constructor.

Constructors

UnsubscribeResponse'

Instances

Generic UnsubscribeResponse

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

Defined in Amazonka.SNS.Unsubscribe

Methods

readsPrec :: Int -> ReadS UnsubscribeResponse

readList :: ReadS [UnsubscribeResponse]

readPrec :: ReadPrec UnsubscribeResponse

readListPrec :: ReadPrec [UnsubscribeResponse]

Show UnsubscribeResponse

Defined in Amazonka.SNS.Unsubscribe

Methods

showsPrec :: Int -> UnsubscribeResponse -> ShowS

show :: UnsubscribeResponse -> String

showList :: [UnsubscribeResponse] -> ShowS

NFData UnsubscribeResponse

Defined in Amazonka.SNS.Unsubscribe

Methods

rnf :: UnsubscribeResponse -> ()

Eq UnsubscribeResponse

Defined in Amazonka.SNS.Unsubscribe

Methods

(==) :: UnsubscribeResponse -> UnsubscribeResponse -> Bool

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

type Rep UnsubscribeResponse

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

Create a value of UnsubscribeResponse with all optional fields omitted.

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