2020/12/02 - Amazon Connect Customer Profiles - 28 new api methods
Changes Removes an incorrectly named service `Profile` that was included in release, v2.801.0
Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.
See also: AWS API Documentation
Request Syntax
client.delete_domain(
DomainName='string'
)
string
[REQUIRED]
The unique name of the domain.
dict
Response Syntax
{
'Message': 'string'
}
Response Structure
(dict) --
Message (string) --
A message that indicates the delete request is done.
Lists all of the template information for object types.
See also: AWS API Documentation
Request Syntax
client.list_profile_object_type_templates(
NextToken='string',
MaxResults=123
)
string
The pagination token from the previous ListObjectTypeTemplates API call.
integer
The maximum number of objects returned per page.
dict
Response Syntax
{
'Items': [
{
'TemplateId': 'string',
'SourceName': 'string',
'SourceObject': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of ListProfileObjectType template instances.
(dict) --
A ProfileObjectTypeTemplate in a list of ProfileObjectTypeTemplates.
TemplateId (string) --
A unique identifier for the object template.
SourceName (string) --
The name of the source of the object template.
SourceObject (string) --
The source of the object template.
NextToken (string) --
The pagination token from the previous ListObjectTypeTemplates API call.
Adds additional objects to customer profiles of a given ObjectType.
When adding a specific profile object, like a Contact Trace Record (CTR), an inferred profile can get created if it is not mapped to an existing profile. The resulting profile will only have a phone number populated in the standard ProfileObject. Any additional CTRs with the same phone number will be mapped to the same inferred profile.
When a ProfileObject is created and if a ProfileObjectType already exists for the ProfileObject, it will provide data to a standard profile depending on the ProfileObjectType definition.
PutProfileObject needs an ObjectType, which can be created using PutProfileObjectType.
See also: AWS API Documentation
Request Syntax
client.put_profile_object(
ObjectTypeName='string',
Object='string',
DomainName='string'
)
string
[REQUIRED]
The name of the profile object type.
string
[REQUIRED]
A string that is serialized from a JSON object.
string
[REQUIRED]
The unique name of the domain.
dict
Response Syntax
{
'ProfileObjectUniqueKey': 'string'
}
Response Structure
(dict) --
ProfileObjectUniqueKey (string) --
The unique identifier of the profile object generated by the service.
Lists all of the integrations in your domain.
See also: AWS API Documentation
Request Syntax
client.list_integrations(
DomainName='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The unique name of the domain.
string
The pagination token from the previous ListIntegrations API call.
integer
The maximum number of objects returned per page.
dict
Response Syntax
{
'Items': [
{
'DomainName': 'string',
'Uri': 'string',
'ObjectTypeName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of ListIntegrations instances.
(dict) --
An integration in list of integrations.
DomainName (string) --
The unique name of the domain.
Uri (string) --
The URI of the S3 bucket or any other type of data source.
ObjectTypeName (string) --
The name of the profile object type.
CreatedAt (datetime) --
The timestamp of when the domain was created.
LastUpdatedAt (datetime) --
The timestamp of when the domain was most recently edited.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
NextToken (string) --
The pagination token from the previous ListIntegrations API call.
Lists all of the templates available within the service.
See also: AWS API Documentation
Request Syntax
client.list_profile_object_types(
DomainName='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The unique name of the domain.
string
Identifies the next page of results to return.
integer
The maximum number of objects returned per page.
dict
Response Syntax
{
'Items': [
{
'ObjectTypeName': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of ListProfileObjectTypes instances.
(dict) --
A ProfileObjectType instance.
ObjectTypeName (string) --
The name of the profile object type.
Description (string) --
Description of the profile object type.
CreatedAt (datetime) --
The timestamp of when the domain was created.
LastUpdatedAt (datetime) --
The timestamp of when the domain was most recently edited.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
NextToken (string) --
Identifies the next page of results to return.
Returns the object types for a specific domain.
See also: AWS API Documentation
Request Syntax
client.get_profile_object_type(
DomainName='string',
ObjectTypeName='string'
)
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The name of the profile object type.
dict
Response Syntax
{
'ObjectTypeName': 'string',
'Description': 'string',
'TemplateId': 'string',
'ExpirationDays': 123,
'EncryptionKey': 'string',
'AllowProfileCreation': True|False,
'Fields': {
'string': {
'Source': 'string',
'Target': 'string',
'ContentType': 'STRING'|'NUMBER'|'PHONE_NUMBER'|'EMAIL_ADDRESS'|'NAME'
}
},
'Keys': {
'string': [
{
'StandardIdentifiers': [
'PROFILE'|'UNIQUE'|'SECONDARY'|'LOOKUP_ONLY'|'NEW_ONLY',
],
'FieldNames': [
'string',
]
},
]
},
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
ObjectTypeName (string) --
The name of the profile object type.
Description (string) --
The description of the profile object type.
TemplateId (string) --
A unique identifier for the object template.
ExpirationDays (integer) --
The number of days until the data in the object expires.
EncryptionKey (string) --
The customer-provided key to encrypt the profile object that will be created in this profile object type.
AllowProfileCreation (boolean) --
Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE . If the AllowProfileCreation flag is set to FALSE , then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE , and if no match is found, then the service creates a new standard profile.
Fields (dict) --
A map of the name and ObjectType field.
(string) --
(dict) --
Represents a field in a ProfileObjectType.
Source (string) --
A field of a ProfileObject. For example: _source.FirstName, where “_source” is a ProfileObjectType of a Zendesk user and “FirstName” is a field in that ObjectType.
Target (string) --
The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.
ContentType (string) --
The content type of the field. Used for determining equality when searching.
Keys (dict) --
A list of unique keys that can be used to map data to the profile.
(string) --
(list) --
(dict) --
An object that defines the Key element of a ProfileObject. A Key is a special element that can be used to search for a customer profile.
StandardIdentifiers (list) --
The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE means that this key can be used to tie an object to a PROFILE. UNIQUE means that it can be used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the profile does not already exist before the object is ingested, otherwise it is only used for matching objects to profiles.
(string) --
FieldNames (list) --
The reference for the key name of the fields map.
(string) --
CreatedAt (datetime) --
The timestamp of when the domain was created.
LastUpdatedAt (datetime) --
The timestamp of when the domain was most recently edited.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect.
An integration can belong to only one domain.
See also: AWS API Documentation
Request Syntax
client.put_integration(
DomainName='string',
Uri='string',
ObjectTypeName='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The URI of the S3 bucket or any other type of data source.
string
[REQUIRED]
The name of the profile object type.
dict
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
dict
Response Syntax
{
'DomainName': 'string',
'Uri': 'string',
'ObjectTypeName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
DomainName (string) --
The unique name of the domain.
Uri (string) --
The URI of the S3 bucket or any other type of data source.
ObjectTypeName (string) --
The name of the profile object type.
CreatedAt (datetime) --
The timestamp of when the domain was created.
LastUpdatedAt (datetime) --
The timestamp of when the domain was most recently edited.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
Lists all of the integrations associated to a specific URI in the AWS account.
See also: AWS API Documentation
Request Syntax
client.list_account_integrations(
Uri='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The URI of the S3 bucket or any other type of data source.
string
The pagination token from the previous ListAccountIntegrations API call.
integer
The maximum number of objects returned per page.
dict
Response Syntax
{
'Items': [
{
'DomainName': 'string',
'Uri': 'string',
'ObjectTypeName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of ListAccountIntegration instances.
(dict) --
An integration in list of integrations.
DomainName (string) --
The unique name of the domain.
Uri (string) --
The URI of the S3 bucket or any other type of data source.
ObjectTypeName (string) --
The name of the profile object type.
CreatedAt (datetime) --
The timestamp of when the domain was created.
LastUpdatedAt (datetime) --
The timestamp of when the domain was most recently edited.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
NextToken (string) --
The pagination token from the previous ListAccountIntegrations API call.
Removes an integration from a specific domain.
See also: AWS API Documentation
Request Syntax
client.delete_integration(
DomainName='string',
Uri='string'
)
string
[REQUIRED]
The unique name of the domain.
string
The URI of the S3 bucket or any other type of data source.
dict
Response Syntax
{
'Message': 'string'
}
Response Structure
(dict) --
Message (string) --
A message that indicates the delete request is done.
Removes one or more tags from the specified Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
string
[REQUIRED]
The ARN of the resource from which you are removing tags.
list
[REQUIRED]
The list of tag keys to remove from the resource.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Removes a searchable key from a customer profile.
See also: AWS API Documentation
Request Syntax
client.delete_profile_key(
ProfileId='string',
KeyName='string',
Values=[
'string',
],
DomainName='string'
)
string
[REQUIRED]
The unique identifier of a customer profile.
string
[REQUIRED]
A searchable identifier of a customer profile.
list
[REQUIRED]
A list of key values.
(string) --
string
[REQUIRED]
The unique name of the domain.
dict
Response Syntax
{
'Message': 'string'
}
Response Structure
(dict) --
Message (string) --
A message that indicates the delete request is done.
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'
}
)
string
[REQUIRED]
The unique name of the domain.
string
A unique account number that you have given 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) --
dict
Response Syntax
{
'ProfileId': 'string'
}
Response Structure
(dict) --
ProfileId (string) --
The unique identifier of a customer profile.
Returns a list of all the domains for an AWS account that have been created.
See also: AWS API Documentation
Request Syntax
client.list_domains(
NextToken='string',
MaxResults=123
)
string
The pagination token from the previous ListDomain API call.
integer
The maximum number of objects returned per page.
dict
Response Syntax
{
'Items': [
{
'DomainName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of ListDomains instances.
(dict) --
An object in a list that represents a domain.
DomainName (string) --
The unique name of the domain.
CreatedAt (datetime) --
The timestamp of when the domain was created.
LastUpdatedAt (datetime) --
The timestamp of when the domain was most recently edited.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
NextToken (string) --
The pagination token from the previous ListDomains API call.
Removes an object associated with a profile of a given ProfileObjectType.
See also: AWS API Documentation
Request Syntax
client.delete_profile_object(
ProfileId='string',
ProfileObjectUniqueKey='string',
ObjectTypeName='string',
DomainName='string'
)
string
[REQUIRED]
The unique identifier of a customer profile.
string
[REQUIRED]
The unique identifier of the profile object generated by the service.
string
[REQUIRED]
The name of the profile object type.
string
[REQUIRED]
The unique name of the domain.
dict
Response Syntax
{
'Message': 'string'
}
Response Structure
(dict) --
Message (string) --
A message that indicates the delete request is done.
Deletes the standard customer profile and all data pertaining to the profile.
See also: AWS API Documentation
Request Syntax
client.delete_profile(
ProfileId='string',
DomainName='string'
)
string
[REQUIRED]
The unique identifier of a customer profile.
string
[REQUIRED]
The unique name of the domain.
dict
Response Syntax
{
'Message': 'string'
}
Response Structure
(dict) --
Message (string) --
A message that indicates the delete request is done.
Removes a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type. It also disables integrations from this specific ProfileObjectType. In addition, it scrubs all of the fields of the standard profile that were populated from this ProfileObjectType.
See also: AWS API Documentation
Request Syntax
client.delete_profile_object_type(
DomainName='string',
ObjectTypeName='string'
)
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The name of the profile object type.
dict
Response Syntax
{
'Message': 'string'
}
Response Structure
(dict) --
Message (string) --
A message that indicates the delete request is done.
Associates a new key value with a specific profile, such as a Contact Trace Record (CTR) ContactId.
A profile object can have a single unique key and any number of additional keys that can be used to identify the profile that it belongs to.
See also: AWS API Documentation
Request Syntax
client.add_profile_key(
ProfileId='string',
KeyName='string',
Values=[
'string',
],
DomainName='string'
)
string
[REQUIRED]
The unique identifier of a customer profile.
string
[REQUIRED]
A searchable identifier of a customer profile.
list
[REQUIRED]
A list of key values.
(string) --
string
[REQUIRED]
The unique name of the domain.
dict
Response Syntax
{
'KeyName': 'string',
'Values': [
'string',
]
}
Response Structure
(dict) --
KeyName (string) --
A searchable identifier of a customer profile.
Values (list) --
A list of key values.
(string) --
Creates a domain, which is a container for all customer data, such as customer profile attributes, object types, profile keys, and encryption keys. You can create multiple domains, and each domain can have multiple third-party integrations.
Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can be associated with one domain.
See also: AWS API Documentation
Request Syntax
client.create_domain(
DomainName='string',
DefaultExpirationDays=123,
DefaultEncryptionKey='string',
DeadLetterQueueUrl='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The unique name of the domain.
integer
[REQUIRED]
The default number of days until the data within the domain expires.
string
The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.
string
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue.
dict
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
dict
Response Syntax
{
'DomainName': 'string',
'DefaultExpirationDays': 123,
'DefaultEncryptionKey': 'string',
'DeadLetterQueueUrl': 'string',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
DomainName (string) --
The unique name of the domain.
DefaultExpirationDays (integer) --
The default number of days until the data within the domain expires.
DefaultEncryptionKey (string) --
The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.
DeadLetterQueueUrl (string) --
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
CreatedAt (datetime) --
The timestamp of when the domain was created.
LastUpdatedAt (datetime) --
The timestamp of when the domain was most recently edited.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
Returns an integration for a domain.
See also: AWS API Documentation
Request Syntax
client.get_integration(
DomainName='string',
Uri='string'
)
string
[REQUIRED]
The unique name of the domain.
string
The URI of the S3 bucket or any other type of data source.
dict
Response Syntax
{
'DomainName': 'string',
'Uri': 'string',
'ObjectTypeName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
DomainName (string) --
The unique name of the domain.
Uri (string) --
The URI of the S3 bucket or any other type of data source.
ObjectTypeName (string) --
The name of the profile object type.
CreatedAt (datetime) --
The timestamp of when the domain was created.
LastUpdatedAt (datetime) --
The timestamp of when the domain was most recently edited.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption key.
Once a domain is created, the name can’t be changed.
See also: AWS API Documentation
Request Syntax
client.update_domain(
DomainName='string',
DefaultExpirationDays=123,
DefaultEncryptionKey='string',
DeadLetterQueueUrl='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The unique name for the domain.
integer
The default number of days until the data within the domain expires.
string
The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage. If specified as an empty string, it will clear any existing value.
string
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. If specified as an empty string, it will clear any existing value. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue.
dict
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
dict
Response Syntax
{
'DomainName': 'string',
'DefaultExpirationDays': 123,
'DefaultEncryptionKey': 'string',
'DeadLetterQueueUrl': 'string',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
DomainName (string) --
The unique name for the domain.
DefaultExpirationDays (integer) --
The default number of days until the data within the domain expires.
DefaultEncryptionKey (string) --
The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.
DeadLetterQueueUrl (string) --
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
CreatedAt (datetime) --
The timestamp of when the domain was created.
LastUpdatedAt (datetime) --
The timestamp of when the domain was most recently edited.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
Returns the template information for a specific object type.
A template is a predefined ProfileObjectType, such as “Salesforce-Account” or “Salesforce-Contact.” When a user sends a ProfileObject, using the PutProfileObject API, with an ObjectTypeName that matches one of the TemplateIds, it uses the mappings from the template.
See also: AWS API Documentation
Request Syntax
client.get_profile_object_type_template(
TemplateId='string'
)
string
[REQUIRED]
A unique identifier for the object template.
dict
Response Syntax
{
'TemplateId': 'string',
'SourceName': 'string',
'SourceObject': 'string',
'AllowProfileCreation': True|False,
'Fields': {
'string': {
'Source': 'string',
'Target': 'string',
'ContentType': 'STRING'|'NUMBER'|'PHONE_NUMBER'|'EMAIL_ADDRESS'|'NAME'
}
},
'Keys': {
'string': [
{
'StandardIdentifiers': [
'PROFILE'|'UNIQUE'|'SECONDARY'|'LOOKUP_ONLY'|'NEW_ONLY',
],
'FieldNames': [
'string',
]
},
]
}
}
Response Structure
(dict) --
TemplateId (string) --
A unique identifier for the object template.
SourceName (string) --
The name of the source of the object template.
SourceObject (string) --
The source of the object template.
AllowProfileCreation (boolean) --
Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE . If the AllowProfileCreation flag is set to FALSE , then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE , and if no match is found, then the service creates a new standard profile.
Fields (dict) --
A map of the name and ObjectType field.
(string) --
(dict) --
Represents a field in a ProfileObjectType.
Source (string) --
A field of a ProfileObject. For example: _source.FirstName, where “_source” is a ProfileObjectType of a Zendesk user and “FirstName” is a field in that ObjectType.
Target (string) --
The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.
ContentType (string) --
The content type of the field. Used for determining equality when searching.
Keys (dict) --
A list of unique keys that can be used to map data to the profile.
(string) --
(list) --
(dict) --
An object that defines the Key element of a ProfileObject. A Key is a special element that can be used to search for a customer profile.
StandardIdentifiers (list) --
The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE means that this key can be used to tie an object to a PROFILE. UNIQUE means that it can be used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the profile does not already exist before the object is ingested, otherwise it is only used for matching objects to profiles.
(string) --
FieldNames (list) --
The reference for the key name of the fields map.
(string) --
Searches for profiles within a specific domain name using name, phone number, email address, account number, or a custom defined index.
See also: AWS API Documentation
Request Syntax
client.search_profiles(
NextToken='string',
MaxResults=123,
DomainName='string',
KeyName='string',
Values=[
'string',
]
)
string
The pagination token from the previous SearchProfiles API call.
integer
The maximum number of objects returned per page.
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, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _zendeskUserId, _zendeskExternalId, _serviceNowSystemId.
list
[REQUIRED]
A list of key values.
(string) --
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'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of SearchProfiles instances.
(dict) --
The standard profile of a customer.
ProfileId (string) --
The unique identifier of a customer profile.
AccountNumber (string) --
A unique account number that you have given to the customer.
AdditionalInformation (string) --
Any additional information relevant to the customer's profile.
PartyType (string) --
The type of profile used to describe the customer.
BusinessName (string) --
The name of the customer’s business.
FirstName (string) --
The customer’s first name.
MiddleName (string) --
The customer’s middle name.
LastName (string) --
The customer’s last name.
BirthDate (string) --
The customer’s birth date.
Gender (string) --
The gender with which the customer identifies.
PhoneNumber (string) --
The customer's phone number, which has not been specified as a mobile, home, or business number.
MobilePhoneNumber (string) --
The customer’s mobile phone number.
HomePhoneNumber (string) --
The customer’s home phone number.
BusinessPhoneNumber (string) --
The customer’s home phone number.
EmailAddress (string) --
The customer's email address, which has not been specified as a personal or business address.
PersonalEmailAddress (string) --
The customer’s personal email address.
BusinessEmailAddress (string) --
The customer’s business email address.
Address (dict) --
A generic address associated with the customer that is not mailing, shipping, or billing.
Address1 (string) --
The first line of a customer address.
Address2 (string) --
The second line of a customer address.
Address3 (string) --
The third line of a customer address.
Address4 (string) --
The fourth line of a customer address.
City (string) --
The city in which a customer lives.
County (string) --
The county in which a customer lives.
State (string) --
The state in which a customer lives.
Province (string) --
The province in which a customer lives.
Country (string) --
The country in which a customer lives.
PostalCode (string) --
The postal code of a customer address.
ShippingAddress (dict) --
The customer’s shipping address.
Address1 (string) --
The first line of a customer address.
Address2 (string) --
The second line of a customer address.
Address3 (string) --
The third line of a customer address.
Address4 (string) --
The fourth line of a customer address.
City (string) --
The city in which a customer lives.
County (string) --
The county in which a customer lives.
State (string) --
The state in which a customer lives.
Province (string) --
The province in which a customer lives.
Country (string) --
The country in which a customer lives.
PostalCode (string) --
The postal code of a customer address.
MailingAddress (dict) --
The customer’s mailing address.
Address1 (string) --
The first line of a customer address.
Address2 (string) --
The second line of a customer address.
Address3 (string) --
The third line of a customer address.
Address4 (string) --
The fourth line of a customer address.
City (string) --
The city in which a customer lives.
County (string) --
The county in which a customer lives.
State (string) --
The state in which a customer lives.
Province (string) --
The province in which a customer lives.
Country (string) --
The country in which a customer lives.
PostalCode (string) --
The postal code of a customer address.
BillingAddress (dict) --
The customer’s billing address.
Address1 (string) --
The first line of a customer address.
Address2 (string) --
The second line of a customer address.
Address3 (string) --
The third line of a customer address.
Address4 (string) --
The fourth line of a customer address.
City (string) --
The city in which a customer lives.
County (string) --
The county in which a customer lives.
State (string) --
The state in which a customer lives.
Province (string) --
The province in which a customer lives.
Country (string) --
The country in which a customer lives.
PostalCode (string) --
The postal code of a customer address.
Attributes (dict) --
A key value pair of attributes of a customer profile.
(string) --
(string) --
NextToken (string) --
The pagination token from the previous SearchProfiles API call.
Assigns one or more tags (key-value pairs) to the specified Amazon Connect Customer Profiles resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.
Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.
You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a resource.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
The ARN of the resource that you're adding tags to.
dict
[REQUIRED]
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
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'
}
)
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
A unique account number that you have given 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) --
dict
Response Syntax
{
'ProfileId': 'string'
}
Response Structure
(dict) --
ProfileId (string) --
The unique identifier of a customer profile.
Returns information about a specific domain.
See also: AWS API Documentation
Request Syntax
client.get_domain(
DomainName='string'
)
string
[REQUIRED]
A unique name for the domain.
dict
Response Syntax
{
'DomainName': 'string',
'DefaultExpirationDays': 123,
'DefaultEncryptionKey': 'string',
'DeadLetterQueueUrl': 'string',
'Stats': {
'ProfileCount': 123,
'MeteringProfileCount': 123,
'ObjectCount': 123,
'TotalSize': 123
},
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
DomainName (string) --
The unique name of the domain.
DefaultExpirationDays (integer) --
The default number of days until the data within the domain expires.
DefaultEncryptionKey (string) --
The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.
DeadLetterQueueUrl (string) --
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
Stats (dict) --
Usage-specific statistics about the domain.
ProfileCount (integer) --
The total number of profiles currently in the domain.
MeteringProfileCount (integer) --
The number of profiles that you are currently paying for in the domain. If you have more than 100 objects associated with a single profile, that profile counts as two profiles. If you have more than 200 objects, that profile counts as three, and so on.
ObjectCount (integer) --
The total number of objects in domain.
TotalSize (integer) --
The total size, in bytes, of all objects in the domain.
CreatedAt (datetime) --
The timestamp of when the domain was created.
LastUpdatedAt (datetime) --
The timestamp of when the domain was most recently edited.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
Defines a ProfileObjectType.
See also: AWS API Documentation
Request Syntax
client.put_profile_object_type(
DomainName='string',
ObjectTypeName='string',
Description='string',
TemplateId='string',
ExpirationDays=123,
EncryptionKey='string',
AllowProfileCreation=True|False,
Fields={
'string': {
'Source': 'string',
'Target': 'string',
'ContentType': 'STRING'|'NUMBER'|'PHONE_NUMBER'|'EMAIL_ADDRESS'|'NAME'
}
},
Keys={
'string': [
{
'StandardIdentifiers': [
'PROFILE'|'UNIQUE'|'SECONDARY'|'LOOKUP_ONLY'|'NEW_ONLY',
],
'FieldNames': [
'string',
]
},
]
},
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The name of the profile object type.
string
[REQUIRED]
Description of the profile object type.
string
A unique identifier for the object template.
integer
The number of days until the data in the object expires.
string
The customer-provided key to encrypt the profile object that will be created in this profile object type.
boolean
Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE . If the AllowProfileCreation flag is set to FALSE , then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE , and if no match is found, then the service creates a new standard profile.
dict
A map of the name and ObjectType field.
(string) --
(dict) --
Represents a field in a ProfileObjectType.
Source (string) --
A field of a ProfileObject. For example: _source.FirstName, where “_source” is a ProfileObjectType of a Zendesk user and “FirstName” is a field in that ObjectType.
Target (string) --
The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.
ContentType (string) --
The content type of the field. Used for determining equality when searching.
dict
A list of unique keys that can be used to map data to the profile.
(string) --
(list) --
(dict) --
An object that defines the Key element of a ProfileObject. A Key is a special element that can be used to search for a customer profile.
StandardIdentifiers (list) --
The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE means that this key can be used to tie an object to a PROFILE. UNIQUE means that it can be used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the profile does not already exist before the object is ingested, otherwise it is only used for matching objects to profiles.
(string) --
FieldNames (list) --
The reference for the key name of the fields map.
(string) --
dict
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
dict
Response Syntax
{
'ObjectTypeName': 'string',
'Description': 'string',
'TemplateId': 'string',
'ExpirationDays': 123,
'EncryptionKey': 'string',
'AllowProfileCreation': True|False,
'Fields': {
'string': {
'Source': 'string',
'Target': 'string',
'ContentType': 'STRING'|'NUMBER'|'PHONE_NUMBER'|'EMAIL_ADDRESS'|'NAME'
}
},
'Keys': {
'string': [
{
'StandardIdentifiers': [
'PROFILE'|'UNIQUE'|'SECONDARY'|'LOOKUP_ONLY'|'NEW_ONLY',
],
'FieldNames': [
'string',
]
},
]
},
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
ObjectTypeName (string) --
The name of the profile object type.
Description (string) --
Description of the profile object type.
TemplateId (string) --
A unique identifier for the object template.
ExpirationDays (integer) --
The number of days until the data in the object expires.
EncryptionKey (string) --
The customer-provided key to encrypt the profile object that will be created in this profile object type.
AllowProfileCreation (boolean) --
Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE . If the AllowProfileCreation flag is set to FALSE , then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE , and if no match is found, then the service creates a new standard profile.
Fields (dict) --
A map of the name and ObjectType field.
(string) --
(dict) --
Represents a field in a ProfileObjectType.
Source (string) --
A field of a ProfileObject. For example: _source.FirstName, where “_source” is a ProfileObjectType of a Zendesk user and “FirstName” is a field in that ObjectType.
Target (string) --
The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.
ContentType (string) --
The content type of the field. Used for determining equality when searching.
Keys (dict) --
A list of unique keys that can be used to map data to the profile.
(string) --
(list) --
(dict) --
An object that defines the Key element of a ProfileObject. A Key is a special element that can be used to search for a customer profile.
StandardIdentifiers (list) --
The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE means that this key can be used to tie an object to a PROFILE. UNIQUE means that it can be used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the profile does not already exist before the object is ingested, otherwise it is only used for matching objects to profiles.
(string) --
FieldNames (list) --
The reference for the key name of the fields map.
(string) --
CreatedAt (datetime) --
The timestamp of when the domain was created.
LastUpdatedAt (datetime) --
The timestamp of when the domain was most recently edited.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
Displays the tags associated with an Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
resourceArn='string'
)
string
[REQUIRED]
The ARN of the resource for which you want to view tags.
dict
Response Syntax
{
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
Returns a list of objects associated with a profile of a given ProfileObjectType.
See also: AWS API Documentation
Request Syntax
client.list_profile_objects(
NextToken='string',
MaxResults=123,
DomainName='string',
ObjectTypeName='string',
ProfileId='string'
)
string
The pagination token from the previous call to ListProfileObjects.
integer
The maximum number of objects returned per page.
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The name of the profile object type.
string
[REQUIRED]
The unique identifier of a customer profile.
dict
Response Syntax
{
'Items': [
{
'ObjectTypeName': 'string',
'ProfileObjectUniqueKey': 'string',
'Object': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of ListProfileObject instances.
(dict) --
A ProfileObject in a list of ProfileObjects.
ObjectTypeName (string) --
Specifies the kind of object being added to a profile, such as "Salesforce-Account."
ProfileObjectUniqueKey (string) --
The unique identifier of the ProfileObject generated by the service.
Object (string) --
A JSON representation of a ProfileObject that belongs to a profile.
NextToken (string) --
The pagination token from the previous call to ListProfileObjects.