segment_memberships

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

Overview

Name	segment_memberships
Type	Resource
Id	aws.customer_profiles.segment_memberships

Fields

The following fields are returned by SELECT queries:

get_segment_membership

Name	Datatype	Description
failures	array	An array of maps where each contains a response per profile failed for the request.
last_computed_at	string (date-time)	The timestamp indicating when the segment membership was last computed or updated.
profiles	array	An array of maps where each contains a response per profile requested.
segment_definition_name	string	The unique name of the segment definition. (pattern: <code>^[a-zA-Z0-9_-]+$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_segment_membership	select	domain_name, segment_definition_name, region		Determines if the given profiles are within a segment.

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
domain_name	string	The unique name of the domain.
region	string	AWS region (default: us-east-1)
segment_definition_name	string	The Id of the wanted segment. Needs to be a valid, and existing segment Id.

SELECT examples

get_segment_membership

Determines if the given profiles are within a segment.

SELECT
failures,
last_computed_at,
profiles,
segment_definition_name
FROM aws.customer_profiles.segment_memberships
WHERE domain_name = '{{ domain_name }}' -- required
AND segment_definition_name = '{{ segment_definition_name }}' -- required
AND region = '{{ region }}' -- required
;