| 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 |
Amazonka.PinpointSmsVoiceV2.DeleteOptedOutNumber
Description
Deletes an existing opted out destination phone number from the specified opt-out list.
Each destination phone number can only be deleted once every 30 days.
If the specified destination phone number doesn't exist or if the opt-out list doesn't exist, an Error is returned.
Synopsis
- data DeleteOptedOutNumber = DeleteOptedOutNumber' {}
- newDeleteOptedOutNumber :: Text -> Text -> DeleteOptedOutNumber
- deleteOptedOutNumber_optOutListName :: Lens' DeleteOptedOutNumber Text
- deleteOptedOutNumber_optedOutNumber :: Lens' DeleteOptedOutNumber Text
- data DeleteOptedOutNumberResponse = DeleteOptedOutNumberResponse' {}
- newDeleteOptedOutNumberResponse :: Int -> DeleteOptedOutNumberResponse
- deleteOptedOutNumberResponse_endUserOptedOut :: Lens' DeleteOptedOutNumberResponse (Maybe Bool)
- deleteOptedOutNumberResponse_optOutListArn :: Lens' DeleteOptedOutNumberResponse (Maybe Text)
- deleteOptedOutNumberResponse_optOutListName :: Lens' DeleteOptedOutNumberResponse (Maybe Text)
- deleteOptedOutNumberResponse_optedOutNumber :: Lens' DeleteOptedOutNumberResponse (Maybe Text)
- deleteOptedOutNumberResponse_optedOutTimestamp :: Lens' DeleteOptedOutNumberResponse (Maybe UTCTime)
- deleteOptedOutNumberResponse_httpStatus :: Lens' DeleteOptedOutNumberResponse Int
Creating a Request
data DeleteOptedOutNumber Source #
See: newDeleteOptedOutNumber smart constructor.
Constructors
| DeleteOptedOutNumber' | |
Fields
| |
Instances
newDeleteOptedOutNumber Source #
Arguments
| :: Text | |
| -> Text | |
| -> DeleteOptedOutNumber |
Create a value of DeleteOptedOutNumber 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:
DeleteOptedOutNumber, deleteOptedOutNumber_optOutListName - The OptOutListName or OptOutListArn to remove the phone number from.
DeleteOptedOutNumber, deleteOptedOutNumber_optedOutNumber - The phone number, in E.164 format, to remove from the OptOutList.
Request Lenses
deleteOptedOutNumber_optOutListName :: Lens' DeleteOptedOutNumber Text Source #
The OptOutListName or OptOutListArn to remove the phone number from.
deleteOptedOutNumber_optedOutNumber :: Lens' DeleteOptedOutNumber Text Source #
The phone number, in E.164 format, to remove from the OptOutList.
Destructuring the Response
data DeleteOptedOutNumberResponse Source #
See: newDeleteOptedOutNumberResponse smart constructor.
Constructors
| DeleteOptedOutNumberResponse' | |
Fields
| |
Instances
newDeleteOptedOutNumberResponse Source #
Create a value of DeleteOptedOutNumberResponse 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:
DeleteOptedOutNumberResponse, deleteOptedOutNumberResponse_endUserOptedOut - This is true if it was the end user who requested their phone number be
removed.
DeleteOptedOutNumberResponse, deleteOptedOutNumberResponse_optOutListArn - The OptOutListArn that the phone number was removed from.
DeleteOptedOutNumber, deleteOptedOutNumberResponse_optOutListName - The OptOutListName that the phone number was removed from.
DeleteOptedOutNumber, deleteOptedOutNumberResponse_optedOutNumber - The phone number that was removed from the OptOutList.
DeleteOptedOutNumberResponse, deleteOptedOutNumberResponse_optedOutTimestamp - The time that the number was removed at, in
UNIX epoch time format.
$sel:httpStatus:DeleteOptedOutNumberResponse', deleteOptedOutNumberResponse_httpStatus - The response's http status code.
Response Lenses
deleteOptedOutNumberResponse_endUserOptedOut :: Lens' DeleteOptedOutNumberResponse (Maybe Bool) Source #
This is true if it was the end user who requested their phone number be removed.
deleteOptedOutNumberResponse_optOutListArn :: Lens' DeleteOptedOutNumberResponse (Maybe Text) Source #
The OptOutListArn that the phone number was removed from.
deleteOptedOutNumberResponse_optOutListName :: Lens' DeleteOptedOutNumberResponse (Maybe Text) Source #
The OptOutListName that the phone number was removed from.
deleteOptedOutNumberResponse_optedOutNumber :: Lens' DeleteOptedOutNumberResponse (Maybe Text) Source #
The phone number that was removed from the OptOutList.
deleteOptedOutNumberResponse_optedOutTimestamp :: Lens' DeleteOptedOutNumberResponse (Maybe UTCTime) Source #
The time that the number was removed at, in UNIX epoch time format.
deleteOptedOutNumberResponse_httpStatus :: Lens' DeleteOptedOutNumberResponse Int Source #
The response's http status code.