notify_templates

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

Overview

Name	notify_templates
Type	Resource
Id	aws.pinpoint_sms_voice_v2.notify_templates

Fields

The following fields are returned by SELECT queries:

describe_notify_templates

Name	Datatype	Description
channels	array	The channels for the template. Supported values are SMS and VOICE.
content	string	The content of the template.
created_timestamp	string (date-time)	The time when the notify template was created, in UNIX epoch time format.
language_code	string	The language code for the template. (pattern: <code>[a-z]{2}(-[A-Z]{2})?</code>)
status	string	The current status of the template. (ACTIVE, INACTIVE)
supported_countries	array	An array of supported country codes for the template.
supported_voice_ids	array	An array of supported voice IDs for voice templates.
template_id	string	Template identifier for notify templates. In UpdateNotifyConfiguration, pass UNSET_DEFAULT_TEMPLATE to clear the default template. The UNSET_DEFAULT_TEMPLATE value is only accepted by UpdateNotifyConfiguration. (pattern: <code>([A-Za-z0-9_-]*|UNSET_DEFAULT_TEMPLATE)</code>)
template_type	string	The type of the template. (OTP_VERIFICATION)
tier_access	array	The tier access level for the template.
variables	object	An array of template variable metadata for the template.
version	integer	The version of the template.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_notify_templates	select	region		Describes the specified notify templates or all notify templates in your account. If you specify template IDs, the output includes information for only the specified notify templates. If you specify filters, the output includes information for only those notify templates that meet the filter criteria. If you don't specify template IDs or filters, the output includes information for all notify templates. If you specify a template ID that isn't valid, an error is returned.

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

describe_notify_templates

Describes the specified notify templates or all notify templates in your account. If you specify template IDs, the output includes information for only the specified notify templates. If you specify filters, the output includes information for only those notify templates that meet the filter criteria. If you don't specify template IDs or filters, the output includes information for all notify templates. If you specify a template ID that isn't valid, an error is returned.

SELECT
channels,
content,
created_timestamp,
language_code,
status,
supported_countries,
supported_voice_ids,
template_id,
template_type,
tier_access,
variables,
version
FROM aws.pinpoint_sms_voice_v2.notify_templates
WHERE region = '{{ region }}' -- required
;