| 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.VerifySMSSandboxPhoneNumber
Description
Verifies a destination phone number with a one-time password (OTP) for the calling account.
When you start using Amazon SNS to send SMS messages, your account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
Synopsis
- data VerifySMSSandboxPhoneNumber = VerifySMSSandboxPhoneNumber' {}
- newVerifySMSSandboxPhoneNumber :: Text -> Text -> VerifySMSSandboxPhoneNumber
- verifySMSSandboxPhoneNumber_phoneNumber :: Lens' VerifySMSSandboxPhoneNumber Text
- verifySMSSandboxPhoneNumber_oneTimePassword :: Lens' VerifySMSSandboxPhoneNumber Text
- data VerifySMSSandboxPhoneNumberResponse = VerifySMSSandboxPhoneNumberResponse' {
- httpStatus :: Int
- newVerifySMSSandboxPhoneNumberResponse :: Int -> VerifySMSSandboxPhoneNumberResponse
- verifySMSSandboxPhoneNumberResponse_httpStatus :: Lens' VerifySMSSandboxPhoneNumberResponse Int
Creating a Request
data VerifySMSSandboxPhoneNumber Source #
See: newVerifySMSSandboxPhoneNumber smart constructor.
Constructors
| VerifySMSSandboxPhoneNumber' | |
Fields
| |
Instances
newVerifySMSSandboxPhoneNumber Source #
Arguments
| :: Text | |
| -> Text | |
| -> VerifySMSSandboxPhoneNumber |
Create a value of VerifySMSSandboxPhoneNumber 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:VerifySMSSandboxPhoneNumber', verifySMSSandboxPhoneNumber_phoneNumber - The destination phone number to verify.
$sel:oneTimePassword:VerifySMSSandboxPhoneNumber', verifySMSSandboxPhoneNumber_oneTimePassword - The OTP sent to the destination number from the
CreateSMSSandBoxPhoneNumber call.
Request Lenses
verifySMSSandboxPhoneNumber_phoneNumber :: Lens' VerifySMSSandboxPhoneNumber Text Source #
The destination phone number to verify.
verifySMSSandboxPhoneNumber_oneTimePassword :: Lens' VerifySMSSandboxPhoneNumber Text Source #
The OTP sent to the destination number from the
CreateSMSSandBoxPhoneNumber call.
Destructuring the Response
data VerifySMSSandboxPhoneNumberResponse Source #
The destination phone number's verification status.
See: newVerifySMSSandboxPhoneNumberResponse smart constructor.
Constructors
| VerifySMSSandboxPhoneNumberResponse' | |
Fields
| |
Instances
newVerifySMSSandboxPhoneNumberResponse Source #
Arguments
| :: Int | |
| -> VerifySMSSandboxPhoneNumberResponse |
Create a value of VerifySMSSandboxPhoneNumberResponse 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:httpStatus:VerifySMSSandboxPhoneNumberResponse', verifySMSSandboxPhoneNumberResponse_httpStatus - The response's http status code.
Response Lenses
verifySMSSandboxPhoneNumberResponse_httpStatus :: Lens' VerifySMSSandboxPhoneNumberResponse Int Source #
The response's http status code.