- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
GetSMSSandboxAccountStatusCommand
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 Syntax
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
// };
GetSMSSandboxAccountStatusCommand Input
GetSMSSandboxAccountStatusCommandInput extends GetSMSSandboxAccountStatusInput
GetSMSSandboxAccountStatusCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
IsInSandbox Required | boolean | undefined | Indicates whether the calling Amazon Web Services account is in the SMS sandbox. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AuthorizationErrorException | client | Indicates that the user has been denied access to the requested resource. |
InternalErrorException | server | Indicates an internal service error. |
ThrottledException | client | Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. |
SNSServiceException | Base exception class for all service exceptions from SNS service. |