GetSMSSandboxAccountStatus -
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

GetSMSSandboxAccountStatus

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.

Response Elements

The following element is returned by the service.

IsInSandbox

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

Type: Boolean

Errors

For information about the errors that are common to all actions, see Common Errors.

AuthorizationError

Indicates that the user has been denied access to the requested resource.

HTTP Status Code: 403

InternalError

Indicates an internal service error.

HTTP Status Code: 500

Throttled

Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account.

HTTP Status Code: 429

Examples

The structure of AUTHPARAMS depends on the signature of the API request. For more information, see Examples of the complete Signature Version 4 signing process (Python) in the Amazon General Reference.

Example

This example illustrates one usage of GetSMSSandboxAccountStatus.

Sample Request

https://sns.us-west-2.amazonaws.com/?Action=GetSMSSandboxAccountStatus &Version=2010-03-31 &AUTHPARAMS

Sample Response

<GetSMSSandboxAccountStatusResponse xmlns="https://sns.amazonaws.com/doc/2010-03-31/"> <GetSMSSandboxAccountStatusResult> <IsInSandbox>true</IsInSandbox> </GetSMSSandboxAccountStatusResult> <ResponseMetadata> <RequestId>197f9501-7eca-5151-8d68-cdfb83a62aeb</RequestId> </ResponseMetadata> </GetSMSSandboxAccountStatusResponse>

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: