linked_whats_app_business_accounts

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

Overview

Name	linked_whats_app_business_accounts
Type	Resource
Id	aws.socialmessaging.linked_whats_app_business_accounts

Fields

The following fields are returned by SELECT queries:

get_linked_whats_app_business_account

Name	Datatype	Description
id	string	The ID of the linked WhatsApp Business Account, formatted as waba-01234567890123456789012345678901. (pattern: <code>.(^waba-.$)|(^arn:.:waba/[0-9a-zA-Z]+$).</code>)
arn	string	The ARN of the linked WhatsApp Business Account. (pattern: <code>arn:.*:waba/[0-9a-zA-Z]+</code>)
dataset_id	string	The Meta Conversions API dataset ID associated with this WhatsApp Business Account. This value is a numeric string of 10 to 20 digits. This field is not present when no dataset has been created for this account. (pattern: <code>[0-9]+</code>)
event_destinations	array	The event destinations for the linked WhatsApp Business Account.
link_date	string (date-time)	The date the WhatsApp Business Account was linked.
marketing_messages_onboarding_status	string	The onboarding status for the Marketing Messages API. This value is fetched from Meta and indicates whether the WhatsApp Business Account is onboarded for Meta's Marketing Messages API.
phone_numbers	array	The phone numbers associated with the Linked WhatsApp Business Account.
registration_status	string	The registration status of the linked WhatsApp Business Account. (COMPLETE, INCOMPLETE)
waba_id	string	The WhatsApp Business Account ID from meta.
waba_name	string	The name of the linked WhatsApp Business Account.

list_linked_whats_app_business_accounts

Name	Datatype	Description
id	string	The ID of the linked WhatsApp Business Account, formatted as waba-01234567890123456789012345678901. (pattern: <code>.(^waba-.$)|(^arn:.:waba/[0-9a-zA-Z]+$).</code>)
arn	string	The ARN of the linked WhatsApp Business Account. (pattern: <code>arn:.*:waba/[0-9a-zA-Z]+</code>)
dataset_id	string	The Meta Conversions API dataset ID associated with this WhatsApp Business Account. This value is a numeric string of 10 to 20 digits. This field is not present when no dataset has been created for this account. (pattern: <code>[0-9]+</code>)
event_destinations	array	The event destinations for the linked WhatsApp Business Account.
link_date	string (date-time)	The date the WhatsApp Business Account was linked.
marketing_messages_onboarding_status	string	The onboarding status for the Marketing Messages API. This value is fetched from Meta and indicates whether the WhatsApp Business Account is onboarded for Meta's Marketing Messages API.
registration_status	string	The registration status of the linked WhatsApp Business Account. (COMPLETE, INCOMPLETE)
waba_id	string	The WhatsApp Business Account ID provided by Meta.
waba_name	string	The name of the linked WhatsApp Business Account.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_linked_whats_app_business_account	select	id, region		Get the details of your linked WhatsApp Business Account.
list_linked_whats_app_business_accounts	select	region	nextToken, maxResults	List all WhatsApp Business Accounts linked to your Amazon Web Services account.

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
id	string	The unique identifier, from Amazon Web Services, of the linked WhatsApp Business Account. WABA identifiers are formatted as waba-01234567890123456789012345678901. Use ListLinkedWhatsAppBusinessAccounts to list all WABAs and their details.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return.
nextToken	string	The next token for pagination.

SELECT examples

get_linked_whats_app_business_account

Get the details of your linked WhatsApp Business Account.

SELECT
id,
arn,
dataset_id,
event_destinations,
link_date,
marketing_messages_onboarding_status,
phone_numbers,
registration_status,
waba_id,
waba_name
FROM aws.socialmessaging.linked_whats_app_business_accounts
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_linked_whats_app_business_accounts

List all WhatsApp Business Accounts linked to your Amazon Web Services account.

SELECT
id,
arn,
dataset_id,
event_destinations,
link_date,
marketing_messages_onboarding_status,
registration_status,
waba_id,
waba_name
FROM aws.socialmessaging.linked_whats_app_business_accounts
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;