Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
This operation returns paginated results.
Synopsis
- data ListPhoneNumbersOptedOut = ListPhoneNumbersOptedOut' {}
- newListPhoneNumbersOptedOut :: ListPhoneNumbersOptedOut
- listPhoneNumbersOptedOut_nextToken :: Lens' ListPhoneNumbersOptedOut (Maybe Text)
- data ListPhoneNumbersOptedOutResponse = ListPhoneNumbersOptedOutResponse' {
- nextToken :: Maybe Text
- phoneNumbers :: Maybe [Text]
- httpStatus :: Int
- newListPhoneNumbersOptedOutResponse :: Int -> ListPhoneNumbersOptedOutResponse
- listPhoneNumbersOptedOutResponse_nextToken :: Lens' ListPhoneNumbersOptedOutResponse (Maybe Text)
- listPhoneNumbersOptedOutResponse_phoneNumbers :: Lens' ListPhoneNumbersOptedOutResponse (Maybe [Text])
- listPhoneNumbersOptedOutResponse_httpStatus :: Lens' ListPhoneNumbersOptedOutResponse Int
Creating a Request
data ListPhoneNumbersOptedOut Source #
The input for the ListPhoneNumbersOptedOut
action.
See: newListPhoneNumbersOptedOut
smart constructor.
Instances
newListPhoneNumbersOptedOut :: ListPhoneNumbersOptedOut Source #
Create a value of ListPhoneNumbersOptedOut
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:
ListPhoneNumbersOptedOut
, listPhoneNumbersOptedOut_nextToken
- A NextToken
string is used when you call the
ListPhoneNumbersOptedOut
action to retrieve additional records that
are available after the first page of results.
Request Lenses
listPhoneNumbersOptedOut_nextToken :: Lens' ListPhoneNumbersOptedOut (Maybe Text) Source #
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
data ListPhoneNumbersOptedOutResponse Source #
The response from the ListPhoneNumbersOptedOut
action.
See: newListPhoneNumbersOptedOutResponse
smart constructor.
ListPhoneNumbersOptedOutResponse' | |
|
Instances
newListPhoneNumbersOptedOutResponse Source #
Create a value of ListPhoneNumbersOptedOutResponse
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:
ListPhoneNumbersOptedOut
, listPhoneNumbersOptedOutResponse_nextToken
- A NextToken
string is returned when you call the
ListPhoneNumbersOptedOut
action if additional records are available
after the first page of results.
$sel:phoneNumbers:ListPhoneNumbersOptedOutResponse'
, listPhoneNumbersOptedOutResponse_phoneNumbers
- 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.
$sel:httpStatus:ListPhoneNumbersOptedOutResponse'
, listPhoneNumbersOptedOutResponse_httpStatus
- The response's http status code.
Response Lenses
listPhoneNumbersOptedOutResponse_nextToken :: Lens' ListPhoneNumbersOptedOutResponse (Maybe Text) Source #
A NextToken
string is returned when you call the
ListPhoneNumbersOptedOut
action if additional records are available
after the first page of results.
listPhoneNumbersOptedOutResponse_phoneNumbers :: Lens' ListPhoneNumbersOptedOutResponse (Maybe [Text]) Source #
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.
listPhoneNumbersOptedOutResponse_httpStatus :: Lens' ListPhoneNumbersOptedOutResponse Int Source #
The response's http status code.