profile_objects

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

Overview

Name	profile_objects
Type	Resource
Id	aws.customer_profiles.profile_objects

Fields

The following fields are returned by SELECT queries:

list_profile_objects

Name	Datatype	Description
items	array	The list of ListProfileObject instances.
next_token	string	The pagination token from the previous call to ListProfileObjects.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_profile_objects	select	domain_name, region	next-token, max-results	Returns a list of objects associated with a profile of a given ProfileObjectType.
put_profile_object	replace	domain_name, region, ObjectTypeName, Object		Adds additional objects to customer profiles of a given ObjectType. When adding a specific profile object, like a Contact Record, an inferred profile can get created if it is not mapped to an existing profile. The resulting profile will only have a phone number populated in the standard ProfileObject. Any additional Contact Records with the same phone number will be mapped to the same inferred profile. When a ProfileObject is created and if a ProfileObjectType already exists for the ProfileObject, it will provide data to a standard profile depending on the ProfileObjectType definition. PutProfileObject needs an ObjectType, which can be created using PutProfileObjectType.
delete_profile_object	delete	domain_name, region		Removes an object associated with a profile of a given ProfileObjectType.

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)
max-results	integer	The maximum number of objects returned per page.
next-token	string	The pagination token from the previous call to ListProfileObjects.

SELECT examples

list_profile_objects

Returns a list of objects associated with a profile of a given ProfileObjectType.

SELECT
items,
next_token
FROM aws.customer_profiles.profile_objects
WHERE domain_name = '{{ domain_name }}' -- required
AND region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `max-results` = '{{ max-results }}'
;

REPLACE examples

put_profile_object

Adds additional objects to customer profiles of a given ObjectType. When adding a specific profile object, like a Contact Record, an inferred profile can get created if it is not mapped to an existing profile. The resulting profile will only have a phone number populated in the standard ProfileObject. Any additional Contact Records with the same phone number will be mapped to the same inferred profile. When a ProfileObject is created and if a ProfileObjectType already exists for the ProfileObject, it will provide data to a standard profile depending on the ProfileObjectType definition. PutProfileObject needs an ObjectType, which can be created using PutProfileObjectType.

REPLACE aws.customer_profiles.profile_objects
SET 
ObjectTypeName = '{{ ObjectTypeName }}',
Object = '{{ Object }}'
WHERE 
domain_name = '{{ domain_name }}' --required
AND region = '{{ region }}' --required
AND ObjectTypeName = '{{ ObjectTypeName }}' --required
AND Object = '{{ Object }}' --required
RETURNING
profile_object_unique_key;

DELETE examples

delete_profile_object

Removes an object associated with a profile of a given ProfileObjectType.

DELETE FROM aws.customer_profiles.profile_objects
WHERE domain_name = '{{ domain_name }}' --required
AND region = '{{ region }}' --required
;