2024/11/18 - Amazon Connect Customer Profiles - 13 new6 updated api methods
Changes This release introduces Segmentation APIs and new Calculated Attribute Event Filters as part of Amazon Connect Customer Profiles service.
Deletes a segment definition from the domain.
See also: AWS API Documentation
Request Syntax
client.delete_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
{
'Message': 'string'
}
Response Structure
(dict) --
Message (string) --
A message that indicates the delete request is done.
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',
]
}
}
},
'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'
}
}
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) --
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) --
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'
}
},
],
'Failures': [
{
'ProfileId': 'string',
'Message': 'string',
'Status': 123
},
]
}
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 given 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.
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.
Retrieve the latest status of a segment snapshot.
See also: AWS API Documentation
Request Syntax
client.get_segment_snapshot(
DomainName='string',
SegmentDefinitionName='string',
SnapshotId='string'
)
string
[REQUIRED]
The unique identifier of the domain.
string
[REQUIRED]
The unique name of the segment definition.
string
[REQUIRED]
The unique identifier of the segment snapshot.
dict
Response Syntax
{
'SnapshotId': 'string',
'Status': 'COMPLETED'|'IN_PROGRESS'|'FAILED',
'StatusMessage': 'string',
'DataFormat': 'CSV'|'JSONL'|'ORC',
'EncryptionKey': 'string',
'RoleArn': 'string',
'DestinationUri': 'string'
}
Response Structure
(dict) --
SnapshotId (string) --
The unique identifier of the segment snapshot.
Status (string) --
The status of the asynchronous job for exporting the segment snapshot.
StatusMessage (string) --
The status message of the asynchronous job for exporting the segment snapshot.
DataFormat (string) --
The format in which the segment will be exported.
EncryptionKey (string) --
The Amazon Resource Name (ARN) of the KMS key used to encrypt the exported segment.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that allows Customer Profiles service principal to assume the role for conducting KMS and S3 operations.
DestinationUri (string) --
The destination to which the segment will be exported. This field must be provided if the request is not submitted from the Amazon Connect Admin Website.
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',
]
}
}
},
'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'
}
)
string
[REQUIRED]
The unique name of the domain.
dict
[REQUIRED]
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) --
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.
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.
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',
]
}
}
},
'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'
},
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
[REQUIRED]
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) --
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.
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) --
Fetch the possible attribute values given the attribute name.
See also: AWS API Documentation
Request Syntax
client.list_object_type_attributes(
NextToken='string',
MaxResults=123,
DomainName='string',
ObjectTypeName='string'
)
string
The pagination token from the previous call.
integer
The maximum number of objects returned per page.
string
[REQUIRED]
The unique identifier of the domain.
string
[REQUIRED]
The name of the profile object type.
dict
Response Syntax
{
'Items': [
{
'AttributeName': 'string',
'LastUpdatedAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The items returned as part of the response.
(dict) --
Item that contains the attribute and when it was last updated.
AttributeName (string) --
Name of the attribute.
LastUpdatedAt (datetime) --
When the attribute was last updated.
NextToken (string) --
The pagination token from the previous call.
Gets the result of a segment estimate query.
See also: AWS API Documentation
Request Syntax
client.get_segment_estimate(
DomainName='string',
EstimateId='string'
)
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The query Id passed by a previous CreateSegmentEstimate operation.
dict
Response Syntax
{
'DomainName': 'string',
'EstimateId': 'string',
'Status': 'RUNNING'|'SUCCEEDED'|'FAILED',
'Estimate': 'string',
'Message': 'string',
'StatusCode': 123
}
Response Structure
(dict) --
DomainName (string) --
The unique name of the domain.
EstimateId (string) --
The QueryId which is the same as the value passed in QueryId.
Status (string) --
The current status of the query.
Estimate (string) --
The estimated number of profiles contained in the segment.
Message (string) --
The error message if there is any error.
StatusCode (integer) --
The status code of the segment estimate.
Fetch the possible attribute values given the attribute name.
See also: AWS API Documentation
Request Syntax
client.list_profile_attribute_values(
DomainName='string',
AttributeName='string'
)
string
[REQUIRED]
The unique identifier of the domain.
string
[REQUIRED]
The attribute name.
dict
Response Syntax
{
'DomainName': 'string',
'AttributeName': 'string',
'Items': [
{
'Value': 'string'
},
],
'StatusCode': 123
}
Response Structure
(dict) --
DomainName (string) --
The name of the domain.
AttributeName (string) --
The attribute name.
Items (list) --
The items returned as part of the response.
(dict) --
List containing the values for the given attribute.
Value (string) --
An individual value belonging to the given attribute.
StatusCode (integer) --
The status code for the response.
Triggers a job to export a segment to a specified destination.
See also: AWS API Documentation
Request Syntax
client.create_segment_snapshot(
DomainName='string',
SegmentDefinitionName='string',
DataFormat='CSV'|'JSONL'|'ORC',
EncryptionKey='string',
RoleArn='string',
DestinationUri='string'
)
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The name of the segment definition used in this snapshot request.
string
[REQUIRED]
The format in which the segment will be exported.
string
The Amazon Resource Name (ARN) of the KMS key used to encrypt the exported segment.
string
The Amazon Resource Name (ARN) of the IAM role that allows Customer Profiles service principal to assume the role for conducting KMS and S3 operations.
string
The destination to which the segment will be exported. This field must be provided if the request is not submitted from the Amazon Connect Admin Website.
dict
Response Syntax
{
'SnapshotId': 'string'
}
Response Structure
(dict) --
SnapshotId (string) --
The unique identifier of the segment snapshot.
Fetch the possible attribute values given the attribute name.
See also: AWS API Documentation
Request Syntax
client.batch_get_calculated_attribute_for_profile(
CalculatedAttributeName='string',
DomainName='string',
ProfileIds=[
'string',
],
ConditionOverrides={
'Range': {
'Start': 123,
'End': 123,
'Unit': 'DAYS'
}
}
)
string
[REQUIRED]
The unique name of the calculated attribute.
string
[REQUIRED]
The unique name of the domain.
list
[REQUIRED]
List of unique identifiers for customer profiles to retrieve.
(string) --
dict
Overrides the condition block within the original calculated attribute 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.
dict
Response Syntax
{
'Errors': [
{
'Code': 'string',
'Message': 'string',
'ProfileId': 'string'
},
],
'CalculatedAttributeValues': [
{
'CalculatedAttributeName': 'string',
'DisplayName': 'string',
'IsDataPartial': 'string',
'ProfileId': 'string',
'Value': 'string'
},
],
'ConditionOverrides': {
'Range': {
'Start': 123,
'End': 123,
'Unit': 'DAYS'
}
}
}
Response Structure
(dict) --
Errors (list) --
List of errors for calculated attribute values that could not be retrieved.
(dict) --
Error object describing why a specific profile and calculated attribute failed.
Code (string) --
Status code for why a specific profile and calculated attribute failed.
Message (string) --
Message describing why a specific profile and calculated attribute failed.
ProfileId (string) --
The profile id that failed.
CalculatedAttributeValues (list) --
List of calculated attribute values retrieved.
(dict) --
The object containing the values of a single calculated attribute value.
CalculatedAttributeName (string) --
The unique name of the calculated attribute.
DisplayName (string) --
The display name of the calculated attribute.
IsDataPartial (string) --
Indicates whether the calculated attribute's value is based on partial data. If the data is partial, it is set to true.
ProfileId (string) --
The profile id belonging to this calculated attribute value.
Value (string) --
The value of the calculated attribute.
ConditionOverrides (dict) --
Overrides the condition block within the original calculated attribute 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.
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'
}
},
]
}
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) --
Get a batch of profiles.
See also: AWS API Documentation
Request Syntax
client.batch_get_profile(
DomainName='string',
ProfileIds=[
'string',
]
)
string
[REQUIRED]
The unique name of the domain.
list
[REQUIRED]
List of unique identifiers for customer profiles to retrieve.
(string) --
dict
Response Syntax
{
'Errors': [
{
'Code': 'string',
'Message': 'string',
'ProfileId': 'string'
},
],
'Profiles': [
{
'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'
},
]
}
Response Structure
(dict) --
Errors (list) --
For information about the errors that are common to all actions, see Common Errors.
(dict) --
Error object describing why a specific profile failed.
Code (string) --
Status code for why a specific profile failed.
Message (string) --
Message describing why a specific profile failed.
ProfileId (string) --
The profile id that failed.
Profiles (list) --
Array of Profile Objects.
(dict) --
The standard profile of a customer.
ProfileId (string) --
The unique identifier of a customer profile.
AccountNumber (string) --
An account number that you have given 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.
{'Filter': {'Groups': [{'Dimensions': [{'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']}}}],
'Type': 'ALL | ANY | NONE'}],
'Include': 'ALL | ANY | NONE'}}
Creates a new calculated attribute definition. After creation, new object data ingested into Customer Profiles will be included in the calculated attribute, which can be retrieved for a profile using the GetCalculatedAttributeForProfile API. Defining a calculated attribute makes it available for all profiles within a domain. Each calculated attribute can only reference one ObjectType and at most, two fields from that ObjectType.
See also: AWS API Documentation
Request Syntax
client.create_calculated_attribute_definition(
DomainName='string',
CalculatedAttributeName='string',
DisplayName='string',
Description='string',
AttributeDetails={
'Attributes': [
{
'Name': 'string'
},
],
'Expression': 'string'
},
Conditions={
'Range': {
'Value': 123,
'Unit': 'DAYS'
},
'ObjectCount': 123,
'Threshold': {
'Value': 'string',
'Operator': 'EQUAL_TO'|'GREATER_THAN'|'LESS_THAN'|'NOT_EQUAL_TO'
}
},
Filter={
'Include': 'ALL'|'ANY'|'NONE',
'Groups': [
{
'Type': 'ALL'|'ANY'|'NONE',
'Dimensions': [
{
'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',
]
}
}
},
]
},
]
},
Statistic='FIRST_OCCURRENCE'|'LAST_OCCURRENCE'|'COUNT'|'SUM'|'MINIMUM'|'MAXIMUM'|'AVERAGE'|'MAX_OCCURRENCE',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The unique name of the calculated attribute.
string
The display name of the calculated attribute.
string
The description of the calculated attribute.
dict
[REQUIRED]
Mathematical expression and a list of attribute items specified in that expression.
Attributes (list) -- [REQUIRED]
A list of attribute items specified in the mathematical expression.
(dict) --
The details of a single attribute item specified in the mathematical expression.
Name (string) -- [REQUIRED]
The name of an attribute defined in a profile object type.
Expression (string) -- [REQUIRED]
Mathematical expression that is performed on attribute items provided in the attribute list. Each element in the expression should follow the structure of "{ObjectTypeName.AttributeName}".
dict
The conditions including range, object count, and threshold for the calculated attribute.
Range (dict) --
The relative time period over which data is included in the aggregation.
Value (integer) -- [REQUIRED]
The amount of time of the specified unit.
Unit (string) -- [REQUIRED]
The unit of time.
ObjectCount (integer) --
The number of profile objects used for the calculated attribute.
Threshold (dict) --
The threshold for the calculated attribute.
Value (string) -- [REQUIRED]
The value of the threshold.
Operator (string) -- [REQUIRED]
The operator of the threshold.
dict
Defines how to filter incoming objects to include part of the Calculated Attribute.
Include (string) -- [REQUIRED]
Define whether to include or exclude objects for Calculated Attributed calculation that fit the filter groups criteria.
Groups (list) -- [REQUIRED]
Holds the list of Filter groups within the Filter definition.
(dict) --
Object that holds the dimensions to filter on.
Type (string) -- [REQUIRED]
The type of logical relationship between the dimensions of the Filter group.
Dimensions (list) -- [REQUIRED]
Object that holds the attributes to filter on.
(dict) --
Contains the map of attribute names to attribute dimensions.
Attributes (dict) -- [REQUIRED]
Is the attribute within the FilterDimension map
(string) --
(dict) --
Object that defines how to filter the incoming objects for the calculated attribute.
DimensionType (string) -- [REQUIRED]
The action to filter with.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
string
[REQUIRED]
The aggregation operation to perform for the calculated attribute.
dict
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
dict
Response Syntax
{
'CalculatedAttributeName': 'string',
'DisplayName': 'string',
'Description': 'string',
'AttributeDetails': {
'Attributes': [
{
'Name': 'string'
},
],
'Expression': 'string'
},
'Conditions': {
'Range': {
'Value': 123,
'Unit': 'DAYS'
},
'ObjectCount': 123,
'Threshold': {
'Value': 'string',
'Operator': 'EQUAL_TO'|'GREATER_THAN'|'LESS_THAN'|'NOT_EQUAL_TO'
}
},
'Filter': {
'Include': 'ALL'|'ANY'|'NONE',
'Groups': [
{
'Type': 'ALL'|'ANY'|'NONE',
'Dimensions': [
{
'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',
]
}
}
},
]
},
]
},
'Statistic': 'FIRST_OCCURRENCE'|'LAST_OCCURRENCE'|'COUNT'|'SUM'|'MINIMUM'|'MAXIMUM'|'AVERAGE'|'MAX_OCCURRENCE',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
CalculatedAttributeName (string) --
The unique name of the calculated attribute.
DisplayName (string) --
The display name of the calculated attribute.
Description (string) --
The description of the calculated attribute.
AttributeDetails (dict) --
Mathematical expression and a list of attribute items specified in that expression.
Attributes (list) --
A list of attribute items specified in the mathematical expression.
(dict) --
The details of a single attribute item specified in the mathematical expression.
Name (string) --
The name of an attribute defined in a profile object type.
Expression (string) --
Mathematical expression that is performed on attribute items provided in the attribute list. Each element in the expression should follow the structure of "{ObjectTypeName.AttributeName}".
Conditions (dict) --
The conditions including range, object count, and threshold for the calculated attribute.
Range (dict) --
The relative time period over which data is included in the aggregation.
Value (integer) --
The amount of time of the specified unit.
Unit (string) --
The unit of time.
ObjectCount (integer) --
The number of profile objects used for the calculated attribute.
Threshold (dict) --
The threshold for the calculated attribute.
Value (string) --
The value of the threshold.
Operator (string) --
The operator of the threshold.
Filter (dict) --
The filter that was used as part of the request.
Include (string) --
Define whether to include or exclude objects for Calculated Attributed calculation that fit the filter groups criteria.
Groups (list) --
Holds the list of Filter groups within the Filter definition.
(dict) --
Object that holds the dimensions to filter on.
Type (string) --
The type of logical relationship between the dimensions of the Filter group.
Dimensions (list) --
Object that holds the attributes to filter on.
(dict) --
Contains the map of attribute names to attribute dimensions.
Attributes (dict) --
Is the attribute within the FilterDimension map
(string) --
(dict) --
Object that defines how to filter the incoming objects for the calculated attribute.
DimensionType (string) --
The action to filter with.
Values (list) --
The values to apply the DimensionType on.
(string) --
Statistic (string) --
The aggregation operation to perform for the calculated attribute.
CreatedAt (datetime) --
The timestamp of when the calculated attribute definition was created.
LastUpdatedAt (datetime) --
The timestamp of when the calculated attribute definition was most recently edited.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
{'DetectedProfileObjectTypes': {'Keys': {'StandardIdentifiers': {'COMMUNICATION_RECORD'}}}}
The process of detecting profile object type mapping by using given objects.
See also: AWS API Documentation
Request Syntax
client.detect_profile_object_type(
Objects=[
'string',
],
DomainName='string'
)
list
[REQUIRED]
A string that is serialized from a JSON object.
(string) --
string
[REQUIRED]
The unique name of the domain.
dict
Response Syntax
{
'DetectedProfileObjectTypes': [
{
'SourceLastUpdatedTimestampFormat': 'string',
'Fields': {
'string': {
'Source': 'string',
'Target': 'string',
'ContentType': 'STRING'|'NUMBER'|'PHONE_NUMBER'|'EMAIL_ADDRESS'|'NAME'
}
},
'Keys': {
'string': [
{
'StandardIdentifiers': [
'PROFILE'|'ASSET'|'CASE'|'ORDER'|'COMMUNICATION_RECORD'|'UNIQUE'|'SECONDARY'|'LOOKUP_ONLY'|'NEW_ONLY',
],
'FieldNames': [
'string',
]
},
]
}
},
]
}
Response Structure
(dict) --
DetectedProfileObjectTypes (list) --
Detected ProfileObjectType mappings from given objects. A maximum of one mapping is supported.
(dict) --
Contains ProfileObjectType mapping information from the model.
SourceLastUpdatedTimestampFormat (string) --
The format of sourceLastUpdatedTimestamp that was detected in fields.
Fields (dict) --
A map of the name and the ObjectType field.
(string) --
(dict) --
Represents a field in a ProfileObjectType.
Source (string) --
A field of a ProfileObject. For example: _source.FirstName, where “_source” is a ProfileObjectType of a Zendesk user and “FirstName” is a field in that ObjectType.
Target (string) --
The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.
ContentType (string) --
The content type of the field. Used for determining equality when searching.
Keys (dict) --
A list of unique keys that can be used to map data to a profile.
(string) --
(list) --
(dict) --
An object that defines the Key element of a ProfileObject. A Key is a special element that can be used to search for a customer profile.
StandardIdentifiers (list) --
The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE, ASSET, CASE, or ORDER means that this key can be used to tie an object to a PROFILE, ASSET, CASE, or ORDER respectively. UNIQUE means that it can be used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the profile does not already exist before the object is ingested, otherwise it is only used for matching objects to profiles.
(string) --
FieldNames (list) --
The reference for the key name of the fields map.
(string) --
{'Filter': {'Groups': [{'Dimensions': [{'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']}}}],
'Type': 'ALL | ANY | NONE'}],
'Include': 'ALL | ANY | NONE'}}
Provides more information on a calculated attribute definition for Customer Profiles.
See also: AWS API Documentation
Request Syntax
client.get_calculated_attribute_definition(
DomainName='string',
CalculatedAttributeName='string'
)
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The unique name of the calculated attribute.
dict
Response Syntax
{
'CalculatedAttributeName': 'string',
'DisplayName': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Statistic': 'FIRST_OCCURRENCE'|'LAST_OCCURRENCE'|'COUNT'|'SUM'|'MINIMUM'|'MAXIMUM'|'AVERAGE'|'MAX_OCCURRENCE',
'Filter': {
'Include': 'ALL'|'ANY'|'NONE',
'Groups': [
{
'Type': 'ALL'|'ANY'|'NONE',
'Dimensions': [
{
'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',
]
}
}
},
]
},
]
},
'Conditions': {
'Range': {
'Value': 123,
'Unit': 'DAYS'
},
'ObjectCount': 123,
'Threshold': {
'Value': 'string',
'Operator': 'EQUAL_TO'|'GREATER_THAN'|'LESS_THAN'|'NOT_EQUAL_TO'
}
},
'AttributeDetails': {
'Attributes': [
{
'Name': 'string'
},
],
'Expression': 'string'
},
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
CalculatedAttributeName (string) --
The unique name of the calculated attribute.
DisplayName (string) --
The display name of the calculated attribute.
Description (string) --
The description of the calculated attribute.
CreatedAt (datetime) --
The timestamp of when the calculated attribute definition was created.
LastUpdatedAt (datetime) --
The timestamp of when the calculated attribute definition was most recently edited.
Statistic (string) --
The aggregation operation to perform for the calculated attribute.
Filter (dict) --
The filter assigned to this calculated attribute definition.
Include (string) --
Define whether to include or exclude objects for Calculated Attributed calculation that fit the filter groups criteria.
Groups (list) --
Holds the list of Filter groups within the Filter definition.
(dict) --
Object that holds the dimensions to filter on.
Type (string) --
The type of logical relationship between the dimensions of the Filter group.
Dimensions (list) --
Object that holds the attributes to filter on.
(dict) --
Contains the map of attribute names to attribute dimensions.
Attributes (dict) --
Is the attribute within the FilterDimension map
(string) --
(dict) --
Object that defines how to filter the incoming objects for the calculated attribute.
DimensionType (string) --
The action to filter with.
Values (list) --
The values to apply the DimensionType on.
(string) --
Conditions (dict) --
The conditions including range, object count, and threshold for the calculated attribute.
Range (dict) --
The relative time period over which data is included in the aggregation.
Value (integer) --
The amount of time of the specified unit.
Unit (string) --
The unit of time.
ObjectCount (integer) --
The number of profile objects used for the calculated attribute.
Threshold (dict) --
The threshold for the calculated attribute.
Value (string) --
The value of the threshold.
Operator (string) --
The operator of the threshold.
AttributeDetails (dict) --
Mathematical expression and a list of attribute items specified in that expression.
Attributes (list) --
A list of attribute items specified in the mathematical expression.
(dict) --
The details of a single attribute item specified in the mathematical expression.
Name (string) --
The name of an attribute defined in a profile object type.
Expression (string) --
Mathematical expression that is performed on attribute items provided in the attribute list. Each element in the expression should follow the structure of "{ObjectTypeName.AttributeName}".
Tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
{'Keys': {'StandardIdentifiers': {'COMMUNICATION_RECORD'}}}
Returns the object types for a specific domain.
See also: AWS API Documentation
Request Syntax
client.get_profile_object_type(
DomainName='string',
ObjectTypeName='string'
)
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The name of the profile object type.
dict
Response Syntax
{
'ObjectTypeName': 'string',
'Description': 'string',
'TemplateId': 'string',
'ExpirationDays': 123,
'EncryptionKey': 'string',
'AllowProfileCreation': True|False,
'SourceLastUpdatedTimestampFormat': 'string',
'MaxAvailableProfileObjectCount': 123,
'MaxProfileObjectCount': 123,
'Fields': {
'string': {
'Source': 'string',
'Target': 'string',
'ContentType': 'STRING'|'NUMBER'|'PHONE_NUMBER'|'EMAIL_ADDRESS'|'NAME'
}
},
'Keys': {
'string': [
{
'StandardIdentifiers': [
'PROFILE'|'ASSET'|'CASE'|'ORDER'|'COMMUNICATION_RECORD'|'UNIQUE'|'SECONDARY'|'LOOKUP_ONLY'|'NEW_ONLY',
],
'FieldNames': [
'string',
]
},
]
},
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
ObjectTypeName (string) --
The name of the profile object type.
Description (string) --
The description of the profile object type.
TemplateId (string) --
A unique identifier for the object template.
ExpirationDays (integer) --
The number of days until the data in the object expires.
EncryptionKey (string) --
The customer-provided key to encrypt the profile object that will be created in this profile object type.
AllowProfileCreation (boolean) --
Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE, and if no match is found, then the service creates a new standard profile.
SourceLastUpdatedTimestampFormat (string) --
The format of your sourceLastUpdatedTimestamp that was previously set up.
MaxAvailableProfileObjectCount (integer) --
The amount of provisioned profile object max count available.
MaxProfileObjectCount (integer) --
The amount of profile object max count assigned to the object type.
Fields (dict) --
A map of the name and ObjectType field.
(string) --
(dict) --
Represents a field in a ProfileObjectType.
Source (string) --
A field of a ProfileObject. For example: _source.FirstName, where “_source” is a ProfileObjectType of a Zendesk user and “FirstName” is a field in that ObjectType.
Target (string) --
The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.
ContentType (string) --
The content type of the field. Used for determining equality when searching.
Keys (dict) --
A list of unique keys that can be used to map data to the profile.
(string) --
(list) --
(dict) --
An object that defines the Key element of a ProfileObject. A Key is a special element that can be used to search for a customer profile.
StandardIdentifiers (list) --
The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE, ASSET, CASE, or ORDER means that this key can be used to tie an object to a PROFILE, ASSET, CASE, or ORDER respectively. UNIQUE means that it can be used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the profile does not already exist before the object is ingested, otherwise it is only used for matching objects to profiles.
(string) --
FieldNames (list) --
The reference for the key name of the fields map.
(string) --
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) --
{'Keys': {'StandardIdentifiers': {'COMMUNICATION_RECORD'}}}
Returns the template information for a specific object type.
A template is a predefined ProfileObjectType, such as “Salesforce-Account” or “Salesforce-Contact.” When a user sends a ProfileObject, using the PutProfileObject API, with an ObjectTypeName that matches one of the TemplateIds, it uses the mappings from the template.
See also: AWS API Documentation
Request Syntax
client.get_profile_object_type_template(
TemplateId='string'
)
string
[REQUIRED]
A unique identifier for the object template.
dict
Response Syntax
{
'TemplateId': 'string',
'SourceName': 'string',
'SourceObject': 'string',
'AllowProfileCreation': True|False,
'SourceLastUpdatedTimestampFormat': 'string',
'Fields': {
'string': {
'Source': 'string',
'Target': 'string',
'ContentType': 'STRING'|'NUMBER'|'PHONE_NUMBER'|'EMAIL_ADDRESS'|'NAME'
}
},
'Keys': {
'string': [
{
'StandardIdentifiers': [
'PROFILE'|'ASSET'|'CASE'|'ORDER'|'COMMUNICATION_RECORD'|'UNIQUE'|'SECONDARY'|'LOOKUP_ONLY'|'NEW_ONLY',
],
'FieldNames': [
'string',
]
},
]
}
}
Response Structure
(dict) --
TemplateId (string) --
A unique identifier for the object template.
SourceName (string) --
The name of the source of the object template.
SourceObject (string) --
The source of the object template.
AllowProfileCreation (boolean) --
Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE, and if no match is found, then the service creates a new standard profile.
SourceLastUpdatedTimestampFormat (string) --
The format of your sourceLastUpdatedTimestamp that was previously set up.
Fields (dict) --
A map of the name and ObjectType field.
(string) --
(dict) --
Represents a field in a ProfileObjectType.
Source (string) --
A field of a ProfileObject. For example: _source.FirstName, where “_source” is a ProfileObjectType of a Zendesk user and “FirstName” is a field in that ObjectType.
Target (string) --
The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.
ContentType (string) --
The content type of the field. Used for determining equality when searching.
Keys (dict) --
A list of unique keys that can be used to map data to the profile.
(string) --
(list) --
(dict) --
An object that defines the Key element of a ProfileObject. A Key is a special element that can be used to search for a customer profile.
StandardIdentifiers (list) --
The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE, ASSET, CASE, or ORDER means that this key can be used to tie an object to a PROFILE, ASSET, CASE, or ORDER respectively. UNIQUE means that it can be used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the profile does not already exist before the object is ingested, otherwise it is only used for matching objects to profiles.
(string) --
FieldNames (list) --
The reference for the key name of the fields map.
(string) --
{'Keys': {'StandardIdentifiers': {'COMMUNICATION_RECORD'}}}
Defines a ProfileObjectType.
To add or remove tags on an existing ObjectType, see TagResource/ UntagResource.
See also: AWS API Documentation
Request Syntax
client.put_profile_object_type(
DomainName='string',
ObjectTypeName='string',
Description='string',
TemplateId='string',
ExpirationDays=123,
EncryptionKey='string',
AllowProfileCreation=True|False,
SourceLastUpdatedTimestampFormat='string',
MaxProfileObjectCount=123,
Fields={
'string': {
'Source': 'string',
'Target': 'string',
'ContentType': 'STRING'|'NUMBER'|'PHONE_NUMBER'|'EMAIL_ADDRESS'|'NAME'
}
},
Keys={
'string': [
{
'StandardIdentifiers': [
'PROFILE'|'ASSET'|'CASE'|'ORDER'|'COMMUNICATION_RECORD'|'UNIQUE'|'SECONDARY'|'LOOKUP_ONLY'|'NEW_ONLY',
],
'FieldNames': [
'string',
]
},
]
},
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The name of the profile object type.
string
[REQUIRED]
Description of the profile object type.
string
A unique identifier for the object template. For some attributes in the request, the service will use the default value from the object template when TemplateId is present. If these attributes are present in the request, the service may return a BadRequestException. These attributes include: AllowProfileCreation, SourceLastUpdatedTimestampFormat, Fields, and Keys. For example, if AllowProfileCreation is set to true when TemplateId is set, the service may return a BadRequestException.
integer
The number of days until the data in the object expires.
string
The customer-provided key to encrypt the profile object that will be created in this profile object type.
boolean
Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE, and if no match is found, then the service creates a new standard profile.
string
The format of your sourceLastUpdatedTimestamp that was previously set up.
integer
The amount of profile object max count assigned to the object type
dict
A map of the name and ObjectType field.
(string) --
(dict) --
Represents a field in a ProfileObjectType.
Source (string) --
A field of a ProfileObject. For example: _source.FirstName, where “_source” is a ProfileObjectType of a Zendesk user and “FirstName” is a field in that ObjectType.
Target (string) --
The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.
ContentType (string) --
The content type of the field. Used for determining equality when searching.
dict
A list of unique keys that can be used to map data to the profile.
(string) --
(list) --
(dict) --
An object that defines the Key element of a ProfileObject. A Key is a special element that can be used to search for a customer profile.
StandardIdentifiers (list) --
The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE, ASSET, CASE, or ORDER means that this key can be used to tie an object to a PROFILE, ASSET, CASE, or ORDER respectively. UNIQUE means that it can be used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the profile does not already exist before the object is ingested, otherwise it is only used for matching objects to profiles.
(string) --
FieldNames (list) --
The reference for the key name of the fields map.
(string) --
dict
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
dict
Response Syntax
{
'ObjectTypeName': 'string',
'Description': 'string',
'TemplateId': 'string',
'ExpirationDays': 123,
'EncryptionKey': 'string',
'AllowProfileCreation': True|False,
'SourceLastUpdatedTimestampFormat': 'string',
'MaxProfileObjectCount': 123,
'MaxAvailableProfileObjectCount': 123,
'Fields': {
'string': {
'Source': 'string',
'Target': 'string',
'ContentType': 'STRING'|'NUMBER'|'PHONE_NUMBER'|'EMAIL_ADDRESS'|'NAME'
}
},
'Keys': {
'string': [
{
'StandardIdentifiers': [
'PROFILE'|'ASSET'|'CASE'|'ORDER'|'COMMUNICATION_RECORD'|'UNIQUE'|'SECONDARY'|'LOOKUP_ONLY'|'NEW_ONLY',
],
'FieldNames': [
'string',
]
},
]
},
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
ObjectTypeName (string) --
The name of the profile object type.
Description (string) --
Description of the profile object type.
TemplateId (string) --
A unique identifier for the object template.
ExpirationDays (integer) --
The number of days until the data in the object expires.
EncryptionKey (string) --
The customer-provided key to encrypt the profile object that will be created in this profile object type.
AllowProfileCreation (boolean) --
Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE, and if no match is found, then the service creates a new standard profile.
SourceLastUpdatedTimestampFormat (string) --
The format of your sourceLastUpdatedTimestamp that was previously set up in fields that were parsed using SimpleDateFormat. If you have sourceLastUpdatedTimestamp in your field, you must set up sourceLastUpdatedTimestampFormat.
MaxProfileObjectCount (integer) --
The amount of profile object max count assigned to the object type.
MaxAvailableProfileObjectCount (integer) --
The amount of provisioned profile object max count available.
Fields (dict) --
A map of the name and ObjectType field.
(string) --
(dict) --
Represents a field in a ProfileObjectType.
Source (string) --
A field of a ProfileObject. For example: _source.FirstName, where “_source” is a ProfileObjectType of a Zendesk user and “FirstName” is a field in that ObjectType.
Target (string) --
The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.
ContentType (string) --
The content type of the field. Used for determining equality when searching.
Keys (dict) --
A list of unique keys that can be used to map data to the profile.
(string) --
(list) --
(dict) --
An object that defines the Key element of a ProfileObject. A Key is a special element that can be used to search for a customer profile.
StandardIdentifiers (list) --
The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE, ASSET, CASE, or ORDER means that this key can be used to tie an object to a PROFILE, ASSET, CASE, or ORDER respectively. UNIQUE means that it can be used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the profile does not already exist before the object is ingested, otherwise it is only used for matching objects to profiles.
(string) --
FieldNames (list) --
The reference for the key name of the fields map.
(string) --
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) --