verify_sms_sandbox_phone_number¶
Operation¶
async
¶
verify_sms_sandbox_phone_number(input: VerifySMSSandboxPhoneNumberInput, plugins: list[Plugin] | None = None) -> VerifySMSSandboxPhoneNumberOutput
Verifies a destination phone number with a one-time password (OTP) for the calling Amazon Web Services account.
When you start using Amazon SNS to send SMS messages, your Amazon Web Services 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 Amazon Web Services 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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
VerifySMSSandboxPhoneNumberInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
VerifySMSSandboxPhoneNumberOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for VerifySMSSandboxPhoneNumberInput structure.
Attributes¶
class-attribute
instance-attribute
¶
one_time_password: str | None = None
The OTP sent to the destination number from the
CreateSMSSandBoxPhoneNumber call.
class-attribute
instance-attribute
¶
phone_number: str | None = field(repr=False, default=None)
The destination phone number to verify.
Output¶
dataclass
¶
The destination phone number's verification status.