template_versions
Creates, updates, deletes, gets or lists a template_versions resource.
Overview
| Name | template_versions |
| Type | Resource |
| Id | aws.pinpoint.template_versions |
Fields
The following fields are returned by SELECT queries:
- list_template_versions
| Name | Datatype | Description |
|---|---|---|
item | array | An array of responses, one for each version of the message template. |
message | string | The message that's returned from the API for the request to retrieve information about all the versions of the message template. |
next_token | string | The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages. |
request_id | string | The unique identifier for the request to retrieve information about all the versions of the message template. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_template_versions | select | template-name, template-type, region | next-token, page-size | Retrieves information about all the versions of a specific message template. |
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) |
template-name | string | The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. |
template-type | string | The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE. |
next-token | string | The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics. |
page-size | string | The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics. |
SELECT examples
- list_template_versions
Retrieves information about all the versions of a specific message template.
SELECT
item,
message,
next_token,
request_id
FROM aws.pinpoint.template_versions
WHERE `template-name` = '{{ template-name }}' -- required
AND `template-type` = '{{ template-type }}' -- required
AND region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `page-size` = '{{ page-size }}'
;