Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Network.AWS.SNS.ListPhoneNumbersOptedOut
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.
- listPhoneNumbersOptedOut :: ListPhoneNumbersOptedOut
- data ListPhoneNumbersOptedOut
- lpnooNextToken :: Lens' ListPhoneNumbersOptedOut (Maybe Text)
- listPhoneNumbersOptedOutResponse :: Int -> ListPhoneNumbersOptedOutResponse
- data ListPhoneNumbersOptedOutResponse
- lpnoorsPhoneNumbers :: Lens' ListPhoneNumbersOptedOutResponse [Text]
- lpnoorsNextToken :: Lens' ListPhoneNumbersOptedOutResponse (Maybe Text)
- lpnoorsResponseStatus :: Lens' ListPhoneNumbersOptedOutResponse Int
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
- ANextToken
string is used when you call theListPhoneNumbersOptedOut
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
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 #
Arguments
:: Int | |
-> 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
- ANextToken
string is returned when you call theListPhoneNumbersOptedOut
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.
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.
lpnoorsResponseStatus :: Lens' ListPhoneNumbersOptedOutResponse Int #
- - | The response status code.