Skip to content

create_sms_sandbox_phone_number

Operation

create_sms_sandbox_phone_number

create_sms_sandbox_phone_number(request: CreateSMSSandboxPhoneNumberInput | CreateSMSSandboxPhoneNumberInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateSMSSandboxPhoneNumberInputDict]) -> 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
request CreateSMSSandboxPhoneNumberInput | CreateSMSSandboxPhoneNumberInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[CreateSMSSandboxPhoneNumberInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateSMSSandboxPhoneNumberOutput

An instance of CreateSMSSandboxPhoneNumberOutput.

create_sms_sandbox_phone_number async

create_sms_sandbox_phone_number(request: CreateSMSSandboxPhoneNumberInput | CreateSMSSandboxPhoneNumberInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateSMSSandboxPhoneNumberInputDict]) -> 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
request CreateSMSSandboxPhoneNumberInput | CreateSMSSandboxPhoneNumberInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[CreateSMSSandboxPhoneNumberInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateSMSSandboxPhoneNumberOutput

An instance of CreateSMSSandboxPhoneNumberOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

CreateSMSSandboxPhoneNumberInputDict

Bases: TypedDict

Dictionary form of CreateSMSSandboxPhoneNumberInput.

Attributes

language_code instance-attribute
language_code: str | None

The language to use for sending the OTP. The default value is en-US.

phone_number instance-attribute
phone_number: Required[str]

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.

CreateSMSSandboxPhoneNumberInput dataclass

Bases: _SerdeShape

Dataclass for CreateSMSSandboxPhoneNumberInput structure.

Attributes

language_code class-attribute instance-attribute
language_code: str | None = ...

The language to use for sending the OTP. The default value is en-US.

phone_number class-attribute instance-attribute
phone_number: str | 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

CreateSMSSandboxPhoneNumberOutput dataclass

Bases: _SerdeShape

Dataclass for CreateSMSSandboxPhoneNumberOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.