whats_app_flow_previews

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

Overview

Name	whats_app_flow_previews
Type	Resource
Id	aws.socialmessaging.whats_app_flow_previews

Fields

The following fields are returned by SELECT queries:

get_whats_app_flow_preview

Name	Datatype	Description
flow_id	string	The unique identifier of the Flow. (pattern: <code>[0-9]+</code>)
preview	object	The preview URL and its expiration timestamp.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_whats_app_flow_preview	select	id, flowId, region	invalidate	Generates a web preview URL for testing a WhatsApp Flow before publishing. Preview URLs expire in 30 days and can be shared with stakeholders for review.

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
flowId	string	The unique identifier of the Flow to preview.
id	string	The ID of the WhatsApp Business Account associated with this Flow.
region	string	AWS region (default: us-east-1)
invalidate	boolean	Set to true to force generation of a new preview URL. Use this if the previous URL has been compromised or you want a fresh expiration period.

SELECT examples

get_whats_app_flow_preview

Generates a web preview URL for testing a WhatsApp Flow before publishing. Preview URLs expire in 30 days and can be shared with stakeholders for review.

SELECT
flow_id,
preview
FROM aws.socialmessaging.whats_app_flow_previews
WHERE id = '{{ id }}' -- required
AND flowId = '{{ flowId }}' -- required
AND region = '{{ region }}' -- required
AND invalidate = '{{ invalidate }}'
;