Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateEventTrigger

Update the properties of an Event Trigger.

Request Syntax


PUT /domains/DomainName/event-triggers/EventTriggerName HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "EventTriggerConditions": [ 
      { 
         "EventTriggerDimensions": [ 
            { 
               "ObjectAttributes": [ 
                  { 
                     "ComparisonOperator": "string",
                     "FieldName": "string",
                     "Source": "string",
                     "Values": [ "string" ]
                  }
               ]
            }
         ],
         "LogicalOperator": "string"
      }
   ],
   "EventTriggerLimits": { 
      "EventExpiration": number,
      "Periods": [ 
         { 
            "MaxInvocationsPerProfile": number,
            "Unit": "string",
            "Unlimited": boolean,
            "Value": number
         }
      ]
   },
   "ObjectTypeName": "string",
   "SegmentFilter": "string"
}

URI Request Parameters

The request uses the following URI parameters.

DomainName

The unique name of the domain.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

EventTriggerName

The unique name of the event trigger.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

Request Body

The request accepts the following data in JSON format.

Description

The description of the event trigger.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Required: No

EventTriggerConditions

A list of conditions that determine when an event should trigger the destination.

Type: Array of EventTriggerCondition objects

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Required: No

EventTriggerLimits

Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.

Type: EventTriggerLimits object

Required: No

ObjectTypeName

The unique name of the object type.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z_][a-zA-Z_0-9-]*$

Required: No

SegmentFilter

The destination is triggered only for profiles that meet the criteria of a segment definition.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "CreatedAt": number,
   "Description": "string",
   "EventTriggerConditions": [ 
      { 
         "EventTriggerDimensions": [ 
            { 
               "ObjectAttributes": [ 
                  { 
                     "ComparisonOperator": "string",
                     "FieldName": "string",
                     "Source": "string",
                     "Values": [ "string" ]
                  }
               ]
            }
         ],
         "LogicalOperator": "string"
      }
   ],
   "EventTriggerLimits": { 
      "EventExpiration": number,
      "Periods": [ 
         { 
            "MaxInvocationsPerProfile": number,
            "Unit": "string",
            "Unlimited": boolean,
            "Value": number
         }
      ]
   },
   "EventTriggerName": "string",
   "LastUpdatedAt": number,
   "ObjectTypeName": "string",
   "SegmentFilter": "string",
   "Tags": { 
      "string" : "string" 
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CreatedAt

The timestamp of when the event trigger was created.

Type: Timestamp

Description

The description of the event trigger.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

EventTriggerConditions

A list of conditions that determine when an event should trigger the destination.

Type: Array of EventTriggerCondition objects

Array Members: Minimum number of 1 item. Maximum number of 5 items.

EventTriggerLimits

Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.

Type: EventTriggerLimits object

EventTriggerName

The unique name of the event trigger.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

LastUpdatedAt

The timestamp of when the event trigger was most recently updated.

Type: Timestamp

ObjectTypeName

The unique name of the object type.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z_][a-zA-Z_0-9-]*$

SegmentFilter

The destination is triggered only for profiles that meet the criteria of a segment definition.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

Tags

An array of key-value pairs to apply to this resource.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

InternalServerException

An internal service error occurred.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource does not exist, or access was denied.

HTTP Status Code: 404

ThrottlingException

You exceeded the maximum number of requests.

HTTP Status Code: 429