phone_numbers_opted_outs

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

Overview

Name	phone_numbers_opted_outs
Type	Resource
Id	aws.sns.phone_numbers_opted_outs

Fields

The following fields are returned by SELECT queries:

list_phone_numbers_opted_out

Name	Datatype	Description
phone_number	string	A list of phone numbers that are opted out of receiving SMS messages. The list is paginated, and each page can contain up to 100 phone numbers.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_phone_numbers_opted_out	select	region	nextToken	Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them. The results for ListPhoneNumbersOptedOut are paginated, and each page returns up to 100 phone numbers. If additional phone numbers are available after the first page of results, then a NextToken string will be returned. To receive the next page, you call ListPhoneNumbersOptedOut again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null.

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)
nextToken	string	A NextToken string is used when you call the ListPhoneNumbersOptedOut action to retrieve additional records that are available after the first page of results.

SELECT examples

list_phone_numbers_opted_out

Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them. The results for ListPhoneNumbersOptedOut are paginated, and each page returns up to 100 phone numbers. If additional phone numbers are available after the first page of results, then a NextToken string will be returned. To receive the next page, you call ListPhoneNumbersOptedOut again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null.

SELECT
phone_number
FROM aws.sns.phone_numbers_opted_outs
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
;