CustomerProfiles / Client / create_event_trigger

create_event_trigger#

CustomerProfiles.Client.create_event_trigger(**kwargs)#

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.

Request Syntax

response = 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'
    }
)

Parameters:

DomainName (string) –
[REQUIRED]

The unique name of the domain.
EventTriggerName (string) –
[REQUIRED]

The unique name of the event trigger.
ObjectTypeName (string) –
[REQUIRED]

The unique name of the object type.
Description (string) – The description of the event trigger.
EventTriggerConditions (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.
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) – [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.
Tags (dict) –
An array of key-value pairs to apply to this resource.
- (string) –
  - (string) –

Return type:

dict

Returns:

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) –

Exceptions

CustomerProfiles.Client.exceptions.BadRequestException
CustomerProfiles.Client.exceptions.ResourceNotFoundException
CustomerProfiles.Client.exceptions.AccessDeniedException
CustomerProfiles.Client.exceptions.ThrottlingException
CustomerProfiles.Client.exceptions.InternalServerException