Amazon Connect Customer Profiles 2020-08-15
- Client: Aws\CustomerProfiles\CustomerProfilesClient
- Service ID: customer-profiles
- Version: 2020-08-15
This page describes the parameters and results for the operations of the Amazon Connect Customer Profiles (2020-08-15), and shows how to use the Aws\CustomerProfiles\CustomerProfilesClient object to call the described operations. This documentation is specific to the 2020-08-15 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- AddProfileKey ( array $params = [] )
Associates a new key value with a specific profile, such as a Contact Trace Record (CTR) ContactId.
- CreateDomain ( array $params = [] )
Creates a domain, which is a container for all customer data, such as customer profile attributes, object types, profile keys, and encryption keys.
- CreateProfile ( array $params = [] )
Creates a standard profile.
- DeleteDomain ( array $params = [] )
Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.
- DeleteIntegration ( array $params = [] )
Removes an integration from a specific domain.
- DeleteProfile ( array $params = [] )
Deletes the standard customer profile and all data pertaining to the profile.
- DeleteProfileKey ( array $params = [] )
Removes a searchable key from a customer profile.
- DeleteProfileObject ( array $params = [] )
Removes an object associated with a profile of a given ProfileObjectType.
- DeleteProfileObjectType ( array $params = [] )
Removes a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type.
- GetDomain ( array $params = [] )
Returns information about a specific domain.
- GetIntegration ( array $params = [] )
Returns an integration for a domain.
- GetProfileObjectType ( array $params = [] )
Returns the object types for a specific domain.
- GetProfileObjectTypeTemplate ( array $params = [] )
Returns the template information for a specific object type.
- ListAccountIntegrations ( array $params = [] )
Lists all of the integrations associated to a specific URI in the AWS account.
- ListDomains ( array $params = [] )
Returns a list of all the domains for an AWS account that have been created.
- ListIntegrations ( array $params = [] )
Lists all of the integrations in your domain.
- ListProfileObjectTypeTemplates ( array $params = [] )
Lists all of the template information for object types.
- ListProfileObjectTypes ( array $params = [] )
Lists all of the templates available within the service.
- ListProfileObjects ( array $params = [] )
Returns a list of objects associated with a profile of a given ProfileObjectType.
- ListTagsForResource ( array $params = [] )
Displays the tags associated with an Amazon Connect Customer Profiles resource.
- PutIntegration ( array $params = [] )
Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect.
- PutProfileObject ( array $params = [] )
Adds additional objects to customer profiles of a given ObjectType.
- PutProfileObjectType ( array $params = [] )
Defines a ProfileObjectType.
- SearchProfiles ( array $params = [] )
Searches for profiles within a specific domain name using name, phone number, email address, account number, or a custom defined index.
- TagResource ( array $params = [] )
Assigns one or more tags (key-value pairs) to the specified Amazon Connect Customer Profiles resource.
- UntagResource ( array $params = [] )
Removes one or more tags from the specified Amazon Connect Customer Profiles resource.
- UpdateDomain ( array $params = [] )
Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption key.
- UpdateProfile ( array $params = [] )
Updates the properties of a profile.
Operations
AddProfileKey
$result = $client->addProfileKey([/* ... */]); $promise = $client->addProfileKeyAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->addProfileKey([
'DomainName' => '<string>', // REQUIRED
'KeyName' => '<string>', // REQUIRED
'ProfileId' => '<string>', // REQUIRED
'Values' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'KeyName' => '<string>',
'Values' => ['<string>', ...],
]
Result Details
Members
Errors
-
The input you provided is invalid.
-
You do not have sufficient access to perform this action.
-
The requested resource does not exist, or access was denied.
-
You exceeded the maximum number of requests.
-
An internal service error occurred.
CreateDomain
$result = $client->createDomain([/* ... */]); $promise = $client->createDomainAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->createDomain([
'DeadLetterQueueUrl' => '<string>',
'DefaultEncryptionKey' => '<string>',
'DefaultExpirationDays' => <integer>, // REQUIRED
'DomainName' => '<string>', // REQUIRED
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- DeadLetterQueueUrl
-
- Type: 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.
- DefaultEncryptionKey
-
- Type: 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.
- DefaultExpirationDays
-
- Required: Yes
- Type: int
The default number of days until the data within the domain expires.
- DomainName
-
- Required: Yes
- Type: string
The unique name of the domain.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
Result Syntax
[
'CreatedAt' => <DateTime>,
'DeadLetterQueueUrl' => '<string>',
'DefaultEncryptionKey' => '<string>',
'DefaultExpirationDays' => <integer>,
'DomainName' => '<string>',
'LastUpdatedAt' => <DateTime>,
'Tags' => ['<string>', ...],
]
Result Details
Members
- CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the domain was created.
- DeadLetterQueueUrl
-
- Type: string
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
- DefaultEncryptionKey
-
- Type: 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.
- DefaultExpirationDays
-
- Required: Yes
- Type: int
The default number of days until the data within the domain expires.
- DomainName
-
- Required: Yes
- Type: string
The unique name of the domain.
- LastUpdatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the domain was most recently edited.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
Errors
-
The input you provided is invalid.
-
The requested resource does not exist, or access was denied.
-
You do not have sufficient access to perform this action.
-
You exceeded the maximum number of requests.
-
An internal service error occurred.
CreateProfile
$result = $client->createProfile([/* ... */]); $promise = $client->createProfileAsync([/* ... */]);
Creates a standard profile.
A standard profile represents the following attributes for a customer profile in a domain.
Parameter Syntax
$result = $client->createProfile([
'AccountNumber' => '<string>',
'AdditionalInformation' => '<string>',
'Address' => [
'Address1' => '<string>',
'Address2' => '<string>',
'Address3' => '<string>',
'Address4' => '<string>',
'City' => '<string>',
'Country' => '<string>',
'County' => '<string>',
'PostalCode' => '<string>',
'Province' => '<string>',
'State' => '<string>',
],
'Attributes' => ['<string>', ...],
'BillingAddress' => [
'Address1' => '<string>',
'Address2' => '<string>',
'Address3' => '<string>',
'Address4' => '<string>',
'City' => '<string>',
'Country' => '<string>',
'County' => '<string>',
'PostalCode' => '<string>',
'Province' => '<string>',
'State' => '<string>',
],
'BirthDate' => '<string>',
'BusinessEmailAddress' => '<string>',
'BusinessName' => '<string>',
'BusinessPhoneNumber' => '<string>',
'DomainName' => '<string>', // REQUIRED
'EmailAddress' => '<string>',
'FirstName' => '<string>',
'Gender' => 'MALE|FEMALE|UNSPECIFIED',
'HomePhoneNumber' => '<string>',
'LastName' => '<string>',
'MailingAddress' => [
'Address1' => '<string>',
'Address2' => '<string>',
'Address3' => '<string>',
'Address4' => '<string>',
'City' => '<string>',
'Country' => '<string>',
'County' => '<string>',
'PostalCode' => '<string>',
'Province' => '<string>',
'State' => '<string>',
],
'MiddleName' => '<string>',
'MobilePhoneNumber' => '<string>',
'PartyType' => 'INDIVIDUAL|BUSINESS|OTHER',
'PersonalEmailAddress' => '<string>',
'PhoneNumber' => '<string>',
'ShippingAddress' => [
'Address1' => '<string>',
'Address2' => '<string>',
'Address3' => '<string>',
'Address4' => '<string>',
'City' => '<string>',
'Country' => '<string>',
'County' => '<string>',
'PostalCode' => '<string>',
'Province' => '<string>',
'State' => '<string>',
],
]);
Parameter Details
Members
- AccountNumber
-
- Type: string
A unique account number that you have given to the customer.
- AdditionalInformation
-
- Type: string
Any additional information relevant to the customer's profile.
- Address
-
- Type: Address structure
A generic address associated with the customer that is not mailing, shipping, or billing.
- Attributes
-
- Type: Associative array of custom strings keys (string1To255) to strings
A key value pair of attributes of a customer profile.
- BillingAddress
-
- Type: Address structure
The customer’s billing address.
- BirthDate
-
- Type: string
The customer’s birth date.
- BusinessEmailAddress
-
- Type: string
The customer’s business email address.
- BusinessName
-
- Type: string
The name of the customer’s business.
- BusinessPhoneNumber
-
- Type: string
The customer’s business phone number.
- DomainName
-
- Required: Yes
- Type: string
The unique name of the domain.
- EmailAddress
-
- Type: string
The customer's email address, which has not been specified as a personal or business address.
- FirstName
-
- Type: string
The customer’s first name.
- Gender
-
- Type: string
The gender with which the customer identifies.
- HomePhoneNumber
-
- Type: string
The customer’s home phone number.
- LastName
-
- Type: string
The customer’s last name.
- MailingAddress
-
- Type: Address structure
The customer’s mailing address.
- MiddleName
-
- Type: string
The customer’s middle name.
- MobilePhoneNumber
-
- Type: string
The customer’s mobile phone number.
- PartyType
-
- Type: string
The type of profile used to describe the customer.
- PersonalEmailAddress
-
- Type: string
The customer’s personal email address.
- PhoneNumber
-
- Type: string
The customer's phone number, which has not been specified as a mobile, home, or business number.
- ShippingAddress
-
- Type: Address structure
The customer’s shipping address.
Result Syntax
[
'ProfileId' => '<string>',
]
Result Details
Errors
-
The input you provided is invalid.
-
You do not have sufficient access to perform this action.
-
The requested resource does not exist, or access was denied.
-
You exceeded the maximum number of requests.
-
An internal service error occurred.
DeleteDomain
$result = $client->deleteDomain([/* ... */]); $promise = $client->deleteDomainAsync([/* ... */]);
Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.
Parameter Syntax
$result = $client->deleteDomain([
'DomainName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Message' => '<string>',
]
Result Details
Errors
-
The input you provided is invalid.
-
The requested resource does not exist, or access was denied.
-
You do not have sufficient access to perform this action.
-
You exceeded the maximum number of requests.
-
An internal service error occurred.
DeleteIntegration
$result = $client->deleteIntegration([/* ... */]); $promise = $client->deleteIntegrationAsync([/* ... */]);
Removes an integration from a specific domain.
Parameter Syntax
$result = $client->deleteIntegration([
'DomainName' => '<string>', // REQUIRED
'Uri' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Message' => '<string>',
]
Result Details
Errors
-
The input you provided is invalid.
-
The requested resource does not exist, or access was denied.
-
You do not have sufficient access to perform this action.
-
You exceeded the maximum number of requests.
-
An internal service error occurred.
DeleteProfile
$result = $client->deleteProfile([/* ... */]); $promise = $client->deleteProfileAsync([/* ... */]);
Deletes the standard customer profile and all data pertaining to the profile.
Parameter Syntax
$result = $client->deleteProfile([
'DomainName' => '<string>', // REQUIRED
'ProfileId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Message' => '<string>',
]
Result Details
Errors
-
The input you provided is invalid.
-
You do not have sufficient access to perform this action.
-
The requested resource does not exist, or access was denied.
-
You exceeded the maximum number of requests.
-
An internal service error occurred.
DeleteProfileKey
$result = $client->deleteProfileKey([/* ... */]); $promise = $client->deleteProfileKeyAsync([/* ... */]);
Removes a searchable key from a customer profile.
Parameter Syntax
$result = $client->deleteProfileKey([
'DomainName' => '<string>', // REQUIRED
'KeyName' => '<string>', // REQUIRED
'ProfileId' => '<string>', // REQUIRED
'Values' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Message' => '<string>',
]
Result Details
Errors
-
The input you provided is invalid.
-
You do not have sufficient access to perform this action.
-
The requested resource does not exist, or access was denied.
-
You exceeded the maximum number of requests.
-
An internal service error occurred.
DeleteProfileObject
$result = $client->deleteProfileObject([/* ... */]); $promise = $client->deleteProfileObjectAsync([/* ... */]);
Removes an object associated with a profile of a given ProfileObjectType.
Parameter Syntax
$result = $client->deleteProfileObject([
'DomainName' => '<string>', // REQUIRED
'ObjectTypeName' => '<string>', // REQUIRED
'ProfileId' => '<string>', // REQUIRED
'ProfileObjectUniqueKey' => '<string>', // REQUIRED
]);
Parameter Details
Members
- DomainName
-
- Required: Yes
- Type: string
The unique name of the domain.
- ObjectTypeName
-
- Required: Yes
- Type: string
The name of the profile object type.
- ProfileId
-
- Required: Yes
- Type: string
The unique identifier of a customer profile.
- ProfileObjectUniqueKey
-
- Required: Yes
- Type: string
The unique identifier of the profile object generated by the service.
Result Syntax
[
'Message' => '<string>',
]
Result Details
Errors
-
The input you provided is invalid.
-
You do not have sufficient access to perform this action.
-
The requested resource does not exist, or access was denied.
-
You exceeded the maximum number of requests.
-
An internal service error occurred.
DeleteProfileObjectType
$result = $client->deleteProfileObjectType([/* ... */]); $promise = $client->deleteProfileObjectTypeAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteProfileObjectType([
'DomainName' => '<string>', // REQUIRED
'ObjectTypeName' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Message' => '<string>',
]
Result Details
Errors
-
The input you provided is invalid.
-
The requested resource does not exist, or access was denied.
-
You do not have sufficient access to perform this action.
-
You exceeded the maximum number of requests.
-
An internal service error occurred.
GetDomain
$result = $client->getDomain([/* ... */]); $promise = $client->getDomainAsync([/* ... */]);
Returns information about a specific domain.
Parameter Syntax
$result = $client->getDomain([
'DomainName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'CreatedAt' => <DateTime>,
'DeadLetterQueueUrl' => '<string>',
'DefaultEncryptionKey' => '<string>',
'DefaultExpirationDays' => <integer>,
'DomainName' => '<string>',
'LastUpdatedAt' => <DateTime>,
'Stats' => [
'MeteringProfileCount' => <integer>,
'ObjectCount' => <integer>,
'ProfileCount' => <integer>,
'TotalSize' => <integer>,
],
'Tags' => ['<string>', ...],
]
Result Details
Members
- CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the domain was created.
- DeadLetterQueueUrl
-
- Type: string
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
- DefaultEncryptionKey
-
- Type: 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.
- DefaultExpirationDays
-
- Type: int
The default number of days until the data within the domain expires.
- DomainName
-
- Required: Yes
- Type: string
The unique name of the domain.
- LastUpdatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the domain was most recently edited.
- Stats
-
- Type: DomainStats structure
Usage-specific statistics about the domain.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
Errors
-
The input you provided is invalid.
-
The requested resource does not exist, or access was denied.
-
You do not have sufficient access to perform this action.
-
You exceeded the maximum number of requests.
-
An internal service error occurred.
GetIntegration
$result = $client->getIntegration([/* ... */]); $promise = $client->getIntegrationAsync([/* ... */]);
Returns an integration for a domain.
Parameter Syntax
$result = $client->getIntegration([
'DomainName' => '<string>', // REQUIRED
'Uri' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'CreatedAt' => <DateTime>,
'DomainName' => '<string>',
'LastUpdatedAt' => <DateTime>,
'ObjectTypeName' => '<string>',
'Tags' => ['<string>', ...],
'Uri' => '<string>',
]
Result Details
Members
- CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the domain was created.
- DomainName
-
- Required: Yes
- Type: string
The unique name of the domain.
- LastUpdatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the domain was most recently edited.
- ObjectTypeName
-
- Required: Yes
- Type: string
The name of the profile object type.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
- Uri
-
- Required: Yes
- Type: string
The URI of the S3 bucket or any other type of data source.
Errors
-
The input you provided is invalid.
-
The requested resource does not exist, or access was denied.
-
You do not have sufficient access to perform this action.
-
You exceeded the maximum number of requests.
-
An internal service error occurred.
GetProfileObjectType
$result = $client->getProfileObjectType([/* ... */]); $promise = $client->getProfileObjectTypeAsync([/* ... */]);
Returns the object types for a specific domain.
Parameter Syntax
$result = $client->getProfileObjectType([
'DomainName' => '<string>', // REQUIRED
'ObjectTypeName' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'AllowProfileCreation' => true || false,
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'EncryptionKey' => '<string>',
'ExpirationDays' => <integer>,
'Fields' => [
'<name>' => [
'ContentType' => 'STRING|NUMBER|PHONE_NUMBER|EMAIL_ADDRESS|NAME',
'Source' => '<string>',
'Target' => '<string>',
],
// ...
],
'Keys' => [
'<name>' => [
[
'FieldNames' => ['<string>', ...],
'StandardIdentifiers' => ['<string>', ...],
],
// ...
],
// ...
],
'LastUpdatedAt' => <DateTime>,
'ObjectTypeName' => '<string>',
'Tags' => ['<string>', ...],
'TemplateId' => '<string>',
]
Result Details
Members
- AllowProfileCreation
-
- 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 toFALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set toTRUE, and if no match is found, then the service creates a new standard profile. - CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the domain was created.
- Description
-
- Required: Yes
- Type: string
The description of the profile object type.
- EncryptionKey
-
- Type: string
The customer-provided key to encrypt the profile object that will be created in this profile object type.
- ExpirationDays
-
- Type: int
The number of days until the data in the object expires.
- Fields
-
- Type: Associative array of custom strings keys (name) to ObjectTypeField structures
A map of the name and ObjectType field.
- Keys
-
- Type: Associative array of custom strings keys (name) to ObjectTypeKey structuress
A list of unique keys that can be used to map data to the profile.
- LastUpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the domain was most recently edited.
- ObjectTypeName
-
- Required: Yes
- Type: string
The name of the profile object type.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
- TemplateId
-
- Type: string
A unique identifier for the object template.
Errors
-
The input you provided is invalid.
-
The requested resource does not exist, or access was denied.
-
You do not have sufficient access to perform this action.
-
You exceeded the maximum number of requests.
-
An internal service error occurred.
GetProfileObjectTypeTemplate
$result = $client->getProfileObjectTypeTemplate([/* ... */]); $promise = $client->getProfileObjectTypeTemplateAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->getProfileObjectTypeTemplate([
'TemplateId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'AllowProfileCreation' => true || false,
'Fields' => [
'<name>' => [
'ContentType' => 'STRING|NUMBER|PHONE_NUMBER|EMAIL_ADDRESS|NAME',
'Source' => '<string>',
'Target' => '<string>',
],
// ...
],
'Keys' => [
'<name>' => [
[
'FieldNames' => ['<string>', ...],
'StandardIdentifiers' => ['<string>', ...],
],
// ...
],
// ...
],
'SourceName' => '<string>',
'SourceObject' => '<string>',
'TemplateId' => '<string>',
]
Result Details
Members
- AllowProfileCreation
-
- 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 toFALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set toTRUE, and if no match is found, then the service creates a new standard profile. - Fields
-
- Type: Associative array of custom strings keys (name) to ObjectTypeField structures
A map of the name and ObjectType field.
- Keys
-
- Type: Associative array of custom strings keys (name) to ObjectTypeKey structuress
A list of unique keys that can be used to map data to the profile.
- SourceName
-
- Type: string
The name of the source of the object template.
- SourceObject
-
- Type: string
The source of the object template.
- TemplateId
-
- Type: string
A unique identifier for the object template.
Errors
-
The input you provided is invalid.
-
The requested resource does not exist, or access was denied.
-
You do not have sufficient access to perform this action.
-
You exceeded the maximum number of requests.
-
An internal service error occurred.
ListAccountIntegrations
$result = $client->listAccountIntegrations([/* ... */]); $promise = $client->listAccountIntegrationsAsync([/* ... */]);
Lists all of the integrations associated to a specific URI in the AWS account.
Parameter Syntax
$result = $client->listAccountIntegrations([
'MaxResults' => <integer>,
'NextToken' => '<string>',
'Uri' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Items' => [
[
'CreatedAt' => <DateTime>,
'DomainName' => '<string>',
'LastUpdatedAt' => <DateTime>,
'ObjectTypeName' => '<string>',
'Tags' => ['<string>', ...],
'Uri' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Items
-
- Type: Array of ListIntegrationItem structures
The list of ListAccountIntegration instances.
- NextToken
-
- Type: string
The pagination token from the previous ListAccountIntegrations API call.
Errors
-
The input you provided is invalid.
-
The requested resource does not exist, or access was denied.
-
You do not have sufficient access to perform this action.
-
You exceeded the maximum number of requests.
-
An internal service error occurred.
ListDomains
$result = $client->listDomains([/* ... */]); $promise = $client->listDomainsAsync([/* ... */]);
Returns a list of all the domains for an AWS account that have been created.
Parameter Syntax
$result = $client->listDomains([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'Items' => [
[
'CreatedAt' => <DateTime>,
'DomainName' => '<string>',
'LastUpdatedAt' => <DateTime>,
'Tags' => ['<string>', ...],
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Items
-
- Type: Array of ListDomainItem structures
The list of ListDomains instances.
- NextToken
-
- Type: string
The pagination token from the previous ListDomains API call.
Errors
-
The input you provided is invalid.
-
The requested resource does not exist, or access was denied.
-
You do not have sufficient access to perform this action.
-
You exceeded the maximum number of requests.
-
An internal service error occurred.
ListIntegrations
$result = $client->listIntegrations([/* ... */]); $promise = $client->listIntegrationsAsync([/* ... */]);
Lists all of the integrations in your domain.
Parameter Syntax
$result = $client->listIntegrations([
'DomainName' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'Items' => [
[
'CreatedAt' => <DateTime>,
'DomainName' => '<string>',
'LastUpdatedAt' => <DateTime>,
'ObjectTypeName' => '<string>',
'Tags' => ['<string>', ...],
'Uri' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Items
-
- Type: Array of ListIntegrationItem structures
The list of ListIntegrations instances.
- NextToken
-
- Type: string
The pagination token from the previous ListIntegrations API call.
Errors
-
The input you provided is invalid.
-
The requested resource does not exist, or access was denied.
-
You do not have sufficient access to perform this action.
-
You exceeded the maximum number of requests.
-
An internal service error occurred.
ListProfileObjectTypeTemplates
$result = $client->listProfileObjectTypeTemplates([/* ... */]); $promise = $client->listProfileObjectTypeTemplatesAsync([/* ... */]);
Lists all of the template information for object types.
Parameter Syntax
$result = $client->listProfileObjectTypeTemplates([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'Items' => [
[
'SourceName' => '<string>',
'SourceObject' => '<string>',
'TemplateId' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Items
-
- Type: Array of ListProfileObjectTypeTemplateItem structures
The list of ListProfileObjectType template instances.
- NextToken
-
- Type: string
The pagination token from the previous ListObjectTypeTemplates API call.
Errors
-
The input you provided is invalid.
-
The requested resource does not exist, or access was denied.
-
You do not have sufficient access to perform this action.
-
You exceeded the maximum number of requests.
-
An internal service error occurred.
ListProfileObjectTypes
$result = $client->listProfileObjectTypes([/* ... */]); $promise = $client->listProfileObjectTypesAsync([/* ... */]);
Lists all of the templates available within the service.
Parameter Syntax
$result = $client->listProfileObjectTypes([
'DomainName' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'Items' => [
[
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'LastUpdatedAt' => <DateTime>,
'ObjectTypeName' => '<string>',
'Tags' => ['<string>', ...],
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Items
-
- Type: Array of ListProfileObjectTypeItem structures
The list of ListProfileObjectTypes instances.
- NextToken
-
- Type: string
Identifies the next page of results to return.
Errors
-
The input you provided is invalid.
-
The requested resource does not exist, or access was denied.
-
You do not have sufficient access to perform this action.
-
You exceeded the maximum number of requests.
-
An internal service error occurred.
ListProfileObjects
$result = $client->listProfileObjects([/* ... */]); $promise = $client->listProfileObjectsAsync([/* ... */]);
Returns a list of objects associated with a profile of a given ProfileObjectType.
Parameter Syntax
$result = $client->listProfileObjects([
'DomainName' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
'ObjectTypeName' => '<string>', // REQUIRED
'ProfileId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- DomainName
-
- Required: Yes
- Type: string
The unique name of the domain.
- MaxResults
-
- Type: int
The maximum number of objects returned per page.
- NextToken
-
- Type: string
The pagination token from the previous call to ListProfileObjects.
- ObjectTypeName
-
- Required: Yes
- Type: string
The name of the profile object type.
- ProfileId
-
- Required: Yes
- Type: string
The unique identifier of a customer profile.
Result Syntax
[
'Items' => [
[
'Object' => '<string>',
'ObjectTypeName' => '<string>',
'ProfileObjectUniqueKey' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Items
-
- Type: Array of ListProfileObjectsItem structures
The list of ListProfileObject instances.
- NextToken
-
- Type: string
The pagination token from the previous call to ListProfileObjects.
Errors
-
The input you provided is invalid.
-
You do not have sufficient access to perform this action.
-
The requested resource does not exist, or access was denied.
-
You exceeded the maximum number of requests.
-
An internal service error occurred.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Displays the tags associated with an Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.
Parameter Syntax
$result = $client->listTagsForResource([
'resourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'tags' => ['<string>', ...],
]
Result Details
Members
Errors
-
An internal service error occurred.
-
The input you provided is invalid.
-
The requested resource does not exist, or access was denied.
PutIntegration
$result = $client->putIntegration([/* ... */]); $promise = $client->putIntegrationAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->putIntegration([
'DomainName' => '<string>', // REQUIRED
'ObjectTypeName' => '<string>', // REQUIRED
'Tags' => ['<string>', ...],
'Uri' => '<string>', // REQUIRED
]);
Parameter Details
Members
- DomainName
-
- Required: Yes
- Type: string
The unique name of the domain.
- ObjectTypeName
-
- Required: Yes
- Type: string
The name of the profile object type.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
- Uri
-
- Required: Yes
- Type: string
The URI of the S3 bucket or any other type of data source.
Result Syntax
[
'CreatedAt' => <DateTime>,
'DomainName' => '<string>',
'LastUpdatedAt' => <DateTime>,
'ObjectTypeName' => '<string>',
'Tags' => ['<string>', ...],
'Uri' => '<string>',
]
Result Details
Members
- CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the domain was created.
- DomainName
-
- Required: Yes
- Type: string
The unique name of the domain.
- LastUpdatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the domain was most recently edited.
- ObjectTypeName
-
- Required: Yes
- Type: string
The name of the profile object type.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
- Uri
-
- Required: Yes
- Type: string
The URI of the S3 bucket or any other type of data source.
Errors
-
The input you provided is invalid.
-
The requested resource does not exist, or access was denied.
-
You do not have sufficient access to perform this action.
-
You exceeded the maximum number of requests.
-
An internal service error occurred.
PutProfileObject
$result = $client->putProfileObject([/* ... */]); $promise = $client->putProfileObjectAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->putProfileObject([
'DomainName' => '<string>', // REQUIRED
'Object' => '<string>', // REQUIRED
'ObjectTypeName' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ProfileObjectUniqueKey' => '<string>',
]
Result Details
Members
Errors
-
The input you provided is invalid.
-
You do not have sufficient access to perform this action.
-
The requested resource does not exist, or access was denied.
-
You exceeded the maximum number of requests.
-
An internal service error occurred.
PutProfileObjectType
$result = $client->putProfileObjectType([/* ... */]); $promise = $client->putProfileObjectTypeAsync([/* ... */]);
Defines a ProfileObjectType.
Parameter Syntax
$result = $client->putProfileObjectType([
'AllowProfileCreation' => true || false,
'Description' => '<string>', // REQUIRED
'DomainName' => '<string>', // REQUIRED
'EncryptionKey' => '<string>',
'ExpirationDays' => <integer>,
'Fields' => [
'<name>' => [
'ContentType' => 'STRING|NUMBER|PHONE_NUMBER|EMAIL_ADDRESS|NAME',
'Source' => '<string>',
'Target' => '<string>',
],
// ...
],
'Keys' => [
'<name>' => [
[
'FieldNames' => ['<string>', ...],
'StandardIdentifiers' => ['<string>', ...],
],
// ...
],
// ...
],
'ObjectTypeName' => '<string>', // REQUIRED
'Tags' => ['<string>', ...],
'TemplateId' => '<string>',
]);
Parameter Details
Members
- AllowProfileCreation
-
- 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 toFALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set toTRUE, and if no match is found, then the service creates a new standard profile. - Description
-
- Required: Yes
- Type: string
Description of the profile object type.
- DomainName
-
- Required: Yes
- Type: string
The unique name of the domain.
- EncryptionKey
-
- Type: string
The customer-provided key to encrypt the profile object that will be created in this profile object type.
- ExpirationDays
-
- Type: int
The number of days until the data in the object expires.
- Fields
-
- Type: Associative array of custom strings keys (name) to ObjectTypeField structures
A map of the name and ObjectType field.
- Keys
-
- Type: Associative array of custom strings keys (name) to ObjectTypeKey structuress
A list of unique keys that can be used to map data to the profile.
- ObjectTypeName
-
- Required: Yes
- Type: string
The name of the profile object type.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
- TemplateId
-
- Type: string
A unique identifier for the object template.
Result Syntax
[
'AllowProfileCreation' => true || false,
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'EncryptionKey' => '<string>',
'ExpirationDays' => <integer>,
'Fields' => [
'<name>' => [
'ContentType' => 'STRING|NUMBER|PHONE_NUMBER|EMAIL_ADDRESS|NAME',
'Source' => '<string>',
'Target' => '<string>',
],
// ...
],
'Keys' => [
'<name>' => [
[
'FieldNames' => ['<string>', ...],
'StandardIdentifiers' => ['<string>', ...],
],
// ...
],
// ...
],
'LastUpdatedAt' => <DateTime>,
'ObjectTypeName' => '<string>',
'Tags' => ['<string>', ...],
'TemplateId' => '<string>',
]
Result Details
Members
- AllowProfileCreation
-
- 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 toFALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set toTRUE, and if no match is found, then the service creates a new standard profile. - CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the domain was created.
- Description
-
- Required: Yes
- Type: string
Description of the profile object type.
- EncryptionKey
-
- Type: string
The customer-provided key to encrypt the profile object that will be created in this profile object type.
- ExpirationDays
-
- Type: int
The number of days until the data in the object expires.
- Fields
-
- Type: Associative array of custom strings keys (name) to ObjectTypeField structures
A map of the name and ObjectType field.
- Keys
-
- Type: Associative array of custom strings keys (name) to ObjectTypeKey structuress
A list of unique keys that can be used to map data to the profile.
- LastUpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the domain was most recently edited.
- ObjectTypeName
-
- Required: Yes
- Type: string
The name of the profile object type.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
- TemplateId
-
- Type: string
A unique identifier for the object template.
Errors
-
The input you provided is invalid.
-
The requested resource does not exist, or access was denied.
-
You do not have sufficient access to perform this action.
-
You exceeded the maximum number of requests.
-
An internal service error occurred.
SearchProfiles
$result = $client->searchProfiles([/* ... */]); $promise = $client->searchProfilesAsync([/* ... */]);
Searches for profiles within a specific domain name using name, phone number, email address, account number, or a custom defined index.
Parameter Syntax
$result = $client->searchProfiles([
'DomainName' => '<string>', // REQUIRED
'KeyName' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
'Values' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- DomainName
-
- Required: Yes
- Type: string
The unique name of the domain.
- KeyName
-
- Required: Yes
- Type: string
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.
- MaxResults
-
- Type: int
The maximum number of objects returned per page.
- NextToken
-
- Type: string
The pagination token from the previous SearchProfiles API call.
- Values
-
- Required: Yes
- Type: Array of strings
A list of key values.
Result Syntax
[
'Items' => [
[
'AccountNumber' => '<string>',
'AdditionalInformation' => '<string>',
'Address' => [
'Address1' => '<string>',
'Address2' => '<string>',
'Address3' => '<string>',
'Address4' => '<string>',
'City' => '<string>',
'Country' => '<string>',
'County' => '<string>',
'PostalCode' => '<string>',
'Province' => '<string>',
'State' => '<string>',
],
'Attributes' => ['<string>', ...],
'BillingAddress' => [
'Address1' => '<string>',
'Address2' => '<string>',
'Address3' => '<string>',
'Address4' => '<string>',
'City' => '<string>',
'Country' => '<string>',
'County' => '<string>',
'PostalCode' => '<string>',
'Province' => '<string>',
'State' => '<string>',
],
'BirthDate' => '<string>',
'BusinessEmailAddress' => '<string>',
'BusinessName' => '<string>',
'BusinessPhoneNumber' => '<string>',
'EmailAddress' => '<string>',
'FirstName' => '<string>',
'Gender' => 'MALE|FEMALE|UNSPECIFIED',
'HomePhoneNumber' => '<string>',
'LastName' => '<string>',
'MailingAddress' => [
'Address1' => '<string>',
'Address2' => '<string>',
'Address3' => '<string>',
'Address4' => '<string>',
'City' => '<string>',
'Country' => '<string>',
'County' => '<string>',
'PostalCode' => '<string>',
'Province' => '<string>',
'State' => '<string>',
],
'MiddleName' => '<string>',
'MobilePhoneNumber' => '<string>',
'PartyType' => 'INDIVIDUAL|BUSINESS|OTHER',
'PersonalEmailAddress' => '<string>',
'PhoneNumber' => '<string>',
'ProfileId' => '<string>',
'ShippingAddress' => [
'Address1' => '<string>',
'Address2' => '<string>',
'Address3' => '<string>',
'Address4' => '<string>',
'City' => '<string>',
'Country' => '<string>',
'County' => '<string>',
'PostalCode' => '<string>',
'Province' => '<string>',
'State' => '<string>',
],
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Items
-
- Type: Array of Profile structures
The list of SearchProfiles instances.
- NextToken
-
- Type: string
The pagination token from the previous SearchProfiles API call.
Errors
-
The input you provided is invalid.
-
You do not have sufficient access to perform this action.
-
The requested resource does not exist, or access was denied.
-
You exceeded the maximum number of requests.
-
An internal service error occurred.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->tagResource([
'resourceArn' => '<string>', // REQUIRED
'tags' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
An internal service error occurred.
-
The input you provided is invalid.
-
The requested resource does not exist, or access was denied.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->untagResource([
'resourceArn' => '<string>', // REQUIRED
'tagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
An internal service error occurred.
-
The input you provided is invalid.
-
The requested resource does not exist, or access was denied.
UpdateDomain
$result = $client->updateDomain([/* ... */]); $promise = $client->updateDomainAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->updateDomain([
'DeadLetterQueueUrl' => '<string>',
'DefaultEncryptionKey' => '<string>',
'DefaultExpirationDays' => <integer>,
'DomainName' => '<string>', // REQUIRED
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- DeadLetterQueueUrl
-
- Type: 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.
- DefaultEncryptionKey
-
- Type: 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.
- DefaultExpirationDays
-
- Type: int
The default number of days until the data within the domain expires.
- DomainName
-
- Required: Yes
- Type: string
The unique name for the domain.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
Result Syntax
[
'CreatedAt' => <DateTime>,
'DeadLetterQueueUrl' => '<string>',
'DefaultEncryptionKey' => '<string>',
'DefaultExpirationDays' => <integer>,
'DomainName' => '<string>',
'LastUpdatedAt' => <DateTime>,
'Tags' => ['<string>', ...],
]
Result Details
Members
- CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the domain was created.
- DeadLetterQueueUrl
-
- Type: string
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
- DefaultEncryptionKey
-
- Type: 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.
- DefaultExpirationDays
-
- Type: int
The default number of days until the data within the domain expires.
- DomainName
-
- Required: Yes
- Type: string
The unique name for the domain.
- LastUpdatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the domain was most recently edited.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
Errors
-
The input you provided is invalid.
-
The requested resource does not exist, or access was denied.
-
You do not have sufficient access to perform this action.
-
You exceeded the maximum number of requests.
-
An internal service error occurred.
UpdateProfile
$result = $client->updateProfile([/* ... */]); $promise = $client->updateProfileAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->updateProfile([
'AccountNumber' => '<string>',
'AdditionalInformation' => '<string>',
'Address' => [
'Address1' => '<string>',
'Address2' => '<string>',
'Address3' => '<string>',
'Address4' => '<string>',
'City' => '<string>',
'Country' => '<string>',
'County' => '<string>',
'PostalCode' => '<string>',
'Province' => '<string>',
'State' => '<string>',
],
'Attributes' => ['<string>', ...],
'BillingAddress' => [
'Address1' => '<string>',
'Address2' => '<string>',
'Address3' => '<string>',
'Address4' => '<string>',
'City' => '<string>',
'Country' => '<string>',
'County' => '<string>',
'PostalCode' => '<string>',
'Province' => '<string>',
'State' => '<string>',
],
'BirthDate' => '<string>',
'BusinessEmailAddress' => '<string>',
'BusinessName' => '<string>',
'BusinessPhoneNumber' => '<string>',
'DomainName' => '<string>', // REQUIRED
'EmailAddress' => '<string>',
'FirstName' => '<string>',
'Gender' => 'MALE|FEMALE|UNSPECIFIED',
'HomePhoneNumber' => '<string>',
'LastName' => '<string>',
'MailingAddress' => [
'Address1' => '<string>',
'Address2' => '<string>',
'Address3' => '<string>',
'Address4' => '<string>',
'City' => '<string>',
'Country' => '<string>',
'County' => '<string>',
'PostalCode' => '<string>',
'Province' => '<string>',
'State' => '<string>',
],
'MiddleName' => '<string>',
'MobilePhoneNumber' => '<string>',
'PartyType' => 'INDIVIDUAL|BUSINESS|OTHER',
'PersonalEmailAddress' => '<string>',
'PhoneNumber' => '<string>',
'ProfileId' => '<string>', // REQUIRED
'ShippingAddress' => [
'Address1' => '<string>',
'Address2' => '<string>',
'Address3' => '<string>',
'Address4' => '<string>',
'City' => '<string>',
'Country' => '<string>',
'County' => '<string>',
'PostalCode' => '<string>',
'Province' => '<string>',
'State' => '<string>',
],
]);
Parameter Details
Members
- AccountNumber
-
- Type: string
A unique account number that you have given to the customer.
- AdditionalInformation
-
- Type: string
Any additional information relevant to the customer's profile.
- Address
-
- Type: UpdateAddress structure
A generic address associated with the customer that is not mailing, shipping, or billing.
- Attributes
-
- Type: Associative array of custom strings keys (string1To255) to strings
A key value pair of attributes of a customer profile.
- BillingAddress
-
- Type: UpdateAddress structure
The customer’s billing address.
- BirthDate
-
- Type: string
The customer’s birth date.
- BusinessEmailAddress
-
- Type: string
The customer’s business email address.
- BusinessName
-
- Type: string
The name of the customer’s business.
- BusinessPhoneNumber
-
- Type: string
The customer’s business phone number.
- DomainName
-
- Required: Yes
- Type: string
The unique name of the domain.
- EmailAddress
-
- Type: string
The customer's email address, which has not been specified as a personal or business address.
- FirstName
-
- Type: string
The customer’s first name.
- Gender
-
- Type: string
The gender with which the customer identifies.
- HomePhoneNumber
-
- Type: string
The customer’s home phone number.
- LastName
-
- Type: string
The customer’s last name.
- MailingAddress
-
- Type: UpdateAddress structure
The customer’s mailing address.
- MiddleName
-
- Type: string
The customer’s middle name.
- MobilePhoneNumber
-
- Type: string
The customer’s mobile phone number.
- PartyType
-
- Type: string
The type of profile used to describe the customer.
- PersonalEmailAddress
-
- Type: string
The customer’s personal email address.
- PhoneNumber
-
- Type: string
The customer's phone number, which has not been specified as a mobile, home, or business number.
- ProfileId
-
- Required: Yes
- Type: string
The unique identifier of a customer profile.
- ShippingAddress
-
- Type: UpdateAddress structure
The customer’s shipping address.
Result Syntax
[
'ProfileId' => '<string>',
]
Result Details
Errors
-
The input you provided is invalid.
-
You do not have sufficient access to perform this action.
-
The requested resource does not exist, or access was denied.
-
You exceeded the maximum number of requests.
-
An internal service error occurred.
Shapes
AccessDeniedException
Address
Description
A generic address associated with the customer that is not mailing, shipping, or billing.
Members
- Address1
-
- Type: string
The first line of a customer address.
- Address2
-
- Type: string
The second line of a customer address.
- Address3
-
- Type: string
The third line of a customer address.
- Address4
-
- Type: string
The fourth line of a customer address.
- City
-
- Type: string
The city in which a customer lives.
- Country
-
- Type: string
The country in which a customer lives.
- County
-
- Type: string
The county in which a customer lives.
- PostalCode
-
- Type: string
The postal code of a customer address.
- Province
-
- Type: string
The province in which a customer lives.
- State
-
- Type: string
The state in which a customer lives.
BadRequestException
DomainStats
Description
Usage-specific statistics about the domain.
Members
- MeteringProfileCount
-
- Type: long (int|float)
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
-
- Type: long (int|float)
The total number of objects in domain.
- ProfileCount
-
- Type: long (int|float)
The total number of profiles currently in the domain.
- TotalSize
-
- Type: long (int|float)
The total size, in bytes, of all objects in the domain.
InternalServerException
ListDomainItem
Description
An object in a list that represents a domain.
Members
- CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the domain was created.
- DomainName
-
- Required: Yes
- Type: string
The unique name of the domain.
- LastUpdatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the domain was most recently edited.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
ListIntegrationItem
Description
An integration in list of integrations.
Members
- CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the domain was created.
- DomainName
-
- Required: Yes
- Type: string
The unique name of the domain.
- LastUpdatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the domain was most recently edited.
- ObjectTypeName
-
- Required: Yes
- Type: string
The name of the profile object type.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
- Uri
-
- Required: Yes
- Type: string
The URI of the S3 bucket or any other type of data source.
ListProfileObjectTypeItem
Description
A ProfileObjectType instance.
Members
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the domain was created.
- Description
-
- Required: Yes
- Type: string
Description of the profile object type.
- LastUpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the domain was most recently edited.
- ObjectTypeName
-
- Required: Yes
- Type: string
The name of the profile object type.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
ListProfileObjectTypeTemplateItem
Description
A ProfileObjectTypeTemplate in a list of ProfileObjectTypeTemplates.
Members
ListProfileObjectsItem
Description
A ProfileObject in a list of ProfileObjects.
Members
- Object
-
- Type: string
A JSON representation of a ProfileObject that belongs to a profile.
- ObjectTypeName
-
- Type: string
Specifies the kind of object being added to a profile, such as "Salesforce-Account."
- ProfileObjectUniqueKey
-
- Type: string
The unique identifier of the ProfileObject generated by the service.
ObjectTypeField
Description
Represents a field in a ProfileObjectType.
Members
- ContentType
-
- Type: string
The content type of the field. Used for determining equality when searching.
- Source
-
- Type: 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
-
- Type: string
The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.
ObjectTypeKey
Description
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.
Members
- FieldNames
-
- Type: Array of strings
The reference for the key name of the fields map.
- StandardIdentifiers
-
- Type: Array of strings
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.
Profile
Description
The standard profile of a customer.
Members
- AccountNumber
-
- Type: string
A unique account number that you have given to the customer.
- AdditionalInformation
-
- Type: string
Any additional information relevant to the customer's profile.
- Address
-
- Type: Address structure
A generic address associated with the customer that is not mailing, shipping, or billing.
- Attributes
-
- Type: Associative array of custom strings keys (string1To255) to strings
A key value pair of attributes of a customer profile.
- BillingAddress
-
- Type: Address structure
The customer’s billing address.
- BirthDate
-
- Type: string
The customer’s birth date.
- BusinessEmailAddress
-
- Type: string
The customer’s business email address.
- BusinessName
-
- Type: string
The name of the customer’s business.
- BusinessPhoneNumber
-
- Type: string
The customer’s home phone number.
- EmailAddress
-
- Type: string
The customer's email address, which has not been specified as a personal or business address.
- FirstName
-
- Type: string
The customer’s first name.
- Gender
-
- Type: string
The gender with which the customer identifies.
- HomePhoneNumber
-
- Type: string
The customer’s home phone number.
- LastName
-
- Type: string
The customer’s last name.
- MailingAddress
-
- Type: Address structure
The customer’s mailing address.
- MiddleName
-
- Type: string
The customer’s middle name.
- MobilePhoneNumber
-
- Type: string
The customer’s mobile phone number.
- PartyType
-
- Type: string
The type of profile used to describe the customer.
- PersonalEmailAddress
-
- Type: string
The customer’s personal email address.
- PhoneNumber
-
- Type: string
The customer's phone number, which has not been specified as a mobile, home, or business number.
- ProfileId
-
- Type: string
The unique identifier of a customer profile.
- ShippingAddress
-
- Type: Address structure
The customer’s shipping address.
ResourceNotFoundException
Description
The requested resource does not exist, or access was denied.
Members
ThrottlingException
UpdateAddress
Description
Updates associated with the address properties of a customer profile.
Members
- Address1
-
- Type: string
The first line of a customer address.
- Address2
-
- Type: string
The second line of a customer address.
- Address3
-
- Type: string
The third line of a customer address.
- Address4
-
- Type: string
The fourth line of a customer address.
- City
-
- Type: string
The city in which a customer lives.
- Country
-
- Type: string
The country in which a customer lives.
- County
-
- Type: string
The county in which a customer lives.
- PostalCode
-
- Type: string
The postal code of a customer address.
- Province
-
- Type: string
The province in which a customer lives.
- State
-
- Type: string
The state in which a customer lives.