sms_sandbox_phone_numbers

Creates, updates, deletes, gets or lists a sms_sandbox_phone_numbers resource.

Overview

Name	sms_sandbox_phone_numbers
Type	Resource
Id	aws.sns.sms_sandbox_phone_numbers

Fields

The following fields are returned by SELECT queries:

list_sms_sandbox_phone_numbers

Name	Datatype	Description
phone_number	string	The destination phone number.
status	string	The destination phone number's verification status.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_sms_sandbox_phone_numbers	select	region	NextToken, MaxResults	Lists the calling Amazon Web Services account's current verified and pending destination phone numbers in the SMS sandbox. 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.
create_sms_sandbox_phone_number	insert	PhoneNumber, region	LanguageCode	Adds a destination phone number to an Amazon Web Services account in the SMS sandbox and sends a one-time password (OTP) to that phone number. 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.
delete_sms_sandbox_phone_number	delete	PhoneNumber, region		Deletes an Amazon Web Services account's verified or pending phone number from the SMS sandbox. 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
PhoneNumber	string	The destination phone number to delete.
region	string	AWS region (default: us-east-1)
LanguageCode	string	The language to use for sending the OTP. The default value is en-US.
MaxResults	integer	The maximum number of phone numbers to return.
NextToken	string	Token that the previous ListSMSSandboxPhoneNumbersInput request returns.

SELECT examples

list_sms_sandbox_phone_numbers

Lists the calling Amazon Web Services account's current verified and pending destination phone numbers in the SMS sandbox. 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
phone_number,
status
FROM aws.sns.sms_sandbox_phone_numbers
WHERE region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
;

INSERT examples

create_sms_sandbox_phone_number

Adds a destination phone number to an Amazon Web Services account in the SMS sandbox and sends a one-time password (OTP) to that phone number. 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.

INSERT INTO aws.sns.sms_sandbox_phone_numbers (
PhoneNumber,
region,
LanguageCode
)
SELECT 
'{{ PhoneNumber }}',
'{{ region }}',
'{{ LanguageCode }}'
;

Manifest

# Description fields are for documentation purposes
- name: sms_sandbox_phone_numbers
props:
  - name: PhoneNumber
    value: "{{ PhoneNumber }}"
    description: Required parameter for the sms_sandbox_phone_numbers resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the sms_sandbox_phone_numbers resource.
  - name: LanguageCode
    value: "{{ LanguageCode }}"
    description: The language to use for sending the OTP. The default value is en-US.
    description: The language to use for sending the OTP. The default value is en-US.

DELETE examples

delete_sms_sandbox_phone_number

Deletes an Amazon Web Services account's verified or pending phone number from the SMS sandbox. 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.

DELETE FROM aws.sns.sms_sandbox_phone_numbers
WHERE PhoneNumber = '{{ PhoneNumber }}' --required
AND region = '{{ region }}' --required
;