2025/07/31 - Amazon Connect Customer Profiles - 9 updated api methods
Changes The release updates standard profile with 2 new fields that supports account-level engagement. Updated APIs include CreateProfile, UpdateProfile, MergeProfiles, SearchProfiles, BatchGetProfile, GetSegmentMembership, CreateSegmentDefinition, CreateSegmentEstimate.
{'Profiles': {'EngagementPreferences': {'Email': [{'ContactType': 'PhoneNumber '
'| '
'MobilePhoneNumber '
'| '
'HomePhoneNumber '
'| '
'BusinessPhoneNumber '
'| '
'EmailAddress '
'| '
'PersonalEmailAddress '
'| '
'BusinessEmailAddress',
'KeyName': 'string',
'KeyValue': 'string',
'ProfileId': 'string'}],
'Phone': [{'ContactType': 'PhoneNumber '
'| '
'MobilePhoneNumber '
'| '
'HomePhoneNumber '
'| '
'BusinessPhoneNumber '
'| '
'EmailAddress '
'| '
'PersonalEmailAddress '
'| '
'BusinessEmailAddress',
'KeyName': 'string',
'KeyValue': 'string',
'ProfileId': 'string'}]},
'ProfileType': 'ACCOUNT_PROFILE | PROFILE'}}
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',
'ProfileType': 'ACCOUNT_PROFILE'|'PROFILE',
'EngagementPreferences': {
'Phone': [
{
'KeyName': 'string',
'KeyValue': 'string',
'ProfileId': 'string',
'ContactType': 'PhoneNumber'|'MobilePhoneNumber'|'HomePhoneNumber'|'BusinessPhoneNumber'|'EmailAddress'|'PersonalEmailAddress'|'BusinessEmailAddress'
},
],
'Email': [
{
'KeyName': 'string',
'KeyValue': 'string',
'ProfileId': 'string',
'ContactType': 'PhoneNumber'|'MobilePhoneNumber'|'HomePhoneNumber'|'BusinessPhoneNumber'|'EmailAddress'|'PersonalEmailAddress'|'BusinessEmailAddress'
},
]
}
},
]
}
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 assigned to the customer.
AdditionalInformation (string) --
Any additional information relevant to the customer’s profile.
PartyType (string) --
The type of profile used to describe the customer.
BusinessName (string) --
The name of the customer’s business.
FirstName (string) --
The customer’s first name.
MiddleName (string) --
The customer’s middle name.
LastName (string) --
The customer’s last name.
BirthDate (string) --
The customer’s birth date.
Gender (string) --
The gender with which the customer identifies.
PhoneNumber (string) --
The customer's phone number, which has not been specified as a mobile, home, or business number.
MobilePhoneNumber (string) --
The customer’s mobile phone number.
HomePhoneNumber (string) --
The customer’s home phone number.
BusinessPhoneNumber (string) --
The customer’s home phone number.
EmailAddress (string) --
The customer’s email address, which has not been specified as a personal or business address.
PersonalEmailAddress (string) --
The customer’s personal email address.
BusinessEmailAddress (string) --
The customer’s business email address.
Address (dict) --
A generic address associated with the customer that is not mailing, shipping, or billing.
Address1 (string) --
The first line of a customer address.
Address2 (string) --
The second line of a customer address.
Address3 (string) --
The third line of a customer address.
Address4 (string) --
The fourth line of a customer address.
City (string) --
The city in which a customer lives.
County (string) --
The county in which a customer lives.
State (string) --
The state in which a customer lives.
Province (string) --
The province in which a customer lives.
Country (string) --
The country in which a customer lives.
PostalCode (string) --
The postal code of a customer address.
ShippingAddress (dict) --
The customer’s shipping address.
Address1 (string) --
The first line of a customer address.
Address2 (string) --
The second line of a customer address.
Address3 (string) --
The third line of a customer address.
Address4 (string) --
The fourth line of a customer address.
City (string) --
The city in which a customer lives.
County (string) --
The county in which a customer lives.
State (string) --
The state in which a customer lives.
Province (string) --
The province in which a customer lives.
Country (string) --
The country in which a customer lives.
PostalCode (string) --
The postal code of a customer address.
MailingAddress (dict) --
The customer’s mailing address.
Address1 (string) --
The first line of a customer address.
Address2 (string) --
The second line of a customer address.
Address3 (string) --
The third line of a customer address.
Address4 (string) --
The fourth line of a customer address.
City (string) --
The city in which a customer lives.
County (string) --
The county in which a customer lives.
State (string) --
The state in which a customer lives.
Province (string) --
The province in which a customer lives.
Country (string) --
The country in which a customer lives.
PostalCode (string) --
The postal code of a customer address.
BillingAddress (dict) --
The customer’s billing address.
Address1 (string) --
The first line of a customer address.
Address2 (string) --
The second line of a customer address.
Address3 (string) --
The third line of a customer address.
Address4 (string) --
The fourth line of a customer address.
City (string) --
The city in which a customer lives.
County (string) --
The county in which a customer lives.
State (string) --
The state in which a customer lives.
Province (string) --
The province in which a customer lives.
Country (string) --
The country in which a customer lives.
PostalCode (string) --
The postal code of a customer address.
Attributes (dict) --
A key value pair of attributes of a customer profile.
(string) --
(string) --
FoundByItems (list) --
A list of items used to find a profile returned in a SearchProfiles response. An item is a key-value(s) pair that matches an attribute in the profile.
If the optional AdditionalSearchKeys parameter was included in the SearchProfiles request, the FoundByItems list should be interpreted based on the LogicalOperator used in the request:
AND - The profile included in the response matched all of the search keys specified in the request. The FoundByItems will include all of the key-value(s) pairs that were specified in the request (as this is a requirement of AND search logic).
OR - The profile included in the response matched at least one of the search keys specified in the request. The FoundByItems will include each of the key-value(s) pairs that the profile was found by.
The OR relationship is the default behavior if the LogicalOperator parameter is not included in the SearchProfiles request.
(dict) --
A data type pair that consists of a KeyName and Values list that were used to find a profile returned in response to a SearchProfiles request.
KeyName (string) --
A searchable identifier of a customer profile.
Values (list) --
A list of key values.
(string) --
PartyTypeString (string) --
An alternative to PartyType which accepts any string as input.
GenderString (string) --
An alternative to Gender which accepts any string as input.
ProfileType (string) --
The type of the profile.
EngagementPreferences (dict) --
The customer or account’s engagement preferences.
Phone (list) --
A list of phone-related contact preferences
(dict) --
Object that defines users contact preference.
KeyName (string) --
A searchable, unique identifier of a customer profile.
KeyValue (string) --
The key value used to look up profile based off the keyName.
ProfileId (string) --
The unique identifier of a customer profile.
ContactType (string) --
The contact type used for engagement. For example: HomePhoneNumber, PersonalEmailAddress.
Email (list) --
A list of email-related contact preferences
(dict) --
Object that defines users contact preference.
KeyName (string) --
A searchable, unique identifier of a customer profile.
KeyValue (string) --
The key value used to look up profile based off the keyName.
ProfileId (string) --
The unique identifier of a customer profile.
ContactType (string) --
The contact type used for engagement. For example: HomePhoneNumber, PersonalEmailAddress.
{'EngagementPreferences': {'Email': [{'ContactType': 'PhoneNumber | '
'MobilePhoneNumber | '
'HomePhoneNumber | '
'BusinessPhoneNumber | '
'EmailAddress | '
'PersonalEmailAddress | '
'BusinessEmailAddress',
'KeyName': 'string',
'KeyValue': 'string',
'ProfileId': 'string'}],
'Phone': [{'ContactType': 'PhoneNumber | '
'MobilePhoneNumber | '
'HomePhoneNumber | '
'BusinessPhoneNumber | '
'EmailAddress | '
'PersonalEmailAddress | '
'BusinessEmailAddress',
'KeyName': 'string',
'KeyValue': 'string',
'ProfileId': 'string'}]},
'ProfileType': 'ACCOUNT_PROFILE | PROFILE'}
Creates a standard profile.
A standard profile represents the following attributes for a customer profile in a domain.
See also: AWS API Documentation
Request Syntax
client.create_profile(
DomainName='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'
},
PartyTypeString='string',
GenderString='string',
ProfileType='ACCOUNT_PROFILE'|'PROFILE',
EngagementPreferences={
'Phone': [
{
'KeyName': 'string',
'KeyValue': 'string',
'ProfileId': 'string',
'ContactType': 'PhoneNumber'|'MobilePhoneNumber'|'HomePhoneNumber'|'BusinessPhoneNumber'|'EmailAddress'|'PersonalEmailAddress'|'BusinessEmailAddress'
},
],
'Email': [
{
'KeyName': 'string',
'KeyValue': 'string',
'ProfileId': 'string',
'ContactType': 'PhoneNumber'|'MobilePhoneNumber'|'HomePhoneNumber'|'BusinessPhoneNumber'|'EmailAddress'|'PersonalEmailAddress'|'BusinessEmailAddress'
},
]
}
)
string
[REQUIRED]
The unique name of the domain.
string
An account number that you have assigned to the customer.
string
Any additional information relevant to the customer’s profile.
string
The type of profile used to describe the customer.
string
The name of the customer’s business.
string
The customer’s first name.
string
The customer’s middle name.
string
The customer’s last name.
string
The customer’s birth date.
string
The gender with which the customer identifies.
string
The customer’s phone number, which has not been specified as a mobile, home, or business number.
string
The customer’s mobile phone number.
string
The customer’s home phone number.
string
The customer’s business phone number.
string
The customer’s email address, which has not been specified as a personal or business address.
string
The customer’s personal email address.
string
The customer’s business email 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.
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.
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.
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.
dict
A key value pair of attributes of a customer profile.
(string) --
(string) --
string
An alternative to PartyType which accepts any string as input.
string
An alternative to Gender which accepts any string as input.
string
The type of the profile.
dict
Object that defines the preferred methods of engagement, per channel.
Phone (list) --
A list of phone-related contact preferences
(dict) --
Object that defines users contact preference.
KeyName (string) --
A searchable, unique identifier of a customer profile.
KeyValue (string) --
The key value used to look up profile based off the keyName.
ProfileId (string) --
The unique identifier of a customer profile.
ContactType (string) --
The contact type used for engagement. For example: HomePhoneNumber, PersonalEmailAddress.
Email (list) --
A list of email-related contact preferences
(dict) --
Object that defines users contact preference.
KeyName (string) --
A searchable, unique identifier of a customer profile.
KeyValue (string) --
The key value used to look up profile based off the keyName.
ProfileId (string) --
The unique identifier of a customer profile.
ContactType (string) --
The contact type used for engagement. For example: HomePhoneNumber, PersonalEmailAddress.
dict
Response Syntax
{
'ProfileId': 'string'
}
Response Structure
(dict) --
ProfileId (string) --
The unique identifier of a customer profile.
{'SegmentGroups': {'Groups': {'Dimensions': {'ProfileAttributes': {'ProfileType': {'DimensionType': 'INCLUSIVE '
'| '
'EXCLUSIVE',
'Values': ['ACCOUNT_PROFILE '
'| '
'PROFILE']}}}}}}
Creates a segment definition associated to the given domain.
See also: AWS API Documentation
Request Syntax
client.create_segment_definition(
DomainName='string',
SegmentDefinitionName='string',
DisplayName='string',
Description='string',
SegmentGroups={
'Groups': [
{
'Dimensions': [
{
'ProfileAttributes': {
'AccountNumber': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'AdditionalInformation': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'FirstName': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'LastName': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'MiddleName': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'GenderString': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PartyTypeString': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'BirthDate': {
'DimensionType': 'BEFORE'|'AFTER'|'BETWEEN'|'NOT_BETWEEN'|'ON',
'Values': [
'string',
]
},
'PhoneNumber': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'BusinessName': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'BusinessPhoneNumber': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'HomePhoneNumber': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'MobilePhoneNumber': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'EmailAddress': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PersonalEmailAddress': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'BusinessEmailAddress': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Address': {
'City': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'County': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PostalCode': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Province': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'State': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
}
},
'ShippingAddress': {
'City': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'County': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PostalCode': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Province': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'State': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
}
},
'MailingAddress': {
'City': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'County': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PostalCode': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Province': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'State': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
}
},
'BillingAddress': {
'City': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'County': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PostalCode': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Province': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'State': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
}
},
'Attributes': {
'string': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH'|'BEFORE'|'AFTER'|'BETWEEN'|'NOT_BETWEEN'|'ON'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL'|'LESS_THAN_OR_EQUAL'|'EQUAL',
'Values': [
'string',
]
}
},
'ProfileType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'ACCOUNT_PROFILE'|'PROFILE',
]
}
},
'CalculatedAttributes': {
'string': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH'|'BEFORE'|'AFTER'|'BETWEEN'|'NOT_BETWEEN'|'ON'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL'|'LESS_THAN_OR_EQUAL'|'EQUAL',
'Values': [
'string',
],
'ConditionOverrides': {
'Range': {
'Start': 123,
'End': 123,
'Unit': 'DAYS'
}
}
}
}
},
],
'SourceSegments': [
{
'SegmentDefinitionName': 'string'
},
],
'SourceType': 'ALL'|'ANY'|'NONE',
'Type': 'ALL'|'ANY'|'NONE'
},
],
'Include': 'ALL'|'ANY'|'NONE'
},
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) --
ProfileType (dict) --
A field to describe values to segment on within profile type.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
CalculatedAttributes (dict) --
Object that holds the calculated attributes to segment on.
(string) --
(dict) --
Object that segments on Customer Profile's Calculated Attributes.
DimensionType (string) -- [REQUIRED]
The action to segment with.
Values (list) -- [REQUIRED]
The values to apply the DimensionType with.
(string) --
ConditionOverrides (dict) --
Applies the given condition over the initial Calculated Attribute's definition.
Range (dict) --
The relative time period over which data is included in the aggregation for this override.
Start (integer) -- [REQUIRED]
The start time of when to include objects.
End (integer) --
The end time of when to include objects.
Unit (string) -- [REQUIRED]
The unit for start and end.
SourceSegments (list) --
Defines the starting source of data.
(dict) --
The source segments to build off of.
SegmentDefinitionName (string) --
The unique name of the segment definition.
SourceType (string) --
Defines how to interact with the source data.
Type (string) --
Defines how to interact with the profiles found in the current filtering.
Include (string) --
Defines whether to include or exclude the profiles that fit the segment criteria.
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) --
{'SegmentQuery': {'Groups': {'Dimensions': {'ProfileAttributes': {'ProfileType': {'DimensionType': 'INCLUSIVE '
'| '
'EXCLUSIVE',
'Values': ['ACCOUNT_PROFILE '
'| '
'PROFILE']}}}}}}
Creates a segment estimate query.
See also: AWS API Documentation
Request Syntax
client.create_segment_estimate(
DomainName='string',
SegmentQuery={
'Groups': [
{
'Dimensions': [
{
'ProfileAttributes': {
'AccountNumber': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'AdditionalInformation': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'FirstName': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'LastName': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'MiddleName': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'GenderString': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PartyTypeString': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'BirthDate': {
'DimensionType': 'BEFORE'|'AFTER'|'BETWEEN'|'NOT_BETWEEN'|'ON',
'Values': [
'string',
]
},
'PhoneNumber': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'BusinessName': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'BusinessPhoneNumber': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'HomePhoneNumber': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'MobilePhoneNumber': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'EmailAddress': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PersonalEmailAddress': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'BusinessEmailAddress': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Address': {
'City': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'County': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PostalCode': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Province': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'State': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
}
},
'ShippingAddress': {
'City': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'County': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PostalCode': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Province': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'State': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
}
},
'MailingAddress': {
'City': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'County': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PostalCode': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Province': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'State': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
}
},
'BillingAddress': {
'City': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'County': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PostalCode': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Province': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'State': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
}
},
'Attributes': {
'string': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH'|'BEFORE'|'AFTER'|'BETWEEN'|'NOT_BETWEEN'|'ON'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL'|'LESS_THAN_OR_EQUAL'|'EQUAL',
'Values': [
'string',
]
}
},
'ProfileType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'ACCOUNT_PROFILE'|'PROFILE',
]
}
},
'CalculatedAttributes': {
'string': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH'|'BEFORE'|'AFTER'|'BETWEEN'|'NOT_BETWEEN'|'ON'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL'|'LESS_THAN_OR_EQUAL'|'EQUAL',
'Values': [
'string',
],
'ConditionOverrides': {
'Range': {
'Start': 123,
'End': 123,
'Unit': 'DAYS'
}
}
}
}
},
],
'SourceSegments': [
{
'SegmentDefinitionName': 'string'
},
],
'SourceType': 'ALL'|'ANY'|'NONE',
'Type': 'ALL'|'ANY'|'NONE'
},
],
'Include': 'ALL'|'ANY'|'NONE'
}
)
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) --
ProfileType (dict) --
A field to describe values to segment on within profile type.
DimensionType (string) -- [REQUIRED]
The action to segment on.
Values (list) -- [REQUIRED]
The values to apply the DimensionType on.
(string) --
CalculatedAttributes (dict) --
Object that holds the calculated attributes to segment on.
(string) --
(dict) --
Object that segments on Customer Profile's Calculated Attributes.
DimensionType (string) -- [REQUIRED]
The action to segment with.
Values (list) -- [REQUIRED]
The values to apply the DimensionType with.
(string) --
ConditionOverrides (dict) --
Applies the given condition over the initial Calculated Attribute's definition.
Range (dict) --
The relative time period over which data is included in the aggregation for this override.
Start (integer) -- [REQUIRED]
The start time of when to include objects.
End (integer) --
The end time of when to include objects.
Unit (string) -- [REQUIRED]
The unit for start and end.
SourceSegments (list) --
Defines the starting source of data.
(dict) --
The source segments to build off of.
SegmentDefinitionName (string) --
The unique name of the segment definition.
SourceType (string) --
Defines how to interact with the source data.
Type (string) --
Defines how to interact with the profiles found in the current filtering.
Include (string) --
Define whether to include or exclude the profiles that fit the segment criteria.
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.
{'SegmentGroups': {'Groups': {'Dimensions': {'ProfileAttributes': {'ProfileType': {'DimensionType': 'INCLUSIVE '
'| '
'EXCLUSIVE',
'Values': ['ACCOUNT_PROFILE '
'| '
'PROFILE']}}}}}}
Gets a segment definition from the domain.
See also: AWS API Documentation
Request Syntax
client.get_segment_definition(
DomainName='string',
SegmentDefinitionName='string'
)
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The unique name of the segment definition.
dict
Response Syntax
{
'SegmentDefinitionName': 'string',
'DisplayName': 'string',
'Description': 'string',
'SegmentGroups': {
'Groups': [
{
'Dimensions': [
{
'ProfileAttributes': {
'AccountNumber': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'AdditionalInformation': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'FirstName': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'LastName': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'MiddleName': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'GenderString': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PartyTypeString': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'BirthDate': {
'DimensionType': 'BEFORE'|'AFTER'|'BETWEEN'|'NOT_BETWEEN'|'ON',
'Values': [
'string',
]
},
'PhoneNumber': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'BusinessName': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'BusinessPhoneNumber': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'HomePhoneNumber': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'MobilePhoneNumber': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'EmailAddress': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PersonalEmailAddress': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'BusinessEmailAddress': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Address': {
'City': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'County': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PostalCode': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Province': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'State': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
}
},
'ShippingAddress': {
'City': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'County': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PostalCode': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Province': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'State': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
}
},
'MailingAddress': {
'City': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'County': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PostalCode': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Province': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'State': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
}
},
'BillingAddress': {
'City': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Country': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'County': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'PostalCode': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'Province': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
},
'State': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH',
'Values': [
'string',
]
}
},
'Attributes': {
'string': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH'|'BEFORE'|'AFTER'|'BETWEEN'|'NOT_BETWEEN'|'ON'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL'|'LESS_THAN_OR_EQUAL'|'EQUAL',
'Values': [
'string',
]
}
},
'ProfileType': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE',
'Values': [
'ACCOUNT_PROFILE'|'PROFILE',
]
}
},
'CalculatedAttributes': {
'string': {
'DimensionType': 'INCLUSIVE'|'EXCLUSIVE'|'CONTAINS'|'BEGINS_WITH'|'ENDS_WITH'|'BEFORE'|'AFTER'|'BETWEEN'|'NOT_BETWEEN'|'ON'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL'|'LESS_THAN_OR_EQUAL'|'EQUAL',
'Values': [
'string',
],
'ConditionOverrides': {
'Range': {
'Start': 123,
'End': 123,
'Unit': 'DAYS'
}
}
}
}
},
],
'SourceSegments': [
{
'SegmentDefinitionName': 'string'
},
],
'SourceType': 'ALL'|'ANY'|'NONE',
'Type': 'ALL'|'ANY'|'NONE'
},
],
'Include': 'ALL'|'ANY'|'NONE'
},
'SegmentDefinitionArn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
SegmentDefinitionName (string) --
The name of the segment definition.
DisplayName (string) --
The display name of the segment definition.
Description (string) --
The description of the segment definition.
SegmentGroups (dict) --
The segment criteria associated with this definition.
Groups (list) --
Holds the list of groups within the segment definition.
(dict) --
Contains dimensions that determine what to segment on.
Dimensions (list) --
Defines the attributes to segment on.
(dict) --
Object that holds what profile and calculated attributes to segment on.
ProfileAttributes (dict) --
Object that holds the profile attributes to segment on.
AccountNumber (dict) --
A field to describe values to segment on within account number.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
AdditionalInformation (dict) --
A field to describe values to segment on within additional information.
DimensionType (string) --
The action to segment with.
Values (list) --
The values to apply the DimensionType on.
(string) --
FirstName (dict) --
A field to describe values to segment on within first name.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
LastName (dict) --
A field to describe values to segment on within last name.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
MiddleName (dict) --
A field to describe values to segment on within middle name.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
GenderString (dict) --
A field to describe values to segment on within genderString.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
PartyTypeString (dict) --
A field to describe values to segment on within partyTypeString.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
BirthDate (dict) --
A field to describe values to segment on within birthDate.
DimensionType (string) --
The action to segment with.
Values (list) --
The values to apply the DimensionType on.
(string) --
PhoneNumber (dict) --
A field to describe values to segment on within phone number.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
BusinessName (dict) --
A field to describe values to segment on within business name.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
BusinessPhoneNumber (dict) --
A field to describe values to segment on within business phone number.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
HomePhoneNumber (dict) --
A field to describe values to segment on within home phone number.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
MobilePhoneNumber (dict) --
A field to describe values to segment on within mobile phone number.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
EmailAddress (dict) --
A field to describe values to segment on within email address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
PersonalEmailAddress (dict) --
A field to describe values to segment on within personal email address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
BusinessEmailAddress (dict) --
A field to describe values to segment on within business email address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
Address (dict) --
A field to describe values to segment on within address.
City (dict) --
The city belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
Country (dict) --
The country belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
County (dict) --
The county belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
PostalCode (dict) --
The postal code belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
Province (dict) --
The province belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
State (dict) --
The state belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
ShippingAddress (dict) --
A field to describe values to segment on within shipping address.
City (dict) --
The city belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
Country (dict) --
The country belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
County (dict) --
The county belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
PostalCode (dict) --
The postal code belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
Province (dict) --
The province belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
State (dict) --
The state belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
MailingAddress (dict) --
A field to describe values to segment on within mailing address.
City (dict) --
The city belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
Country (dict) --
The country belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
County (dict) --
The county belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
PostalCode (dict) --
The postal code belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
Province (dict) --
The province belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
State (dict) --
The state belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
BillingAddress (dict) --
A field to describe values to segment on within billing address.
City (dict) --
The city belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
Country (dict) --
The country belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
County (dict) --
The county belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
PostalCode (dict) --
The postal code belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
Province (dict) --
The province belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
State (dict) --
The state belonging to the address.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
Attributes (dict) --
A field to describe values to segment on within attributes.
(string) --
(dict) --
Object that segments on various Customer Profile's fields.
DimensionType (string) --
The action to segment with.
Values (list) --
The values to apply the DimensionType on.
(string) --
ProfileType (dict) --
A field to describe values to segment on within profile type.
DimensionType (string) --
The action to segment on.
Values (list) --
The values to apply the DimensionType on.
(string) --
CalculatedAttributes (dict) --
Object that holds the calculated attributes to segment on.
(string) --
(dict) --
Object that segments on Customer Profile's Calculated Attributes.
DimensionType (string) --
The action to segment with.
Values (list) --
The values to apply the DimensionType with.
(string) --
ConditionOverrides (dict) --
Applies the given condition over the initial Calculated Attribute's definition.
Range (dict) --
The relative time period over which data is included in the aggregation for this override.
Start (integer) --
The start time of when to include objects.
End (integer) --
The end time of when to include objects.
Unit (string) --
The unit for start and end.
SourceSegments (list) --
Defines the starting source of data.
(dict) --
The source segments to build off of.
SegmentDefinitionName (string) --
The unique name of the segment definition.
SourceType (string) --
Defines how to interact with the source data.
Type (string) --
Defines how to interact with the profiles found in the current filtering.
Include (string) --
Defines whether to include or exclude the profiles that fit the segment criteria.
SegmentDefinitionArn (string) --
The arn of the segment definition.
CreatedAt (datetime) --
The timestamp of when the segment definition was created.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
{'Profiles': {'Profile': {'EngagementPreferences': {'Email': [{'ContactType': 'PhoneNumber '
'| '
'MobilePhoneNumber '
'| '
'HomePhoneNumber '
'| '
'BusinessPhoneNumber '
'| '
'EmailAddress '
'| '
'PersonalEmailAddress '
'| '
'BusinessEmailAddress',
'KeyName': 'string',
'KeyValue': 'string',
'ProfileId': 'string'}],
'Phone': [{'ContactType': 'PhoneNumber '
'| '
'MobilePhoneNumber '
'| '
'HomePhoneNumber '
'| '
'BusinessPhoneNumber '
'| '
'EmailAddress '
'| '
'PersonalEmailAddress '
'| '
'BusinessEmailAddress',
'KeyName': 'string',
'KeyValue': 'string',
'ProfileId': 'string'}]},
'ProfileType': 'ACCOUNT_PROFILE | PROFILE'}}}
Determines if the given profiles are within a segment.
See also: AWS API Documentation
Request Syntax
client.get_segment_membership(
DomainName='string',
SegmentDefinitionName='string',
ProfileIds=[
'string',
]
)
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The Id of the wanted segment. Needs to be a valid, and existing segment Id.
list
[REQUIRED]
The list of profile IDs to query for.
(string) --
dict
Response Syntax
{
'SegmentDefinitionName': 'string',
'Profiles': [
{
'ProfileId': 'string',
'QueryResult': 'PRESENT'|'ABSENT',
'Profile': {
'ProfileId': 'string',
'AccountNumber': 'string',
'AdditionalInformation': 'string',
'PartyType': 'INDIVIDUAL'|'BUSINESS'|'OTHER',
'BusinessName': 'string',
'FirstName': 'string',
'MiddleName': 'string',
'LastName': 'string',
'BirthDate': 'string',
'Gender': 'MALE'|'FEMALE'|'UNSPECIFIED',
'PhoneNumber': 'string',
'MobilePhoneNumber': 'string',
'HomePhoneNumber': 'string',
'BusinessPhoneNumber': 'string',
'EmailAddress': 'string',
'PersonalEmailAddress': 'string',
'BusinessEmailAddress': 'string',
'Address': {
'Address1': 'string',
'Address2': 'string',
'Address3': 'string',
'Address4': 'string',
'City': 'string',
'County': 'string',
'State': 'string',
'Province': 'string',
'Country': 'string',
'PostalCode': 'string'
},
'ShippingAddress': {
'Address1': 'string',
'Address2': 'string',
'Address3': 'string',
'Address4': 'string',
'City': 'string',
'County': 'string',
'State': 'string',
'Province': 'string',
'Country': 'string',
'PostalCode': 'string'
},
'MailingAddress': {
'Address1': 'string',
'Address2': 'string',
'Address3': 'string',
'Address4': 'string',
'City': 'string',
'County': 'string',
'State': 'string',
'Province': 'string',
'Country': 'string',
'PostalCode': 'string'
},
'BillingAddress': {
'Address1': 'string',
'Address2': 'string',
'Address3': 'string',
'Address4': 'string',
'City': 'string',
'County': 'string',
'State': 'string',
'Province': 'string',
'Country': 'string',
'PostalCode': 'string'
},
'Attributes': {
'string': 'string'
},
'FoundByItems': [
{
'KeyName': 'string',
'Values': [
'string',
]
},
],
'PartyTypeString': 'string',
'GenderString': 'string',
'ProfileType': 'ACCOUNT_PROFILE'|'PROFILE',
'EngagementPreferences': {
'Phone': [
{
'KeyName': 'string',
'KeyValue': 'string',
'ProfileId': 'string',
'ContactType': 'PhoneNumber'|'MobilePhoneNumber'|'HomePhoneNumber'|'BusinessPhoneNumber'|'EmailAddress'|'PersonalEmailAddress'|'BusinessEmailAddress'
},
],
'Email': [
{
'KeyName': 'string',
'KeyValue': 'string',
'ProfileId': 'string',
'ContactType': 'PhoneNumber'|'MobilePhoneNumber'|'HomePhoneNumber'|'BusinessPhoneNumber'|'EmailAddress'|'PersonalEmailAddress'|'BusinessEmailAddress'
},
]
}
}
},
],
'Failures': [
{
'ProfileId': 'string',
'Message': 'string',
'Status': 123
},
]
}
Response Structure
(dict) --
SegmentDefinitionName (string) --
The unique name of the segment definition.
Profiles (list) --
An array of maps where each contains a response per profile requested.
(dict) --
Object that holds the results for membership.
ProfileId (string) --
The profile id the result belongs to.
QueryResult (string) --
Describes whether the profile was absent or present in the segment.
Profile (dict) --
The standard profile of a customer.
ProfileId (string) --
The unique identifier of a customer profile.
AccountNumber (string) --
An account number that you have assigned to the customer.
AdditionalInformation (string) --
Any additional information relevant to the customer’s profile.
PartyType (string) --
The type of profile used to describe the customer.
BusinessName (string) --
The name of the customer’s business.
FirstName (string) --
The customer’s first name.
MiddleName (string) --
The customer’s middle name.
LastName (string) --
The customer’s last name.
BirthDate (string) --
The customer’s birth date.
Gender (string) --
The gender with which the customer identifies.
PhoneNumber (string) --
The customer's phone number, which has not been specified as a mobile, home, or business number.
MobilePhoneNumber (string) --
The customer’s mobile phone number.
HomePhoneNumber (string) --
The customer’s home phone number.
BusinessPhoneNumber (string) --
The customer’s home phone number.
EmailAddress (string) --
The customer’s email address, which has not been specified as a personal or business address.
PersonalEmailAddress (string) --
The customer’s personal email address.
BusinessEmailAddress (string) --
The customer’s business email address.
Address (dict) --
A generic address associated with the customer that is not mailing, shipping, or billing.
Address1 (string) --
The first line of a customer address.
Address2 (string) --
The second line of a customer address.
Address3 (string) --
The third line of a customer address.
Address4 (string) --
The fourth line of a customer address.
City (string) --
The city in which a customer lives.
County (string) --
The county in which a customer lives.
State (string) --
The state in which a customer lives.
Province (string) --
The province in which a customer lives.
Country (string) --
The country in which a customer lives.
PostalCode (string) --
The postal code of a customer address.
ShippingAddress (dict) --
The customer’s shipping address.
Address1 (string) --
The first line of a customer address.
Address2 (string) --
The second line of a customer address.
Address3 (string) --
The third line of a customer address.
Address4 (string) --
The fourth line of a customer address.
City (string) --
The city in which a customer lives.
County (string) --
The county in which a customer lives.
State (string) --
The state in which a customer lives.
Province (string) --
The province in which a customer lives.
Country (string) --
The country in which a customer lives.
PostalCode (string) --
The postal code of a customer address.
MailingAddress (dict) --
The customer’s mailing address.
Address1 (string) --
The first line of a customer address.
Address2 (string) --
The second line of a customer address.
Address3 (string) --
The third line of a customer address.
Address4 (string) --
The fourth line of a customer address.
City (string) --
The city in which a customer lives.
County (string) --
The county in which a customer lives.
State (string) --
The state in which a customer lives.
Province (string) --
The province in which a customer lives.
Country (string) --
The country in which a customer lives.
PostalCode (string) --
The postal code of a customer address.
BillingAddress (dict) --
The customer’s billing address.
Address1 (string) --
The first line of a customer address.
Address2 (string) --
The second line of a customer address.
Address3 (string) --
The third line of a customer address.
Address4 (string) --
The fourth line of a customer address.
City (string) --
The city in which a customer lives.
County (string) --
The county in which a customer lives.
State (string) --
The state in which a customer lives.
Province (string) --
The province in which a customer lives.
Country (string) --
The country in which a customer lives.
PostalCode (string) --
The postal code of a customer address.
Attributes (dict) --
A key value pair of attributes of a customer profile.
(string) --
(string) --
FoundByItems (list) --
A list of items used to find a profile returned in a SearchProfiles response. An item is a key-value(s) pair that matches an attribute in the profile.
If the optional AdditionalSearchKeys parameter was included in the SearchProfiles request, the FoundByItems list should be interpreted based on the LogicalOperator used in the request:
AND - The profile included in the response matched all of the search keys specified in the request. The FoundByItems will include all of the key-value(s) pairs that were specified in the request (as this is a requirement of AND search logic).
OR - The profile included in the response matched at least one of the search keys specified in the request. The FoundByItems will include each of the key-value(s) pairs that the profile was found by.
The OR relationship is the default behavior if the LogicalOperator parameter is not included in the SearchProfiles request.
(dict) --
A data type pair that consists of a KeyName and Values list that were used to find a profile returned in response to a SearchProfiles request.
KeyName (string) --
A searchable identifier of a customer profile.
Values (list) --
A list of key values.
(string) --
PartyTypeString (string) --
An alternative to PartyType which accepts any string as input.
GenderString (string) --
An alternative to Gender which accepts any string as input.
ProfileType (string) --
The type of the profile.
EngagementPreferences (dict) --
The customer or account’s engagement preferences.
Phone (list) --
A list of phone-related contact preferences
(dict) --
Object that defines users contact preference.
KeyName (string) --
A searchable, unique identifier of a customer profile.
KeyValue (string) --
The key value used to look up profile based off the keyName.
ProfileId (string) --
The unique identifier of a customer profile.
ContactType (string) --
The contact type used for engagement. For example: HomePhoneNumber, PersonalEmailAddress.
Email (list) --
A list of email-related contact preferences
(dict) --
Object that defines users contact preference.
KeyName (string) --
A searchable, unique identifier of a customer profile.
KeyValue (string) --
The key value used to look up profile based off the keyName.
ProfileId (string) --
The unique identifier of a customer profile.
ContactType (string) --
The contact type used for engagement. For example: HomePhoneNumber, PersonalEmailAddress.
Failures (list) --
An array of maps where each contains a response per profile failed for the request.
(dict) --
Object that holds failures for membership.
ProfileId (string) --
The profile id the failure belongs to.
Message (string) --
A message describing the failure.
Status (integer) --
The status describing the failure.
{'FieldSourceProfileIds': {'EngagementPreferences': 'string',
'ProfileType': 'string'}}
Runs an AWS Lambda job that does the following:
All the profileKeys in the ProfileToBeMerged will be moved to the main profile.
All the objects in the ProfileToBeMerged will be moved to the main profile.
All the ProfileToBeMerged will be deleted at the end.
All the profileKeys in the ProfileIdsToBeMerged will be moved to the main profile.
Standard fields are merged as follows:
Fields are always "union"-ed if there are no conflicts in standard fields or attributeKeys.
When there are conflicting fields:
If no SourceProfileIds entry is specified, the main Profile value is always taken.
If a SourceProfileIds entry is specified, the specified profileId is always taken, even if it is a NULL value.
You can use MergeProfiles together with GetMatches, which returns potentially matching profiles, or use it with the results of another matching system. After profiles have been merged, they cannot be separated (unmerged).
See also: AWS API Documentation
Request Syntax
client.merge_profiles(
DomainName='string',
MainProfileId='string',
ProfileIdsToBeMerged=[
'string',
],
FieldSourceProfileIds={
'AccountNumber': 'string',
'AdditionalInformation': 'string',
'PartyType': 'string',
'BusinessName': 'string',
'FirstName': 'string',
'MiddleName': 'string',
'LastName': 'string',
'BirthDate': 'string',
'Gender': 'string',
'PhoneNumber': 'string',
'MobilePhoneNumber': 'string',
'HomePhoneNumber': 'string',
'BusinessPhoneNumber': 'string',
'EmailAddress': 'string',
'PersonalEmailAddress': 'string',
'BusinessEmailAddress': 'string',
'Address': 'string',
'ShippingAddress': 'string',
'MailingAddress': 'string',
'BillingAddress': 'string',
'Attributes': {
'string': 'string'
},
'ProfileType': 'string',
'EngagementPreferences': 'string'
}
)
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The identifier of the profile to be taken.
list
[REQUIRED]
The identifier of the profile to be merged into MainProfileId.
(string) --
dict
The identifiers of the fields in the profile that has the information you want to apply to the merge. For example, say you want to merge EmailAddress from Profile1 into MainProfile. This would be the identifier of the EmailAddress field in Profile1.
AccountNumber (string) --
A unique identifier for the account number field to be merged.
AdditionalInformation (string) --
A unique identifier for the additional information field to be merged.
PartyType (string) --
A unique identifier for the party type field to be merged.
BusinessName (string) --
A unique identifier for the business name field to be merged.
FirstName (string) --
A unique identifier for the first name field to be merged.
MiddleName (string) --
A unique identifier for the middle name field to be merged.
LastName (string) --
A unique identifier for the last name field to be merged.
BirthDate (string) --
A unique identifier for the birthdate field to be merged.
Gender (string) --
A unique identifier for the gender field to be merged.
PhoneNumber (string) --
A unique identifier for the phone number field to be merged.
MobilePhoneNumber (string) --
A unique identifier for the mobile phone number field to be merged.
HomePhoneNumber (string) --
A unique identifier for the home phone number field to be merged.
BusinessPhoneNumber (string) --
A unique identifier for the business phone number field to be merged.
EmailAddress (string) --
A unique identifier for the email address field to be merged.
PersonalEmailAddress (string) --
A unique identifier for the personal email address field to be merged.
BusinessEmailAddress (string) --
A unique identifier for the party type field to be merged.
Address (string) --
A unique identifier for the party type field to be merged.
ShippingAddress (string) --
A unique identifier for the shipping address field to be merged.
MailingAddress (string) --
A unique identifier for the mailing address field to be merged.
BillingAddress (string) --
A unique identifier for the billing type field to be merged.
Attributes (dict) --
A unique identifier for the attributes field to be merged.
(string) --
(string) --
ProfileType (string) --
A unique identifier for the profile type field to be merged.
EngagementPreferences (string) --
A unique identifier for the engagement preferences field to be merged.
dict
Response Syntax
{
'Message': 'string'
}
Response Structure
(dict) --
Message (string) --
A message that indicates the merge request is complete.
{'Items': {'EngagementPreferences': {'Email': [{'ContactType': 'PhoneNumber | '
'MobilePhoneNumber '
'| '
'HomePhoneNumber '
'| '
'BusinessPhoneNumber '
'| EmailAddress '
'| '
'PersonalEmailAddress '
'| '
'BusinessEmailAddress',
'KeyName': 'string',
'KeyValue': 'string',
'ProfileId': 'string'}],
'Phone': [{'ContactType': 'PhoneNumber | '
'MobilePhoneNumber '
'| '
'HomePhoneNumber '
'| '
'BusinessPhoneNumber '
'| EmailAddress '
'| '
'PersonalEmailAddress '
'| '
'BusinessEmailAddress',
'KeyName': 'string',
'KeyValue': 'string',
'ProfileId': 'string'}]},
'ProfileType': 'ACCOUNT_PROFILE | PROFILE'}}
Searches for profiles within a specific domain using one or more predefined search keys (e.g., _fullName, _phone, _email, _account, etc.) and/or custom-defined search keys. A search key is a data type pair that consists of a KeyName and Values list.
This operation supports searching for profiles with a minimum of 1 key-value(s) pair and up to 5 key-value(s) pairs using either AND or OR logic.
See also: AWS API Documentation
Request Syntax
client.search_profiles(
NextToken='string',
MaxResults=123,
DomainName='string',
KeyName='string',
Values=[
'string',
],
AdditionalSearchKeys=[
{
'KeyName': 'string',
'Values': [
'string',
]
},
],
LogicalOperator='AND'|'OR'
)
string
The pagination token from the previous SearchProfiles API call.
integer
The maximum number of objects returned per page.
The default is 20 if this parameter is not included in the request.
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId, _shopifyOrderId.
list
[REQUIRED]
A list of key values.
(string) --
list
A list of AdditionalSearchKey objects that are each searchable identifiers of a profile. Each AdditionalSearchKey object contains a KeyName and a list of Values associated with that specific key (i.e., a key-value(s) pair). These additional search keys will be used in conjunction with the LogicalOperator and the required KeyName and Values parameters to search for profiles that satisfy the search criteria.
(dict) --
A data type pair that consists of a KeyName and Values list that is used in conjunction with the KeyName and Values parameters to search for profiles using the SearchProfiles API.
KeyName (string) -- [REQUIRED]
A searchable identifier of a customer profile.
Values (list) -- [REQUIRED]
A list of key values.
(string) --
string
Relationship between all specified search keys that will be used to search for profiles. This includes the required KeyName and Values parameters as well as any key-value(s) pairs specified in the AdditionalSearchKeys list.
This parameter influences which profiles will be returned in the response in the following manner:
AND - The response only includes profiles that match all of the search keys.
OR - The response includes profiles that match at least one of the search keys.
The OR relationship is the default behavior if this parameter is not included in the request.
dict
Response Syntax
{
'Items': [
{
'ProfileId': 'string',
'AccountNumber': 'string',
'AdditionalInformation': 'string',
'PartyType': 'INDIVIDUAL'|'BUSINESS'|'OTHER',
'BusinessName': 'string',
'FirstName': 'string',
'MiddleName': 'string',
'LastName': 'string',
'BirthDate': 'string',
'Gender': 'MALE'|'FEMALE'|'UNSPECIFIED',
'PhoneNumber': 'string',
'MobilePhoneNumber': 'string',
'HomePhoneNumber': 'string',
'BusinessPhoneNumber': 'string',
'EmailAddress': 'string',
'PersonalEmailAddress': 'string',
'BusinessEmailAddress': 'string',
'Address': {
'Address1': 'string',
'Address2': 'string',
'Address3': 'string',
'Address4': 'string',
'City': 'string',
'County': 'string',
'State': 'string',
'Province': 'string',
'Country': 'string',
'PostalCode': 'string'
},
'ShippingAddress': {
'Address1': 'string',
'Address2': 'string',
'Address3': 'string',
'Address4': 'string',
'City': 'string',
'County': 'string',
'State': 'string',
'Province': 'string',
'Country': 'string',
'PostalCode': 'string'
},
'MailingAddress': {
'Address1': 'string',
'Address2': 'string',
'Address3': 'string',
'Address4': 'string',
'City': 'string',
'County': 'string',
'State': 'string',
'Province': 'string',
'Country': 'string',
'PostalCode': 'string'
},
'BillingAddress': {
'Address1': 'string',
'Address2': 'string',
'Address3': 'string',
'Address4': 'string',
'City': 'string',
'County': 'string',
'State': 'string',
'Province': 'string',
'Country': 'string',
'PostalCode': 'string'
},
'Attributes': {
'string': 'string'
},
'FoundByItems': [
{
'KeyName': 'string',
'Values': [
'string',
]
},
],
'PartyTypeString': 'string',
'GenderString': 'string',
'ProfileType': 'ACCOUNT_PROFILE'|'PROFILE',
'EngagementPreferences': {
'Phone': [
{
'KeyName': 'string',
'KeyValue': 'string',
'ProfileId': 'string',
'ContactType': 'PhoneNumber'|'MobilePhoneNumber'|'HomePhoneNumber'|'BusinessPhoneNumber'|'EmailAddress'|'PersonalEmailAddress'|'BusinessEmailAddress'
},
],
'Email': [
{
'KeyName': 'string',
'KeyValue': 'string',
'ProfileId': 'string',
'ContactType': 'PhoneNumber'|'MobilePhoneNumber'|'HomePhoneNumber'|'BusinessPhoneNumber'|'EmailAddress'|'PersonalEmailAddress'|'BusinessEmailAddress'
},
]
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of Profiles matching the search criteria.
(dict) --
The standard profile of a customer.
ProfileId (string) --
The unique identifier of a customer profile.
AccountNumber (string) --
An account number that you have assigned to the customer.
AdditionalInformation (string) --
Any additional information relevant to the customer’s profile.
PartyType (string) --
The type of profile used to describe the customer.
BusinessName (string) --
The name of the customer’s business.
FirstName (string) --
The customer’s first name.
MiddleName (string) --
The customer’s middle name.
LastName (string) --
The customer’s last name.
BirthDate (string) --
The customer’s birth date.
Gender (string) --
The gender with which the customer identifies.
PhoneNumber (string) --
The customer's phone number, which has not been specified as a mobile, home, or business number.
MobilePhoneNumber (string) --
The customer’s mobile phone number.
HomePhoneNumber (string) --
The customer’s home phone number.
BusinessPhoneNumber (string) --
The customer’s home phone number.
EmailAddress (string) --
The customer’s email address, which has not been specified as a personal or business address.
PersonalEmailAddress (string) --
The customer’s personal email address.
BusinessEmailAddress (string) --
The customer’s business email address.
Address (dict) --
A generic address associated with the customer that is not mailing, shipping, or billing.
Address1 (string) --
The first line of a customer address.
Address2 (string) --
The second line of a customer address.
Address3 (string) --
The third line of a customer address.
Address4 (string) --
The fourth line of a customer address.
City (string) --
The city in which a customer lives.
County (string) --
The county in which a customer lives.
State (string) --
The state in which a customer lives.
Province (string) --
The province in which a customer lives.
Country (string) --
The country in which a customer lives.
PostalCode (string) --
The postal code of a customer address.
ShippingAddress (dict) --
The customer’s shipping address.
Address1 (string) --
The first line of a customer address.
Address2 (string) --
The second line of a customer address.
Address3 (string) --
The third line of a customer address.
Address4 (string) --
The fourth line of a customer address.
City (string) --
The city in which a customer lives.
County (string) --
The county in which a customer lives.
State (string) --
The state in which a customer lives.
Province (string) --
The province in which a customer lives.
Country (string) --
The country in which a customer lives.
PostalCode (string) --
The postal code of a customer address.
MailingAddress (dict) --
The customer’s mailing address.
Address1 (string) --
The first line of a customer address.
Address2 (string) --
The second line of a customer address.
Address3 (string) --
The third line of a customer address.
Address4 (string) --
The fourth line of a customer address.
City (string) --
The city in which a customer lives.
County (string) --
The county in which a customer lives.
State (string) --
The state in which a customer lives.
Province (string) --
The province in which a customer lives.
Country (string) --
The country in which a customer lives.
PostalCode (string) --
The postal code of a customer address.
BillingAddress (dict) --
The customer’s billing address.
Address1 (string) --
The first line of a customer address.
Address2 (string) --
The second line of a customer address.
Address3 (string) --
The third line of a customer address.
Address4 (string) --
The fourth line of a customer address.
City (string) --
The city in which a customer lives.
County (string) --
The county in which a customer lives.
State (string) --
The state in which a customer lives.
Province (string) --
The province in which a customer lives.
Country (string) --
The country in which a customer lives.
PostalCode (string) --
The postal code of a customer address.
Attributes (dict) --
A key value pair of attributes of a customer profile.
(string) --
(string) --
FoundByItems (list) --
A list of items used to find a profile returned in a SearchProfiles response. An item is a key-value(s) pair that matches an attribute in the profile.
If the optional AdditionalSearchKeys parameter was included in the SearchProfiles request, the FoundByItems list should be interpreted based on the LogicalOperator used in the request:
AND - The profile included in the response matched all of the search keys specified in the request. The FoundByItems will include all of the key-value(s) pairs that were specified in the request (as this is a requirement of AND search logic).
OR - The profile included in the response matched at least one of the search keys specified in the request. The FoundByItems will include each of the key-value(s) pairs that the profile was found by.
The OR relationship is the default behavior if the LogicalOperator parameter is not included in the SearchProfiles request.
(dict) --
A data type pair that consists of a KeyName and Values list that were used to find a profile returned in response to a SearchProfiles request.
KeyName (string) --
A searchable identifier of a customer profile.
Values (list) --
A list of key values.
(string) --
PartyTypeString (string) --
An alternative to PartyType which accepts any string as input.
GenderString (string) --
An alternative to Gender which accepts any string as input.
ProfileType (string) --
The type of the profile.
EngagementPreferences (dict) --
The customer or account’s engagement preferences.
Phone (list) --
A list of phone-related contact preferences
(dict) --
Object that defines users contact preference.
KeyName (string) --
A searchable, unique identifier of a customer profile.
KeyValue (string) --
The key value used to look up profile based off the keyName.
ProfileId (string) --
The unique identifier of a customer profile.
ContactType (string) --
The contact type used for engagement. For example: HomePhoneNumber, PersonalEmailAddress.
Email (list) --
A list of email-related contact preferences
(dict) --
Object that defines users contact preference.
KeyName (string) --
A searchable, unique identifier of a customer profile.
KeyValue (string) --
The key value used to look up profile based off the keyName.
ProfileId (string) --
The unique identifier of a customer profile.
ContactType (string) --
The contact type used for engagement. For example: HomePhoneNumber, PersonalEmailAddress.
NextToken (string) --
The pagination token from the previous SearchProfiles API call.
{'EngagementPreferences': {'Email': [{'ContactType': 'PhoneNumber | '
'MobilePhoneNumber | '
'HomePhoneNumber | '
'BusinessPhoneNumber | '
'EmailAddress | '
'PersonalEmailAddress | '
'BusinessEmailAddress',
'KeyName': 'string',
'KeyValue': 'string',
'ProfileId': 'string'}],
'Phone': [{'ContactType': 'PhoneNumber | '
'MobilePhoneNumber | '
'HomePhoneNumber | '
'BusinessPhoneNumber | '
'EmailAddress | '
'PersonalEmailAddress | '
'BusinessEmailAddress',
'KeyName': 'string',
'KeyValue': 'string',
'ProfileId': 'string'}]},
'ProfileType': 'ACCOUNT_PROFILE | PROFILE'}
Updates the properties of a profile. The ProfileId is required for updating a customer profile.
When calling the UpdateProfile API, specifying an empty string value means that any existing value will be removed. Not specifying a string value means that any value already there will be kept.
See also: AWS API Documentation
Request Syntax
client.update_profile(
DomainName='string',
ProfileId='string',
AdditionalInformation='string',
AccountNumber='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'
},
PartyTypeString='string',
GenderString='string',
ProfileType='ACCOUNT_PROFILE'|'PROFILE',
EngagementPreferences={
'Phone': [
{
'KeyName': 'string',
'KeyValue': 'string',
'ProfileId': 'string',
'ContactType': 'PhoneNumber'|'MobilePhoneNumber'|'HomePhoneNumber'|'BusinessPhoneNumber'|'EmailAddress'|'PersonalEmailAddress'|'BusinessEmailAddress'
},
],
'Email': [
{
'KeyName': 'string',
'KeyValue': 'string',
'ProfileId': 'string',
'ContactType': 'PhoneNumber'|'MobilePhoneNumber'|'HomePhoneNumber'|'BusinessPhoneNumber'|'EmailAddress'|'PersonalEmailAddress'|'BusinessEmailAddress'
},
]
}
)
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The unique identifier of a customer profile.
string
Any additional information relevant to the customer’s profile.
string
An account number that you have assigned to the customer.
string
The type of profile used to describe the customer.
string
The name of the customer’s business.
string
The customer’s first name.
string
The customer’s middle name.
string
The customer’s last name.
string
The customer’s birth date.
string
The gender with which the customer identifies.
string
The customer’s phone number, which has not been specified as a mobile, home, or business number.
string
The customer’s mobile phone number.
string
The customer’s home phone number.
string
The customer’s business phone number.
string
The customer’s email address, which has not been specified as a personal or business address.
string
The customer’s personal email address.
string
The customer’s business email 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.
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.
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.
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.
dict
A key value pair of attributes of a customer profile.
(string) --
(string) --
string
An alternative to PartyType which accepts any string as input.
string
An alternative to Gender which accepts any string as input.
string
Determines the type of the profile.
dict
Object that defines users preferred methods of engagement.
Phone (list) --
A list of phone-related contact preferences
(dict) --
Object that defines users contact preference.
KeyName (string) --
A searchable, unique identifier of a customer profile.
KeyValue (string) --
The key value used to look up profile based off the keyName.
ProfileId (string) --
The unique identifier of a customer profile.
ContactType (string) --
The contact type used for engagement. For example: HomePhoneNumber, PersonalEmailAddress.
Email (list) --
A list of email-related contact preferences
(dict) --
Object that defines users contact preference.
KeyName (string) --
A searchable, unique identifier of a customer profile.
KeyValue (string) --
The key value used to look up profile based off the keyName.
ProfileId (string) --
The unique identifier of a customer profile.
ContactType (string) --
The contact type used for engagement. For example: HomePhoneNumber, PersonalEmailAddress.
dict
Response Syntax
{
'ProfileId': 'string'
}
Response Structure
(dict) --
ProfileId (string) --
The unique identifier of a customer profile.