in_app_messages
Creates, updates, deletes, gets or lists an in_app_messages resource.
Overview
| Name | in_app_messages |
| Type | Resource |
| Id | aws.pinpoint.in_app_messages |
Fields
The following fields are returned by SELECT queries:
- get_in_app_messages
| Name | Datatype | Description |
|---|---|---|
in_app_message_campaigns | array | List of targeted in-app message campaigns. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_in_app_messages | select | application-id, endpoint-id, region | Retrieves the in-app messages targeted for the provided endpoint ID. |
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 |
|---|---|---|
application-id | string | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
endpoint-id | string | The unique identifier for the endpoint. |
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_in_app_messages
Retrieves the in-app messages targeted for the provided endpoint ID.
SELECT
in_app_message_campaigns
FROM aws.pinpoint.in_app_messages
WHERE `application-id` = '{{ application-id }}' -- required
AND `endpoint-id` = '{{ endpoint-id }}' -- required
AND region = '{{ region }}' -- required
;