Skip to content

get_sms_sandbox_account_status

Operation

get_sms_sandbox_account_status

get_sms_sandbox_account_status(request: GetSMSSandboxAccountStatusInput | GetSMSSandboxAccountStatusInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetSMSSandboxAccountStatusInputDict]) -> GetSMSSandboxAccountStatusOutput

Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target Amazon Web Services Region.

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 GetSMSSandboxAccountStatusInput | GetSMSSandboxAccountStatusInputDict | 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[GetSMSSandboxAccountStatusInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetSMSSandboxAccountStatusOutput

An instance of GetSMSSandboxAccountStatusOutput.

get_sms_sandbox_account_status async

get_sms_sandbox_account_status(request: GetSMSSandboxAccountStatusInput | GetSMSSandboxAccountStatusInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetSMSSandboxAccountStatusInputDict]) -> GetSMSSandboxAccountStatusOutput

Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target Amazon Web Services Region.

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 GetSMSSandboxAccountStatusInput | GetSMSSandboxAccountStatusInputDict | 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[GetSMSSandboxAccountStatusInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetSMSSandboxAccountStatusOutput

An instance of GetSMSSandboxAccountStatusOutput.

Input

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

GetSMSSandboxAccountStatusInputDict

Bases: TypedDict

Dictionary form of GetSMSSandboxAccountStatusInput.

GetSMSSandboxAccountStatusInput dataclass

Bases: _SerdeShape

Dataclass for GetSMSSandboxAccountStatusInput structure.

Output

GetSMSSandboxAccountStatusOutput dataclass

Bases: _SerdeShape

Dataclass for GetSMSSandboxAccountStatusOutput structure.

Attributes

is_in_sandbox class-attribute instance-attribute
is_in_sandbox: bool = ...

Indicates whether the calling Amazon Web Services account is in the SMS sandbox.

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.