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 |
Creates an opted out destination phone number in the opt-out list.
If the destination phone number isn't valid or if the specified opt-out list doesn't exist, an Error is returned.
Synopsis
- data PutOptedOutNumber = PutOptedOutNumber' {}
- newPutOptedOutNumber :: Text -> Text -> PutOptedOutNumber
- putOptedOutNumber_optOutListName :: Lens' PutOptedOutNumber Text
- putOptedOutNumber_optedOutNumber :: Lens' PutOptedOutNumber Text
- data PutOptedOutNumberResponse = PutOptedOutNumberResponse' {}
- newPutOptedOutNumberResponse :: Int -> PutOptedOutNumberResponse
- putOptedOutNumberResponse_endUserOptedOut :: Lens' PutOptedOutNumberResponse (Maybe Bool)
- putOptedOutNumberResponse_optOutListArn :: Lens' PutOptedOutNumberResponse (Maybe Text)
- putOptedOutNumberResponse_optOutListName :: Lens' PutOptedOutNumberResponse (Maybe Text)
- putOptedOutNumberResponse_optedOutNumber :: Lens' PutOptedOutNumberResponse (Maybe Text)
- putOptedOutNumberResponse_optedOutTimestamp :: Lens' PutOptedOutNumberResponse (Maybe UTCTime)
- putOptedOutNumberResponse_httpStatus :: Lens' PutOptedOutNumberResponse Int
Creating a Request
data PutOptedOutNumber Source #
See: newPutOptedOutNumber
smart constructor.
PutOptedOutNumber' | |
|
Instances
Create a value of PutOptedOutNumber
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:
PutOptedOutNumber
, putOptedOutNumber_optOutListName
- The OptOutListName or OptOutListArn to add the phone number to.
PutOptedOutNumber
, putOptedOutNumber_optedOutNumber
- The phone number to add to the OptOutList in E.164 format.
Request Lenses
putOptedOutNumber_optOutListName :: Lens' PutOptedOutNumber Text Source #
The OptOutListName or OptOutListArn to add the phone number to.
putOptedOutNumber_optedOutNumber :: Lens' PutOptedOutNumber Text Source #
The phone number to add to the OptOutList in E.164 format.
Destructuring the Response
data PutOptedOutNumberResponse Source #
See: newPutOptedOutNumberResponse
smart constructor.
PutOptedOutNumberResponse' | |
|
Instances
newPutOptedOutNumberResponse Source #
Create a value of PutOptedOutNumberResponse
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:
PutOptedOutNumberResponse
, putOptedOutNumberResponse_endUserOptedOut
- This is true if it was the end user who requested their phone number be
removed.
PutOptedOutNumberResponse
, putOptedOutNumberResponse_optOutListArn
- The OptOutListArn that the phone number was removed from.
PutOptedOutNumber
, putOptedOutNumberResponse_optOutListName
- The OptOutListName that the phone number was removed from.
PutOptedOutNumber
, putOptedOutNumberResponse_optedOutNumber
- The phone number that was added to the OptOutList.
PutOptedOutNumberResponse
, putOptedOutNumberResponse_optedOutTimestamp
- The time that the phone number was added to the OptOutList, in
UNIX epoch time format.
$sel:httpStatus:PutOptedOutNumberResponse'
, putOptedOutNumberResponse_httpStatus
- The response's http status code.
Response Lenses
putOptedOutNumberResponse_endUserOptedOut :: Lens' PutOptedOutNumberResponse (Maybe Bool) Source #
This is true if it was the end user who requested their phone number be removed.
putOptedOutNumberResponse_optOutListArn :: Lens' PutOptedOutNumberResponse (Maybe Text) Source #
The OptOutListArn that the phone number was removed from.
putOptedOutNumberResponse_optOutListName :: Lens' PutOptedOutNumberResponse (Maybe Text) Source #
The OptOutListName that the phone number was removed from.
putOptedOutNumberResponse_optedOutNumber :: Lens' PutOptedOutNumberResponse (Maybe Text) Source #
The phone number that was added to the OptOutList.
putOptedOutNumberResponse_optedOutTimestamp :: Lens' PutOptedOutNumberResponse (Maybe UTCTime) Source #
The time that the phone number was added to the OptOutList, in UNIX epoch time format.
putOptedOutNumberResponse_httpStatus :: Lens' PutOptedOutNumberResponse Int Source #
The response's http status code.