| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.SNS.CheckIfPhoneNumberIsOptedOut
Description
Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your account. You cannot send SMS messages to a number that is opted out.
To resume sending messages, you can opt in the number by using the
OptInPhoneNumber action.
Synopsis
- data CheckIfPhoneNumberIsOptedOut = CheckIfPhoneNumberIsOptedOut' {
- phoneNumber :: Text
- newCheckIfPhoneNumberIsOptedOut :: Text -> CheckIfPhoneNumberIsOptedOut
- checkIfPhoneNumberIsOptedOut_phoneNumber :: Lens' CheckIfPhoneNumberIsOptedOut Text
- data CheckIfPhoneNumberIsOptedOutResponse = CheckIfPhoneNumberIsOptedOutResponse' {
- isOptedOut :: Maybe Bool
- httpStatus :: Int
- newCheckIfPhoneNumberIsOptedOutResponse :: Int -> CheckIfPhoneNumberIsOptedOutResponse
- checkIfPhoneNumberIsOptedOutResponse_isOptedOut :: Lens' CheckIfPhoneNumberIsOptedOutResponse (Maybe Bool)
- checkIfPhoneNumberIsOptedOutResponse_httpStatus :: Lens' CheckIfPhoneNumberIsOptedOutResponse Int
Creating a Request
data CheckIfPhoneNumberIsOptedOut Source #
The input for the CheckIfPhoneNumberIsOptedOut action.
See: newCheckIfPhoneNumberIsOptedOut smart constructor.
Constructors
| CheckIfPhoneNumberIsOptedOut' | |
Fields
| |
Instances
newCheckIfPhoneNumberIsOptedOut Source #
Create a value of CheckIfPhoneNumberIsOptedOut 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:
$sel:phoneNumber:CheckIfPhoneNumberIsOptedOut', checkIfPhoneNumberIsOptedOut_phoneNumber - The phone number for which you want to check the opt out status.
Request Lenses
checkIfPhoneNumberIsOptedOut_phoneNumber :: Lens' CheckIfPhoneNumberIsOptedOut Text Source #
The phone number for which you want to check the opt out status.
Destructuring the Response
data CheckIfPhoneNumberIsOptedOutResponse Source #
The response from the CheckIfPhoneNumberIsOptedOut action.
See: newCheckIfPhoneNumberIsOptedOutResponse smart constructor.
Constructors
| CheckIfPhoneNumberIsOptedOutResponse' | |
Fields
| |
Instances
newCheckIfPhoneNumberIsOptedOutResponse Source #
Arguments
| :: Int | |
| -> CheckIfPhoneNumberIsOptedOutResponse |
Create a value of CheckIfPhoneNumberIsOptedOutResponse 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:
$sel:isOptedOut:CheckIfPhoneNumberIsOptedOutResponse', checkIfPhoneNumberIsOptedOutResponse_isOptedOut - Indicates whether the phone number is opted out:
true– The phone number is opted out, meaning you cannot publish SMS messages to it.false– The phone number is opted in, meaning you can publish SMS messages to it.
$sel:httpStatus:CheckIfPhoneNumberIsOptedOutResponse', checkIfPhoneNumberIsOptedOutResponse_httpStatus - The response's http status code.
Response Lenses
checkIfPhoneNumberIsOptedOutResponse_isOptedOut :: Lens' CheckIfPhoneNumberIsOptedOutResponse (Maybe Bool) Source #
Indicates whether the phone number is opted out:
true– The phone number is opted out, meaning you cannot publish SMS messages to it.false– The phone number is opted in, meaning you can publish SMS messages to it.
checkIfPhoneNumberIsOptedOutResponse_httpStatus :: Lens' CheckIfPhoneNumberIsOptedOutResponse Int Source #
The response's http status code.