2025/12/01 - Amazon Connect Customer Profiles - 15 new12 updated api methods
Changes This release introduces, CRUD APIs for the DomainObjectType and Recommender resources, APIs to offer statistical insights on Object Type Attributes, Changes to SegmentDefinition APIs to support SQL queries to create Segments, and Changes to Domain APIs to support Data Store.
Updates the properties of an existing recommender, allowing you to modify its configuration and description.
See also: AWS API Documentation
Request Syntax
client.update_recommender(
DomainName='string',
RecommenderName='string',
Description='string',
RecommenderConfig={
'EventsConfig': {
'EventParametersList': [
{
'EventType': 'string',
'EventValueThreshold': 123.0
},
]
},
'TrainingFrequency': 123
}
)
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The name of the recommender to update.
string
The new description to assign to the recommender.
dict
The new configuration settings to apply to the recommender, including updated parameters and settings that define its behavior.
EventsConfig (dict) -- [REQUIRED]
Configuration settings for how the recommender processes and uses events.
EventParametersList (list) -- [REQUIRED]
A list of event parameters configurations that specify how different event types should be handled.
(dict) --
Configuration parameters for events in the personalization system.
EventType (string) -- [REQUIRED]
The type of event being tracked (e.g., 'click', 'purchase', 'view').
EventValueThreshold (float) --
The minimum value threshold that an event must meet to be considered valid.
TrainingFrequency (integer) --
How often the recommender should retrain its model with new data.
dict
Response Syntax
{
'RecommenderName': 'string'
}
Response Structure
(dict) --
RecommenderName (string) --
The name of the recommender that was updated.
Creates a recommender
See also: AWS API Documentation
Request Syntax
client.create_recommender(
DomainName='string',
RecommenderName='string',
RecommenderRecipeName='recommended-for-you'|'similar-items'|'frequently-paired-items'|'popular-items'|'trending-now',
RecommenderConfig={
'EventsConfig': {
'EventParametersList': [
{
'EventType': 'string',
'EventValueThreshold': 123.0
},
]
},
'TrainingFrequency': 123
},
Description='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The name of the recommender.
string
[REQUIRED]
The name of the recommeder recipe.
dict
The recommender configuration.
EventsConfig (dict) -- [REQUIRED]
Configuration settings for how the recommender processes and uses events.
EventParametersList (list) -- [REQUIRED]
A list of event parameters configurations that specify how different event types should be handled.
(dict) --
Configuration parameters for events in the personalization system.
EventType (string) -- [REQUIRED]
The type of event being tracked (e.g., 'click', 'purchase', 'view').
EventValueThreshold (float) --
The minimum value threshold that an event must meet to be considered valid.
TrainingFrequency (integer) --
How often the recommender should retrain its model with new data.
string
The description of the domain object type.
dict
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
dict
Response Syntax
{
'RecommenderArn': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
RecommenderArn (string) --
The ARN of the recommender
Tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
Returns a list of recommenders in the specified domain.
See also: AWS API Documentation
Request Syntax
client.list_recommenders(
DomainName='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The unique name of the domain.
integer
The maximum number of recommenders to return in the response. The default value is 100.
string
A token received from a previous ListRecommenders call to retrieve the next page of results.
dict
Response Syntax
{
'NextToken': 'string',
'Recommenders': [
{
'RecommenderName': 'string',
'RecipeName': 'recommended-for-you'|'similar-items'|'frequently-paired-items'|'popular-items'|'trending-now',
'RecommenderConfig': {
'EventsConfig': {
'EventParametersList': [
{
'EventType': 'string',
'EventValueThreshold': 123.0
},
]
},
'TrainingFrequency': 123
},
'CreatedAt': datetime(2015, 1, 1),
'Description': 'string',
'Status': 'PENDING'|'IN_PROGRESS'|'ACTIVE'|'FAILED'|'STOPPING'|'INACTIVE'|'STARTING'|'DELETING',
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
},
'FailureReason': 'string',
'LatestRecommenderUpdate': {
'RecommenderConfig': {
'EventsConfig': {
'EventParametersList': [
{
'EventType': 'string',
'EventValueThreshold': 123.0
},
]
},
'TrainingFrequency': 123
},
'Status': 'PENDING'|'IN_PROGRESS'|'ACTIVE'|'FAILED'|'STOPPING'|'INACTIVE'|'STARTING'|'DELETING',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'FailureReason': 'string'
}
},
]
}
Response Structure
(dict) --
NextToken (string) --
A token to retrieve the next page of results. Null if there are no more results to retrieve.
Recommenders (list) --
A list of recommenders and their properties in the specified domain.
(dict) --
Provides a summary of a recommender's configuration and current state.
RecommenderName (string) --
The name of the recommender.
RecipeName (string) --
The name of the recipe used by this recommender.
RecommenderConfig (dict) --
The configuration settings applied to this recommender.
EventsConfig (dict) --
Configuration settings for how the recommender processes and uses events.
EventParametersList (list) --
A list of event parameters configurations that specify how different event types should be handled.
(dict) --
Configuration parameters for events in the personalization system.
EventType (string) --
The type of event being tracked (e.g., 'click', 'purchase', 'view').
EventValueThreshold (float) --
The minimum value threshold that an event must meet to be considered valid.
TrainingFrequency (integer) --
How often the recommender should retrain its model with new data.
CreatedAt (datetime) --
The timestamp when the recommender was created.
Description (string) --
A description of the recommender's purpose and characteristics.
Status (string) --
The current operational status of the recommender.
LastUpdatedAt (datetime) --
The timestamp of when the recommender was edited.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
FailureReason (string) --
If the recommender is in a failed state, provides the reason for the failure.
LatestRecommenderUpdate (dict) --
Information about the most recent update performed on the recommender, including its status and timing.
RecommenderConfig (dict) --
The updated configuration settings applied to the recommender during this update.
EventsConfig (dict) --
Configuration settings for how the recommender processes and uses events.
EventParametersList (list) --
A list of event parameters configurations that specify how different event types should be handled.
(dict) --
Configuration parameters for events in the personalization system.
EventType (string) --
The type of event being tracked (e.g., 'click', 'purchase', 'view').
EventValueThreshold (float) --
The minimum value threshold that an event must meet to be considered valid.
TrainingFrequency (integer) --
How often the recommender should retrain its model with new data.
Status (string) --
The current status of the recommender update operation.
CreatedAt (datetime) --
The timestamp when this recommender update was initiated.
LastUpdatedAt (datetime) --
The timestamp of when the recommender was edited.
FailureReason (string) --
If the update operation failed, provides the reason for the failure.
Return a DomainObjectType for the input Domain and ObjectType names.
See also: AWS API Documentation
Request Syntax
client.get_domain_object_type(
DomainName='string',
ObjectTypeName='string'
)
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The unique name of the domain object type.
dict
Response Syntax
{
'ObjectTypeName': 'string',
'Description': 'string',
'EncryptionKey': 'string',
'Fields': {
'string': {
'Source': 'string',
'Target': 'string',
'ContentType': 'STRING'|'NUMBER',
'FeatureType': 'TEXTUAL'|'CATEGORICAL'
}
},
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
ObjectTypeName (string) --
The unique name of the domain object type.
Description (string) --
The description of the domain object type.
EncryptionKey (string) --
The customer provided KMS key used to encrypt this type of domain object.
Fields (dict) --
A map of field names to their corresponding domain object type field definitions.
(string) --
(dict) --
The standard domain object type.
Source (string) --
The expression that defines how to extract the field value from the source object.>
Target (string) --
The expression that defines where the field value should be placed in the standard domain object.
ContentType (string) --
The content type of the field.
FeatureType (string) --
The semantic meaning of the field.
CreatedAt (datetime) --
The timestamp of when the domain object type was created.
LastUpdatedAt (datetime) --
The timestamp of when the domain object type was most recently edited.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
Stops a recommender, suspending its ability to generate recommendations. The recommender can be restarted later using StartRecommender.
See also: AWS API Documentation
Request Syntax
client.stop_recommender(
DomainName='string',
RecommenderName='string'
)
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The name of the recommender to stop.
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves a recommender.
See also: AWS API Documentation
Request Syntax
client.get_recommender(
DomainName='string',
RecommenderName='string',
TrainingMetricsCount=123
)
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The name of the recommender.
integer
The number of training metrics to retrieve for the recommender.
dict
Response Syntax
{
'RecommenderName': 'string',
'RecommenderRecipeName': 'recommended-for-you'|'similar-items'|'frequently-paired-items'|'popular-items'|'trending-now',
'RecommenderConfig': {
'EventsConfig': {
'EventParametersList': [
{
'EventType': 'string',
'EventValueThreshold': 123.0
},
]
},
'TrainingFrequency': 123
},
'Description': 'string',
'Status': 'PENDING'|'IN_PROGRESS'|'ACTIVE'|'FAILED'|'STOPPING'|'INACTIVE'|'STARTING'|'DELETING',
'LastUpdatedAt': datetime(2015, 1, 1),
'CreatedAt': datetime(2015, 1, 1),
'FailureReason': 'string',
'LatestRecommenderUpdate': {
'RecommenderConfig': {
'EventsConfig': {
'EventParametersList': [
{
'EventType': 'string',
'EventValueThreshold': 123.0
},
]
},
'TrainingFrequency': 123
},
'Status': 'PENDING'|'IN_PROGRESS'|'ACTIVE'|'FAILED'|'STOPPING'|'INACTIVE'|'STARTING'|'DELETING',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'FailureReason': 'string'
},
'TrainingMetrics': [
{
'Time': datetime(2015, 1, 1),
'Metrics': {
'string': 123.0
}
},
],
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
RecommenderName (string) --
The name of the recommender.
RecommenderRecipeName (string) --
The name of the recipe used by the recommender to generate recommendations.
RecommenderConfig (dict) --
The configuration settings for the recommender, including parameters and settings that define its behavior.
EventsConfig (dict) --
Configuration settings for how the recommender processes and uses events.
EventParametersList (list) --
A list of event parameters configurations that specify how different event types should be handled.
(dict) --
Configuration parameters for events in the personalization system.
EventType (string) --
The type of event being tracked (e.g., 'click', 'purchase', 'view').
EventValueThreshold (float) --
The minimum value threshold that an event must meet to be considered valid.
TrainingFrequency (integer) --
How often the recommender should retrain its model with new data.
Description (string) --
A detailed description of the recommender providing information about its purpose and functionality.
Status (string) --
The current status of the recommender, indicating whether it is active, creating, updating, or in another state.
LastUpdatedAt (datetime) --
The timestamp of when the recommender was edited.
CreatedAt (datetime) --
The timestamp of when the recommender was created.
FailureReason (string) --
If the recommender fails, provides the reason for the failure.
LatestRecommenderUpdate (dict) --
Information about the most recent update performed on the recommender, including status and timestamp.
RecommenderConfig (dict) --
The updated configuration settings applied to the recommender during this update.
EventsConfig (dict) --
Configuration settings for how the recommender processes and uses events.
EventParametersList (list) --
A list of event parameters configurations that specify how different event types should be handled.
(dict) --
Configuration parameters for events in the personalization system.
EventType (string) --
The type of event being tracked (e.g., 'click', 'purchase', 'view').
EventValueThreshold (float) --
The minimum value threshold that an event must meet to be considered valid.
TrainingFrequency (integer) --
How often the recommender should retrain its model with new data.
Status (string) --
The current status of the recommender update operation.
CreatedAt (datetime) --
The timestamp when this recommender update was initiated.
LastUpdatedAt (datetime) --
The timestamp of when the recommender was edited.
FailureReason (string) --
If the update operation failed, provides the reason for the failure.
TrainingMetrics (list) --
A set of metrics that provide information about the recommender's training performance and accuracy.
(dict) --
Contains metrics and performance indicators from the training of a recommender model.
Time (datetime) --
The timestamp when these training metrics were recorded.
Metrics (dict) --
A collection of performance metrics and statistics from the training process.
(string) --
(float) --
Tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
Delete a DomainObjectType for the given Domain and ObjectType name.
See also: AWS API Documentation
Request Syntax
client.delete_domain_object_type(
DomainName='string',
ObjectTypeName='string'
)
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The unique name of the domain object type.
dict
Response Syntax
{}
Response Structure
(dict) --
Fetches the recommendations for a profile in the input Customer Profiles domain. Fetches all the profile recommendations
See also: AWS API Documentation
Request Syntax
client.get_profile_recommendations(
DomainName='string',
ProfileId='string',
RecommenderName='string',
Context={
'string': 'string'
},
MaxResults=123
)
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The unique identifier of the profile for which to retrieve recommendations.
string
[REQUIRED]
The unique name of the recommender.
dict
The contextual metadata used to provide dynamic runtime information to tailor recommendations.
(string) --
(string) --
integer
The maximum number of recommendations to return. The default value is 10.
dict
Response Syntax
{
'Recommendations': [
{
'CatalogItem': {
'Id': 'string',
'Name': 'string',
'Code': 'string',
'Type': 'string',
'Category': 'string',
'Description': 'string',
'AdditionalInformation': 'string',
'ImageLink': 'string',
'Link': 'string',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'Price': 'string',
'Attributes': {
'string': 'string'
}
},
'Score': 123.0
},
]
}
Response Structure
(dict) --
Recommendations (list) --
List of recommendations generated by the recommender.
(dict) --
Represents a single recommendation generated by the recommender system.
CatalogItem (dict) --
The catalog item being recommended, including its complete details and attributes.
Id (string) --
The unique identifier for the catalog item.
Name (string) --
The display name of the catalog item.
Code (string) --
The product code or SKU of the catalog item.
Type (string) --
The type classification of the catalog item.
Category (string) --
The category to which the catalog item belongs.
Description (string) --
A detailed description of the catalog item.
AdditionalInformation (string) --
Supplementary information about the catalog item beyond the basic description.
ImageLink (string) --
The URL link to the item's image.
Link (string) --
The URL link to the item's detailed page or external resource.
CreatedAt (datetime) --
The timestamp when the catalog item was created.
UpdatedAt (datetime) --
The timestamp when the catalog item was last updated.
Price (string) --
The price of the catalog item.
Attributes (dict) --
Additional attributes or properties associated with the catalog item stored as key-value pairs.
(string) --
(string) --
Score (float) --
Recommendation Score between 0 and 1.
Starts a recommender that was previously stopped. Starting a recommender resumes its ability to generate recommendations.
See also: AWS API Documentation
Request Syntax
client.start_recommender(
DomainName='string',
RecommenderName='string'
)
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The name of the recommender to start.
dict
Response Syntax
{}
Response Structure
(dict) --
The ListObjectTypeAttributeValues API provides access to the most recent distinct values for any specified attribute, making it valuable for real-time data validation and consistency checks within your object types. This API works across domain, supporting both custom and standard object types. The API accepts the object type name, attribute name, and domain name as input parameters and returns values up to the storage limit of approximately 350KB.
See also: AWS API Documentation
Request Syntax
client.list_object_type_attribute_values(
NextToken='string',
MaxResults=123,
DomainName='string',
ObjectTypeName='string',
AttributeName='string'
)
string
The pagination token from the previous call.
integer
The maximum number of objects returned per page. Valid Range: Minimum value of 1. Maximum value of 100. If not provided default as 100.
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The unique name of the domain object type.
string
[REQUIRED]
The attribute name.
dict
Response Syntax
{
'Items': [
{
'Value': 'string',
'LastUpdatedAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
A list of unique attribute values sorted on the basis of LastUpdatedAt.
(dict) --
Represents an item in the list of object type attribute values with its associated metadata.
Value (string) --
The actual value of the object type attribute.
LastUpdatedAt (datetime) --
The timestamp of when the object type attribute value was most recently updated.
NextToken (string) --
The pagination token from the previous call to call ListObjectTypeAttributeValues.
Create/Update a DomainObjectType in a Customer Profiles domain. To create a new DomainObjectType, Data Store needs to be enabled on the Domain.
See also: AWS API Documentation
Request Syntax
client.put_domain_object_type(
DomainName='string',
ObjectTypeName='string',
Description='string',
EncryptionKey='string',
Fields={
'string': {
'Source': 'string',
'Target': 'string',
'ContentType': 'STRING'|'NUMBER',
'FeatureType': 'TEXTUAL'|'CATEGORICAL'
}
},
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The unique name of the domain object type.
string
The description of the domain object type.
string
The customer provided KMS key used to encrypt this type of domain object.
dict
[REQUIRED]
A map of field names to their corresponding domain object type field definitions.
(string) --
(dict) --
The standard domain object type.
Source (string) -- [REQUIRED]
The expression that defines how to extract the field value from the source object.>
Target (string) -- [REQUIRED]
The expression that defines where the field value should be placed in the standard domain object.
ContentType (string) --
The content type of the field.
FeatureType (string) --
The semantic meaning of the field.
dict
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
dict
Response Syntax
{
'ObjectTypeName': 'string',
'Description': 'string',
'EncryptionKey': 'string',
'Fields': {
'string': {
'Source': 'string',
'Target': 'string',
'ContentType': 'STRING'|'NUMBER',
'FeatureType': 'TEXTUAL'|'CATEGORICAL'
}
},
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
ObjectTypeName (string) --
The unique name of the domain object type.
Description (string) --
The description of the domain object type.
EncryptionKey (string) --
The customer provided KMS key used to encrypt this type of domain object.
Fields (dict) --
A map of field names to their corresponding domain object type field definitions.
(string) --
(dict) --
The standard domain object type.
Source (string) --
The expression that defines how to extract the field value from the source object.>
Target (string) --
The expression that defines where the field value should be placed in the standard domain object.
ContentType (string) --
The content type of the field.
FeatureType (string) --
The semantic meaning of the field.
CreatedAt (datetime) --
The timestamp of when the domain object type was created.
LastUpdatedAt (datetime) --
The timestamp of when the domain object type was most recently edited.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
Deletes a recommender.
See also: AWS API Documentation
Request Syntax
client.delete_recommender(
DomainName='string',
RecommenderName='string'
)
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The recommender name.
dict
Response Syntax
{}
Response Structure
(dict) --
List all DomainObjectType(s) in a Customer Profiles domain.
See also: AWS API Documentation
Request Syntax
client.list_domain_object_types(
DomainName='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The unique name of the domain.
integer
The maximum number of domain object types returned per page.
string
The pagination token from the previous call to ListDomainObjectTypes.
dict
Response Syntax
{
'Items': [
{
'ObjectTypeName': '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 domain object types.
(dict) --
Represents an item in the list of domain object types, containing basic information about a specific object type within a domain.
ObjectTypeName (string) --
The name that identifies the object type within the domain.
Description (string) --
A description explaining the purpose and characteristics of this object type.
CreatedAt (datetime) --
The timestamp of when the domain object type was created.
LastUpdatedAt (datetime) --
The timestamp of when the domain object type was most recently edited.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
NextToken (string) --
The pagination token from the previous call to ListDomainObjectTypes.
The GetObjectTypeAttributeValues API delivers statistical insights about attributes within a specific object type, but is exclusively available for domains with data store enabled. This API performs daily calculations to provide statistical information about your attribute values, helping you understand patterns and trends in your data. The statistical calculations are performed once per day, providing a consistent snapshot of your attribute data characteristics.
See also: AWS API Documentation
Request Syntax
client.get_object_type_attribute_statistics(
DomainName='string',
ObjectTypeName='string',
AttributeName='string'
)
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The unique name of the domain object type.
string
[REQUIRED]
The attribute name.
dict
Response Syntax
{
'Statistics': {
'Maximum': 123.0,
'Minimum': 123.0,
'Average': 123.0,
'StandardDeviation': 123.0,
'Percentiles': {
'P5': 123.0,
'P25': 123.0,
'P50': 123.0,
'P75': 123.0,
'P95': 123.0
}
},
'CalculatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Statistics (dict) --
The statistics.
Maximum (float) --
The maximum value found in the attribute dataset.
Minimum (float) --
The minimum value found in the attribute dataset.
Average (float) --
The arithmetic mean of the attribute values.
StandardDeviation (float) --
The standard deviation of the attribute values, measuring their spread around the mean.
Percentiles (dict) --
Percentile distribution statistics for the attribute values.
P5 (float) --
The 5th percentile value of the attribute.
P25 (float) --
The 25th percentile value of the attribute.
P50 (float) --
The 50th percentile (median) value of the attribute.
P75 (float) --
The 75th percentile value of the attribute.
P95 (float) --
The 95th percentile value of the attribute.
CalculatedAt (datetime) --
Time when this statistics was calculated.
Returns a list of available recommender recipes that can be used to create recommenders.
See also: AWS API Documentation
Request Syntax
client.list_recommender_recipes(
MaxResults=123,
NextToken='string'
)
integer
The maximum number of recommender recipes to return in the response. The default value is 100.
string
A token received from a previous ListRecommenderRecipes call to retrieve the next page of results.
dict
Response Syntax
{
'NextToken': 'string',
'RecommenderRecipes': [
{
'name': 'recommended-for-you'|'similar-items'|'frequently-paired-items'|'popular-items'|'trending-now',
'description': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
A token to retrieve the next page of results. Null if there are no more results to retrieve.
RecommenderRecipes (list) --
A list of available recommender recipes and their properties.
(dict) --
Defines the algorithm and approach used to generate recommendations.
name (string) --
The name of the recommender recipe.
description (string) --
A description of the recommender recipe's purpose and functionality.
{'DataStore': {'Enabled': 'boolean'}}
Response {'DataStore': {'Enabled': 'boolean',
'Readiness': {'Message': 'string',
'ProgressPercentage': 'integer'}}}
Creates a domain, which is a container for all customer data, such as customer profile attributes, object types, profile keys, and encryption keys. You can create multiple domains, and each domain can have multiple third-party integrations.
Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can be associated with one domain.
Use this API or UpdateDomain to enable identity resolution: set Matching to true.
To prevent cross-service impersonation when you call this API, see Cross-service confused deputy prevention for sample policies that you should apply.
See also: AWS API Documentation
Request Syntax
client.create_domain(
DomainName='string',
DefaultExpirationDays=123,
DefaultEncryptionKey='string',
DeadLetterQueueUrl='string',
Matching={
'Enabled': True|False,
'JobSchedule': {
'DayOfTheWeek': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
'Time': 'string'
},
'AutoMerging': {
'Enabled': True|False,
'Consolidation': {
'MatchingAttributesList': [
[
'string',
],
]
},
'ConflictResolution': {
'ConflictResolvingModel': 'RECENCY'|'SOURCE',
'SourceName': 'string'
},
'MinAllowedConfidenceScoreForMerging': 123.0
},
'ExportingConfig': {
'S3Exporting': {
'S3BucketName': 'string',
'S3KeyName': 'string'
}
}
},
RuleBasedMatching={
'Enabled': True|False,
'MatchingRules': [
{
'Rule': [
'string',
]
},
],
'MaxAllowedRuleLevelForMerging': 123,
'MaxAllowedRuleLevelForMatching': 123,
'AttributeTypesSelector': {
'AttributeMatchingModel': 'ONE_TO_ONE'|'MANY_TO_MANY',
'Address': [
'string',
],
'PhoneNumber': [
'string',
],
'EmailAddress': [
'string',
]
},
'ConflictResolution': {
'ConflictResolvingModel': 'RECENCY'|'SOURCE',
'SourceName': 'string'
},
'ExportingConfig': {
'S3Exporting': {
'S3BucketName': 'string',
'S3KeyName': 'string'
}
}
},
DataStore={
'Enabled': True|False
},
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The unique name of the domain.
integer
[REQUIRED]
The default number of days until the data within the domain expires.
string
The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.
string
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue.
dict
The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.
After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.
Enabled (boolean) -- [REQUIRED]
The flag that enables the matching process of duplicate profiles.
JobSchedule (dict) --
The day and time when do you want to start the Identity Resolution Job every week.
DayOfTheWeek (string) -- [REQUIRED]
The day when the Identity Resolution Job should run every week.
Time (string) -- [REQUIRED]
The time when the Identity Resolution Job should run every week.
AutoMerging (dict) --
Configuration information about the auto-merging process.
Enabled (boolean) -- [REQUIRED]
The flag that enables the auto-merging of duplicate profiles.
Consolidation (dict) --
A list of matching attributes that represent matching criteria. If two profiles meet at least one of the requirements in the matching attributes list, they will be merged.
MatchingAttributesList (list) -- [REQUIRED]
A list of matching criteria.
(list) --
(string) --
ConflictResolution (dict) --
How the auto-merging process should resolve conflicts between different profiles. For example, if Profile A and Profile B have the same FirstName and LastName (and that is the matching criteria), which EmailAddress should be used?
ConflictResolvingModel (string) -- [REQUIRED]
How the auto-merging process should resolve conflicts between different profiles.
RECENCY: Uses the data that was most recently updated.
SOURCE: Uses the data from a specific source. For example, if a company has been aquired or two departments have merged, data from the specified source is used. If two duplicate profiles are from the same source, then RECENCY is used again.
SourceName (string) --
The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel.
MinAllowedConfidenceScoreForMerging (float) --
A number between 0 and 1 that represents the minimum confidence score required for profiles within a matching group to be merged during the auto-merge process. A higher score means higher similarity required to merge profiles.
ExportingConfig (dict) --
Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.
S3Exporting (dict) --
The S3 location where Identity Resolution Jobs write result files.
S3BucketName (string) -- [REQUIRED]
The name of the S3 bucket where Identity Resolution Jobs write result files.
S3KeyName (string) --
The S3 key name of the location where Identity Resolution Jobs write result files.
dict
The process of matching duplicate profiles using the Rule-Based matching. If RuleBasedMatching = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3.
Enabled (boolean) -- [REQUIRED]
The flag that enables the rule-based matching process of duplicate profiles.
MatchingRules (list) --
Configures how the rule-based matching process should match profiles. You can have up to 15 MatchingRule in the MatchingRules.
(dict) --
Specifies how does the rule-based matching process should match profiles. You can choose from the following attributes to build the matching Rule:
AccountNumber
Address.Address
Address.City
Address.Country
Address.County
Address.PostalCode
Address.State
Address.Province
BirthDate
BusinessName
EmailAddress
FirstName
Gender
LastName
MiddleName
PhoneNumber
Any customized profile attributes that start with the Attributes
Rule (list) -- [REQUIRED]
A single rule level of the MatchRules. Configures how the rule-based matching process should match profiles.
(string) --
MaxAllowedRuleLevelForMerging (integer) --
MaxAllowedRuleLevelForMatching (integer) --
Indicates the maximum allowed rule level.
AttributeTypesSelector (dict) --
Configures information about the AttributeTypesSelector where the rule-based identity resolution uses to match profiles.
AttributeMatchingModel (string) -- [REQUIRED]
Configures the AttributeMatchingModel, you can either choose ONE_TO_ONE or MANY_TO_MANY.
Address (list) --
The Address type. You can choose from Address, BusinessAddress, MaillingAddress, and ShippingAddress.
You only can use the Address type in the MatchingRule. For example, if you want to match profile based on BusinessAddress.City or MaillingAddress.City, you need to choose the BusinessAddress and the MaillingAddress to represent the Address type and specify the Address.City on the matching rule.
(string) --
PhoneNumber (list) --
The PhoneNumber type. You can choose from PhoneNumber, HomePhoneNumber, and MobilePhoneNumber.
You only can use the PhoneNumber type in the MatchingRule. For example, if you want to match a profile based on Phone or HomePhone, you need to choose the Phone and the HomePhone to represent the PhoneNumber type and only specify the PhoneNumber on the matching rule.
(string) --
EmailAddress (list) --
The Email type. You can choose from EmailAddress, BusinessEmailAddress and PersonalEmailAddress.
You only can use the EmailAddress type in the MatchingRule. For example, if you want to match profile based on PersonalEmailAddress or BusinessEmailAddress, you need to choose the PersonalEmailAddress and the BusinessEmailAddress to represent the EmailAddress type and only specify the EmailAddress on the matching rule.
(string) --
ConflictResolution (dict) --
How the auto-merging process should resolve conflicts between different profiles.
ConflictResolvingModel (string) -- [REQUIRED]
How the auto-merging process should resolve conflicts between different profiles.
RECENCY: Uses the data that was most recently updated.
SOURCE: Uses the data from a specific source. For example, if a company has been aquired or two departments have merged, data from the specified source is used. If two duplicate profiles are from the same source, then RECENCY is used again.
SourceName (string) --
The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel.
ExportingConfig (dict) --
Configuration information about the S3 bucket where Identity Resolution Jobs writes result files.
S3Exporting (dict) --
The S3 location where Identity Resolution Jobs write result files.
S3BucketName (string) -- [REQUIRED]
The name of the S3 bucket where Identity Resolution Jobs write result files.
S3KeyName (string) --
The S3 key name of the location where Identity Resolution Jobs write result files.
dict
Set to true to enabled data store for this domain.
Enabled (boolean) --
Enabled: Set to true to enabled data store for this domain.
dict
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
dict
Response Syntax
{
'DomainName': 'string',
'DefaultExpirationDays': 123,
'DefaultEncryptionKey': 'string',
'DeadLetterQueueUrl': 'string',
'Matching': {
'Enabled': True|False,
'JobSchedule': {
'DayOfTheWeek': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
'Time': 'string'
},
'AutoMerging': {
'Enabled': True|False,
'Consolidation': {
'MatchingAttributesList': [
[
'string',
],
]
},
'ConflictResolution': {
'ConflictResolvingModel': 'RECENCY'|'SOURCE',
'SourceName': 'string'
},
'MinAllowedConfidenceScoreForMerging': 123.0
},
'ExportingConfig': {
'S3Exporting': {
'S3BucketName': 'string',
'S3KeyName': 'string'
}
}
},
'RuleBasedMatching': {
'Enabled': True|False,
'MatchingRules': [
{
'Rule': [
'string',
]
},
],
'Status': 'PENDING'|'IN_PROGRESS'|'ACTIVE',
'MaxAllowedRuleLevelForMerging': 123,
'MaxAllowedRuleLevelForMatching': 123,
'AttributeTypesSelector': {
'AttributeMatchingModel': 'ONE_TO_ONE'|'MANY_TO_MANY',
'Address': [
'string',
],
'PhoneNumber': [
'string',
],
'EmailAddress': [
'string',
]
},
'ConflictResolution': {
'ConflictResolvingModel': 'RECENCY'|'SOURCE',
'SourceName': 'string'
},
'ExportingConfig': {
'S3Exporting': {
'S3BucketName': 'string',
'S3KeyName': 'string'
}
}
},
'DataStore': {
'Enabled': True|False,
'Readiness': {
'ProgressPercentage': 123,
'Message': 'string'
}
},
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
DomainName (string) --
The unique name of the domain.
DefaultExpirationDays (integer) --
The default number of days until the data within the domain expires.
DefaultEncryptionKey (string) --
The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.
DeadLetterQueueUrl (string) --
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
Matching (dict) --
The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.
After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.
Enabled (boolean) --
The flag that enables the matching process of duplicate profiles.
JobSchedule (dict) --
The day and time when do you want to start the Identity Resolution Job every week.
DayOfTheWeek (string) --
The day when the Identity Resolution Job should run every week.
Time (string) --
The time when the Identity Resolution Job should run every week.
AutoMerging (dict) --
Configuration information about the auto-merging process.
Enabled (boolean) --
The flag that enables the auto-merging of duplicate profiles.
Consolidation (dict) --
A list of matching attributes that represent matching criteria. If two profiles meet at least one of the requirements in the matching attributes list, they will be merged.
MatchingAttributesList (list) --
A list of matching criteria.
(list) --
(string) --
ConflictResolution (dict) --
How the auto-merging process should resolve conflicts between different profiles. For example, if Profile A and Profile B have the same FirstName and LastName (and that is the matching criteria), which EmailAddress should be used?
ConflictResolvingModel (string) --
How the auto-merging process should resolve conflicts between different profiles.
RECENCY: Uses the data that was most recently updated.
SOURCE: Uses the data from a specific source. For example, if a company has been aquired or two departments have merged, data from the specified source is used. If two duplicate profiles are from the same source, then RECENCY is used again.
SourceName (string) --
The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel.
MinAllowedConfidenceScoreForMerging (float) --
A number between 0 and 1 that represents the minimum confidence score required for profiles within a matching group to be merged during the auto-merge process. A higher score means higher similarity required to merge profiles.
ExportingConfig (dict) --
Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.
S3Exporting (dict) --
The S3 location where Identity Resolution Jobs write result files.
S3BucketName (string) --
The name of the S3 bucket where Identity Resolution Jobs write result files.
S3KeyName (string) --
The S3 key name of the location where Identity Resolution Jobs write result files.
RuleBasedMatching (dict) --
The process of matching duplicate profiles using the Rule-Based matching. If RuleBasedMatching = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3.
Enabled (boolean) --
The flag that enables the rule-based matching process of duplicate profiles.
MatchingRules (list) --
Configures how the rule-based matching process should match profiles. You can have up to 15 MatchingRule in the MatchingRules.
(dict) --
Specifies how does the rule-based matching process should match profiles. You can choose from the following attributes to build the matching Rule:
AccountNumber
Address.Address
Address.City
Address.Country
Address.County
Address.PostalCode
Address.State
Address.Province
BirthDate
BusinessName
EmailAddress
FirstName
Gender
LastName
MiddleName
PhoneNumber
Any customized profile attributes that start with the Attributes
Rule (list) --
A single rule level of the MatchRules. Configures how the rule-based matching process should match profiles.
(string) --
Status (string) --
PENDING
The first status after configuration a rule-based matching rule. If it is an existing domain, the rule-based Identity Resolution waits one hour before creating the matching rule. If it is a new domain, the system will skip the PENDING stage.
IN_PROGRESS
The system is creating the rule-based matching rule. Under this status, the system is evaluating the existing data and you can no longer change the Rule-based matching configuration.
ACTIVE
The rule is ready to use. You can change the rule a day after the status is in ACTIVE.
MaxAllowedRuleLevelForMerging (integer) --
MaxAllowedRuleLevelForMatching (integer) --
Indicates the maximum allowed rule level.
AttributeTypesSelector (dict) --
Configures information about the AttributeTypesSelector where the rule-based identity resolution uses to match profiles.
AttributeMatchingModel (string) --
Configures the AttributeMatchingModel, you can either choose ONE_TO_ONE or MANY_TO_MANY.
Address (list) --
The Address type. You can choose from Address, BusinessAddress, MaillingAddress, and ShippingAddress.
You only can use the Address type in the MatchingRule. For example, if you want to match profile based on BusinessAddress.City or MaillingAddress.City, you need to choose the BusinessAddress and the MaillingAddress to represent the Address type and specify the Address.City on the matching rule.
(string) --
PhoneNumber (list) --
The PhoneNumber type. You can choose from PhoneNumber, HomePhoneNumber, and MobilePhoneNumber.
You only can use the PhoneNumber type in the MatchingRule. For example, if you want to match a profile based on Phone or HomePhone, you need to choose the Phone and the HomePhone to represent the PhoneNumber type and only specify the PhoneNumber on the matching rule.
(string) --
EmailAddress (list) --
The Email type. You can choose from EmailAddress, BusinessEmailAddress and PersonalEmailAddress.
You only can use the EmailAddress type in the MatchingRule. For example, if you want to match profile based on PersonalEmailAddress or BusinessEmailAddress, you need to choose the PersonalEmailAddress and the BusinessEmailAddress to represent the EmailAddress type and only specify the EmailAddress on the matching rule.
(string) --
ConflictResolution (dict) --
How the auto-merging process should resolve conflicts between different profiles.
ConflictResolvingModel (string) --
How the auto-merging process should resolve conflicts between different profiles.
RECENCY: Uses the data that was most recently updated.
SOURCE: Uses the data from a specific source. For example, if a company has been aquired or two departments have merged, data from the specified source is used. If two duplicate profiles are from the same source, then RECENCY is used again.
SourceName (string) --
The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel.
ExportingConfig (dict) --
Configuration information about the S3 bucket where Identity Resolution Jobs writes result files.
S3Exporting (dict) --
The S3 location where Identity Resolution Jobs write result files.
S3BucketName (string) --
The name of the S3 bucket where Identity Resolution Jobs write result files.
S3KeyName (string) --
The S3 key name of the location where Identity Resolution Jobs write result files.
DataStore (dict) --
The data store.
Enabled (boolean) --
True if data store is enabled for this domain
Readiness (dict) --
Information indicating if the Calculated Attribute is ready for use by confirming all historical data has been processed and reflected.
ProgressPercentage (integer) --
Approximately how far the Calculated Attribute creation is from completion.
Message (string) --
Any customer messaging.
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) --
{'SegmentSqlQuery': 'string'}
Creates a segment definition associated to the given domain.
See also: AWS API Documentation
Request Syntax
client.create_segment_definition(
DomainName='string',
SegmentDefinitionName='string',
DisplayName='string',
Description='string',
SegmentGroups={
'Groups': [
{
'Dimensions': [
{
'ProfileAttributes': {
'AccountNumber': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'AdditionalInformation': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'FirstName': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'LastName': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'MiddleName': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'GenderString': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PartyTypeString': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'BirthDate': {
'DimensionType': 'BEFORE'|'AFTER'|'BETWEEN'|'NOT_BETWEEN'|'ON',
'Values': [
'string',
]
},
'PhoneNumber': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'BusinessName': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'BusinessPhoneNumber': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'HomePhoneNumber': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'MobilePhoneNumber': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'EmailAddress': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PersonalEmailAddress': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'BusinessEmailAddress': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Address': {
'City': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'County': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PostalCode': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Province': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'State': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
}
},
'ShippingAddress': {
'City': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'County': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PostalCode': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Province': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'State': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
}
},
'MailingAddress': {
'City': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'County': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PostalCode': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Province': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'State': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
}
},
'BillingAddress': {
'City': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'County': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PostalCode': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Province': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'State': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
}
},
'Attributes': {
'string': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH'|'BEFORE'|'AFTER'|'BETWEEN'|'NOT_BETWEEN'|'ON'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL'|'LESS_THAN_OR_EQUAL'|'EQUAL',
'Values': [
'string',
]
}
},
'ProfileType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'ACCOUNT_PROFILE'|'PROFILE',
]
}
},
'CalculatedAttributes': {
'string': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH'|'BEFORE'|'AFTER'|'BETWEEN'|'NOT_BETWEEN'|'ON'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL'|'LESS_THAN_OR_EQUAL'|'EQUAL',
'Values': [
'string',
],
'ConditionOverrides': {
'Range': {
'Start': 123,
'End': 123,
'Unit': 'DAYS'
}
}
}
}
},
],
'SourceSegments': [
{
'SegmentDefinitionName': 'string'
},
],
'SourceType': 'ALL'|'ANY'|'NONE',
'Type': 'ALL'|'ANY'|'NONE'
},
],
'Include': 'ALL'|'ANY'|'NONE'
},
SegmentSqlQuery='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The unique name of the segment definition.
string
[REQUIRED]
The display name of the segment definition.
string
The description of the segment definition.
dict
Specifies the base segments and dimensions for a segment definition along with their respective relationship.
Groups (list) --
Holds the list of groups within the segment definition.
(dict) --
Contains dimensions that determine what to segment on.
Dimensions (list) --
Defines the attributes to segment on.
(dict) --
Object that holds what profile and calculated attributes to segment on.
ProfileAttributes (dict) --
Object that holds the profile attributes to segment on.
AccountNumber (dict) --
A field to describe values to segment on within account number.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
AdditionalInformation (dict) --
A field to describe values to segment on within additional information.
DimensionType (string) -- [REQUIRED]
The action to segment with.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
FirstName (dict) --
A field to describe values to segment on within first name.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
LastName (dict) --
A field to describe values to segment on within last name.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
MiddleName (dict) --
A field to describe values to segment on within middle name.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
GenderString (dict) --
A field to describe values to segment on within genderString.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
PartyTypeString (dict) --
A field to describe values to segment on within partyTypeString.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
BirthDate (dict) --
A field to describe values to segment on within birthDate.
DimensionType (string) -- [REQUIRED]
The action to segment with.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
PhoneNumber (dict) --
A field to describe values to segment on within phone number.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
BusinessName (dict) --
A field to describe values to segment on within business name.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
BusinessPhoneNumber (dict) --
A field to describe values to segment on within business phone number.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
HomePhoneNumber (dict) --
A field to describe values to segment on within home phone number.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
MobilePhoneNumber (dict) --
A field to describe values to segment on within mobile phone number.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
EmailAddress (dict) --
A field to describe values to segment on within email address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
PersonalEmailAddress (dict) --
A field to describe values to segment on within personal email address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
BusinessEmailAddress (dict) --
A field to describe values to segment on within business email address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
Address (dict) --
A field to describe values to segment on within address.
City (dict) --
The city belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
Country (dict) --
The country belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
County (dict) --
The county belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
PostalCode (dict) --
The postal code belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
Province (dict) --
The province belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
State (dict) --
The state belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
ShippingAddress (dict) --
A field to describe values to segment on within shipping address.
City (dict) --
The city belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
Country (dict) --
The country belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
County (dict) --
The county belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
PostalCode (dict) --
The postal code belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
Province (dict) --
The province belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
State (dict) --
The state belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
MailingAddress (dict) --
A field to describe values to segment on within mailing address.
City (dict) --
The city belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
Country (dict) --
The country belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
County (dict) --
The county belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
PostalCode (dict) --
The postal code belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
Province (dict) --
The province belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
State (dict) --
The state belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
BillingAddress (dict) --
A field to describe values to segment on within billing address.
City (dict) --
The city belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
Country (dict) --
The country belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
County (dict) --
The county belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
PostalCode (dict) --
The postal code belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
Province (dict) --
The province belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
State (dict) --
The state belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
Attributes (dict) --
A field to describe values to segment on within attributes.
(string) --
(dict) --
Object that segments on various Customer Profile's fields.
DimensionType (string) -- [REQUIRED]
The action to segment with.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
ProfileType (dict) --
A field to describe values to segment on within profile type.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
CalculatedAttributes (dict) --
Object that holds the calculated attributes to segment on.
(string) --
(dict) --
Object that segments on Customer Profile's Calculated Attributes.
DimensionType (string) -- [REQUIRED]
The action to segment with.
Values (list) -- [REQUIRED]
The values to apply the DimensionType with.
(string) --
ConditionOverrides (dict) --
Applies the given condition over the initial Calculated Attribute's definition.
Range (dict) --
The relative time period over which data is included in the aggregation for this override.
Start (integer) -- [REQUIRED]
The start time of when to include objects.
End (integer) --
The end time of when to include objects.
Unit (string) -- [REQUIRED]
The unit for start and end.
SourceSegments (list) --
Defines the starting source of data.
(dict) --
The source segments to build off of.
SegmentDefinitionName (string) --
The unique name of the segment definition.
SourceType (string) --
Defines how to interact with the source data.
Type (string) --
Defines how to interact with the profiles found in the current filtering.
Include (string) --
Defines whether to include or exclude the profiles that fit the segment criteria.
string
The segment SQL query.
dict
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
dict
Response Syntax
{
'SegmentDefinitionName': 'string',
'DisplayName': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'SegmentDefinitionArn': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
SegmentDefinitionName (string) --
The name of the segment definition.
DisplayName (string) --
The display name of the segment definition.
Description (string) --
The description of the segment definition.
CreatedAt (datetime) --
The timestamp of when the segment definition was created.
SegmentDefinitionArn (string) --
The arn of the segment definition.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
{'SegmentSqlQuery': 'string'}
Creates a segment estimate query.
See also: AWS API Documentation
Request Syntax
client.create_segment_estimate(
DomainName='string',
SegmentQuery={
'Groups': [
{
'Dimensions': [
{
'ProfileAttributes': {
'AccountNumber': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'AdditionalInformation': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'FirstName': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'LastName': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'MiddleName': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'GenderString': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PartyTypeString': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'BirthDate': {
'DimensionType': 'BEFORE'|'AFTER'|'BETWEEN'|'NOT_BETWEEN'|'ON',
'Values': [
'string',
]
},
'PhoneNumber': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'BusinessName': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'BusinessPhoneNumber': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'HomePhoneNumber': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'MobilePhoneNumber': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'EmailAddress': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PersonalEmailAddress': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'BusinessEmailAddress': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Address': {
'City': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'County': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PostalCode': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Province': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'State': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
}
},
'ShippingAddress': {
'City': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'County': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PostalCode': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Province': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'State': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
}
},
'MailingAddress': {
'City': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'County': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PostalCode': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Province': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'State': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
}
},
'BillingAddress': {
'City': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'County': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PostalCode': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Province': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'State': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
}
},
'Attributes': {
'string': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH'|'BEFORE'|'AFTER'|'BETWEEN'|'NOT_BETWEEN'|'ON'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL'|'LESS_THAN_OR_EQUAL'|'EQUAL',
'Values': [
'string',
]
}
},
'ProfileType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'ACCOUNT_PROFILE'|'PROFILE',
]
}
},
'CalculatedAttributes': {
'string': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH'|'BEFORE'|'AFTER'|'BETWEEN'|'NOT_BETWEEN'|'ON'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL'|'LESS_THAN_OR_EQUAL'|'EQUAL',
'Values': [
'string',
],
'ConditionOverrides': {
'Range': {
'Start': 123,
'End': 123,
'Unit': 'DAYS'
}
}
}
}
},
],
'SourceSegments': [
{
'SegmentDefinitionName': 'string'
},
],
'SourceType': 'ALL'|'ANY'|'NONE',
'Type': 'ALL'|'ANY'|'NONE'
},
],
'Include': 'ALL'|'ANY'|'NONE'
},
SegmentSqlQuery='string'
)
string
[REQUIRED]
The unique name of the domain.
dict
The segment query for calculating a segment estimate.
Groups (list) --
Holds the list of groups within the segment definition.
(dict) --
Contains dimensions that determine what to segment on.
Dimensions (list) --
Defines the attributes to segment on.
(dict) --
Object that holds what profile and calculated attributes to segment on.
ProfileAttributes (dict) --
Object that holds the profile attributes to segment on.
AccountNumber (dict) --
A field to describe values to segment on within account number.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
AdditionalInformation (dict) --
A field to describe values to segment on within additional information.
DimensionType (string) -- [REQUIRED]
The action to segment with.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
FirstName (dict) --
A field to describe values to segment on within first name.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
LastName (dict) --
A field to describe values to segment on within last name.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
MiddleName (dict) --
A field to describe values to segment on within middle name.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
GenderString (dict) --
A field to describe values to segment on within genderString.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
PartyTypeString (dict) --
A field to describe values to segment on within partyTypeString.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
BirthDate (dict) --
A field to describe values to segment on within birthDate.
DimensionType (string) -- [REQUIRED]
The action to segment with.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
PhoneNumber (dict) --
A field to describe values to segment on within phone number.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
BusinessName (dict) --
A field to describe values to segment on within business name.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
BusinessPhoneNumber (dict) --
A field to describe values to segment on within business phone number.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
HomePhoneNumber (dict) --
A field to describe values to segment on within home phone number.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
MobilePhoneNumber (dict) --
A field to describe values to segment on within mobile phone number.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
EmailAddress (dict) --
A field to describe values to segment on within email address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
PersonalEmailAddress (dict) --
A field to describe values to segment on within personal email address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
BusinessEmailAddress (dict) --
A field to describe values to segment on within business email address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
Address (dict) --
A field to describe values to segment on within address.
City (dict) --
The city belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
Country (dict) --
The country belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
County (dict) --
The county belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
PostalCode (dict) --
The postal code belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
Province (dict) --
The province belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
State (dict) --
The state belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
ShippingAddress (dict) --
A field to describe values to segment on within shipping address.
City (dict) --
The city belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
Country (dict) --
The country belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
County (dict) --
The county belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
PostalCode (dict) --
The postal code belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
Province (dict) --
The province belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
State (dict) --
The state belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
MailingAddress (dict) --
A field to describe values to segment on within mailing address.
City (dict) --
The city belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
Country (dict) --
The country belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
County (dict) --
The county belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
PostalCode (dict) --
The postal code belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
Province (dict) --
The province belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
State (dict) --
The state belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
BillingAddress (dict) --
A field to describe values to segment on within billing address.
City (dict) --
The city belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
Country (dict) --
The country belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
County (dict) --
The county belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
PostalCode (dict) --
The postal code belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
Province (dict) --
The province belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
State (dict) --
The state belonging to the address.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
Attributes (dict) --
A field to describe values to segment on within attributes.
(string) --
(dict) --
Object that segments on various Customer Profile's fields.
DimensionType (string) -- [REQUIRED]
The action to segment with.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
ProfileType (dict) --
A field to describe values to segment on within profile type.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
CalculatedAttributes (dict) --
Object that holds the calculated attributes to segment on.
(string) --
(dict) --
Object that segments on Customer Profile's Calculated Attributes.
DimensionType (string) -- [REQUIRED]
The action to segment with.
Values (list) -- [REQUIRED]
The values to apply the DimensionType with.
(string) --
ConditionOverrides (dict) --
Applies the given condition over the initial Calculated Attribute's definition.
Range (dict) --
The relative time period over which data is included in the aggregation for this override.
Start (integer) -- [REQUIRED]
The start time of when to include objects.
End (integer) --
The end time of when to include objects.
Unit (string) -- [REQUIRED]
The unit for start and end.
SourceSegments (list) --
Defines the starting source of data.
(dict) --
The source segments to build off of.
SegmentDefinitionName (string) --
The unique name of the segment definition.
SourceType (string) --
Defines how to interact with the source data.
Type (string) --
Defines how to interact with the profiles found in the current filtering.
Include (string) --
Define whether to include or exclude the profiles that fit the segment criteria.
string
The segment SQL query.
dict
Response Syntax
{
'DomainName': 'string',
'EstimateId': 'string',
'StatusCode': 123
}
Response Structure
(dict) --
DomainName (string) --
The unique name of the domain.
EstimateId (string) --
A unique identifier for the resource. The value can be passed to GetSegmentEstimate to retrieve the result of segment estimate status.
StatusCode (integer) --
The status code for the response.
{'DataStore': {'Enabled': 'boolean',
'Readiness': {'Message': 'string',
'ProgressPercentage': 'integer'}}}
Returns information about a specific domain.
See also: AWS API Documentation
Request Syntax
client.get_domain(
DomainName='string'
)
string
[REQUIRED]
The unique name of the domain.
dict
Response Syntax
{
'DomainName': 'string',
'DefaultExpirationDays': 123,
'DefaultEncryptionKey': 'string',
'DeadLetterQueueUrl': 'string',
'Stats': {
'ProfileCount': 123,
'MeteringProfileCount': 123,
'ObjectCount': 123,
'TotalSize': 123
},
'Matching': {
'Enabled': True|False,
'JobSchedule': {
'DayOfTheWeek': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
'Time': 'string'
},
'AutoMerging': {
'Enabled': True|False,
'Consolidation': {
'MatchingAttributesList': [
[
'string',
],
]
},
'ConflictResolution': {
'ConflictResolvingModel': 'RECENCY'|'SOURCE',
'SourceName': 'string'
},
'MinAllowedConfidenceScoreForMerging': 123.0
},
'ExportingConfig': {
'S3Exporting': {
'S3BucketName': 'string',
'S3KeyName': 'string'
}
}
},
'RuleBasedMatching': {
'Enabled': True|False,
'MatchingRules': [
{
'Rule': [
'string',
]
},
],
'Status': 'PENDING'|'IN_PROGRESS'|'ACTIVE',
'MaxAllowedRuleLevelForMerging': 123,
'MaxAllowedRuleLevelForMatching': 123,
'AttributeTypesSelector': {
'AttributeMatchingModel': 'ONE_TO_ONE'|'MANY_TO_MANY',
'Address': [
'string',
],
'PhoneNumber': [
'string',
],
'EmailAddress': [
'string',
]
},
'ConflictResolution': {
'ConflictResolvingModel': 'RECENCY'|'SOURCE',
'SourceName': 'string'
},
'ExportingConfig': {
'S3Exporting': {
'S3BucketName': 'string',
'S3KeyName': 'string'
}
}
},
'DataStore': {
'Enabled': True|False,
'Readiness': {
'ProgressPercentage': 123,
'Message': 'string'
}
},
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
DomainName (string) --
The unique name of the domain.
DefaultExpirationDays (integer) --
The default number of days until the data within the domain expires.
DefaultEncryptionKey (string) --
The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.
DeadLetterQueueUrl (string) --
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
Stats (dict) --
Usage-specific statistics about the domain.
ProfileCount (integer) --
The total number of profiles currently in the domain.
MeteringProfileCount (integer) --
The number of profiles that you are currently paying for in the domain. If you have more than 100 objects associated with a single profile, that profile counts as two profiles. If you have more than 200 objects, that profile counts as three, and so on.
ObjectCount (integer) --
The total number of objects in domain.
TotalSize (integer) --
The total size, in bytes, of all objects in the domain.
Matching (dict) --
The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.
After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.
Enabled (boolean) --
The flag that enables the matching process of duplicate profiles.
JobSchedule (dict) --
The day and time when do you want to start the Identity Resolution Job every week.
DayOfTheWeek (string) --
The day when the Identity Resolution Job should run every week.
Time (string) --
The time when the Identity Resolution Job should run every week.
AutoMerging (dict) --
Configuration information about the auto-merging process.
Enabled (boolean) --
The flag that enables the auto-merging of duplicate profiles.
Consolidation (dict) --
A list of matching attributes that represent matching criteria. If two profiles meet at least one of the requirements in the matching attributes list, they will be merged.
MatchingAttributesList (list) --
A list of matching criteria.
(list) --
(string) --
ConflictResolution (dict) --
How the auto-merging process should resolve conflicts between different profiles. For example, if Profile A and Profile B have the same FirstName and LastName (and that is the matching criteria), which EmailAddress should be used?
ConflictResolvingModel (string) --
How the auto-merging process should resolve conflicts between different profiles.
RECENCY: Uses the data that was most recently updated.
SOURCE: Uses the data from a specific source. For example, if a company has been aquired or two departments have merged, data from the specified source is used. If two duplicate profiles are from the same source, then RECENCY is used again.
SourceName (string) --
The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel.
MinAllowedConfidenceScoreForMerging (float) --
A number between 0 and 1 that represents the minimum confidence score required for profiles within a matching group to be merged during the auto-merge process. A higher score means higher similarity required to merge profiles.
ExportingConfig (dict) --
Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.
S3Exporting (dict) --
The S3 location where Identity Resolution Jobs write result files.
S3BucketName (string) --
The name of the S3 bucket where Identity Resolution Jobs write result files.
S3KeyName (string) --
The S3 key name of the location where Identity Resolution Jobs write result files.
RuleBasedMatching (dict) --
The process of matching duplicate profiles using the Rule-Based matching. If RuleBasedMatching = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3.
Enabled (boolean) --
The flag that enables the rule-based matching process of duplicate profiles.
MatchingRules (list) --
Configures how the rule-based matching process should match profiles. You can have up to 15 MatchingRule in the MatchingRules.
(dict) --
Specifies how does the rule-based matching process should match profiles. You can choose from the following attributes to build the matching Rule:
AccountNumber
Address.Address
Address.City
Address.Country
Address.County
Address.PostalCode
Address.State
Address.Province
BirthDate
BusinessName
EmailAddress
FirstName
Gender
LastName
MiddleName
PhoneNumber
Any customized profile attributes that start with the Attributes
Rule (list) --
A single rule level of the MatchRules. Configures how the rule-based matching process should match profiles.
(string) --
Status (string) --
PENDING
The first status after configuration a rule-based matching rule. If it is an existing domain, the rule-based Identity Resolution waits one hour before creating the matching rule. If it is a new domain, the system will skip the PENDING stage.
IN_PROGRESS
The system is creating the rule-based matching rule. Under this status, the system is evaluating the existing data and you can no longer change the Rule-based matching configuration.
ACTIVE
The rule is ready to use. You can change the rule a day after the status is in ACTIVE.
MaxAllowedRuleLevelForMerging (integer) --
MaxAllowedRuleLevelForMatching (integer) --
Indicates the maximum allowed rule level.
AttributeTypesSelector (dict) --
Configures information about the AttributeTypesSelector where the rule-based identity resolution uses to match profiles.
AttributeMatchingModel (string) --
Configures the AttributeMatchingModel, you can either choose ONE_TO_ONE or MANY_TO_MANY.
Address (list) --
The Address type. You can choose from Address, BusinessAddress, MaillingAddress, and ShippingAddress.
You only can use the Address type in the MatchingRule. For example, if you want to match profile based on BusinessAddress.City or MaillingAddress.City, you need to choose the BusinessAddress and the MaillingAddress to represent the Address type and specify the Address.City on the matching rule.
(string) --
PhoneNumber (list) --
The PhoneNumber type. You can choose from PhoneNumber, HomePhoneNumber, and MobilePhoneNumber.
You only can use the PhoneNumber type in the MatchingRule. For example, if you want to match a profile based on Phone or HomePhone, you need to choose the Phone and the HomePhone to represent the PhoneNumber type and only specify the PhoneNumber on the matching rule.
(string) --
EmailAddress (list) --
The Email type. You can choose from EmailAddress, BusinessEmailAddress and PersonalEmailAddress.
You only can use the EmailAddress type in the MatchingRule. For example, if you want to match profile based on PersonalEmailAddress or BusinessEmailAddress, you need to choose the PersonalEmailAddress and the BusinessEmailAddress to represent the EmailAddress type and only specify the EmailAddress on the matching rule.
(string) --
ConflictResolution (dict) --
How the auto-merging process should resolve conflicts between different profiles.
ConflictResolvingModel (string) --
How the auto-merging process should resolve conflicts between different profiles.
RECENCY: Uses the data that was most recently updated.
SOURCE: Uses the data from a specific source. For example, if a company has been aquired or two departments have merged, data from the specified source is used. If two duplicate profiles are from the same source, then RECENCY is used again.
SourceName (string) --
The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel.
ExportingConfig (dict) --
Configuration information about the S3 bucket where Identity Resolution Jobs writes result files.
S3Exporting (dict) --
The S3 location where Identity Resolution Jobs write result files.
S3BucketName (string) --
The name of the S3 bucket where Identity Resolution Jobs write result files.
S3KeyName (string) --
The S3 key name of the location where Identity Resolution Jobs write result files.
DataStore (dict) --
True if data store is enabled for this domain.
Enabled (boolean) --
True if data store is enabled for this domain
Readiness (dict) --
Information indicating if the Calculated Attribute is ready for use by confirming all historical data has been processed and reflected.
ProgressPercentage (integer) --
Approximately how far the Calculated Attribute creation is from completion.
Message (string) --
Any customer messaging.
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) --
{'Scope': 'PROFILE | DOMAIN'}
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',
],
'Scope': 'PROFILE'|'DOMAIN'
}
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) --
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.
{'SegmentSqlQuery': 'string', 'SegmentType': 'CLASSIC | ENHANCED'}
Gets a segment definition from the domain.
See also: AWS API Documentation
Request Syntax
client.get_segment_definition(
DomainName='string',
SegmentDefinitionName='string'
)
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The unique name of the segment definition.
dict
Response Syntax
{
'SegmentDefinitionName': 'string',
'DisplayName': 'string',
'Description': 'string',
'SegmentGroups': {
'Groups': [
{
'Dimensions': [
{
'ProfileAttributes': {
'AccountNumber': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'AdditionalInformation': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'FirstName': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'LastName': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'MiddleName': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'GenderString': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PartyTypeString': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'BirthDate': {
'DimensionType': 'BEFORE'|'AFTER'|'BETWEEN'|'NOT_BETWEEN'|'ON',
'Values': [
'string',
]
},
'PhoneNumber': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'BusinessName': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'BusinessPhoneNumber': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'HomePhoneNumber': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'MobilePhoneNumber': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'EmailAddress': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PersonalEmailAddress': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'BusinessEmailAddress': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Address': {
'City': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'County': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PostalCode': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Province': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'State': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
}
},
'ShippingAddress': {
'City': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'County': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PostalCode': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Province': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'State': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
}
},
'MailingAddress': {
'City': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'County': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PostalCode': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Province': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'State': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
}
},
'BillingAddress': {
'City': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'County': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PostalCode': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Province': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'State': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
}
},
'Attributes': {
'string': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH'|'BEFORE'|'AFTER'|'BETWEEN'|'NOT_BETWEEN'|'ON'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL'|'LESS_THAN_OR_EQUAL'|'EQUAL',
'Values': [
'string',
]
}
},
'ProfileType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'ACCOUNT_PROFILE'|'PROFILE',
]
}
},
'CalculatedAttributes': {
'string': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH'|'BEFORE'|'AFTER'|'BETWEEN'|'NOT_BETWEEN'|'ON'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL'|'LESS_THAN_OR_EQUAL'|'EQUAL',
'Values': [
'string',
],
'ConditionOverrides': {
'Range': {
'Start': 123,
'End': 123,
'Unit': 'DAYS'
}
}
}
}
},
],
'SourceSegments': [
{
'SegmentDefinitionName': 'string'
},
],
'SourceType': 'ALL'|'ANY'|'NONE',
'Type': 'ALL'|'ANY'|'NONE'
},
],
'Include': 'ALL'|'ANY'|'NONE'
},
'SegmentDefinitionArn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
},
'SegmentSqlQuery': 'string',
'SegmentType': 'CLASSIC'|'ENHANCED'
}
Response Structure
(dict) --
SegmentDefinitionName (string) --
The name of the segment definition.
DisplayName (string) --
The display name of the segment definition.
Description (string) --
The description of the segment definition.
SegmentGroups (dict) --
The segment criteria associated with this definition.
Groups (list) --
Holds the list of groups within the segment definition.
(dict) --
Contains dimensions that determine what to segment on.
Dimensions (list) --
Defines the attributes to segment on.
(dict) --
Object that holds what profile and calculated attributes to segment on.
ProfileAttributes (dict) --
Object that holds the profile attributes to segment on.
AccountNumber (dict) --
A field to describe values to segment on within account number.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
AdditionalInformation (dict) --
A field to describe values to segment on within additional information.
DimensionType (string) --
The action to segment with.
Values (list) --
The values to apply the DimensionType on.
(string) --
FirstName (dict) --
A field to describe values to segment on within first name.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
LastName (dict) --
A field to describe values to segment on within last name.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
MiddleName (dict) --
A field to describe values to segment on within middle name.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
GenderString (dict) --
A field to describe values to segment on within genderString.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
PartyTypeString (dict) --
A field to describe values to segment on within partyTypeString.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
BirthDate (dict) --
A field to describe values to segment on within birthDate.
DimensionType (string) --
The action to segment with.
Values (list) --
The values to apply the DimensionType on.
(string) --
PhoneNumber (dict) --
A field to describe values to segment on within phone number.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
BusinessName (dict) --
A field to describe values to segment on within business name.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
BusinessPhoneNumber (dict) --
A field to describe values to segment on within business phone number.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
HomePhoneNumber (dict) --
A field to describe values to segment on within home phone number.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
MobilePhoneNumber (dict) --
A field to describe values to segment on within mobile phone number.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
EmailAddress (dict) --
A field to describe values to segment on within email address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
PersonalEmailAddress (dict) --
A field to describe values to segment on within personal email address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
BusinessEmailAddress (dict) --
A field to describe values to segment on within business email address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
Address (dict) --
A field to describe values to segment on within address.
City (dict) --
The city belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
Country (dict) --
The country belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
County (dict) --
The county belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
PostalCode (dict) --
The postal code belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
Province (dict) --
The province belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
State (dict) --
The state belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
ShippingAddress (dict) --
A field to describe values to segment on within shipping address.
City (dict) --
The city belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
Country (dict) --
The country belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
County (dict) --
The county belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
PostalCode (dict) --
The postal code belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
Province (dict) --
The province belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
State (dict) --
The state belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
MailingAddress (dict) --
A field to describe values to segment on within mailing address.
City (dict) --
The city belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
Country (dict) --
The country belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
County (dict) --
The county belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
PostalCode (dict) --
The postal code belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
Province (dict) --
The province belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
State (dict) --
The state belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
BillingAddress (dict) --
A field to describe values to segment on within billing address.
City (dict) --
The city belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
Country (dict) --
The country belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
County (dict) --
The county belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
PostalCode (dict) --
The postal code belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
Province (dict) --
The province belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
State (dict) --
The state belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
Attributes (dict) --
A field to describe values to segment on within attributes.
(string) --
(dict) --
Object that segments on various Customer Profile's fields.
DimensionType (string) --
The action to segment with.
Values (list) --
The values to apply the DimensionType on.
(string) --
ProfileType (dict) --
A field to describe values to segment on within profile type.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
CalculatedAttributes (dict) --
Object that holds the calculated attributes to segment on.
(string) --
(dict) --
Object that segments on Customer Profile's Calculated Attributes.
DimensionType (string) --
The action to segment with.
Values (list) --
The values to apply the DimensionType with.
(string) --
ConditionOverrides (dict) --
Applies the given condition over the initial Calculated Attribute's definition.
Range (dict) --
The relative time period over which data is included in the aggregation for this override.
Start (integer) --
The start time of when to include objects.
End (integer) --
The end time of when to include objects.
Unit (string) --
The unit for start and end.
SourceSegments (list) --
Defines the starting source of data.
(dict) --
The source segments to build off of.
SegmentDefinitionName (string) --
The unique name of the segment definition.
SourceType (string) --
Defines how to interact with the source data.
Type (string) --
Defines how to interact with the profiles found in the current filtering.
Include (string) --
Defines whether to include or exclude the profiles that fit the segment criteria.
SegmentDefinitionArn (string) --
The arn of the segment definition.
CreatedAt (datetime) --
The timestamp of when the segment definition was created.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
SegmentSqlQuery (string) --
The segment SQL query.
SegmentType (string) --
The segment type.
Classic : Segments created using traditional SegmentGroup structure
Enhanced : Segments created using SQL queries
{'LastComputedAt': 'timestamp'}
Determines if the given profiles are within a segment.
See also: AWS API Documentation
Request Syntax
client.get_segment_membership(
DomainName='string',
SegmentDefinitionName='string',
ProfileIds=[
'string',
]
)
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The Id of the wanted segment. Needs to be a valid, and existing segment Id.
list
[REQUIRED]
The list of profile IDs to query for.
(string) --
dict
Response Syntax
{
'SegmentDefinitionName': 'string',
'Profiles': [
{
'ProfileId': 'string',
'QueryResult': 'PRESENT'|'ABSENT',
'Profile': {
'ProfileId': 'string',
'AccountNumber': 'string',
'AdditionalInformation': 'string',
'PartyType': 'INDIVIDUAL'|'BUSINESS'|'OTHER',
'BusinessName': 'string',
'FirstName': 'string',
'MiddleName': 'string',
'LastName': 'string',
'BirthDate': 'string',
'Gender': 'MALE'|'FEMALE'|'UNSPECIFIED',
'PhoneNumber': 'string',
'MobilePhoneNumber': 'string',
'HomePhoneNumber': 'string',
'BusinessPhoneNumber': 'string',
'EmailAddress': 'string',
'PersonalEmailAddress': 'string',
'BusinessEmailAddress': 'string',
'Address': {
'Address1': 'string',
'Address2': 'string',
'Address3': 'string',
'Address4': 'string',
'City': 'string',
'County': 'string',
'State': 'string',
'Province': 'string',
'Country': 'string',
'PostalCode': 'string'
},
'ShippingAddress': {
'Address1': 'string',
'Address2': 'string',
'Address3': 'string',
'Address4': 'string',
'City': 'string',
'County': 'string',
'State': 'string',
'Province': 'string',
'Country': 'string',
'PostalCode': 'string'
},
'MailingAddress': {
'Address1': 'string',
'Address2': 'string',
'Address3': 'string',
'Address4': 'string',
'City': 'string',
'County': 'string',
'State': 'string',
'Province': 'string',
'Country': 'string',
'PostalCode': 'string'
},
'BillingAddress': {
'Address1': 'string',
'Address2': 'string',
'Address3': 'string',
'Address4': 'string',
'City': 'string',
'County': 'string',
'State': 'string',
'Province': 'string',
'Country': 'string',
'PostalCode': 'string'
},
'Attributes': {
'string': 'string'
},
'FoundByItems': [
{
'KeyName': 'string',
'Values': [
'string',
]
},
],
'PartyTypeString': 'string',
'GenderString': 'string',
'ProfileType': 'ACCOUNT_PROFILE'|'PROFILE',
'EngagementPreferences': {
'Phone': [
{
'KeyName': 'string',
'KeyValue': 'string',
'ProfileId': 'string',
'ContactType': 'PhoneNumber'|'MobilePhoneNumber'|'HomePhoneNumber'|'BusinessPhoneNumber'|'EmailAddress'|'PersonalEmailAddress'|'BusinessEmailAddress'
},
],
'Email': [
{
'KeyName': 'string',
'KeyValue': 'string',
'ProfileId': 'string',
'ContactType': 'PhoneNumber'|'MobilePhoneNumber'|'HomePhoneNumber'|'BusinessPhoneNumber'|'EmailAddress'|'PersonalEmailAddress'|'BusinessEmailAddress'
},
]
}
}
},
],
'Failures': [
{
'ProfileId': 'string',
'Message': 'string',
'Status': 123
},
],
'LastComputedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
SegmentDefinitionName (string) --
The unique name of the segment definition.
Profiles (list) --
An array of maps where each contains a response per profile requested.
(dict) --
Object that holds the results for membership.
ProfileId (string) --
The profile id the result belongs to.
QueryResult (string) --
Describes whether the profile was absent or present in the segment.
Profile (dict) --
The standard profile of a customer.
ProfileId (string) --
The unique identifier of a customer profile.
AccountNumber (string) --
An account number that you have assigned to the customer.
AdditionalInformation (string) --
Any additional information relevant to the customer’s profile.
PartyType (string) --
The type of profile used to describe the customer.
BusinessName (string) --
The name of the customer’s business.
FirstName (string) --
The customer’s first name.
MiddleName (string) --
The customer’s middle name.
LastName (string) --
The customer’s last name.
BirthDate (string) --
The customer’s birth date.
Gender (string) --
The gender with which the customer identifies.
PhoneNumber (string) --
The customer's phone number, which has not been specified as a mobile, home, or business number.
MobilePhoneNumber (string) --
The customer’s mobile phone number.
HomePhoneNumber (string) --
The customer’s home phone number.
BusinessPhoneNumber (string) --
The customer’s home phone number.
EmailAddress (string) --
The customer’s email address, which has not been specified as a personal or business address.
PersonalEmailAddress (string) --
The customer’s personal email address.
BusinessEmailAddress (string) --
The customer’s business email address.
Address (dict) --
A generic address associated with the customer that is not mailing, shipping, or billing.
Address1 (string) --
The first line of a customer address.
Address2 (string) --
The second line of a customer address.
Address3 (string) --
The third line of a customer address.
Address4 (string) --
The fourth line of a customer address.
City (string) --
The city in which a customer lives.
County (string) --
The county in which a customer lives.
State (string) --
The state in which a customer lives.
Province (string) --
The province in which a customer lives.
Country (string) --
The country in which a customer lives.
PostalCode (string) --
The postal code of a customer address.
ShippingAddress (dict) --
The customer’s shipping address.
Address1 (string) --
The first line of a customer address.
Address2 (string) --
The second line of a customer address.
Address3 (string) --
The third line of a customer address.
Address4 (string) --
The fourth line of a customer address.
City (string) --
The city in which a customer lives.
County (string) --
The county in which a customer lives.
State (string) --
The state in which a customer lives.
Province (string) --
The province in which a customer lives.
Country (string) --
The country in which a customer lives.
PostalCode (string) --
The postal code of a customer address.
MailingAddress (dict) --
The customer’s mailing address.
Address1 (string) --
The first line of a customer address.
Address2 (string) --
The second line of a customer address.
Address3 (string) --
The third line of a customer address.
Address4 (string) --
The fourth line of a customer address.
City (string) --
The city in which a customer lives.
County (string) --
The county in which a customer lives.
State (string) --
The state in which a customer lives.
Province (string) --
The province in which a customer lives.
Country (string) --
The country in which a customer lives.
PostalCode (string) --
The postal code of a customer address.
BillingAddress (dict) --
The customer’s billing address.
Address1 (string) --
The first line of a customer address.
Address2 (string) --
The second line of a customer address.
Address3 (string) --
The third line of a customer address.
Address4 (string) --
The fourth line of a customer address.
City (string) --
The city in which a customer lives.
County (string) --
The county in which a customer lives.
State (string) --
The state in which a customer lives.
Province (string) --
The province in which a customer lives.
Country (string) --
The country in which a customer lives.
PostalCode (string) --
The postal code of a customer address.
Attributes (dict) --
A key value pair of attributes of a customer profile.
(string) --
(string) --
FoundByItems (list) --
A list of items used to find a profile returned in a SearchProfiles response. An item is a key-value(s) pair that matches an attribute in the profile.
If the optional AdditionalSearchKeys parameter was included in the SearchProfiles request, the FoundByItems list should be interpreted based on the LogicalOperator used in the request:
AND - The profile included in the response matched all of the search keys specified in the request. The FoundByItems will include all of the key-value(s) pairs that were specified in the request (as this is a requirement of AND search logic).
OR - The profile included in the response matched at least one of the search keys specified in the request. The FoundByItems will include each of the key-value(s) pairs that the profile was found by.
The OR relationship is the default behavior if the LogicalOperator parameter is not included in the SearchProfiles request.
(dict) --
A data type pair that consists of a KeyName and Values list that were used to find a profile returned in response to a SearchProfiles request.
KeyName (string) --
A searchable identifier of a customer profile.
Values (list) --
A list of key values.
(string) --
PartyTypeString (string) --
An alternative to PartyType which accepts any string as input.
GenderString (string) --
An alternative to Gender which accepts any string as input.
ProfileType (string) --
The type of the profile.
EngagementPreferences (dict) --
The customer or account’s engagement preferences.
Phone (list) --
A list of phone-related contact preferences
(dict) --
Object that defines users contact preference.
KeyName (string) --
A searchable, unique identifier of a customer profile.
KeyValue (string) --
The key value used to look up profile based off the keyName.
ProfileId (string) --
The unique identifier of a customer profile.
ContactType (string) --
The contact type used for engagement. For example: HomePhoneNumber, PersonalEmailAddress.
Email (list) --
A list of email-related contact preferences
(dict) --
Object that defines users contact preference.
KeyName (string) --
A searchable, unique identifier of a customer profile.
KeyValue (string) --
The key value used to look up profile based off the keyName.
ProfileId (string) --
The unique identifier of a customer profile.
ContactType (string) --
The contact type used for engagement. For example: HomePhoneNumber, PersonalEmailAddress.
Failures (list) --
An array of maps where each contains a response per profile failed for the request.
(dict) --
Object that holds failures for membership.
ProfileId (string) --
The profile id the failure belongs to.
Message (string) --
A message describing the failure.
Status (integer) --
The status describing the failure.
LastComputedAt (datetime) --
The timestamp indicating when the segment membership was last computed or updated.
{'Items': {'Scope': 'PROFILE | DOMAIN'}}
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',
],
'Scope': 'PROFILE'|'DOMAIN'
},
],
'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 integration 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) --
Scope (string) --
The scope or boundary of the integration item's applicability.
NextToken (string) --
The pagination token from the previous ListAccountIntegrations API call.
{'Items': {'Scope': 'PROFILE | DOMAIN'}}
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',
],
'Scope': 'PROFILE'|'DOMAIN'
},
],
'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 integration 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) --
Scope (string) --
The scope or boundary of the integration item's applicability.
NextToken (string) --
The pagination token from the previous ListIntegrations API call.
{'Items': {'SegmentType': 'CLASSIC | ENHANCED'}}
Lists all segment definitions under a domain.
See also: AWS API Documentation
Request Syntax
client.list_segment_definitions(
DomainName='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The unique identifier of the domain.
integer
The maximum number of objects returned per page.
string
The pagination token from the previous call.
dict
Response Syntax
{
'NextToken': 'string',
'Items': [
{
'SegmentDefinitionName': 'string',
'DisplayName': 'string',
'Description': 'string',
'SegmentDefinitionArn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
},
'SegmentType': 'CLASSIC'|'ENHANCED'
},
]
}
Response Structure
(dict) --
NextToken (string) --
The pagination token from the previous call.
Items (list) --
List of segment definitions.
(dict) --
Object holding the segment definition fields.
SegmentDefinitionName (string) --
Name of the segment definition.
DisplayName (string) --
Display name of the segment definition.
Description (string) --
The description of the segment definition.
SegmentDefinitionArn (string) --
The arn of the segment definition.
CreatedAt (datetime) --
When the segment definition was created.
Tags (dict) --
The tags belonging to the segment definition.
(string) --
(string) --
SegmentType (string) --
The segment type.
Classic : Segments created using traditional SegmentGroup structure
Enhanced : Segments created using SQL queries
{'Scope': 'PROFILE | DOMAIN'}
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',
ObjectTypeNames={
'string': '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)
}
}
}
},
RoleArn='string',
EventTriggerNames=[
'string',
],
Scope='PROFILE'|'DOMAIN'
)
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
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) --
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.
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) --
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.
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',
],
'Scope': 'PROFILE'|'DOMAIN'
}
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) --
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.
{'DataStore': {'Enabled': 'boolean'}}
Response {'DataStore': {'Enabled': 'boolean',
'Readiness': {'Message': 'string',
'ProgressPercentage': 'integer'}}}
Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption key.
After a domain is created, the name can’t be changed.
Use this API or CreateDomain to enable identity resolution: set Matching to true.
To prevent cross-service impersonation when you call this API, see Cross-service confused deputy prevention for sample policies that you should apply.
To add or remove tags on an existing Domain, see TagResource/ UntagResource.
See also: AWS API Documentation
Request Syntax
client.update_domain(
DomainName='string',
DefaultExpirationDays=123,
DefaultEncryptionKey='string',
DeadLetterQueueUrl='string',
Matching={
'Enabled': True|False,
'JobSchedule': {
'DayOfTheWeek': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
'Time': 'string'
},
'AutoMerging': {
'Enabled': True|False,
'Consolidation': {
'MatchingAttributesList': [
[
'string',
],
]
},
'ConflictResolution': {
'ConflictResolvingModel': 'RECENCY'|'SOURCE',
'SourceName': 'string'
},
'MinAllowedConfidenceScoreForMerging': 123.0
},
'ExportingConfig': {
'S3Exporting': {
'S3BucketName': 'string',
'S3KeyName': 'string'
}
}
},
RuleBasedMatching={
'Enabled': True|False,
'MatchingRules': [
{
'Rule': [
'string',
]
},
],
'MaxAllowedRuleLevelForMerging': 123,
'MaxAllowedRuleLevelForMatching': 123,
'AttributeTypesSelector': {
'AttributeMatchingModel': 'ONE_TO_ONE'|'MANY_TO_MANY',
'Address': [
'string',
],
'PhoneNumber': [
'string',
],
'EmailAddress': [
'string',
]
},
'ConflictResolution': {
'ConflictResolvingModel': 'RECENCY'|'SOURCE',
'SourceName': 'string'
},
'ExportingConfig': {
'S3Exporting': {
'S3BucketName': 'string',
'S3KeyName': 'string'
}
}
},
DataStore={
'Enabled': True|False
},
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The unique name of the domain.
integer
The default number of days until the data within the domain expires.
string
The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage. If specified as an empty string, it will clear any existing value.
string
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. If specified as an empty string, it will clear any existing value. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue.
dict
The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.
After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.
Enabled (boolean) -- [REQUIRED]
The flag that enables the matching process of duplicate profiles.
JobSchedule (dict) --
The day and time when do you want to start the Identity Resolution Job every week.
DayOfTheWeek (string) -- [REQUIRED]
The day when the Identity Resolution Job should run every week.
Time (string) -- [REQUIRED]
The time when the Identity Resolution Job should run every week.
AutoMerging (dict) --
Configuration information about the auto-merging process.
Enabled (boolean) -- [REQUIRED]
The flag that enables the auto-merging of duplicate profiles.
Consolidation (dict) --
A list of matching attributes that represent matching criteria. If two profiles meet at least one of the requirements in the matching attributes list, they will be merged.
MatchingAttributesList (list) -- [REQUIRED]
A list of matching criteria.
(list) --
(string) --
ConflictResolution (dict) --
How the auto-merging process should resolve conflicts between different profiles. For example, if Profile A and Profile B have the same FirstName and LastName (and that is the matching criteria), which EmailAddress should be used?
ConflictResolvingModel (string) -- [REQUIRED]
How the auto-merging process should resolve conflicts between different profiles.
RECENCY: Uses the data that was most recently updated.
SOURCE: Uses the data from a specific source. For example, if a company has been aquired or two departments have merged, data from the specified source is used. If two duplicate profiles are from the same source, then RECENCY is used again.
SourceName (string) --
The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel.
MinAllowedConfidenceScoreForMerging (float) --
A number between 0 and 1 that represents the minimum confidence score required for profiles within a matching group to be merged during the auto-merge process. A higher score means higher similarity required to merge profiles.
ExportingConfig (dict) --
Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.
S3Exporting (dict) --
The S3 location where Identity Resolution Jobs write result files.
S3BucketName (string) -- [REQUIRED]
The name of the S3 bucket where Identity Resolution Jobs write result files.
S3KeyName (string) --
The S3 key name of the location where Identity Resolution Jobs write result files.
dict
The process of matching duplicate profiles using the rule-Based matching. If RuleBasedMatching = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3.
Enabled (boolean) -- [REQUIRED]
The flag that enables the rule-based matching process of duplicate profiles.
MatchingRules (list) --
Configures how the rule-based matching process should match profiles. You can have up to 15 MatchingRule in the MatchingRules.
(dict) --
Specifies how does the rule-based matching process should match profiles. You can choose from the following attributes to build the matching Rule:
AccountNumber
Address.Address
Address.City
Address.Country
Address.County
Address.PostalCode
Address.State
Address.Province
BirthDate
BusinessName
EmailAddress
FirstName
Gender
LastName
MiddleName
PhoneNumber
Any customized profile attributes that start with the Attributes
Rule (list) -- [REQUIRED]
A single rule level of the MatchRules. Configures how the rule-based matching process should match profiles.
(string) --
MaxAllowedRuleLevelForMerging (integer) --
MaxAllowedRuleLevelForMatching (integer) --
Indicates the maximum allowed rule level.
AttributeTypesSelector (dict) --
Configures information about the AttributeTypesSelector where the rule-based identity resolution uses to match profiles.
AttributeMatchingModel (string) -- [REQUIRED]
Configures the AttributeMatchingModel, you can either choose ONE_TO_ONE or MANY_TO_MANY.
Address (list) --
The Address type. You can choose from Address, BusinessAddress, MaillingAddress, and ShippingAddress.
You only can use the Address type in the MatchingRule. For example, if you want to match profile based on BusinessAddress.City or MaillingAddress.City, you need to choose the BusinessAddress and the MaillingAddress to represent the Address type and specify the Address.City on the matching rule.
(string) --
PhoneNumber (list) --
The PhoneNumber type. You can choose from PhoneNumber, HomePhoneNumber, and MobilePhoneNumber.
You only can use the PhoneNumber type in the MatchingRule. For example, if you want to match a profile based on Phone or HomePhone, you need to choose the Phone and the HomePhone to represent the PhoneNumber type and only specify the PhoneNumber on the matching rule.
(string) --
EmailAddress (list) --
The Email type. You can choose from EmailAddress, BusinessEmailAddress and PersonalEmailAddress.
You only can use the EmailAddress type in the MatchingRule. For example, if you want to match profile based on PersonalEmailAddress or BusinessEmailAddress, you need to choose the PersonalEmailAddress and the BusinessEmailAddress to represent the EmailAddress type and only specify the EmailAddress on the matching rule.
(string) --
ConflictResolution (dict) --
How the auto-merging process should resolve conflicts between different profiles.
ConflictResolvingModel (string) -- [REQUIRED]
How the auto-merging process should resolve conflicts between different profiles.
RECENCY: Uses the data that was most recently updated.
SOURCE: Uses the data from a specific source. For example, if a company has been aquired or two departments have merged, data from the specified source is used. If two duplicate profiles are from the same source, then RECENCY is used again.
SourceName (string) --
The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel.
ExportingConfig (dict) --
Configuration information about the S3 bucket where Identity Resolution Jobs writes result files.
S3Exporting (dict) --
The S3 location where Identity Resolution Jobs write result files.
S3BucketName (string) -- [REQUIRED]
The name of the S3 bucket where Identity Resolution Jobs write result files.
S3KeyName (string) --
The S3 key name of the location where Identity Resolution Jobs write result files.
dict
Set to true to enabled data store for this domain.
Enabled (boolean) --
Enabled: Set to true to enabled data store for this domain.
dict
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
dict
Response Syntax
{
'DomainName': 'string',
'DefaultExpirationDays': 123,
'DefaultEncryptionKey': 'string',
'DeadLetterQueueUrl': 'string',
'Matching': {
'Enabled': True|False,
'JobSchedule': {
'DayOfTheWeek': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
'Time': 'string'
},
'AutoMerging': {
'Enabled': True|False,
'Consolidation': {
'MatchingAttributesList': [
[
'string',
],
]
},
'ConflictResolution': {
'ConflictResolvingModel': 'RECENCY'|'SOURCE',
'SourceName': 'string'
},
'MinAllowedConfidenceScoreForMerging': 123.0
},
'ExportingConfig': {
'S3Exporting': {
'S3BucketName': 'string',
'S3KeyName': 'string'
}
}
},
'RuleBasedMatching': {
'Enabled': True|False,
'MatchingRules': [
{
'Rule': [
'string',
]
},
],
'Status': 'PENDING'|'IN_PROGRESS'|'ACTIVE',
'MaxAllowedRuleLevelForMerging': 123,
'MaxAllowedRuleLevelForMatching': 123,
'AttributeTypesSelector': {
'AttributeMatchingModel': 'ONE_TO_ONE'|'MANY_TO_MANY',
'Address': [
'string',
],
'PhoneNumber': [
'string',
],
'EmailAddress': [
'string',
]
},
'ConflictResolution': {
'ConflictResolvingModel': 'RECENCY'|'SOURCE',
'SourceName': 'string'
},
'ExportingConfig': {
'S3Exporting': {
'S3BucketName': 'string',
'S3KeyName': 'string'
}
}
},
'DataStore': {
'Enabled': True|False,
'Readiness': {
'ProgressPercentage': 123,
'Message': 'string'
}
},
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
DomainName (string) --
The unique name of the domain.
DefaultExpirationDays (integer) --
The default number of days until the data within the domain expires.
DefaultEncryptionKey (string) --
The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.
DeadLetterQueueUrl (string) --
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
Matching (dict) --
The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.
After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.
Enabled (boolean) --
The flag that enables the matching process of duplicate profiles.
JobSchedule (dict) --
The day and time when do you want to start the Identity Resolution Job every week.
DayOfTheWeek (string) --
The day when the Identity Resolution Job should run every week.
Time (string) --
The time when the Identity Resolution Job should run every week.
AutoMerging (dict) --
Configuration information about the auto-merging process.
Enabled (boolean) --
The flag that enables the auto-merging of duplicate profiles.
Consolidation (dict) --
A list of matching attributes that represent matching criteria. If two profiles meet at least one of the requirements in the matching attributes list, they will be merged.
MatchingAttributesList (list) --
A list of matching criteria.
(list) --
(string) --
ConflictResolution (dict) --
How the auto-merging process should resolve conflicts between different profiles. For example, if Profile A and Profile B have the same FirstName and LastName (and that is the matching criteria), which EmailAddress should be used?
ConflictResolvingModel (string) --
How the auto-merging process should resolve conflicts between different profiles.
RECENCY: Uses the data that was most recently updated.
SOURCE: Uses the data from a specific source. For example, if a company has been aquired or two departments have merged, data from the specified source is used. If two duplicate profiles are from the same source, then RECENCY is used again.
SourceName (string) --
The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel.
MinAllowedConfidenceScoreForMerging (float) --
A number between 0 and 1 that represents the minimum confidence score required for profiles within a matching group to be merged during the auto-merge process. A higher score means higher similarity required to merge profiles.
ExportingConfig (dict) --
Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.
S3Exporting (dict) --
The S3 location where Identity Resolution Jobs write result files.
S3BucketName (string) --
The name of the S3 bucket where Identity Resolution Jobs write result files.
S3KeyName (string) --
The S3 key name of the location where Identity Resolution Jobs write result files.
RuleBasedMatching (dict) --
The process of matching duplicate profiles using the rule-Based matching. If RuleBasedMatching = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3.
Enabled (boolean) --
The flag that enables the rule-based matching process of duplicate profiles.
MatchingRules (list) --
Configures how the rule-based matching process should match profiles. You can have up to 15 MatchingRule in the MatchingRules.
(dict) --
Specifies how does the rule-based matching process should match profiles. You can choose from the following attributes to build the matching Rule:
AccountNumber
Address.Address
Address.City
Address.Country
Address.County
Address.PostalCode
Address.State
Address.Province
BirthDate
BusinessName
EmailAddress
FirstName
Gender
LastName
MiddleName
PhoneNumber
Any customized profile attributes that start with the Attributes
Rule (list) --
A single rule level of the MatchRules. Configures how the rule-based matching process should match profiles.
(string) --
Status (string) --
PENDING
The first status after configuration a rule-based matching rule. If it is an existing domain, the rule-based Identity Resolution waits one hour before creating the matching rule. If it is a new domain, the system will skip the PENDING stage.
IN_PROGRESS
The system is creating the rule-based matching rule. Under this status, the system is evaluating the existing data and you can no longer change the Rule-based matching configuration.
ACTIVE
The rule is ready to use. You can change the rule a day after the status is in ACTIVE.
MaxAllowedRuleLevelForMerging (integer) --
MaxAllowedRuleLevelForMatching (integer) --
Indicates the maximum allowed rule level.
AttributeTypesSelector (dict) --
Configures information about the AttributeTypesSelector where the rule-based identity resolution uses to match profiles.
AttributeMatchingModel (string) --
Configures the AttributeMatchingModel, you can either choose ONE_TO_ONE or MANY_TO_MANY.
Address (list) --
The Address type. You can choose from Address, BusinessAddress, MaillingAddress, and ShippingAddress.
You only can use the Address type in the MatchingRule. For example, if you want to match profile based on BusinessAddress.City or MaillingAddress.City, you need to choose the BusinessAddress and the MaillingAddress to represent the Address type and specify the Address.City on the matching rule.
(string) --
PhoneNumber (list) --
The PhoneNumber type. You can choose from PhoneNumber, HomePhoneNumber, and MobilePhoneNumber.
You only can use the PhoneNumber type in the MatchingRule. For example, if you want to match a profile based on Phone or HomePhone, you need to choose the Phone and the HomePhone to represent the PhoneNumber type and only specify the PhoneNumber on the matching rule.
(string) --
EmailAddress (list) --
The Email type. You can choose from EmailAddress, BusinessEmailAddress and PersonalEmailAddress.
You only can use the EmailAddress type in the MatchingRule. For example, if you want to match profile based on PersonalEmailAddress or BusinessEmailAddress, you need to choose the PersonalEmailAddress and the BusinessEmailAddress to represent the EmailAddress type and only specify the EmailAddress on the matching rule.
(string) --
ConflictResolution (dict) --
How the auto-merging process should resolve conflicts between different profiles.
ConflictResolvingModel (string) --
How the auto-merging process should resolve conflicts between different profiles.
RECENCY: Uses the data that was most recently updated.
SOURCE: Uses the data from a specific source. For example, if a company has been aquired or two departments have merged, data from the specified source is used. If two duplicate profiles are from the same source, then RECENCY is used again.
SourceName (string) --
The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel.
ExportingConfig (dict) --
Configuration information about the S3 bucket where Identity Resolution Jobs writes result files.
S3Exporting (dict) --
The S3 location where Identity Resolution Jobs write result files.
S3BucketName (string) --
The name of the S3 bucket where Identity Resolution Jobs write result files.
S3KeyName (string) --
The S3 key name of the location where Identity Resolution Jobs write result files.
DataStore (dict) --
The data store.
Enabled (boolean) --
True if data store is enabled for this domain
Readiness (dict) --
Information indicating if the Calculated Attribute is ready for use by confirming all historical data has been processed and reflected.
ProgressPercentage (integer) --
Approximately how far the Calculated Attribute creation is from completion.
Message (string) --
Any customer messaging.
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) --