integrations

Creates, updates, deletes, gets or lists an integrations resource.

Overview

Name	integrations
Type	Resource
Id	aws.customer_profiles.integrations

Fields

The following fields are returned by SELECT queries:

get_integration

Name	Datatype	Description
created_at	string (date-time)	The timestamp of when the domain was created.
domain_name	string	The unique name of the domain. (pattern: <code>^[a-zA-Z0-9_-]+$</code>)
event_trigger_names	array	A list of unique names for active event triggers associated with the integration. This list would be empty if no Event Trigger is associated with the integration.
is_unstructured	boolean	Boolean that shows if the Flow that's associated with the Integration is created in Amazon Appflow, or with ObjectTypeName equals _unstructured via API/CLI in flowDefinition.
last_updated_at	string (date-time)	The timestamp of when the domain was most recently edited.
object_type_name	string	The name of the profile object type. (pattern: <code>^[a-zA-Z_][a-zA-Z_0-9-]*$</code>)
object_type_names	object	A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an ObjectTypeName (template) used to ingest the event. It supports the following event types: SegmentIdentify, ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, ShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders.
role_arn	string	The Amazon Resource Name (ARN) of the IAM role. The Integration uses this role to make Customer Profiles requests on your behalf. (pattern: <code>arn:aws:iam:.:[0-9]+:.</code>)
scope	string	Specifies whether the integration applies to profile level data (associated with profiles) or domain level data (not associated with any specific profile). The default value is PROFILE. (PROFILE, DOMAIN)
tags	object	The tags used to organize, track, or control access for this resource.
uri	string	The URI of the S3 bucket or any other type of data source.
workflow_id	string	Unique identifier for the workflow.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_integration	select	domain_name, region		Returns an integration for a domain.
put_integration	replace	domain_name, region		Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect. An integration can belong to only one domain. To add or remove tags on an existing Integration, see TagResource / UntagResource.
delete_integration	delete	domain_name, region		Removes an integration from a specific domain.
list_integrations	exec	domain_name, region	next-token, max-results, include-hidden	Lists all of the integrations in your domain.

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)
include-hidden	boolean	Boolean to indicate if hidden integration should be returned. Defaults to False.
max-results	integer	The maximum number of objects returned per page.
next-token	string	The pagination token from the previous ListIntegrations API call.

SELECT examples

get_integration

Returns an integration for a domain.

SELECT
created_at,
domain_name,
event_trigger_names,
is_unstructured,
last_updated_at,
object_type_name,
object_type_names,
role_arn,
scope,
tags,
uri,
workflow_id
FROM aws.customer_profiles.integrations
WHERE domain_name = '{{ domain_name }}' -- required
AND region = '{{ region }}' -- required
;

REPLACE examples

put_integration

Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect. An integration can belong to only one domain. To add or remove tags on an existing Integration, see TagResource / UntagResource.

REPLACE aws.customer_profiles.integrations
SET 
Uri = '{{ Uri }}',
ObjectTypeName = '{{ ObjectTypeName }}',
ObjectTypeNames = '{{ ObjectTypeNames }}',
Tags = '{{ Tags }}',
FlowDefinition = '{{ FlowDefinition }}',
RoleArn = '{{ RoleArn }}',
EventTriggerNames = '{{ EventTriggerNames }}',
Scope = '{{ Scope }}'
WHERE 
domain_name = '{{ domain_name }}' --required
AND region = '{{ region }}' --required
RETURNING
created_at,
domain_name,
event_trigger_names,
is_unstructured,
last_updated_at,
object_type_name,
object_type_names,
role_arn,
scope,
tags,
uri,
workflow_id;

DELETE examples

delete_integration

Removes an integration from a specific domain.

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

Lifecycle Methods

list_integrations

Lists all of the integrations in your domain.

EXEC aws.customer_profiles.integrations.list_integrations 
@domain_name='{{ domain_name }}' --required, 
@region='{{ region }}' --required, 
@next-token='{{ next-token }}', 
@max-results='{{ max-results }}', 
@include-hidden={{ include-hidden }}
;