Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.SNS.CheckIfPhoneNumberIsOptedOut

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

Creating a Request

checkIfPhoneNumberIsOptedOut Source #

Arguments

:: Text	`cipniooPhoneNumber`
-> 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:

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

data CheckIfPhoneNumberIsOptedOut Source #

The input for the CheckIfPhoneNumberIsOptedOut action.

See: checkIfPhoneNumberIsOptedOut smart constructor.

Instances

Eq CheckIfPhoneNumberIsOptedOut Source #
Methods (==) :: CheckIfPhoneNumberIsOptedOut -> CheckIfPhoneNumberIsOptedOut -> Bool # (/=) :: CheckIfPhoneNumberIsOptedOut -> CheckIfPhoneNumberIsOptedOut -> Bool #
Data CheckIfPhoneNumberIsOptedOut Source #
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 Source #
Methods readsPrec :: Int -> ReadS CheckIfPhoneNumberIsOptedOut # readList :: ReadS [CheckIfPhoneNumberIsOptedOut] # readPrec :: ReadPrec CheckIfPhoneNumberIsOptedOut # readListPrec :: ReadPrec [CheckIfPhoneNumberIsOptedOut] #
Show CheckIfPhoneNumberIsOptedOut Source #
Methods showsPrec :: Int -> CheckIfPhoneNumberIsOptedOut -> ShowS # show :: CheckIfPhoneNumberIsOptedOut -> String # showList :: [CheckIfPhoneNumberIsOptedOut] -> ShowS #
Generic CheckIfPhoneNumberIsOptedOut Source #
Associated Types type Rep CheckIfPhoneNumberIsOptedOut :: * -> * # Methods from :: CheckIfPhoneNumberIsOptedOut -> Rep CheckIfPhoneNumberIsOptedOut x # to :: Rep CheckIfPhoneNumberIsOptedOut x -> CheckIfPhoneNumberIsOptedOut #
Hashable CheckIfPhoneNumberIsOptedOut Source #
Methods hashWithSalt :: Int -> CheckIfPhoneNumberIsOptedOut -> Int # hash :: CheckIfPhoneNumberIsOptedOut -> Int #
NFData CheckIfPhoneNumberIsOptedOut Source #
Methods rnf :: CheckIfPhoneNumberIsOptedOut -> () #
AWSRequest CheckIfPhoneNumberIsOptedOut Source #
Associated Types type Rs CheckIfPhoneNumberIsOptedOut :: * # Methods request :: CheckIfPhoneNumberIsOptedOut -> Request CheckIfPhoneNumberIsOptedOut # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * CheckIfPhoneNumberIsOptedOut -> ClientResponse -> m (Response CheckIfPhoneNumberIsOptedOut) #
ToHeaders CheckIfPhoneNumberIsOptedOut Source #
Methods toHeaders :: CheckIfPhoneNumberIsOptedOut -> [Header] #
ToPath CheckIfPhoneNumberIsOptedOut Source #
Methods toPath :: CheckIfPhoneNumberIsOptedOut -> ByteString #
ToQuery CheckIfPhoneNumberIsOptedOut Source #
Methods toQuery :: CheckIfPhoneNumberIsOptedOut -> QueryString #
type Rep CheckIfPhoneNumberIsOptedOut Source #
type Rep CheckIfPhoneNumberIsOptedOut = D1 * (MetaData "CheckIfPhoneNumberIsOptedOut" "Network.AWS.SNS.CheckIfPhoneNumberIsOptedOut" "amazonka-sns-1.6.0-9aFI2fxVFLPtYIjs5ltfP" True) (C1 * (MetaCons "CheckIfPhoneNumberIsOptedOut'" PrefixI True) (S1 * (MetaSel (Just Symbol "_cipniooPhoneNumber") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))
type Rs CheckIfPhoneNumberIsOptedOut Source #
type Rs CheckIfPhoneNumberIsOptedOut = CheckIfPhoneNumberIsOptedOutResponse

Request Lenses

cipniooPhoneNumber :: Lens' CheckIfPhoneNumberIsOptedOut Text Source #

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

Destructuring the Response

checkIfPhoneNumberIsOptedOutResponse Source #

Arguments

:: Int	`cipnioorsResponseStatus`
-> 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 Source #

The response from the CheckIfPhoneNumberIsOptedOut action.

See: checkIfPhoneNumberIsOptedOutResponse smart constructor.

Instances

Eq CheckIfPhoneNumberIsOptedOutResponse Source #
Methods (==) :: CheckIfPhoneNumberIsOptedOutResponse -> CheckIfPhoneNumberIsOptedOutResponse -> Bool # (/=) :: CheckIfPhoneNumberIsOptedOutResponse -> CheckIfPhoneNumberIsOptedOutResponse -> Bool #
Data CheckIfPhoneNumberIsOptedOutResponse Source #
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 Source #
Methods readsPrec :: Int -> ReadS CheckIfPhoneNumberIsOptedOutResponse # readList :: ReadS [CheckIfPhoneNumberIsOptedOutResponse] # readPrec :: ReadPrec CheckIfPhoneNumberIsOptedOutResponse # readListPrec :: ReadPrec [CheckIfPhoneNumberIsOptedOutResponse] #
Show CheckIfPhoneNumberIsOptedOutResponse Source #
Methods showsPrec :: Int -> CheckIfPhoneNumberIsOptedOutResponse -> ShowS # show :: CheckIfPhoneNumberIsOptedOutResponse -> String # showList :: [CheckIfPhoneNumberIsOptedOutResponse] -> ShowS #
Generic CheckIfPhoneNumberIsOptedOutResponse Source #
Associated Types type Rep CheckIfPhoneNumberIsOptedOutResponse :: * -> * # Methods from :: CheckIfPhoneNumberIsOptedOutResponse -> Rep CheckIfPhoneNumberIsOptedOutResponse x # to :: Rep CheckIfPhoneNumberIsOptedOutResponse x -> CheckIfPhoneNumberIsOptedOutResponse #
NFData CheckIfPhoneNumberIsOptedOutResponse Source #
Methods rnf :: CheckIfPhoneNumberIsOptedOutResponse -> () #
type Rep CheckIfPhoneNumberIsOptedOutResponse Source #
type Rep CheckIfPhoneNumberIsOptedOutResponse = D1 * (MetaData "CheckIfPhoneNumberIsOptedOutResponse" "Network.AWS.SNS.CheckIfPhoneNumberIsOptedOut" "amazonka-sns-1.6.0-9aFI2fxVFLPtYIjs5ltfP" False) (C1 * (MetaCons "CheckIfPhoneNumberIsOptedOutResponse'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_cipnioorsIsOptedOut") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_cipnioorsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

cipnioorsIsOptedOut :: Lens' CheckIfPhoneNumberIsOptedOutResponse (Maybe Bool) Source #

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 :: Lens' CheckIfPhoneNumberIsOptedOutResponse Int Source #

- | The response status code.