create_sms_sandbox_phone_number¶
Operation¶
async
¶
create_sms_sandbox_phone_number(input: CreateSMSSandboxPhoneNumberInput, plugins: list[Plugin] | None = None) -> CreateSMSSandboxPhoneNumberOutput
Adds a destination phone number to an Amazon Web Services account in the SMS sandbox and sends a one-time password (OTP) to that phone number.
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
|
CreateSMSSandboxPhoneNumberInput
|
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 |
|---|---|
CreateSMSSandboxPhoneNumberOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for CreateSMSSandboxPhoneNumberInput structure.
Attributes¶
class-attribute
instance-attribute
¶
language_code: LanguageCodeString | None = None
The language to use for sending the OTP. The default value is en-US.
class-attribute
instance-attribute
¶
phone_number: str | None = field(repr=False, default=None)
The destination phone number to verify. On verification, Amazon SNS adds this phone number to the list of verified phone numbers that you can send SMS messages to.
Output¶
dataclass
¶
Dataclass for CreateSMSSandboxPhoneNumberOutput structure.