2026/05/28 - Amazon Connect Customer Profiles - 1 new 3 updated api methods
Changes BatchPutProfileObject API adds multiple profile objects to a domain of a given ObjectType in a single API call.
Adds multiple profile objects to a domain of a given ObjectType in a single API call.
When adding a specific profile object, like a Contact Record, an inferred profile can get created if it is not mapped to an existing profile. The resulting profile will only have a phone number populated in the standard ProfileObject. Any additional Contact Records with the same phone number will be mapped to the same inferred profile.
When a ProfileObject is created and if a ProfileObjectType already exists for the ProfileObject, it will provide data to a standard profile depending on the ProfileObjectType definition.
BatchPutProfileObject needs an ObjectType, which can be created using PutProfileObjectType.
See also: AWS API Documentation
Request Syntax
client.batch_put_profile_object(
DomainName='string',
ObjectTypeName='string',
Items=[
{
'Id': 'string',
'Object': 'string'
},
]
)
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The name of the profile object type.
list
[REQUIRED]
A list of items to add to the domain.
(dict) --
An item to add to the domain as part of a batch request.
Id (string) -- [REQUIRED]
A unique identifier for this item in the batch request. Used to correlate items in the response.
Object (string) -- [REQUIRED]
A string that is serialized from a JSON object.
dict
Response Syntax
{
'Successful': [
{
'Id': 'string',
'ProfileObjectUniqueKey': 'string'
},
],
'Failed': [
{
'Id': 'string',
'Code': 123,
'Message': 'string'
},
]
}
Response Structure
(dict) --
Successful (list) --
A list of items that were successfully added to the domain.
(dict) --
An item that was successfully added to the domain.
Id (string) --
The unique identifier of the item in the batch request.
ProfileObjectUniqueKey (string) --
The unique identifier of the profile object generated by the service.
Failed (list) --
A list of items that failed to be added to the domain.
(dict) --
An item that failed to be added to the domain.
Id (string) --
The unique identifier of the item in the batch request that failed.
Code (integer) --
The HTTP status code for the error.
Message (string) --
A message describing the error.
{'EventTriggerLimits': {'Periods': {'Unit': {'MINUTES'}}}}
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': 'MINUTES'|'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': 'MINUTES'|'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) --
{'EventTriggerLimits': {'Periods': {'Unit': {'MINUTES'}}}}
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': 'MINUTES'|'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) --
{'EventTriggerLimits': {'Periods': {'Unit': {'MINUTES'}}}}
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': 'MINUTES'|'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': 'MINUTES'|'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) --