profile_object_type_templates

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

Overview

Name	profile_object_type_templates
Type	Resource
Id	aws.customer_profiles.profile_object_type_templates

Fields

The following fields are returned by SELECT queries:

get_profile_object_type_template

Name	Datatype	Description
allow_profile_creation	boolean	Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE, and if no match is found, then the service creates a new standard profile.
fields	object	A map of the name and ObjectType field.
keys	object	A list of unique keys that can be used to map data to the profile.
source_last_updated_timestamp_format	string	The format of your sourceLastUpdatedTimestamp that was previously set up.
source_name	string	The name of the source of the object template. (pattern: <code>^[a-zA-Z0-9_-]+$</code>)
source_object	string	The source of the object template. (pattern: <code>^[a-zA-Z0-9_-]+$</code>)
template_id	string	A unique identifier for the object template. (pattern: <code>^[a-zA-Z0-9_-]+$</code>)

list_profile_object_type_templates

Name	Datatype	Description
items	array	The list of ListProfileObjectType template instances.
next_token	string	The pagination token from the previous ListObjectTypeTemplates API call.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_profile_object_type_template	select	template_id, region		Returns the template information for a specific object type. A template is a predefined ProfileObjectType, such as “Salesforce-Account” or “Salesforce-Contact.” When a user sends a ProfileObject, using the PutProfileObject API, with an ObjectTypeName that matches one of the TemplateIds, it uses the mappings from the template.
list_profile_object_type_templates	select	region	next-token, max-results	Lists all of the template information for object types.

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
region	string	AWS region (default: us-east-1)
template_id	string	A unique identifier for the object template.
max-results	integer	The maximum number of objects returned per page.
next-token	string	The pagination token from the previous ListObjectTypeTemplates API call.

SELECT examples

get_profile_object_type_template

Returns the template information for a specific object type. A template is a predefined ProfileObjectType, such as “Salesforce-Account” or “Salesforce-Contact.” When a user sends a ProfileObject, using the PutProfileObject API, with an ObjectTypeName that matches one of the TemplateIds, it uses the mappings from the template.

SELECT
allow_profile_creation,
fields,
keys,
source_last_updated_timestamp_format,
source_name,
source_object,
template_id
FROM aws.customer_profiles.profile_object_type_templates
WHERE template_id = '{{ template_id }}' -- required
AND region = '{{ region }}' -- required
;

list_profile_object_type_templates

Lists all of the template information for object types.

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