Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Class GetSMSSandboxAccountStatusCommandProtected

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.

Example

Use a bare-bones client and the command you need to make an API call.

import { SNSClient, GetSMSSandboxAccountStatusCommand } from "@aws-sdk/client-sns"; // ES Modules import
// const { SNSClient, GetSMSSandboxAccountStatusCommand } = require("@aws-sdk/client-sns"); // CommonJS import
const client = new SNSClient(config);
const input = {};
const command = new GetSMSSandboxAccountStatusCommand(input);
const response = await client.send(command);
// { // GetSMSSandboxAccountStatusResult
// IsInSandbox: true || false, // required
// };

Param

GetSMSSandboxAccountStatusCommandInput

Returns

GetSMSSandboxAccountStatusCommandOutput

See

Throws

AuthorizationErrorException (client fault)

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

Throws

InternalErrorException (server fault)

Indicates an internal service error.

Throws

ThrottledException (client fault)

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

Throws

SNSServiceException

Base exception class for all service exceptions from SNS service.

Hierarchy

Constructors

Properties

Methods