2024/12/02 - Amazon Connect Customer Profiles - 5 new4 updated api methods
Changes This release introduces Event Trigger APIs as part of Amazon Connect Customer Profiles service.
Creates an event trigger, which specifies the rules when to perform action based on customer's ingested data.
Each event stream can be associated with only one integration in the same region and AWS account as the event stream.
See also: AWS API Documentation
Request Syntax
client.create_event_trigger(
DomainName='string',
EventTriggerName='string',
ObjectTypeName='string',
Description='string',
EventTriggerConditions=[
{
'EventTriggerDimensions': [
{
'ObjectAttributes': [
{
'Source': 'string',
'FieldName': 'string',
'ComparisonOperator': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL'|'LESS_THAN_OR_EQUAL'|'EQUAL'|'BEFORE'|'AFTER'|'ON'|'BETWEEN'|'NOT_BETWEEN',
'Values': [
'string',
]
},
]
},
],
'LogicalOperator': 'ANY'|'ALL'|'NONE'
},
],
SegmentFilter='string',
EventTriggerLimits={
'EventExpiration': 123,
'Periods': [
{
'Unit': 'HOURS'|'DAYS'|'WEEKS'|'MONTHS',
'Value': 123,
'MaxInvocationsPerProfile': 123,
'Unlimited': True|False
},
]
},
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The unique name of the event trigger.
string
[REQUIRED]
The unique name of the object type.
string
The description of the event trigger.
list
[REQUIRED]
A list of conditions that determine when an event should trigger the destination.
(dict) --
Specifies the circumstances under which the event should trigger the destination.
EventTriggerDimensions (list) -- [REQUIRED]
A list of dimensions to be evaluated for the event.
(dict) --
A specific event dimension to be assessed.
ObjectAttributes (list) -- [REQUIRED]
A list of object attributes to be evaluated.
(dict) --
The criteria that a specific object attribute must meet to trigger the destination.
Source (string) --
An attribute contained within a source object.
FieldName (string) --
A field defined within an object type.
ComparisonOperator (string) -- [REQUIRED]
The operator used to compare an attribute against a list of values.
Values (list) -- [REQUIRED]
A list of attribute values used for comparison.
(string) --
LogicalOperator (string) -- [REQUIRED]
The operator used to combine multiple dimensions.
string
The destination is triggered only for profiles that meet the criteria of a segment definition.
dict
Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.
EventExpiration (integer) --
In milliseconds. Specifies that an event will only trigger the destination if it is processed within a certain latency period.
Periods (list) --
A list of time periods during which the limits apply.
(dict) --
Defines a limit and the time period during which it is enforced.
Unit (string) -- [REQUIRED]
The unit of time.
Value (integer) -- [REQUIRED]
The amount of time of the specified unit.
MaxInvocationsPerProfile (integer) --
The maximum allowed number of destination invocations per profile.
Unlimited (boolean) --
If set to true, there is no limit on the number of destination invocations per profile. The default is false.
dict
An array of key-value pairs to apply to this resource.
(string) --
(string) --
dict
Response Syntax
{
'EventTriggerName': 'string',
'ObjectTypeName': 'string',
'Description': 'string',
'EventTriggerConditions': [
{
'EventTriggerDimensions': [
{
'ObjectAttributes': [
{
'Source': 'string',
'FieldName': 'string',
'ComparisonOperator': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL'|'LESS_THAN_OR_EQUAL'|'EQUAL'|'BEFORE'|'AFTER'|'ON'|'BETWEEN'|'NOT_BETWEEN',
'Values': [
'string',
]
},
]
},
],
'LogicalOperator': 'ANY'|'ALL'|'NONE'
},
],
'SegmentFilter': 'string',
'EventTriggerLimits': {
'EventExpiration': 123,
'Periods': [
{
'Unit': 'HOURS'|'DAYS'|'WEEKS'|'MONTHS',
'Value': 123,
'MaxInvocationsPerProfile': 123,
'Unlimited': True|False
},
]
},
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
EventTriggerName (string) --
The unique name of the event trigger.
ObjectTypeName (string) --
The unique name of the object type.
Description (string) --
The description of the event trigger.
EventTriggerConditions (list) --
A list of conditions that determine when an event should trigger the destination.
(dict) --
Specifies the circumstances under which the event should trigger the destination.
EventTriggerDimensions (list) --
A list of dimensions to be evaluated for the event.
(dict) --
A specific event dimension to be assessed.
ObjectAttributes (list) --
A list of object attributes to be evaluated.
(dict) --
The criteria that a specific object attribute must meet to trigger the destination.
Source (string) --
An attribute contained within a source object.
FieldName (string) --
A field defined within an object type.
ComparisonOperator (string) --
The operator used to compare an attribute against a list of values.
Values (list) --
A list of attribute values used for comparison.
(string) --
LogicalOperator (string) --
The operator used to combine multiple dimensions.
SegmentFilter (string) --
The destination is triggered only for profiles that meet the criteria of a segment definition.
EventTriggerLimits (dict) --
Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.
EventExpiration (integer) --
In milliseconds. Specifies that an event will only trigger the destination if it is processed within a certain latency period.
Periods (list) --
A list of time periods during which the limits apply.
(dict) --
Defines a limit and the time period during which it is enforced.
Unit (string) --
The unit of time.
Value (integer) --
The amount of time of the specified unit.
MaxInvocationsPerProfile (integer) --
The maximum allowed number of destination invocations per profile.
Unlimited (boolean) --
If set to true, there is no limit on the number of destination invocations per profile. The default is false.
CreatedAt (datetime) --
The timestamp of when the event trigger was created.
LastUpdatedAt (datetime) --
The timestamp of when the event trigger was most recently updated.
Tags (dict) --
An array of key-value pairs to apply to this resource.
(string) --
(string) --
Update the properties of an Event Trigger.
See also: AWS API Documentation
Request Syntax
client.update_event_trigger(
DomainName='string',
EventTriggerName='string',
ObjectTypeName='string',
Description='string',
EventTriggerConditions=[
{
'EventTriggerDimensions': [
{
'ObjectAttributes': [
{
'Source': 'string',
'FieldName': 'string',
'ComparisonOperator': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL'|'LESS_THAN_OR_EQUAL'|'EQUAL'|'BEFORE'|'AFTER'|'ON'|'BETWEEN'|'NOT_BETWEEN',
'Values': [
'string',
]
},
]
},
],
'LogicalOperator': 'ANY'|'ALL'|'NONE'
},
],
SegmentFilter='string',
EventTriggerLimits={
'EventExpiration': 123,
'Periods': [
{
'Unit': 'HOURS'|'DAYS'|'WEEKS'|'MONTHS',
'Value': 123,
'MaxInvocationsPerProfile': 123,
'Unlimited': True|False
},
]
}
)
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The unique name of the event trigger.
string
The unique name of the object type.
string
The description of the event trigger.
list
A list of conditions that determine when an event should trigger the destination.
(dict) --
Specifies the circumstances under which the event should trigger the destination.
EventTriggerDimensions (list) -- [REQUIRED]
A list of dimensions to be evaluated for the event.
(dict) --
A specific event dimension to be assessed.
ObjectAttributes (list) -- [REQUIRED]
A list of object attributes to be evaluated.
(dict) --
The criteria that a specific object attribute must meet to trigger the destination.
Source (string) --
An attribute contained within a source object.
FieldName (string) --
A field defined within an object type.
ComparisonOperator (string) -- [REQUIRED]
The operator used to compare an attribute against a list of values.
Values (list) -- [REQUIRED]
A list of attribute values used for comparison.
(string) --
LogicalOperator (string) -- [REQUIRED]
The operator used to combine multiple dimensions.
string
The destination is triggered only for profiles that meet the criteria of a segment definition.
dict
Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.
EventExpiration (integer) --
In milliseconds. Specifies that an event will only trigger the destination if it is processed within a certain latency period.
Periods (list) --
A list of time periods during which the limits apply.
(dict) --
Defines a limit and the time period during which it is enforced.
Unit (string) -- [REQUIRED]
The unit of time.
Value (integer) -- [REQUIRED]
The amount of time of the specified unit.
MaxInvocationsPerProfile (integer) --
The maximum allowed number of destination invocations per profile.
Unlimited (boolean) --
If set to true, there is no limit on the number of destination invocations per profile. The default is false.
dict
Response Syntax
{
'EventTriggerName': 'string',
'ObjectTypeName': 'string',
'Description': 'string',
'EventTriggerConditions': [
{
'EventTriggerDimensions': [
{
'ObjectAttributes': [
{
'Source': 'string',
'FieldName': 'string',
'ComparisonOperator': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL'|'LESS_THAN_OR_EQUAL'|'EQUAL'|'BEFORE'|'AFTER'|'ON'|'BETWEEN'|'NOT_BETWEEN',
'Values': [
'string',
]
},
]
},
],
'LogicalOperator': 'ANY'|'ALL'|'NONE'
},
],
'SegmentFilter': 'string',
'EventTriggerLimits': {
'EventExpiration': 123,
'Periods': [
{
'Unit': 'HOURS'|'DAYS'|'WEEKS'|'MONTHS',
'Value': 123,
'MaxInvocationsPerProfile': 123,
'Unlimited': True|False
},
]
},
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
EventTriggerName (string) --
The unique name of the event trigger.
ObjectTypeName (string) --
The unique name of the object type.
Description (string) --
The description of the event trigger.
EventTriggerConditions (list) --
A list of conditions that determine when an event should trigger the destination.
(dict) --
Specifies the circumstances under which the event should trigger the destination.
EventTriggerDimensions (list) --
A list of dimensions to be evaluated for the event.
(dict) --
A specific event dimension to be assessed.
ObjectAttributes (list) --
A list of object attributes to be evaluated.
(dict) --
The criteria that a specific object attribute must meet to trigger the destination.
Source (string) --
An attribute contained within a source object.
FieldName (string) --
A field defined within an object type.
ComparisonOperator (string) --
The operator used to compare an attribute against a list of values.
Values (list) --
A list of attribute values used for comparison.
(string) --
LogicalOperator (string) --
The operator used to combine multiple dimensions.
SegmentFilter (string) --
The destination is triggered only for profiles that meet the criteria of a segment definition.
EventTriggerLimits (dict) --
Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.
EventExpiration (integer) --
In milliseconds. Specifies that an event will only trigger the destination if it is processed within a certain latency period.
Periods (list) --
A list of time periods during which the limits apply.
(dict) --
Defines a limit and the time period during which it is enforced.
Unit (string) --
The unit of time.
Value (integer) --
The amount of time of the specified unit.
MaxInvocationsPerProfile (integer) --
The maximum allowed number of destination invocations per profile.
Unlimited (boolean) --
If set to true, there is no limit on the number of destination invocations per profile. The default is false.
CreatedAt (datetime) --
The timestamp of when the event trigger was created.
LastUpdatedAt (datetime) --
The timestamp of when the event trigger was most recently updated.
Tags (dict) --
An array of key-value pairs to apply to this resource.
(string) --
(string) --
Disable and deletes the Event Trigger.
See also: AWS API Documentation
Request Syntax
client.delete_event_trigger(
DomainName='string',
EventTriggerName='string'
)
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The unique name of the event trigger.
dict
Response Syntax
{
'Message': 'string'
}
Response Structure
(dict) --
Message (string) --
A message that indicates the delete request is done.
Get a specific Event Trigger from the domain.
See also: AWS API Documentation
Request Syntax
client.get_event_trigger(
DomainName='string',
EventTriggerName='string'
)
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The unique name of the event trigger.
dict
Response Syntax
{
'EventTriggerName': 'string',
'ObjectTypeName': 'string',
'Description': 'string',
'EventTriggerConditions': [
{
'EventTriggerDimensions': [
{
'ObjectAttributes': [
{
'Source': 'string',
'FieldName': 'string',
'ComparisonOperator': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL'|'LESS_THAN_OR_EQUAL'|'EQUAL'|'BEFORE'|'AFTER'|'ON'|'BETWEEN'|'NOT_BETWEEN',
'Values': [
'string',
]
},
]
},
],
'LogicalOperator': 'ANY'|'ALL'|'NONE'
},
],
'SegmentFilter': 'string',
'EventTriggerLimits': {
'EventExpiration': 123,
'Periods': [
{
'Unit': 'HOURS'|'DAYS'|'WEEKS'|'MONTHS',
'Value': 123,
'MaxInvocationsPerProfile': 123,
'Unlimited': True|False
},
]
},
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
EventTriggerName (string) --
The unique name of the event trigger.
ObjectTypeName (string) --
The unique name of the object type.
Description (string) --
The description of the event trigger.
EventTriggerConditions (list) --
A list of conditions that determine when an event should trigger the destination.
(dict) --
Specifies the circumstances under which the event should trigger the destination.
EventTriggerDimensions (list) --
A list of dimensions to be evaluated for the event.
(dict) --
A specific event dimension to be assessed.
ObjectAttributes (list) --
A list of object attributes to be evaluated.
(dict) --
The criteria that a specific object attribute must meet to trigger the destination.
Source (string) --
An attribute contained within a source object.
FieldName (string) --
A field defined within an object type.
ComparisonOperator (string) --
The operator used to compare an attribute against a list of values.
Values (list) --
A list of attribute values used for comparison.
(string) --
LogicalOperator (string) --
The operator used to combine multiple dimensions.
SegmentFilter (string) --
The destination is triggered only for profiles that meet the criteria of a segment definition.
EventTriggerLimits (dict) --
Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.
EventExpiration (integer) --
In milliseconds. Specifies that an event will only trigger the destination if it is processed within a certain latency period.
Periods (list) --
A list of time periods during which the limits apply.
(dict) --
Defines a limit and the time period during which it is enforced.
Unit (string) --
The unit of time.
Value (integer) --
The amount of time of the specified unit.
MaxInvocationsPerProfile (integer) --
The maximum allowed number of destination invocations per profile.
Unlimited (boolean) --
If set to true, there is no limit on the number of destination invocations per profile. The default is false.
CreatedAt (datetime) --
The timestamp of when the event trigger was created.
LastUpdatedAt (datetime) --
The timestamp of when the event trigger was most recently updated.
Tags (dict) --
An array of key-value pairs to apply to this resource.
(string) --
(string) --
List all Event Triggers under a domain.
See also: AWS API Documentation
Request Syntax
client.list_event_triggers(
DomainName='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The unique name of the domain.
string
The pagination token to use with ListEventTriggers.
integer
The maximum number of results to return per page.
dict
Response Syntax
{
'Items': [
{
'ObjectTypeName': 'string',
'EventTriggerName': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of Event Triggers.
(dict) --
The summary of the event trigger.
ObjectTypeName (string) --
The unique name of the object type.
EventTriggerName (string) --
The unique name of the event trigger.
Description (string) --
The description of the event trigger.
CreatedAt (datetime) --
The timestamp of when the event trigger was created.
LastUpdatedAt (datetime) --
The timestamp of when the event trigger was most recently updated.
Tags (dict) --
An array of key-value pairs to apply to this resource.
(string) --
(string) --
NextToken (string) --
The pagination token from the previous call to ListEventTriggers.
{'EventTriggerNames': ['string']}
Returns an integration for a domain.
See also: AWS API Documentation
Request Syntax
client.get_integration(
DomainName='string',
Uri='string'
)
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The URI of the S3 bucket or any other type of data source.
dict
Response Syntax
{
'DomainName': 'string',
'Uri': 'string',
'ObjectTypeName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
},
'ObjectTypeNames': {
'string': 'string'
},
'WorkflowId': 'string',
'IsUnstructured': True|False,
'RoleArn': 'string',
'EventTriggerNames': [
'string',
]
}
Response Structure
(dict) --
DomainName (string) --
The unique name of the domain.
Uri (string) --
The URI of the S3 bucket or any other type of data source.
ObjectTypeName (string) --
The name of the profile object type.
CreatedAt (datetime) --
The timestamp of when the domain was created.
LastUpdatedAt (datetime) --
The timestamp of when the domain was most recently edited.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
ObjectTypeNames (dict) --
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.
(string) --
(string) --
WorkflowId (string) --
Unique identifier for the workflow.
IsUnstructured (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.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role. The Integration uses this role to make Customer Profiles requests on your behalf.
EventTriggerNames (list) --
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.
(string) --
{'Items': {'EventTriggerNames': ['string']}}
Lists all of the integrations associated to a specific URI in the AWS account.
See also: AWS API Documentation
Request Syntax
client.list_account_integrations(
Uri='string',
NextToken='string',
MaxResults=123,
IncludeHidden=True|False
)
string
[REQUIRED]
The URI of the S3 bucket or any other type of data source.
string
The pagination token from the previous ListAccountIntegrations API call.
integer
The maximum number of objects returned per page.
boolean
Boolean to indicate if hidden integration should be returned. Defaults to False.
dict
Response Syntax
{
'Items': [
{
'DomainName': 'string',
'Uri': 'string',
'ObjectTypeName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
},
'ObjectTypeNames': {
'string': 'string'
},
'WorkflowId': 'string',
'IsUnstructured': True|False,
'RoleArn': 'string',
'EventTriggerNames': [
'string',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of ListAccountIntegration instances.
(dict) --
An integration in list of integrations.
DomainName (string) --
The unique name of the domain.
Uri (string) --
The URI of the S3 bucket or any other type of data source.
ObjectTypeName (string) --
The name of the profile object type.
CreatedAt (datetime) --
The timestamp of when the domain was created.
LastUpdatedAt (datetime) --
The timestamp of when the domain was most recently edited.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
ObjectTypeNames (dict) --
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.
(string) --
(string) --
WorkflowId (string) --
Unique identifier for the workflow.
IsUnstructured (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.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role. The Integration uses this role to make Customer Profiles requests on your behalf.
EventTriggerNames (list) --
A list of unique names for active event triggers associated with the integration.
(string) --
NextToken (string) --
The pagination token from the previous ListAccountIntegrations API call.
{'Items': {'EventTriggerNames': ['string']}}
Lists all of the integrations in your domain.
See also: AWS API Documentation
Request Syntax
client.list_integrations(
DomainName='string',
NextToken='string',
MaxResults=123,
IncludeHidden=True|False
)
string
[REQUIRED]
The unique name of the domain.
string
The pagination token from the previous ListIntegrations API call.
integer
The maximum number of objects returned per page.
boolean
Boolean to indicate if hidden integration should be returned. Defaults to False.
dict
Response Syntax
{
'Items': [
{
'DomainName': 'string',
'Uri': 'string',
'ObjectTypeName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
},
'ObjectTypeNames': {
'string': 'string'
},
'WorkflowId': 'string',
'IsUnstructured': True|False,
'RoleArn': 'string',
'EventTriggerNames': [
'string',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of ListIntegrations instances.
(dict) --
An integration in list of integrations.
DomainName (string) --
The unique name of the domain.
Uri (string) --
The URI of the S3 bucket or any other type of data source.
ObjectTypeName (string) --
The name of the profile object type.
CreatedAt (datetime) --
The timestamp of when the domain was created.
LastUpdatedAt (datetime) --
The timestamp of when the domain was most recently edited.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
ObjectTypeNames (dict) --
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.
(string) --
(string) --
WorkflowId (string) --
Unique identifier for the workflow.
IsUnstructured (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.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role. The Integration uses this role to make Customer Profiles requests on your behalf.
EventTriggerNames (list) --
A list of unique names for active event triggers associated with the integration.
(string) --
NextToken (string) --
The pagination token from the previous ListIntegrations API call.
{'EventTriggerNames': ['string']}
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.
See also: AWS API Documentation
Request Syntax
client.put_integration(
DomainName='string',
Uri='string',
ObjectTypeName='string',
Tags={
'string': 'string'
},
FlowDefinition={
'Description': 'string',
'FlowName': 'string',
'KmsArn': 'string',
'SourceFlowConfig': {
'ConnectorProfileName': 'string',
'ConnectorType': 'Salesforce'|'Marketo'|'Zendesk'|'Servicenow'|'S3',
'IncrementalPullConfig': {
'DatetimeTypeFieldName': 'string'
},
'SourceConnectorProperties': {
'Marketo': {
'Object': 'string'
},
'S3': {
'BucketName': 'string',
'BucketPrefix': 'string'
},
'Salesforce': {
'Object': 'string',
'EnableDynamicFieldUpdate': True|False,
'IncludeDeletedRecords': True|False
},
'ServiceNow': {
'Object': 'string'
},
'Zendesk': {
'Object': 'string'
}
}
},
'Tasks': [
{
'ConnectorOperator': {
'Marketo': 'PROJECTION'|'LESS_THAN'|'GREATER_THAN'|'BETWEEN'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
'S3': 'PROJECTION'|'LESS_THAN'|'GREATER_THAN'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
'Salesforce': 'PROJECTION'|'LESS_THAN'|'CONTAINS'|'GREATER_THAN'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
'ServiceNow': 'PROJECTION'|'CONTAINS'|'LESS_THAN'|'GREATER_THAN'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
'Zendesk': 'PROJECTION'|'GREATER_THAN'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP'
},
'DestinationField': 'string',
'SourceFields': [
'string',
],
'TaskProperties': {
'string': 'string'
},
'TaskType': 'Arithmetic'|'Filter'|'Map'|'Mask'|'Merge'|'Truncate'|'Validate'
},
],
'TriggerConfig': {
'TriggerType': 'Scheduled'|'Event'|'OnDemand',
'TriggerProperties': {
'Scheduled': {
'ScheduleExpression': 'string',
'DataPullMode': 'Incremental'|'Complete',
'ScheduleStartTime': datetime(2015, 1, 1),
'ScheduleEndTime': datetime(2015, 1, 1),
'Timezone': 'string',
'ScheduleOffset': 123,
'FirstExecutionFrom': datetime(2015, 1, 1)
}
}
}
},
ObjectTypeNames={
'string': 'string'
},
RoleArn='string',
EventTriggerNames=[
'string',
]
)
string
[REQUIRED]
The unique name of the domain.
string
The URI of the S3 bucket or any other type of data source.
string
The name of the profile object type.
dict
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
dict
The configuration that controls how Customer Profiles retrieves data from the source.
Description (string) --
A description of the flow you want to create.
FlowName (string) -- [REQUIRED]
The specified name of the flow. Use underscores (_) or hyphens (-) only. Spaces are not allowed.
KmsArn (string) -- [REQUIRED]
The Amazon Resource Name of the AWS Key Management Service (KMS) key you provide for encryption.
SourceFlowConfig (dict) -- [REQUIRED]
The configuration that controls how Customer Profiles retrieves data from the source.
ConnectorProfileName (string) --
The name of the AppFlow connector profile. This name must be unique for each connector profile in the AWS account.
ConnectorType (string) -- [REQUIRED]
The type of connector, such as Salesforce, Marketo, and so on.
IncrementalPullConfig (dict) --
Defines the configuration for a scheduled incremental data pull. If a valid configuration is provided, the fields specified in the configuration are used when querying for the incremental data pull.
DatetimeTypeFieldName (string) --
A field that specifies the date time or timestamp field as the criteria to use when importing incremental records from the source.
SourceConnectorProperties (dict) -- [REQUIRED]
Specifies the information that is required to query a particular source connector.
Marketo (dict) --
The properties that are applied when Marketo is being used as a source.
Object (string) -- [REQUIRED]
The object specified in the Marketo flow source.
S3 (dict) --
The properties that are applied when Amazon S3 is being used as the flow source.
BucketName (string) -- [REQUIRED]
The Amazon S3 bucket name where the source files are stored.
BucketPrefix (string) --
The object key for the Amazon S3 bucket in which the source files are stored.
Salesforce (dict) --
The properties that are applied when Salesforce is being used as a source.
Object (string) -- [REQUIRED]
The object specified in the Salesforce flow source.
EnableDynamicFieldUpdate (boolean) --
The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow.
IncludeDeletedRecords (boolean) --
Indicates whether Amazon AppFlow includes deleted files in the flow run.
ServiceNow (dict) --
The properties that are applied when ServiceNow is being used as a source.
Object (string) -- [REQUIRED]
The object specified in the ServiceNow flow source.
Zendesk (dict) --
The properties that are applied when using Zendesk as a flow source.
Object (string) -- [REQUIRED]
The object specified in the Zendesk flow source.
Tasks (list) -- [REQUIRED]
A list of tasks that Customer Profiles performs while transferring the data in the flow run.
(dict) --
A class for modeling different type of tasks. Task implementation varies based on the TaskType.
ConnectorOperator (dict) --
The operation to be performed on the provided source fields.
Marketo (string) --
The operation to be performed on the provided Marketo source fields.
S3 (string) --
The operation to be performed on the provided Amazon S3 source fields.
Salesforce (string) --
The operation to be performed on the provided Salesforce source fields.
ServiceNow (string) --
The operation to be performed on the provided ServiceNow source fields.
Zendesk (string) --
The operation to be performed on the provided Zendesk source fields.
DestinationField (string) --
A field in a destination connector, or a field value against which Amazon AppFlow validates a source field.
SourceFields (list) -- [REQUIRED]
The source fields to which a particular task is applied.
(string) --
TaskProperties (dict) --
A map used to store task-related information. The service looks for particular information based on the TaskType.
(string) --
(string) --
TaskType (string) -- [REQUIRED]
Specifies the particular task implementation that Amazon AppFlow performs.
TriggerConfig (dict) -- [REQUIRED]
The trigger settings that determine how and when the flow runs.
TriggerType (string) -- [REQUIRED]
Specifies the type of flow trigger. It can be OnDemand, Scheduled, or Event.
TriggerProperties (dict) --
Specifies the configuration details of a schedule-triggered flow that you define. Currently, these settings only apply to the Scheduled trigger type.
Scheduled (dict) --
Specifies the configuration details of a schedule-triggered flow that you define.
ScheduleExpression (string) -- [REQUIRED]
The scheduling expression that determines the rate at which the schedule will run, for example rate (5 minutes).
DataPullMode (string) --
Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.
ScheduleStartTime (datetime) --
Specifies the scheduled start time for a scheduled-trigger flow.
ScheduleEndTime (datetime) --
Specifies the scheduled end time for a scheduled-trigger flow.
Timezone (string) --
Specifies the time zone used when referring to the date and time of a scheduled-triggered flow, such as America/New_York.
ScheduleOffset (integer) --
Specifies the optional offset that is added to the time interval for a schedule-triggered flow.
FirstExecutionFrom (datetime) --
Specifies the date range for the records to import from the connector in the first flow run.
dict
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.
(string) --
(string) --
string
The Amazon Resource Name (ARN) of the IAM role. The Integration uses this role to make Customer Profiles requests on your behalf.
list
A list of unique names for active event triggers associated with the integration.
(string) --
dict
Response Syntax
{
'DomainName': 'string',
'Uri': 'string',
'ObjectTypeName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
},
'ObjectTypeNames': {
'string': 'string'
},
'WorkflowId': 'string',
'IsUnstructured': True|False,
'RoleArn': 'string',
'EventTriggerNames': [
'string',
]
}
Response Structure
(dict) --
DomainName (string) --
The unique name of the domain.
Uri (string) --
The URI of the S3 bucket or any other type of data source.
ObjectTypeName (string) --
The name of the profile object type.
CreatedAt (datetime) --
The timestamp of when the domain was created.
LastUpdatedAt (datetime) --
The timestamp of when the domain was most recently edited.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
ObjectTypeNames (dict) --
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.
(string) --
(string) --
WorkflowId (string) --
Unique identifier for the workflow.
IsUnstructured (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.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role. The Integration uses this role to make Customer Profiles requests on your behalf.
EventTriggerNames (list) --
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.
(string) --