String address1
The first line of a customer address.
String address2
The second line of a customer address.
String address3
The third line of a customer address.
String address4
The fourth line of a customer address.
String city
The city in which a customer lives.
String county
The county in which a customer lives.
String state
The state in which a customer lives.
String province
The province in which a customer lives.
String country
The country in which a customer lives.
String postalCode
The postal code of a customer address.
String domainName
The unique name of the domain.
Integer defaultExpirationDays
The default number of days until the data within the domain expires.
String defaultEncryptionKey
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 deadLetterQueueUrl
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.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String domainName
The unique name of the domain.
Integer defaultExpirationDays
The default number of days until the data within the domain expires.
String defaultEncryptionKey
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 deadLetterQueueUrl
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
Date createdAt
The timestamp of when the domain was created.
Date lastUpdatedAt
The timestamp of when the domain was most recently edited.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String domainName
The unique name of the domain.
String accountNumber
A unique account number that you have given to the customer.
String additionalInformation
Any additional information relevant to the customer's profile.
String partyType
The type of profile used to describe the customer.
String businessName
The name of the customer’s business.
String firstName
The customer’s first name.
String middleName
The customer’s middle name.
String lastName
The customer’s last name.
String birthDate
The customer’s birth date.
String gender
The gender with which the customer identifies.
String phoneNumber
The customer's phone number, which has not been specified as a mobile, home, or business number.
String mobilePhoneNumber
The customer’s mobile phone number.
String homePhoneNumber
The customer’s home phone number.
String businessPhoneNumber
The customer’s business phone number.
String emailAddress
The customer's email address, which has not been specified as a personal or business address.
String personalEmailAddress
The customer’s personal email address.
String businessEmailAddress
The customer’s business email address.
Address address
A generic address associated with the customer that is not mailing, shipping, or billing.
Address shippingAddress
The customer’s shipping address.
Address mailingAddress
The customer’s mailing address.
Address billingAddress
The customer’s billing address.
Map<K,V> attributes
A key value pair of attributes of a customer profile.
String profileId
The unique identifier of a customer profile.
String domainName
The unique name of the domain.
String message
A message that indicates the delete request is done.
String message
A message that indicates the delete request is done.
String message
A message that indicates the delete request is done.
String profileId
The unique identifier of a customer profile.
String profileObjectUniqueKey
The unique identifier of the profile object generated by the service.
String objectTypeName
The name of the profile object type.
String domainName
The unique name of the domain.
String message
A message that indicates the delete request is done.
String message
A message that indicates the delete request is done.
String message
A message that indicates the delete request is done.
Long profileCount
The total number of profiles currently in the domain.
Long meteringProfileCount
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.
Long objectCount
The total number of objects in domain.
Long totalSize
The total size, in bytes, of all objects in the domain.
String domainName
A unique name for the domain.
String domainName
The unique name of the domain.
Integer defaultExpirationDays
The default number of days until the data within the domain expires.
String defaultEncryptionKey
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 deadLetterQueueUrl
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
DomainStats stats
Usage-specific statistics about the domain.
Date createdAt
The timestamp of when the domain was created.
Date lastUpdatedAt
The timestamp of when the domain was most recently edited.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String domainName
The unique name of the domain.
String uri
The URI of the S3 bucket or any other type of data source.
String objectTypeName
The name of the profile object type.
Date createdAt
The timestamp of when the domain was created.
Date lastUpdatedAt
The timestamp of when the domain was most recently edited.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String objectTypeName
The name of the profile object type.
String description
The description of the profile object type.
String templateId
A unique identifier for the object template.
Integer expirationDays
The number of days until the data in the object expires.
String encryptionKey
The customer-provided key to encrypt the profile object that will be created in this profile object type.
Boolean allowProfileCreation
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.
Map<K,V> fields
A map of the name and ObjectType field.
Map<K,V> keys
A list of unique keys that can be used to map data to the profile.
Date createdAt
The timestamp of when the domain was created.
Date lastUpdatedAt
The timestamp of when the domain was most recently edited.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String templateId
A unique identifier for the object template.
String templateId
A unique identifier for the object template.
String sourceName
The name of the source of the object template.
String sourceObject
The source of the object template.
Boolean allowProfileCreation
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.
Map<K,V> fields
A map of the name and ObjectType field.
Map<K,V> keys
A list of unique keys that can be used to map data to the profile.
String domainName
The unique name of the domain.
Date createdAt
The timestamp of when the domain was created.
Date lastUpdatedAt
The timestamp of when the domain was most recently edited.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String domainName
The unique name of the domain.
String uri
The URI of the S3 bucket or any other type of data source.
String objectTypeName
The name of the profile object type.
Date createdAt
The timestamp of when the domain was created.
Date lastUpdatedAt
The timestamp of when the domain was most recently edited.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String objectTypeName
Specifies the kind of object being added to a profile, such as "Salesforce-Account."
String profileObjectUniqueKey
The unique identifier of the ProfileObject generated by the service.
String object
A JSON representation of a ProfileObject that belongs to a profile.
String nextToken
The pagination token from the previous call to ListProfileObjects.
Integer maxResults
The maximum number of objects returned per page.
String domainName
The unique name of the domain.
String objectTypeName
The name of the profile object type.
String profileId
The unique identifier of a customer profile.
String objectTypeName
The name of the profile object type.
String description
Description of the profile object type.
Date createdAt
The timestamp of when the domain was created.
Date lastUpdatedAt
The timestamp of when the domain was most recently edited.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String resourceArn
The ARN of the resource for which you want to view tags.
String source
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.
String target
The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.
String contentType
The content type of the field. Used for determining equality when searching.
List<E> standardIdentifiers
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.
List<E> fieldNames
The reference for the key name of the fields map.
String profileId
The unique identifier of a customer profile.
String accountNumber
A unique account number that you have given to the customer.
String additionalInformation
Any additional information relevant to the customer's profile.
String partyType
The type of profile used to describe the customer.
String businessName
The name of the customer’s business.
String firstName
The customer’s first name.
String middleName
The customer’s middle name.
String lastName
The customer’s last name.
String birthDate
The customer’s birth date.
String gender
The gender with which the customer identifies.
String phoneNumber
The customer's phone number, which has not been specified as a mobile, home, or business number.
String mobilePhoneNumber
The customer’s mobile phone number.
String homePhoneNumber
The customer’s home phone number.
String businessPhoneNumber
The customer’s home phone number.
String emailAddress
The customer's email address, which has not been specified as a personal or business address.
String personalEmailAddress
The customer’s personal email address.
String businessEmailAddress
The customer’s business email address.
Address address
A generic address associated with the customer that is not mailing, shipping, or billing.
Address shippingAddress
The customer’s shipping address.
Address mailingAddress
The customer’s mailing address.
Address billingAddress
The customer’s billing address.
Map<K,V> attributes
A key value pair of attributes of a customer profile.
String domainName
The unique name of the domain.
String uri
The URI of the S3 bucket or any other type of data source.
String objectTypeName
The name of the profile object type.
Date createdAt
The timestamp of when the domain was created.
Date lastUpdatedAt
The timestamp of when the domain was most recently edited.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String profileObjectUniqueKey
The unique identifier of the profile object generated by the service.
String domainName
The unique name of the domain.
String objectTypeName
The name of the profile object type.
String description
Description of the profile object type.
String templateId
A unique identifier for the object template.
Integer expirationDays
The number of days until the data in the object expires.
String encryptionKey
The customer-provided key to encrypt the profile object that will be created in this profile object type.
Boolean allowProfileCreation
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.
Map<K,V> fields
A map of the name and ObjectType field.
Map<K,V> keys
A list of unique keys that can be used to map data to the profile.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String objectTypeName
The name of the profile object type.
String description
Description of the profile object type.
String templateId
A unique identifier for the object template.
Integer expirationDays
The number of days until the data in the object expires.
String encryptionKey
The customer-provided key to encrypt the profile object that will be created in this profile object type.
Boolean allowProfileCreation
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.
Map<K,V> fields
A map of the name and ObjectType field.
Map<K,V> keys
A list of unique keys that can be used to map data to the profile.
Date createdAt
The timestamp of when the domain was created.
Date lastUpdatedAt
The timestamp of when the domain was most recently edited.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String nextToken
The pagination token from the previous SearchProfiles API call.
Integer maxResults
The maximum number of objects returned per page.
String domainName
The unique name of the domain.
String keyName
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<E> values
A list of key values.
String address1
The first line of a customer address.
String address2
The second line of a customer address.
String address3
The third line of a customer address.
String address4
The fourth line of a customer address.
String city
The city in which a customer lives.
String county
The county in which a customer lives.
String state
The state in which a customer lives.
String province
The province in which a customer lives.
String country
The country in which a customer lives.
String postalCode
The postal code of a customer address.
String domainName
The unique name for the domain.
Integer defaultExpirationDays
The default number of days until the data within the domain expires.
String defaultEncryptionKey
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 deadLetterQueueUrl
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.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String domainName
The unique name for the domain.
Integer defaultExpirationDays
The default number of days until the data within the domain expires.
String defaultEncryptionKey
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 deadLetterQueueUrl
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
Date createdAt
The timestamp of when the domain was created.
Date lastUpdatedAt
The timestamp of when the domain was most recently edited.
Map<K,V> tags
The tags used to organize, track, or control access for this resource.
String domainName
The unique name of the domain.
String profileId
The unique identifier of a customer profile.
String additionalInformation
Any additional information relevant to the customer's profile.
String accountNumber
A unique account number that you have given to the customer.
String partyType
The type of profile used to describe the customer.
String businessName
The name of the customer’s business.
String firstName
The customer’s first name.
String middleName
The customer’s middle name.
String lastName
The customer’s last name.
String birthDate
The customer’s birth date.
String gender
The gender with which the customer identifies.
String phoneNumber
The customer's phone number, which has not been specified as a mobile, home, or business number.
String mobilePhoneNumber
The customer’s mobile phone number.
String homePhoneNumber
The customer’s home phone number.
String businessPhoneNumber
The customer’s business phone number.
String emailAddress
The customer's email address, which has not been specified as a personal or business address.
String personalEmailAddress
The customer’s personal email address.
String businessEmailAddress
The customer’s business email address.
UpdateAddress address
A generic address associated with the customer that is not mailing, shipping, or billing.
UpdateAddress shippingAddress
The customer’s shipping address.
UpdateAddress mailingAddress
The customer’s mailing address.
UpdateAddress billingAddress
The customer’s billing address.
Map<K,V> attributes
A key value pair of attributes of a customer profile.
String profileId
The unique identifier of a customer profile.
Copyright © 2021. All rights reserved.