Skip to content

Sns  >  Operations  >  list_sms_sandbox_phone_numbers

list_sms_sandbox_phone_numbers

Operation

list_sms_sandbox_phone_numbers async

list_sms_sandbox_phone_numbers(input: ListSMSSandboxPhoneNumbersInput, plugins: list[Plugin] | None = None) -> ListSMSSandboxPhoneNumbersOutput

Lists the calling Amazon Web Services account's current verified and pending destination phone numbers in the SMS sandbox.

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 ListSMSSandboxPhoneNumbersInput

An instance of ListSMSSandboxPhoneNumbersInput.

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
ListSMSSandboxPhoneNumbersOutput

An instance of ListSMSSandboxPhoneNumbersOutput.

Input

ListSMSSandboxPhoneNumbersInput dataclass

Dataclass for ListSMSSandboxPhoneNumbersInput structure.

Attributes

max_results class-attribute instance-attribute
max_results: int | None = None

The maximum number of phone numbers to return.

next_token class-attribute instance-attribute
next_token: str | None = None

Token that the previous ListSMSSandboxPhoneNumbersInput request returns.

Output

ListSMSSandboxPhoneNumbersOutput dataclass

Dataclass for ListSMSSandboxPhoneNumbersOutput structure.

Attributes

next_token class-attribute instance-attribute
next_token: str | None = None

A NextToken string is returned when you call the ListSMSSandboxPhoneNumbersInput operation if additional pages of records are available.

phone_numbers instance-attribute
phone_numbers: list[SMSSandboxPhoneNumber]

A list of the calling account's pending and verified phone numbers.