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

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

Network.AWS.SNS.ListPhoneNumbersOptedOut

Contents

Description

Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.

The results for ListPhoneNumbersOptedOut are paginated, and each page returns up to 100 phone numbers. If additional phone numbers are available after the first page of results, then a NextToken string will be returned. To receive the next page, you call ListPhoneNumbersOptedOut again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null.

Synopsis

Creating a Request

listPhoneNumbersOptedOut :: ListPhoneNumbersOptedOut #

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

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

  • lpnooNextToken - A NextToken string is used when you call the ListPhoneNumbersOptedOut action to retrieve additional records that are available after the first page of results.

data ListPhoneNumbersOptedOut #

The input for the ListPhoneNumbersOptedOut action.

See: listPhoneNumbersOptedOut smart constructor.

Instances
Eq ListPhoneNumbersOptedOut # 
Instance details

Defined in Network.AWS.SNS.ListPhoneNumbersOptedOut

Data ListPhoneNumbersOptedOut # 
Instance details

Defined in Network.AWS.SNS.ListPhoneNumbersOptedOut

Methods

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

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

toConstr :: ListPhoneNumbersOptedOut -> Constr #

dataTypeOf :: ListPhoneNumbersOptedOut -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ListPhoneNumbersOptedOut # 
Instance details

Defined in Network.AWS.SNS.ListPhoneNumbersOptedOut

Show ListPhoneNumbersOptedOut # 
Instance details

Defined in Network.AWS.SNS.ListPhoneNumbersOptedOut

Generic ListPhoneNumbersOptedOut # 
Instance details

Defined in Network.AWS.SNS.ListPhoneNumbersOptedOut

Associated Types

type Rep ListPhoneNumbersOptedOut :: * -> * #

Hashable ListPhoneNumbersOptedOut # 
Instance details

Defined in Network.AWS.SNS.ListPhoneNumbersOptedOut

AWSRequest ListPhoneNumbersOptedOut # 
Instance details

Defined in Network.AWS.SNS.ListPhoneNumbersOptedOut

Associated Types

type Rs ListPhoneNumbersOptedOut :: * #

ToHeaders ListPhoneNumbersOptedOut # 
Instance details

Defined in Network.AWS.SNS.ListPhoneNumbersOptedOut

ToPath ListPhoneNumbersOptedOut # 
Instance details

Defined in Network.AWS.SNS.ListPhoneNumbersOptedOut

ToQuery ListPhoneNumbersOptedOut # 
Instance details

Defined in Network.AWS.SNS.ListPhoneNumbersOptedOut

NFData ListPhoneNumbersOptedOut # 
Instance details

Defined in Network.AWS.SNS.ListPhoneNumbersOptedOut

type Rep ListPhoneNumbersOptedOut # 
Instance details

Defined in Network.AWS.SNS.ListPhoneNumbersOptedOut

type Rep ListPhoneNumbersOptedOut = D1 (MetaData "ListPhoneNumbersOptedOut" "Network.AWS.SNS.ListPhoneNumbersOptedOut" "amazonka-sns-1.6.0-HtFY9r81ykN4UA9Dx2hCIO" True) (C1 (MetaCons "ListPhoneNumbersOptedOut'" PrefixI True) (S1 (MetaSel (Just "_lpnooNextToken") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))))
type Rs ListPhoneNumbersOptedOut # 
Instance details

Defined in Network.AWS.SNS.ListPhoneNumbersOptedOut

Request Lenses

lpnooNextToken :: Lens' ListPhoneNumbersOptedOut (Maybe Text) #

A NextToken string is used when you call the ListPhoneNumbersOptedOut action to retrieve additional records that are available after the first page of results.

Destructuring the Response

listPhoneNumbersOptedOutResponse #

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

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

  • lpnoorsPhoneNumbers - A list of phone numbers that are opted out of receiving SMS messages. The list is paginated, and each page can contain up to 100 phone numbers.
  • lpnoorsNextToken - A NextToken string is returned when you call the ListPhoneNumbersOptedOut action if additional records are available after the first page of results.
  • lpnoorsResponseStatus - -- | The response status code.

data ListPhoneNumbersOptedOutResponse #

The response from the ListPhoneNumbersOptedOut action.

See: listPhoneNumbersOptedOutResponse smart constructor.

Instances
Eq ListPhoneNumbersOptedOutResponse # 
Instance details

Defined in Network.AWS.SNS.ListPhoneNumbersOptedOut

Data ListPhoneNumbersOptedOutResponse # 
Instance details

Defined in Network.AWS.SNS.ListPhoneNumbersOptedOut

Methods

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

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

toConstr :: ListPhoneNumbersOptedOutResponse -> Constr #

dataTypeOf :: ListPhoneNumbersOptedOutResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ListPhoneNumbersOptedOutResponse # 
Instance details

Defined in Network.AWS.SNS.ListPhoneNumbersOptedOut

Show ListPhoneNumbersOptedOutResponse # 
Instance details

Defined in Network.AWS.SNS.ListPhoneNumbersOptedOut

Generic ListPhoneNumbersOptedOutResponse # 
Instance details

Defined in Network.AWS.SNS.ListPhoneNumbersOptedOut

Associated Types

type Rep ListPhoneNumbersOptedOutResponse :: * -> * #

NFData ListPhoneNumbersOptedOutResponse # 
Instance details

Defined in Network.AWS.SNS.ListPhoneNumbersOptedOut

type Rep ListPhoneNumbersOptedOutResponse # 
Instance details

Defined in Network.AWS.SNS.ListPhoneNumbersOptedOut

type Rep ListPhoneNumbersOptedOutResponse = D1 (MetaData "ListPhoneNumbersOptedOutResponse" "Network.AWS.SNS.ListPhoneNumbersOptedOut" "amazonka-sns-1.6.0-HtFY9r81ykN4UA9Dx2hCIO" False) (C1 (MetaCons "ListPhoneNumbersOptedOutResponse'" PrefixI True) (S1 (MetaSel (Just "_lpnoorsPhoneNumbers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 (MetaSel (Just "_lpnoorsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lpnoorsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

lpnoorsPhoneNumbers :: Lens' ListPhoneNumbersOptedOutResponse [Text] #

A list of phone numbers that are opted out of receiving SMS messages. The list is paginated, and each page can contain up to 100 phone numbers.

lpnoorsNextToken :: Lens' ListPhoneNumbersOptedOutResponse (Maybe Text) #

A NextToken string is returned when you call the ListPhoneNumbersOptedOut action if additional records are available after the first page of results.