amazonka-sns-1.4.5: Amazon Simple Notification Service SDK.

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

Network.AWS.SNS.CheckIfPhoneNumberIsOptedOut

Contents

Description

Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your account. You cannot send SMS messages to a number that is opted out.

To resume sending messages, you can opt in the number by using the OptInPhoneNumber action.

Synopsis

Creating a Request

checkIfPhoneNumberIsOptedOut #

Creates a value of CheckIfPhoneNumberIsOptedOut with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data CheckIfPhoneNumberIsOptedOut #

The input for the CheckIfPhoneNumberIsOptedOut action.

See: checkIfPhoneNumberIsOptedOut smart constructor.

Instances

Eq CheckIfPhoneNumberIsOptedOut # 
Data CheckIfPhoneNumberIsOptedOut # 

Methods

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

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

toConstr :: CheckIfPhoneNumberIsOptedOut -> Constr #

dataTypeOf :: CheckIfPhoneNumberIsOptedOut -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> CheckIfPhoneNumberIsOptedOut -> CheckIfPhoneNumberIsOptedOut #

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

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

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

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

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

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

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

Read CheckIfPhoneNumberIsOptedOut # 
Show CheckIfPhoneNumberIsOptedOut # 
Generic CheckIfPhoneNumberIsOptedOut # 
Hashable CheckIfPhoneNumberIsOptedOut # 
NFData CheckIfPhoneNumberIsOptedOut # 
AWSRequest CheckIfPhoneNumberIsOptedOut # 
ToQuery CheckIfPhoneNumberIsOptedOut # 
ToPath CheckIfPhoneNumberIsOptedOut # 
ToHeaders CheckIfPhoneNumberIsOptedOut # 
type Rep CheckIfPhoneNumberIsOptedOut # 
type Rep CheckIfPhoneNumberIsOptedOut = D1 (MetaData "CheckIfPhoneNumberIsOptedOut" "Network.AWS.SNS.CheckIfPhoneNumberIsOptedOut" "amazonka-sns-1.4.5-5x1MjGFUMvV6p7MfMkg43e" True) (C1 (MetaCons "CheckIfPhoneNumberIsOptedOut'" PrefixI True) (S1 (MetaSel (Just Symbol "_cipniooPhoneNumber") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))
type Rs CheckIfPhoneNumberIsOptedOut # 

Request Lenses

cipniooPhoneNumber :: Lens' CheckIfPhoneNumberIsOptedOut Text #

The phone number for which you want to check the opt out status.

Destructuring the Response

checkIfPhoneNumberIsOptedOutResponse #

Creates a value of CheckIfPhoneNumberIsOptedOutResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • cipnioorsIsOptedOut - Indicates whether the phone number is opted out: * true – The phone number is opted out, meaning you cannot publish SMS messages to it. * false – The phone number is opted in, meaning you can publish SMS messages to it.
  • cipnioorsResponseStatus - -- | The response status code.

data CheckIfPhoneNumberIsOptedOutResponse #

The response from the CheckIfPhoneNumberIsOptedOut action.

See: checkIfPhoneNumberIsOptedOutResponse smart constructor.

Instances

Eq CheckIfPhoneNumberIsOptedOutResponse # 
Data CheckIfPhoneNumberIsOptedOutResponse # 

Methods

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

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

toConstr :: CheckIfPhoneNumberIsOptedOutResponse -> Constr #

dataTypeOf :: CheckIfPhoneNumberIsOptedOutResponse -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> CheckIfPhoneNumberIsOptedOutResponse -> CheckIfPhoneNumberIsOptedOutResponse #

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

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

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

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

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

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

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

Read CheckIfPhoneNumberIsOptedOutResponse # 
Show CheckIfPhoneNumberIsOptedOutResponse # 
Generic CheckIfPhoneNumberIsOptedOutResponse # 
NFData CheckIfPhoneNumberIsOptedOutResponse # 
type Rep CheckIfPhoneNumberIsOptedOutResponse # 
type Rep CheckIfPhoneNumberIsOptedOutResponse = D1 (MetaData "CheckIfPhoneNumberIsOptedOutResponse" "Network.AWS.SNS.CheckIfPhoneNumberIsOptedOut" "amazonka-sns-1.4.5-5x1MjGFUMvV6p7MfMkg43e" False) (C1 (MetaCons "CheckIfPhoneNumberIsOptedOutResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_cipnioorsIsOptedOut") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_cipnioorsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

cipnioorsIsOptedOut :: Lens' CheckIfPhoneNumberIsOptedOutResponse (Maybe Bool) #

Indicates whether the phone number is opted out: * true – The phone number is opted out, meaning you cannot publish SMS messages to it. * false – The phone number is opted in, meaning you can publish SMS messages to it.