sms_sandbox_account_status
Creates, updates, deletes, gets or lists a sms_sandbox_account_status resource.
Overview
| Name | sms_sandbox_account_status |
| Type | Resource |
| Id | aws.sns.sms_sandbox_account_status |
Fields
The following fields are returned by SELECT queries:
- get_sms_sandbox_account_status
| Name | Datatype | Description |
|---|---|---|
is_in_sandbox | boolean | Indicates whether the calling Amazon Web Services account is in the SMS sandbox. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_sms_sandbox_account_status | select | region | 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
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_sms_sandbox_account_status
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.
SELECT
is_in_sandbox
FROM aws.sns.sms_sandbox_account_status
WHERE region = '{{ region }}' -- required
;